Jump to

• Request
• Response

Generate a Schema Implementation Guide

get

/ic/api/b2b/v1/projects/{projectId}/schemas/{schemaId}/guide

Generates implementation guide for the schema.

Request

Path Parameters

• projectId(required): string
  Project identifier
• schemaId(required): string
  B2B schema ID.

Query Parameters

• format(required): string
  Document format.

  Default Value: html
• standardId(required): string
  Document standard ID.
• transactionId(required): string

  Document transaction ID.

  Example:

  /b2b/v1/projects/PROJECTID/schemas/STANDARD/guide?format=html&standardId=X12&versionId=4010&transactionId=100

• versionId(required): string
  Document version ID.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• text/plain

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

500 Response

Server error

Back to Top