Update a B2B Document
put
/ic/api/b2b/v1/b2bdocuments/{documentId}
Updates a B2B Document with the specified document id. To modify a document used by an active agreement, you need to deactivate it first.
Request
Supported Media Types
- application/json
Path Parameters
-
documentId(required): string
B2B document ID.
Example:
/b2b/v1/b2bdocuments/DOC123
Update b2b document request details.
Example:
{"name": "Updated Document", "desc": "updating document desciption ", "schema": "Schema123", "std": "X12", "txId": "100", "version": "4010", "businessIdentifiers":{ "bizIdName1": "/edi-xml-document/transaction-data/C3/C301", "bizIdName2": "/edi-xml-document/transaction-data/BGN/BGN01", "bizIdName3", "/edi-xml-document/transaction-data/Loop-NM1/N3/N301"}}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
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, malformed parameters or missing required data
412 Response
Pre condition failure, please ensure that the length of name is no longer that 50 characters, length of identifier is no longer than 32 characters, length of decsription is no longer than 1024 characters, length of identifier is no longer than 32 characters, Name and Identifier should not be named as 'Standard' or 'Default' and there must be a valid combination of std, version and txId
500 Response
Server error