Jump to

• Request
• Response

Undeploy an Inbound Agreement

post

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

Undeploys an inbound agreement to disallow acceptance of new messages by the agreement. However, all in-flight messages will be processed successfully.

Request

Supported Media Types

• application/json

Path Parameters

• agrId(required): string

  Inbound agreement ID.

  Example:

  /b2b/v1/tpm/partners/TP123/inboundagrs/INAGR12333344/undeploy

• tpId(required): string

  Trading partner ID.

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : DeployUndeployRs

Type: object

Show Source

• links: array links
• responseStatus: object ResponseStatus

{
    "type":"object",
    "properties":{
        "responseStatus":{
            "$ref":"#/definitions/ResponseStatus"
        },
        "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 : ResponseStatus

Type: object

Show Source

• code: string
• msg: array msg
• status: string

{
    "type":"object",
    "properties":{
        "msg":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        },
        "code":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        }
    }
}

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 : msg

Type: array

Show Source

• Array of: string

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

412 Response

Pre condition failure

500 Response

Server error

Back to Top