Jump to

• Request
• Response

Update a B2B Document

put

/ic/api/b2b/v1/b2bdocuments/{documentId}

Updates a B2B Document with the specified document ID. To modify a document used by an active agreement, you need to deactivate it first.

Request

Path Parameters

• documentId(required): string

  B2B document ID.

  Example:

  /b2b/v1/b2bdocuments/DOC123

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• documentUi: schema

{
    "type":"object",
    "properties":{
        "documentUi":{
            "$ref":"#/components/schemas/DocumentUI"
        }
    }
}

Nested Schema : schema

Match All

Show Source

• allOf ViewModel
• object GenericRestRs
• object type

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

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• allOf ViewModel
• object GenericRestRs
• object type

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

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

400 Response

Bad request, malformed parameters or missing required data

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 decsription does not exceed 1024 characters, and the length of identifier does not exceed 32 characters. Ensure that name and identifier are not named as Standard or Default. Ensure that there is a valid combination of std, version and txId.

500 Response

Server error

Back to Top