Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• schemaUi: SchemaUI

{
    "type":"object",
    "properties":{
        "schemaUi":{
            "$ref":"#/components/schemas/SchemaUI"
        }
    }
}

Nested Schema : SchemaUI

Match All

Show Source

• allOf ViewModel
• object GenericRestRs
• object SchemaUI-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ViewModel"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "segmentDelimiter":{
                    "type":"string"
                },
                "elementDelimiter":{
                    "type":"string"
                },
                "activeAgr":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AgreementUI"
                    }
                },
                "inActiveAgr":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AgreementUI"
                    }
                },
                "docNode":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/DocumentNode"
                    }
                },
                "state":{
                    "type":"string"
                },
                "active":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/DocumentUI"
                    }
                },
                "inActive":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/DocumentUI"
                    }
                },
                "maxSize":{
                    "$ref":"#/components/schemas/MaxSize"
                },
                "parameters":{
                    "type":"string"
                },
                "chars":{
                    "type":"integer",
                    "format":"int32"
                },
                "encoding":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : ViewModel

Match All

Show Source

• object GenericRestRs
• object ViewModel-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "name":{
                    "type":"string"
                },
                "createdBy":{
                    "type":"string"
                },
                "updatedBy":{
                    "type":"string"
                },
                "createdDate":{
                    "type":"string"
                },
                "updatedDate":{
                    "type":"string"
                },
                "txName":{
                    "type":"string"
                },
                "id":{
                    "type":"string"
                },
                "txId":{
                    "type":"string"
                },
                "std":{
                    "type":"string"
                },
                "version":{
                    "type":"string"
                },
                "desc":{
                    "type":"string"
                },
                "count":{
                    "type":"integer",
                    "format":"int32"
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        }
    }
}

Nested Schema : ViewModel-allOf[1]

Type: object

Show Source

• count: integer (int32)
• createdBy: string
• createdDate: string
• desc: string
• id: string
• name: string
• std: string
• txId: string
• txName: string
• updatedBy: string
• updatedDate: string
• version: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "txName":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "txId":{
            "type":"string"
        },
        "std":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : SchemaUI-allOf[2]

Type: object

Show Source

• active: array active
• activeAgr: array activeAgr
• chars: integer (int32)
• docNode: array docNode
• elementDelimiter: string
• encoding: string
• inActive: array inActive
• inActiveAgr: array inActiveAgr
• maxSize: object MaxSize
• parameters: string
• segmentDelimiter: string
• state: string

{
    "type":"object",
    "properties":{
        "segmentDelimiter":{
            "type":"string"
        },
        "elementDelimiter":{
            "type":"string"
        },
        "activeAgr":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementUI"
            }
        },
        "inActiveAgr":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementUI"
            }
        },
        "docNode":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DocumentNode"
            }
        },
        "state":{
            "type":"string"
        },
        "active":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DocumentUI"
            }
        },
        "inActive":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DocumentUI"
            }
        },
        "maxSize":{
            "$ref":"#/components/schemas/MaxSize"
        },
        "parameters":{
            "type":"string"
        },
        "chars":{
            "type":"integer",
            "format":"int32"
        },
        "encoding":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SuiteLink"
    }
}

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• media-type: string
• method: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

Nested Schema : active

Type: array

Show Source

• Array of: DocumentUI

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DocumentUI"
    }
}

Nested Schema : activeAgr

Type: array

Show Source

• Array of: AgreementUI

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AgreementUI"
    }
}

Nested Schema : docNode

Type: array

Show Source

• Array of: object DocumentNode

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DocumentNode"
    }
}

Nested Schema : inActive

Type: array

Show Source

• Array of: DocumentUI

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DocumentUI"
    }
}

Nested Schema : inActiveAgr

Type: array

Show Source

• Array of: AgreementUI

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AgreementUI"
    }
}

Nested Schema : MaxSize

Type: object

Show Source

• cmnts: integer (int32)
• desc: integer (int32)
• notes: integer (int32)
• pos: boolean
• purpose: integer (int32)
• steps: integer (int32)
• txt: integer (int32)
• ver: number (float)

