Jump to

• Request
• Response

Create an Outbound Agreement

post

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

Creates an outbound agreement with the specified trading partner ID. 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• outboundAgrUI: OutboundAgrRs

{
    "type":"object",
    "properties":{
        "outboundAgrUI":{
            "$ref":"#/components/schemas/OutboundAgrRs"
        }
    }
}

Nested Schema : OutboundAgrRs

Match All

Show Source

• allOf IdRs
• object GenericRestRs
• object OutboundAgrRs-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"
                },
                "tpIdentifiersRef":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/IdentifierRs"
                    }
                },
                "hostIdentifiersRef":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/HostIdentifierRs"
                    }
                },
                "transportName":{
                    "type":"string"
                },
                "params":{
                    "$ref":"#/components/schemas/OutboundAgr.Params"
                },
                "transportId":{
                    "type":"string"
                },
                "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 : OutboundAgrRs-allOf[2]

Type: object

Show Source

• createdDate: string
• desc: string
• docDef: string
• docId: string
• docStd: string
• docTxId: string
• docVersion: string
• hostIdentifiersRef: array hostIdentifiersRef
• id: string
• lastDeployed: string
• name: string
• params: object OutboundAgr.Params
• status: string
• tpIdentifiersRef: array tpIdentifiersRef
• tpmVerson: string
• transportId: string
• transportName: string
• updatedDate: string

{
    "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"
        },
        "tpIdentifiersRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IdentifierRs"
            }
        },
        "hostIdentifiersRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/HostIdentifierRs"
            }
        },
        "transportName":{
            "type":"string"
        },
        "params":{
            "$ref":"#/components/schemas/OutboundAgr.Params"
        },
        "transportId":{
            "type":"string"
        },
        "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 : hostIdentifiersRef

Type: array

Show Source

• Array of: HostIdentifierRs

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

Nested Schema : OutboundAgr.Params

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "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"
        }
    }
}

Nested Schema : tpIdentifiersRef

Type: array

Show Source

• Array of: IdentifierRs

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

Nested Schema : HostIdentifierRs

Match All

Show Source

• allOf IdRs
• object GenericRestRs
• object HostIdentifierRs-allOf[2]

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

Nested Schema : HostIdentifierRs-allOf[2]

Type: object

Show Source

• id: string
• identifierType: string
• identifierValue: string

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

Nested Schema : IdentifierRs

Match All

Show Source

• allOf IdRs
• object GenericRestRs
• object IdentifierRs-allOf[2]

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

Nested Schema : IdentifierRs-allOf[2]

Type: object

Show Source

• id: string
• identifierType: string
• identifierValue: string

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

Back to Top

Response

Supported Media Types

• application/json

201 Response

Successful operation

Body ()

Root Schema : OutboundAgrRs

Match All

Show Source

• allOf IdRs
• object GenericRestRs
• object OutboundAgrRs-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"
                },
                "tpIdentifiersRef":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/IdentifierRs"
                    }
                },
                "hostIdentifiersRef":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/HostIdentifierRs"
                    }
                },
                "transportName":{
                    "type":"string"
                },
                "params":{
                    "$ref":"#/components/schemas/OutboundAgr.Params"
                },
                "transportId":{
                    "type":"string"
                },
                "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 : OutboundAgrRs-allOf[2]

Type: object

Show Source

• createdDate: string
• desc: string
• docDef: string
• docId: string
• docStd: string
• docTxId: string
• docVersion: string
• hostIdentifiersRef: array hostIdentifiersRef
• id: string
• lastDeployed: string
• name: string
• params: object OutboundAgr.Params
• status: string
• tpIdentifiersRef: array tpIdentifiersRef
• tpmVerson: string
• transportId: string
• transportName: string
• updatedDate: string

{
    "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"
        },
        "tpIdentifiersRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IdentifierRs"
            }
        },
        "hostIdentifiersRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/HostIdentifierRs"
            }
        },
        "transportName":{
            "type":"string"
        },
        "params":{
            "$ref":"#/components/schemas/OutboundAgr.Params"
        },
        "transportId":{
            "type":"string"
        },
        "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 : hostIdentifiersRef

Type: array

Show Source

• Array of: HostIdentifierRs

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

Nested Schema : OutboundAgr.Params

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "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"
        }
    }
}

Nested Schema : tpIdentifiersRef

Type: array

Show Source

• Array of: IdentifierRs

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

Nested Schema : HostIdentifierRs

Match All

Show Source

• allOf IdRs
• object GenericRestRs
• object HostIdentifierRs-allOf[2]

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

Nested Schema : HostIdentifierRs-allOf[2]

Type: object

Show Source

• id: string
• identifierType: string
• identifierValue: string

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

Nested Schema : IdentifierRs

Match All

Show Source

• allOf IdRs
• object GenericRestRs
• object IdentifierRs-allOf[2]

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

Nested Schema : IdentifierRs-allOf[2]

Type: object

Show Source

• id: string
• identifierType: string
• identifierValue: string

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

409 Response

Duplicate data error

412 Response

Pre-condition failure

500 Response

Server error

Back to Top