Create a B2B Document
post
/ic/api/b2b/v1/b2bdocuments
Creates a B2B document with the specified id, name description, standard, txId and version. Examples of standard values are X12, EDIFACT. Examples of version for EDIFACT are D00A, D00B, etc, for X12 are 4010. 4011, etc. Examples of txId (or transaction type) for EDIFACT are APERAK, AUTHOR, etc, for X12 are 100, 850, etc.
Request
Supported Media Types
- application/json
Create B2B Document request details.
Example:
{"id": "DOC123", "name": "PO Doc", "std": "X12", "version": "4010", "txId": "850", "desc": "Purchase Order Document" }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
201 Response
Successful operation
400 Response
Bad request, malformed parameters or missing required data
409 Response
Duplicate data error
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