REST API for Oracle Integration 3

Create an Inbound Agreement

post

/ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs

Creates an inbound agreement for the trading partner. The request body must contain at least the name and docId fields.

Request

Path Parameters

tpId(required): string

Trading partner ID.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

inboundAgrUI: InboundAgrRs

{
    "type":"object",
    "properties":{
        "inboundAgrUI":{
            "$ref":"#/components/schemas/InboundAgrRs"
        }
    }
}

Nested Schema : InboundAgrRs

Match All

Show Source

allOf IdRs
object GenericRestRs
object InboundAgrRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                },
                "name":{
                    "type":"string"
                },
                "desc":{
                    "type":"string"
                },
                "docStd":{
                    "type":"string"
                },
                "docVersion":{
                    "type":"string"
                },
                "docTxId":{
                    "type":"string"
                },
                "docDef":{
                    "type":"string"
                },
                "docId":{
                    "type":"string"
                },
                "status":{
                    "type":"string"
                },
                "createdDate":{
                    "type":"string"
                },
                "lastDeployed":{
                    "type":"string"
                },
                "updatedDate":{
                    "type":"string"
                },
                "backendIntgName":{
                    "type":"string"
                },
                "backendIntgCode":{
                    "type":"string"
                },
                "backendIntgVersion":{
                    "type":"string"
                },
                "backendIntgProjectcode":{
                    "type":"string"
                },
                "warning":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "params":{
                    "$ref":"#/components/schemas/InboundAgr.Params"
                },
                "tpmVerson":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : IdRs

Match All

Show Source

object GenericRestRs
object IdRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        }
    }
}

Nested Schema : IdRs-allOf[1]

Type: object

Show Source

id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : InboundAgrRs-allOf[2]

Type: object

Show Source

backendIntgCode: string
backendIntgName: string
backendIntgProjectcode: string
backendIntgVersion: string
createdDate: string
desc: string
docDef: string
docId: string
docStd: string
docTxId: string
docVersion: string
id: string
lastDeployed: string
name: string
params: object InboundAgr.Params
status: string
tpmVerson: string
updatedDate: string
warning: array warning

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        },
        "docStd":{
            "type":"string"
        },
        "docVersion":{
            "type":"string"
        },
        "docTxId":{
            "type":"string"
        },
        "docDef":{
            "type":"string"
        },
        "docId":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "lastDeployed":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "backendIntgName":{
            "type":"string"
        },
        "backendIntgCode":{
            "type":"string"
        },
        "backendIntgVersion":{
            "type":"string"
        },
        "backendIntgProjectcode":{
            "type":"string"
        },
        "warning":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "params":{
            "$ref":"#/components/schemas/InboundAgr.Params"
        },
        "tpmVerson":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SuiteLink"
    }
}

Nested Schema : SuiteLink

Type: object

Show Source

href: string
media-type: string
method: string
rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

Nested Schema : InboundAgr.Params

Type: object

Show Source

acceptGroup: string
acceptGroupName: string
duplicateCtrlNumCheck: boolean

Gets the value of the duplicateCtrlNumCheck property. possible object is Boolean
fa: boolean

Gets the value of the fa property. possible object is Boolean
rejectGroup: string
rejectGroupName: string
validate: boolean

Gets the value of the validate property. possible object is Boolean

{
    "type":"object",
    "properties":{
        "acceptGroupName":{
            "type":"string"
        },
        "rejectGroupName":{
            "type":"string"
        },
        "validate":{
            "type":"boolean",
            "description":"Gets the value of the validate property.\n \n     possible object is\n     Boolean"
        },
        "fa":{
            "type":"boolean",
            "description":"Gets the value of the fa property.\n \n     possible object is\n     Boolean"
        },
        "duplicateCtrlNumCheck":{
            "type":"boolean",
            "description":"Gets the value of the duplicateCtrlNumCheck property.\n \n     possible object is\n     Boolean"
        },
        "acceptGroup":{
            "type":"string"
        },
        "rejectGroup":{
            "type":"string"
        }
    }
}

