Jump to

• Request
• Response

Export a B2B Schema

get

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

Exports a B2B Schema as a zipped file.

Request

Path Parameters

• schemaId(required): string

  Schema ID.

  Example:

  /b2b/v1/schemas/SCHEMA-123/export?includeDoc=true

Query Parameters

• includeDoc(required): boolean

  Use the includeDoc flag to include all its documents in the zip file along with the schema. Default value is false.

  Example:

  /b2b/v1/schemas/SCHEMA-123/export?includeDoc=true

  Default Value: false

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/octet-stream

200 Response

Successful operation

Body ()

Root Schema : schema

Type: string(binary)

400 Response

Bad request

404 Response

Not found

500 Response

Server error

Back to Top