{
    "type":"object",
    "properties":{
        "purpose":{
            "type":"integer",
            "format":"int32"
        },
        "notes":{
            "type":"integer",
            "format":"int32"
        },
        "steps":{
            "type":"integer",
            "format":"int32"
        },
        "cmnts":{
            "type":"integer",
            "format":"int32"
        },
        "desc":{
            "type":"integer",
            "format":"int32"
        },
        "txt":{
            "type":"integer",
            "format":"int32"
        },
        "ver":{
            "type":"number",
            "format":"float"
        },
        "pos":{
            "type":"boolean"
        }
    }
}

Nested Schema : DocumentUI

Match All

Show Source

• allOf ViewModel
• object GenericRestRs
• object DocumentUI-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ViewModel"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "activeAgr":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AgreementUI"
                    }
                },
                "inActiveAgr":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AgreementUI"
                    }
                },
                "parameters":{
                    "type":"string"
                },
                "businessIdentifiers":{
                    "$ref":"#/components/schemas/BusinessIdentifierUI"
                },
                "partnerCnt":{
                    "type":"integer",
                    "format":"int32"
                },
                "schema":{
                    "type":"string"
                },
                "state":{
                    "type":"string"
                },
                "schemaName":{
                    "type":"string"
                },
                "active":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/IntegrationResourceUI"
                    }
                },
                "inActive":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/IntegrationResourceUI"
                    }
                }
            }
        }
    ]
}

Nested Schema : DocumentUI-allOf[2]

Type: object

Show Source

• active: array active
• activeAgr: array activeAgr
• businessIdentifiers: object BusinessIdentifierUI
• inActive: array inActive
• inActiveAgr: array inActiveAgr
• parameters: string
• partnerCnt: integer (int32)
• schema: string
• schemaName: string
• state: string

{
    "type":"object",
    "properties":{
        "activeAgr":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementUI"
            }
        },
        "inActiveAgr":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementUI"
            }
        },
        "parameters":{
            "type":"string"
        },
        "businessIdentifiers":{
            "$ref":"#/components/schemas/BusinessIdentifierUI"
        },
        "partnerCnt":{
            "type":"integer",
            "format":"int32"
        },
        "schema":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "schemaName":{
            "type":"string"
        },
        "active":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationResourceUI"
            }
        },
        "inActive":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationResourceUI"
            }
        }
    }
}

Nested Schema : active

Type: array

Show Source

• Array of: IntegrationResourceUI

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IntegrationResourceUI"
    }
}

Nested Schema : activeAgr

Type: array

Show Source

• Array of: AgreementUI

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AgreementUI"
    }
}

Nested Schema : BusinessIdentifierUI

Type: object

Show Source

• bizIdName1: string
• bizIdName2: string
• bizIdName3: string
• bizIdXpath1: string
• bizIdXpath2: string
• bizIdXpath3: string

{
    "type":"object",
    "properties":{
        "bizIdName1":{
            "type":"string"
        },
        "bizIdXpath1":{
            "type":"string"
        },
        "bizIdName2":{
            "type":"string"
        },
        "bizIdXpath2":{
            "type":"string"
        },
        "bizIdName3":{
            "type":"string"
        },
        "bizIdXpath3":{
            "type":"string"
        }
    }
}

Nested Schema : inActive

Type: array

Show Source

• Array of: IntegrationResourceUI

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IntegrationResourceUI"
    }
}

Nested Schema : inActiveAgr

Type: array

Show Source

• Array of: AgreementUI

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AgreementUI"
    }
}

Nested Schema : IntegrationResourceUI

Match All

Show Source

• allOf ViewModel
• object GenericRestRs
• object IntegrationResourceUI-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ViewModel"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "name":{
                    "type":"string"
                },
                "id":{
                    "type":"string"
                },
                "status":{
                    "type":"string"
                },
                "version":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : IntegrationResourceUI-allOf[2]

Type: object

Show Source

• id: string
• name: string
• status: string
• version: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "version":{
            "type":"string"
        }
    }
}

Nested Schema : AgreementUI

Match All

Show Source

• allOf ViewModel
• object GenericRestRs
• object AgreementUI-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ViewModel"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "deployStatus":{
                    "type":"string"
                },
                "direction":{
                    "type":"string"
                },
                "agrID":{
                    "type":"string"
                },
                "tpId":{
                    "type":"string"
                },
                "docId":{
                    "type":"string"
                },
                "agrName":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : AgreementUI-allOf[2]

