Create a B2B Schema
post
/ic/api/b2b/v1/projects/{projectId}/schemas
Creates a B2B schema with the specified ID, name, description, standard, txId and version in project context. Examples of standard values are X12, EDIFACT, etc. Examples of version for EDIFACT are D00A, D00B, etc. Examples for X12 are 4010, 4011, etc. Examples for txId (or transaction type) for EDIFACT are APERAK, AUTHOR, etc. Examples for X12 are 100, 850, etc.
Request
Path Parameters
-
projectId(required): string
Project identifier
Supported Media Types
- application/json
Nested Schema : DocumentNode
Type:
Show Source
object
-
attr(required): object
Discriminator: objType
Discriminator:
{ "propertyName":"objType", "mapping":{ "CELMS":"#/components/schemas/ElementUI", "SEGS":"#/components/schemas/SegmentUI", "SEG_LOOP":"#/components/schemas/SegLoopUI", "ELMS":"#/components/schemas/ElementUI", "COMS":"#/components/schemas/CompositeUI" } }
-
children(required): array
children
Nested Schema : Discriminator: objType
Type:
object
Discriminator: objType
Discriminator Values
Show Source-
cmnts: string
-
msk: boolean
-
name: string
-
notes: string
-
objId: string
-
objType: string
-
posNo: string
-
purpose: string
-
r: boolean
-
req: string
-
rptCnt: string
-
usage: string
-
var: integer
(int32)
Match One Schema
Show Source
Nested Schema : SegmentUI
Match All
Show Source
-
object
Discriminator: objType
Discriminator:
{ "propertyName":"objType", "mapping":{ "CELMS":"#/components/schemas/ElementUI", "SEGS":"#/components/schemas/SegmentUI", "SEG_LOOP":"#/components/schemas/SegLoopUI", "ELMS":"#/components/schemas/ElementUI", "COMS":"#/components/schemas/CompositeUI" } }
-
object
SegmentUI-allOf[1]
Nested Schema : SegLoopUI
Match All
Show Source
-
object
Discriminator: objType
Discriminator:
{ "propertyName":"objType", "mapping":{ "CELMS":"#/components/schemas/ElementUI", "SEGS":"#/components/schemas/SegmentUI", "SEG_LOOP":"#/components/schemas/SegLoopUI", "ELMS":"#/components/schemas/ElementUI", "COMS":"#/components/schemas/CompositeUI" } }
-
object
SegLoopUI-allOf[1]
Nested Schema : ElementUI
Match All
Show Source
-
object
Discriminator: objType
Discriminator:
{ "propertyName":"objType", "mapping":{ "CELMS":"#/components/schemas/ElementUI", "SEGS":"#/components/schemas/SegmentUI", "SEG_LOOP":"#/components/schemas/SegLoopUI", "ELMS":"#/components/schemas/ElementUI", "COMS":"#/components/schemas/CompositeUI" } }
-
object
ElementUI-allOf[1]
Nested Schema : CompositeUI
Match All
Show Source
-
object
Discriminator: objType
Discriminator:
{ "propertyName":"objType", "mapping":{ "CELMS":"#/components/schemas/ElementUI", "SEGS":"#/components/schemas/SegmentUI", "SEG_LOOP":"#/components/schemas/SegLoopUI", "ELMS":"#/components/schemas/ElementUI", "COMS":"#/components/schemas/CompositeUI" } }
-
object
CompositeUI-allOf[1]
Response
Supported Media Types
- application/json
201 Response
Successful operation
Nested Schema : Object
Type:
object
400 Response
Bad request, malformed parameters or missing required data
409 Response
Duplicate data error
412 Response
Pre-condition failure. Ensure that the length of name does not exceed 50 characters, length of identifier does not exceed 32 characters, length of description does not exceed 1024 characters, length of identifier does not exceed 32 characters, Name and Identifier is not named as 'Standard' or 'Default', and there must be a valid combination of std, version and txId.
500 Response
Server error