Jump to

• Request
• Response

Delete a B2B Schema

delete

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

Deletes the B2B Schema with the specified ID. Ensure that the B2B schema that you want to delete is not in use by any B2B document. Before deleting the B2B schema, remove any references to it.

Request

Path Parameters

• schemaId(required): string

  Delete B2B schema.

  Example:

  /b2b/v1/b2bdocuments/SCH123

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 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

409 Response

Not allowed, schema in use

500 Response

Server error

Back to Top