Type: object

Show Source

• agrID: string
• agrName: string
• deployStatus: string
• direction: string
• docId: string
• tpId: string

{
    "type":"object",
    "properties":{
        "deployStatus":{
            "type":"string"
        },
        "direction":{
            "type":"string"
        },
        "agrID":{
            "type":"string"
        },
        "tpId":{
            "type":"string"
        },
        "docId":{
            "type":"string"
        },
        "agrName":{
            "type":"string"
        }
    }
}

Nested Schema : DocumentNode

Type: object

Show Source

• 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

{
    "required":[
        "attr",
        "children"
    ],
    "type":"object",
    "properties":{
        "attr":{
            "$ref":"#/components/schemas/DocumentModelUI"
        },
        "children":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DocumentNode"
            }
        }
    }
}

Nested Schema : Discriminator: objType

Type: object

Discriminator: objType

Discriminator Values

• CELMS
• SEGS
• SEG_LOOP
• ELMS
• COMS

{
    "type":"object",
    "properties":{
        "objId":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "req":{
            "type":"string"
        },
        "purpose":{
            "type":"string"
        },
        "objType":{
            "type":"string"
        },
        "rptCnt":{
            "type":"string"
        },
        "usage":{
            "type":"string"
        },
        "msk":{
            "type":"boolean"
        },
        "posNo":{
            "type":"string"
        },
        "notes":{
            "type":"string"
        },
        "r":{
            "type":"boolean"
        },
        "cmnts":{
            "type":"string"
        },
        "var":{
            "type":"integer",
            "format":"int32"
        }
    },
    "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"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/SegmentUI"
        },
        {
            "$ref":"#/components/schemas/SegLoopUI"
        },
        {
            "$ref":"#/components/schemas/ElementUI"
        },
        {
            "$ref":"#/components/schemas/ElementUI"
        },
        {
            "$ref":"#/components/schemas/CompositeUI"
        }
    ]
}

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)

{
    "type":"object",
    "properties":{
        "objId":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "req":{
            "type":"string"
        },
        "purpose":{
            "type":"string"
        },
        "objType":{
            "type":"string"
        },
        "rptCnt":{
            "type":"string"
        },
        "usage":{
            "type":"string"
        },
        "msk":{
            "type":"boolean"
        },
        "posNo":{
            "type":"string"
        },
        "notes":{
            "type":"string"
        },
        "r":{
            "type":"boolean"
        },
        "cmnts":{
            "type":"string"
        },
        "var":{
            "type":"integer",
            "format":"int32"
        }
    },
    "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"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/SegmentUI"
        },
        {
            "$ref":"#/components/schemas/SegLoopUI"
        },
        {
            "$ref":"#/components/schemas/ElementUI"
        },
        {
            "$ref":"#/components/schemas/ElementUI"
        },
        {
            "$ref":"#/components/schemas/CompositeUI"
        }
    ]
}

Match One Schema

Show Source

• SegmentUI
• SegLoopUI
• ElementUI
• ElementUI
• CompositeUI

{
    "type":"object",
    "properties":{
        "objId":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "req":{
            "type":"string"
        },
        "purpose":{
            "type":"string"
        },
        "objType":{
            "type":"string"
        },
        "rptCnt":{
            "type":"string"
        },
        "usage":{
            "type":"string"
        },
        "msk":{
            "type":"boolean"
        },
        "posNo":{
            "type":"string"
        },
        "notes":{
            "type":"string"
        },
        "r":{
            "type":"boolean"
        },
        "cmnts":{
            "type":"string"
        },
        "var":{
            "type":"integer",
            "format":"int32"
        }
    },
    "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"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/SegmentUI"
        },
        {
            "$ref":"#/components/schemas/SegLoopUI"
        },
        {
            "$ref":"#/components/schemas/ElementUI"
        },
        {
            "$ref":"#/components/schemas/ElementUI"
        },
        {
            "$ref":"#/components/schemas/CompositeUI"
        }
    ]
}

Nested Schema : children

Type: array

