Jump to

• Request
• Response

Undeploy an Outbound Agreement

post

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

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

Request

Path Parameters

• agrId(required): string

  Outbound agreement ID.

• tpId(required): string

  Trading partner ID.

  Example:

  /b2b/v1/tpm/partners/TP123/outboundagrs/OUTAGR12333344/undeploy

Query Parameters

• isProceedWithWarnings(required): boolean
  Default Value: false

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : DeployUndeployRs

Match All

Show Source

• object GenericRestRs
• object DeployUndeployRs-allOf[1]

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

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

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

Nested Schema : DeployUndeployRs-allOf[1]

Type: object

Show Source

• responseStatus: object ResponseStatus

{
    "type":"object",
    "properties":{
        "responseStatus":{
            "$ref":"#/components/schemas/ResponseStatus"
        }
    }
}

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

Type: object

Show Source

• code: string
  Gets the value of the code property. possible object is String
• msg: array msg
  Gets the value of the msg property. This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the msg property. For example, to add a new item, do as follows: getMsg().add(newItem); Objects of the following type(s) are allowed in the list String
• status: string
  Gets the value of the status property. possible object is String

{
    "type":"object",
    "properties":{
        "msg":{
            "type":"array",
            "description":"Gets the value of the msg property.\n \n \n This accessor method returns a reference to the live list,\n not a snapshot. Therefore any modification you make to the\n returned list will be present inside the JAXB object.\n This is why there is not a set method for the msg property.\n \n \n For example, to add a new item, do as follows:\n \n    getMsg().add(newItem);\n \n \n \n \n Objects of the following type(s) are allowed in the list\n String",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"Gets the value of the status property.\n \n     possible object is\n     String"
        },
        "code":{
            "type":"string",
            "description":"Gets the value of the code property.\n \n     possible object is\n     String"
        }
    }
}

Nested Schema : msg

Type: array

Gets the value of the msg property. This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the msg property. For example, to add a new item, do as follows: getMsg().add(newItem); Objects of the following type(s) are allowed in the list String

Show Source

• Array of: string

{
    "type":"array",
    "description":"Gets the value of the msg property.\n \n \n This accessor method returns a reference to the live list,\n not a snapshot. Therefore any modification you make to the\n returned list will be present inside the JAXB object.\n This is why there is not a set method for the msg property.\n \n \n For example, to add a new item, do as follows:\n \n    getMsg().add(newItem);\n \n \n \n \n Objects of the following type(s) are allowed in the list\n String",
    "items":{
        "type":"string"
    }
}

412 Response

Pre-condition failure

500 Response

Server error

Back to Top