Jump to

• Request
• Response

Retrieve B2B Schemas

get

/ic/api/b2b/v1/schemas

Retrieves all the available B2B schemas.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : SchemasUI

Match All

Show Source

• object GenericRestRs
• object SchemasUI-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/SchemaUI"
                    }
                },
                "size":{
                    "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 : SchemasUI-allOf[1]

Type: object

Show Source

• items: array items
• size: integer (int32)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SchemaUI"
            }
        },
        "size":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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 : items

Type: array

Show Source

• Array of: SchemaUI

{
    "type":"array",
    "items":{
        "$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":{
                "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"
                }
            }
        }
    ]
}

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 : 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
• docNode: array docNode
• inActive: array inActive
• inActiveAgr: array inActiveAgr
• maxSize: object MaxSize
• parameters: string
• state: string

{
    "type":"object",
    "properties":{
        "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"
        }
    }
}

Nested Schema : active

Type: array

Show Source

• Array of: DocumentUI
  View Object to represent Document type resources. Sep 18, 20192:10:50 PM

{
    "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
  View Object to represent Document type resources. Sep 18, 20192:10:50 PM

{
    "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

View Object to represent Document type resources. Sep 18, 20192:10:50 PM

Match All

Show Source

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

{
    "description":"View Object to represent Document type resources.\n \n  Sep 18, 20192:10:50 PM",
    "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: object DocumentModelUI
• children: array children

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

Nested Schema : DocumentModelUI

Type: object

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"
        }
    }
}

Nested Schema : children

Type: array

Show Source

• Array of: object DocumentNode

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

400 Response

Bad request

500 Response

Server error

Back to Top