Retrieve an Outbound Agreement
get
/ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs/{agrId}
Retrieves an outbound agreement with the specified trading partner id and agrrement id.
Request
Path Parameters
-
agrId(required): string
Trading partner outbound agreement ID.
Example:
/b2b/v1/tpm/partners/TP123/outboundagrs/OUTAGR1604824600539
-
tpId(required): string
Trading partner Id.
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : OutboundAgrRs
Type:
Show Source
object
-
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
404 Response
Not found
412 Response
Pre condition failure
500 Response
Server error