Jump to

• Request
• Response

Clone a B2B Schema

post

/ic/api/b2b/v1/schemas/{schemaId}/clone

Creates a new copy of a B2B Schema with identical metadata. The request body must contain at least the name and identifier fields.

Request

Supported Media Types

• application/json

Path Parameters

• schemaId(required): string

  B2B schema ID.

  Example:

  /b2b/v1/schemas/SCH123/clone

Body ()

Clone b2b schema request details.

Example:

{"id": "CLONED_SCH", "name": "Cloned Schema", "desc": "Cloned Schema Description"}

Root Schema : SchemaUI

Type: object

Show Source

• active: array active
  Read Only: true
• activeAgr: array activeAgr
  Read Only: true
• count: integer(int32)
• createdBy: string
• createdDate: string
• desc: string
• docNode: array docNode
• id: string
• inActive: array inActive
  Read Only: true
• inActiveAgr: array inActiveAgr
  Read Only: true
• links: array links
• maxSize: object MaxSize
• name: string
• state: string
• std: string
• txId: string
• txName: string
• updatedBy: string
• updatedDate: string
• version: 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: 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"
        },
        "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: 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

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

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: integer(int32)
• createdBy: string
• createdDate: string
• desc: string
• id: string
• links: array links
• name: string
• status: string
• std: string
• txId: string
• txName: string
• updatedBy: string
• updatedDate: string
• version: 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: string
• mediaType: string
• rel: string

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

Nested Schema : AgreementUI

Type: object

Show Source

• 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

{
    "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: object DocumentModelUI
  Discriminator: objType
• children: 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: string
• getcRef: integer(int32)
• getnRef: integer(int32)
• getpRef: integer(int32)
• 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",
    "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

500 Response

Server error

Back to Top