Jump to

• Request
• Response

Create a B2B Schema

post

/ic/api/b2b/v1/schemas

Creates a B2B schema 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

Body ()

Create B2B Schema request details.

Example:

{"id": "SCH123",	"name": "Sch123", "std": "X12", "version": "4010", "txId": "850", "desc": "Schema Document" }

Root Schema : SchemaUI

Type: object

Show Source

• active(optional): array active
  Read Only: true
• activeAgr(optional): array activeAgr
  Read Only: true
• count(optional): integer(int32)
• createdBy(optional): string
• createdDate(optional): string
• desc(optional): string
• docNode(optional): array docNode
• id(optional): string
• inActive(optional): array inActive
  Read Only: true
• inActiveAgr(optional): array inActiveAgr
  Read Only: true
• links(optional): array links
• maxSize(optional): object MaxSize
• name(optional): string
• state(optional): string
• std(optional): string
• txId(optional): string
• txName(optional): string
• updatedBy(optional): string
• updatedDate(optional): string
• version(optional): string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "std":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "txId":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "txName":{
            "type":"string"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "docNode":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DocumentNode"
            }
        },
        "state":{
            "type":"string"
        },
        "active":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/DocumentUI"
            }
        },
        "inActive":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/DocumentUI"
            }
        },
        "maxSize":{
            "$ref":"#/definitions/MaxSize"
        },
        "activeAgr":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/AgreementUI"
            }
        },
        "inActiveAgr":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/AgreementUI"
            }
        }
    }
}

Nested Schema : active

Type: array

Read Only: true

Show Source

• Array of: object DocumentUI

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/DocumentUI"
    }
}

Nested Schema : activeAgr

Type: array

Read Only: true

Show Source

• Array of: object AgreementUI

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/AgreementUI"
    }
}

Nested Schema : docNode

Type: array

Show Source

• Array of: object DocumentNode

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

Nested Schema : inActive

Type: array

Read Only: true

Show Source

• Array of: object DocumentUI

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/DocumentUI"
    }
}

Nested Schema : inActiveAgr

Type: array

Read Only: true

Show Source

• Array of: object AgreementUI

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/AgreementUI"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : MaxSize

Type: object

Show Source

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

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

Nested Schema : DocumentUI

Type: object

Show Source

• active(optional): array active
  Read Only: true
• activeAgr(optional): array activeAgr
  Read Only: true
• businessIdentifiers(optional): object BusinessIdentifierUI
• count(optional): integer(int32)
• createdBy(optional): string
• createdDate(optional): string
• desc(optional): string
• id(optional): string
• inActive(optional): array inActive
  Read Only: true
• inActiveAgr(optional): array inActiveAgr
  Read Only: true
• links(optional): array links
• name(optional): string
• partnerCnt(optional): integer(int32)
• schema(optional): string
• schemaName(optional): string
• state(optional): string
• std(optional): string
• txId(optional): string
• txName(optional): string
• updatedBy(optional): string
• updatedDate(optional): string
• version(optional): string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "std":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "txId":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "txName":{
            "type":"string"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "schema":{
            "type":"string"
        },
        "schemaName":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "active":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/IntegrationResourceUI"
            }
        },
        "inActive":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/IntegrationResourceUI"
            }
        },
        "activeAgr":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/AgreementUI"
            }
        },
        "inActiveAgr":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/AgreementUI"
            }
        },
        "partnerCnt":{
            "type":"integer",
            "format":"int32"
        },
        "businessIdentifiers":{
            "$ref":"#/definitions/BusinessIdentifierUI"
        }
    }
}

Nested Schema : active

Type: array

Read Only: true

Show Source

• Array of: object IntegrationResourceUI

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/IntegrationResourceUI"
    }
}

Nested Schema : activeAgr

Type: array

Read Only: true

Show Source

• Array of: object AgreementUI

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/AgreementUI"
    }
}

Nested Schema : BusinessIdentifierUI

Type: object

Show Source

• bizIdName1(optional): string
• bizIdName2(optional): string
• bizIdName3(optional): string
• bizIdXpath1(optional): string
• bizIdXpath2(optional): string
• bizIdXpath3(optional): 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

Read Only: true

Show Source

• Array of: object IntegrationResourceUI

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/IntegrationResourceUI"
    }
}

Nested Schema : inActiveAgr

Type: array

Read Only: true

Show Source

• Array of: object AgreementUI

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/AgreementUI"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : IntegrationResourceUI

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "std":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "txId":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "txName":{
            "type":"string"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "status":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : SuiteLink

Type: object

Show Source

• href(optional): string
• mediaType(optional): string
• rel(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

Nested Schema : AgreementUI

Type: object

Show Source

• agrID(optional): string
• agrName(optional): string
• count(optional): integer(int32)
• createdBy(optional): string
• createdDate(optional): string
• deployStatus(optional): string
• desc(optional): string
• direction(optional): string
• docId(optional): string
• id(optional): string
• links(optional): array links
• name(optional): string
• std(optional): string
• tpId(optional): string
• txId(optional): string
• txName(optional): string
• updatedBy(optional): string
• updatedDate(optional): string
• version(optional): string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "std":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "txId":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "txName":{
            "type":"string"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "agrID":{
            "type":"string"
        },
        "agrName":{
            "type":"string"
        },
        "tpId":{
            "type":"string"
        },
        "docId":{
            "type":"string"
        },
        "direction":{
            "type":"string"
        },
        "deployStatus":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : DocumentNode

Type: object

Show Source

• attr(optional): object DocumentModelUI
  Discriminator: objType
• children(optional): array children

{
    "type":"object",
    "properties":{
        "attr":{
            "$ref":"#/definitions/DocumentModelUI"
        },
        "children":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DocumentNode"
            }
        }
    }
}

Nested Schema : DocumentModelUI

Type: object

Discriminator: objType

Show Source

• cmnts(optional): string
• getcRef(optional): integer(int32)
• getnRef(optional): integer(int32)
• getpRef(optional): integer(int32)
• msk(optional): boolean
• name(optional): string
• notes(optional): string
• objId(optional): string
• objType(optional): string
• posNo(optional): string
• purpose(optional): string
• r(optional): boolean
• req(optional): string
• rptCnt(optional): string
• usage(optional): string
• var(optional): integer(int32)

{
    "type":"object",
    "discriminator":"objType",
    "properties":{
        "objId":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "objType":{
            "type":"string"
        },
        "rptCnt":{
            "type":"string"
        },
        "req":{
            "type":"string"
        },
        "usage":{
            "type":"string"
        },
        "purpose":{
            "type":"string"
        },
        "notes":{
            "type":"string"
        },
        "cmnts":{
            "type":"string"
        },
        "posNo":{
            "type":"string"
        },
        "msk":{
            "type":"boolean"
        },
        "var":{
            "type":"integer",
            "format":"int32"
        },
        "r":{
            "type":"boolean"
        },
        "getpRef":{
            "type":"integer",
            "format":"int32"
        },
        "getnRef":{
            "type":"integer",
            "format":"int32"
        },
        "getcRef":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : children

Type: array

Show Source

• Array of: object DocumentNode

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object items

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

Nested Schema : items

Type: object

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

Back to Top