Show Source

• Array of: object DocumentNode

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DocumentNode"
    }
}

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]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DocumentModelUI"
        },
        {
            "type":"object",
            "properties":{
                "tableArea":{
                    "type":"string"
                },
                "synRl":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/SyntaxRuleUI"
                    }
                }
            }
        }
    ]
}

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]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DocumentModelUI"
        },
        {
            "type":"object",
            "properties":{
                "tableArea":{
                    "type":"string"
                }
            }
        }
    ]
}

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]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DocumentModelUI"
        },
        {
            "type":"object",
            "properties":{
                "type":{
                    "type":"string"
                },
                "min":{
                    "type":"integer",
                    "format":"int32"
                },
                "max":{
                    "type":"integer",
                    "format":"int32"
                },
                "elem":{
                    "type":"string"
                },
                "part":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/CodesPartitionUI"
                    }
                },
                "codeId":{
                    "type":"string"
                },
                "ln":{
                    "type":"integer",
                    "format":"int32"
                }
            }
        }
    ]
}

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]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DocumentModelUI"
        },
        {
            "type":"object",
            "properties":{
                "elem":{
                    "type":"string"
                },
                "type":{
                    "type":"string"
                },
                "min":{
                    "type":"integer",
                    "format":"int32"
                },
                "max":{
                    "type":"integer",
                    "format":"int32"
                },
                "synRl":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/SyntaxRuleUI"
                    }
                }
            }
        }
    ]
}

Nested Schema : SegmentUI-allOf[1]

Type: object

Show Source

• synRl: array synRl
• tableArea: string

{
    "type":"object",
    "properties":{
        "tableArea":{
            "type":"string"
        },
        "synRl":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SyntaxRuleUI"
            }
        }
    }
}

Nested Schema : synRl

Type: array

Show Source

• Array of: object SyntaxRuleUI

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SyntaxRuleUI"
    }
}

Nested Schema : SyntaxRuleUI

Type: object

Show Source

• elems: array elems
• r: boolean
• rule: string

{
    "type":"object",
    "properties":{
        "elems":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "rule":{
            "type":"string"
        },
        "r":{
            "type":"boolean"
        }
    }
}

Nested Schema : elems

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : SegLoopUI-allOf[1]

Type: object

Show Source

• tableArea: string

{
    "type":"object",
    "properties":{
        "tableArea":{
            "type":"string"
        }
    }
}

Nested Schema : ElementUI-allOf[1]

Type: object

Show Source

• codeId: string
• elem: string
• ln: integer (int32)
• max: integer (int32)
• min: integer (int32)
• part: array part
• type: string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "min":{
            "type":"integer",
            "format":"int32"
        },
        "max":{
            "type":"integer",
            "format":"int32"
        },
        "elem":{
            "type":"string"
        },
        "part":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodesPartitionUI"
            }
        },
        "codeId":{
            "type":"string"
        },
        "ln":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : part

Type: array

Show Source

• Array of: object CodesPartitionUI

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CodesPartitionUI"
    }
}

Nested Schema : CodesPartitionUI

Type: object

Show Source

• codes: array codes

{
    "type":"object",
    "properties":{
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeUI"
            }
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object CodeUI

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CodeUI"
    }
}

Nested Schema : CodeUI

Type: object

Show Source

• c: string
• d: string
• n: string
• r: boolean

{
    "type":"object",
    "properties":{
        "c":{
            "type":"string"
        },
        "d":{
            "type":"string"
        },
        "n":{
            "type":"string"
        },
        "r":{
            "type":"boolean"
        }
    }
}

Nested Schema : CompositeUI-allOf[1]

Type: object

Show Source

• elem: string
• max: integer (int32)
• min: integer (int32)
• synRl: array synRl
• type: string

{
    "type":"object",
    "properties":{
        "elem":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "min":{
            "type":"integer",
            "format":"int32"
        },
        "max":{
            "type":"integer",
            "format":"int32"
        },
        "synRl":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SyntaxRuleUI"
            }
        }
    }
}

Nested Schema : synRl

Type: array

Show Source

• Array of: object SyntaxRuleUI

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SyntaxRuleUI"
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Object

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Object"
    }
}

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

Back to Top