Undeploy an Inbound Agreement
post
/ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/inboundagrs/{agrId}/undeploy
Undeploys an inbound agreement to disallow acceptance of new messages by the agreement in project context. However, all in-flight messages are processed successfully.
Request
Path Parameters
-
agrId(required): string
Inbound agreement ID.
Example:
/b2b/v1/projects/PROJECTID/tpm/partners/TP123/inboundagrs/INAGR12333344/undeploy
-
projectId(required): string
Project identifier
-
tpId(required): string
Trading partner ID.
Query Parameters
-
isProceedWithWarnings(required): boolean
Default Value:
false
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : ResponseStatus
Type:
Show Source
object
-
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
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
412 Response
Pre-condition failure
500 Response
Server error