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 atleast name, transportId and docId fields.

Request

Supported Media Types

• application/json

Path Parameters

• tpId(required): string
  Trading partner ID.

Body ()

Create trading partner outbound agreement request.

Example:

{ "name": "outagr", "desc": "out agr",	"docId":"DOC1",  "transportId":"TRANS123456",  "params":{      "validate":true,         "fa":true    }, "hostIdentifiersRef": [ {"id": 3730642141264966 }],        "tpIdentifiersRef": [{"id": 3710624275162543 }, {"id": 3710624275252203}]}

Root Schema : OutboundAgrRs

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
• links: array links
• name: string
• params: object Params
• status: string
• tpIdentifiersRef: array tpIdentifiersRef
• 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"
        },
        "updatedDate":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "lastDeployed":{
            "type":"string"
        },
        "tpIdentifiersRef":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IdentifierRs"
            }
        },
        "hostIdentifiersRef":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/HostIdentifierRs"
            }
        },
        "transportId":{
            "type":"string"
        },
        "transportName":{
            "type":"string"
        },
        "params":{
            "$ref":"#/definitions/Params"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        }
    }
}

Nested Schema : hostIdentifiersRef

Type: array

Show Source

• Array of: object HostIdentifierRs

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

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : Params

Type: object

Show Source

• fa: boolean
• validate: boolean

{
    "type":"object",
    "properties":{
        "validate":{
            "type":"boolean",
            "xml":{
                "attribute":true
            }
        },
        "fa":{
            "type":"boolean",
            "xml":{
                "attribute":true
            }
        }
    }
}

Nested Schema : tpIdentifiersRef

Type: array

Show Source

• Array of: object IdentifierRs

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

Nested Schema : HostIdentifierRs

Type: object

Show Source

• id: string
• identifierType: string
• identifierValue: string
• links: array links

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "identifierType":{
            "type":"string"
        },
        "identifierValue":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

Nested Schema : IdentifierRs

Type: object

Show Source

• id: string
• identifierType: string
• identifierValue: string
• links: array links

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "identifierType":{
            "type":"string"
        },
        "identifierValue":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : OutboundAgrRs

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
• links: array links
• name: string
• params: object Params
• status: string
• tpIdentifiersRef: array tpIdentifiersRef
• 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"
        },
        "updatedDate":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "lastDeployed":{
            "type":"string"
        },
        "tpIdentifiersRef":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IdentifierRs"
            }
        },
        "hostIdentifiersRef":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/HostIdentifierRs"
            }
        },
        "transportId":{
            "type":"string"
        },
        "transportName":{
            "type":"string"
        },
        "params":{
            "$ref":"#/definitions/Params"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        }
    }
}

Nested Schema : hostIdentifiersRef

Type: array

Show Source

• Array of: object HostIdentifierRs

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

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : Params

Type: object

Show Source

• fa: boolean
• validate: boolean

{
    "type":"object",
    "properties":{
        "validate":{
            "type":"boolean",
            "xml":{
                "attribute":true
            }
        },
        "fa":{
            "type":"boolean",
            "xml":{
                "attribute":true
            }
        }
    }
}

Nested Schema : tpIdentifiersRef

Type: array

Show Source

• Array of: object IdentifierRs

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

Nested Schema : HostIdentifierRs

Type: object

Show Source

• id: string
• identifierType: string
• identifierValue: string
• links: array links

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "identifierType":{
            "type":"string"
        },
        "identifierValue":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

Nested Schema : IdentifierRs

Type: object

Show Source

• id: string
• identifierType: string
• identifierValue: string
• links: array links

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "identifierType":{
            "type":"string"
        },
        "identifierValue":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

201 Response

Successful operation

409 Response

Duplicate data error

412 Response

Pre condition failure

500 Response

Server error

Back to Top