Retrieve a B2B Document
get
/ic/api/b2b/v1/b2bdocuments/{documentId}
Retrieves detailed information about the B2B Document with the specified ID.
Request
Path Parameters
-
documentId(required): string
Retrieves a b2b document.
Example:
/b2b/v1/b2bdocuments/DOC123
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : DocumentUI
Type:
Show Source
object-
active:
array active
Read Only:
true -
activeAgr:
array activeAgr
Read Only:
true -
businessIdentifiers:
object BusinessIdentifierUI
-
count:
integer(int32)
-
createdBy:
string
-
createdDate:
string
-
desc:
string
-
id:
string
-
inActive:
array inActive
Read Only:
true -
inActiveAgr:
array inActiveAgr
Read Only:
true -
links:
array links
-
name:
string
-
partnerCnt:
integer(int32)
-
schema:
string
-
schemaName:
string
-
state:
string
-
std:
string
-
txId:
string
-
txName:
string
-
updatedBy:
string
-
updatedDate:
string
-
version:
string
Nested Schema : AgreementUI
Type:
Show Source
object-
agrID:
string
-
agrName:
string
-
count:
integer(int32)
-
createdBy:
string
-
createdDate:
string
-
deployStatus:
string
-
desc:
string
-
direction:
string
-
docId:
string
-
id:
string
-
links:
array links
-
name:
string
-
std:
string
-
tpId:
string
-
txId:
string
-
txName:
string
-
updatedBy:
string
-
updatedDate:
string
-
version:
string
400 Response
Bad request
500 Response
Server error