Jump to

• Request
• Response

Retrieve a B2B Schema

get

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

Retrieves detailed information about the B2B Schema with the specified ID.

Request

Supported Media Types

• application/json

Path Parameters

• schemaId(required): string
  B2B schema ID.

Query Parameters

• standard(required): string
  Document standard.
• transactionId(required): string

  Document transaction id.

  Example:

  /b2b/v1/schemas/SCH2

• version(required): string
  Document version.

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

400 Response

Bad request

500 Response

Server error

Back to Top