Nested Schema : warning

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

201 Response

Successful operation

Root Schema : InboundAgrRs

Match All

Show Source

allOf IdRs
object GenericRestRs
object InboundAgrRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                },
                "name":{
                    "type":"string"
                },
                "desc":{
                    "type":"string"
                },
                "docStd":{
                    "type":"string"
                },
                "docVersion":{
                    "type":"string"
                },
                "docTxId":{
                    "type":"string"
                },
                "docDef":{
                    "type":"string"
                },
                "docId":{
                    "type":"string"
                },
                "status":{
                    "type":"string"
                },
                "createdDate":{
                    "type":"string"
                },
                "lastDeployed":{
                    "type":"string"
                },
                "updatedDate":{
                    "type":"string"
                },
                "backendIntgName":{
                    "type":"string"
                },
                "backendIntgCode":{
                    "type":"string"
                },
                "backendIntgVersion":{
                    "type":"string"
                },
                "backendIntgProjectcode":{
                    "type":"string"
                },
                "warning":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "params":{
                    "$ref":"#/components/schemas/InboundAgr.Params"
                },
                "tpmVerson":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : IdRs

Match All

Show Source

object GenericRestRs
object IdRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        }
    }
}

Nested Schema : IdRs-allOf[1]

Type: object

Show Source

id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : InboundAgrRs-allOf[2]

Type: object

Show Source

backendIntgCode: string
backendIntgName: string
backendIntgProjectcode: string
backendIntgVersion: string
createdDate: string
desc: string
docDef: string
docId: string
docStd: string
docTxId: string
docVersion: string
id: string
lastDeployed: string
name: string
params: object InboundAgr.Params
status: string
tpmVerson: string
updatedDate: string
warning: array warning

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        },
        "docStd":{
            "type":"string"
        },
        "docVersion":{
            "type":"string"
        },
        "docTxId":{
            "type":"string"
        },
        "docDef":{
            "type":"string"
        },
        "docId":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "lastDeployed":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "backendIntgName":{
            "type":"string"
        },
        "backendIntgCode":{
            "type":"string"
        },
        "backendIntgVersion":{
            "type":"string"
        },
        "backendIntgProjectcode":{
            "type":"string"
        },
        "warning":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "params":{
            "$ref":"#/components/schemas/InboundAgr.Params"
        },
        "tpmVerson":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SuiteLink"
    }
}

Nested Schema : SuiteLink

Type: object

Show Source

href: string
media-type: string
method: string
rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

Nested Schema : InboundAgr.Params

Type: object

Show Source

acceptGroup: string
acceptGroupName: string
duplicateCtrlNumCheck: boolean

Gets the value of the duplicateCtrlNumCheck property. possible object is Boolean
fa: boolean

Gets the value of the fa property. possible object is Boolean
rejectGroup: string
rejectGroupName: string
validate: boolean

Gets the value of the validate property. possible object is Boolean

{
    "type":"object",
    "properties":{
        "acceptGroupName":{
            "type":"string"
        },
        "rejectGroupName":{
            "type":"string"
        },
        "validate":{
            "type":"boolean",
            "description":"Gets the value of the validate property.\n \n     possible object is\n     Boolean"
        },
        "fa":{
            "type":"boolean",
            "description":"Gets the value of the fa property.\n \n     possible object is\n     Boolean"
        },
        "duplicateCtrlNumCheck":{
            "type":"boolean",
            "description":"Gets the value of the duplicateCtrlNumCheck property.\n \n     possible object is\n     Boolean"
        },
        "acceptGroup":{
            "type":"string"
        },
        "rejectGroup":{
            "type":"string"
        }
    }
}

Nested Schema : warning

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

409 Response

Duplicate data error

412 Response

Pre-condition failure

500 Response

Server error