All pages
Powered by GitBook
1 of 14

Schema Creation Using APIs

Listing of Schema

SCHEMA LISTING

Returns all schemas

GET /schemas

Returns all schemas

Query Parameters

Name
Type
Description

pageIndex

Integer

The number of pages to skip before starting to collect the result set

pageSize

Integer

The numbers of items to return

{
    // Response
}
{
    // Response
}
{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
}
{
    headers:
            x-total-count:
              schema:
                type: integer
              description: Total items in the collection.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Schema'
}

Publishing schema based on schema ID

PUBLISHING SCHEMA BASED ON SCHEMA ID

Publishes the schema

PUT /schemas/{schemaId}/publish

Publishes the schema with the provided (internal) schema ID onto IPFS, sends a message featuring IPFS CID into the corresponding Hedera topic. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

schemaID*

String

Schema ID

Request Body

Name
Type
Description

version*

Object

Object that contains policy version

{
    content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Schema'
}
{
    // Response
}
{
    // Response
}
{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
}

Updating Schema

UPDATING SCHEMA BASED ON SCHEMA ID

Updates the schema

PUT /schemas/{schemaId}

Updates the schema matching the id in the request body. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

schemaID*

String

Schema ID

Request Body

Name
Type
Description

*

schema

Object that contains a valid schema including the id of the schema that is to be update

{
    content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Schema'
}
{
    // Response
}
{
    // Response
}
{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
}

Deleting a Schema

DELETING SCHEMA BASED ON SCHEMA ID

Deletes the schema

DELETE /schema/{schemaID}

Deletes the schema with the provided schema ID. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

schemaID*

String

Schema ID

{
    content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Schema'
}
{
    // Response
}
{
    // Response
}
{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
}

Schema Preview from IPFS

PREVIEWING SCHEMA FROM IPFS FILE

Schema preview from IPFS

POST /schemas/import/message/preview

Previews the schema from IPFS without loading it into the local DB. Only users with the Standard Registry role are allowed to make the request.

Request Body

Name
Type
Description

*

Object

Object that contains the identifier of the Hedera message which contains the IPFS CID of the schema

{
    content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Schema'
}
{
    // Response
}
{
    // Response
}
{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
}

Schema Preview from Zip

PREVIEWING SCHEMA FROM ZIP FILE

Schema preview from a zip file

POST /schemas/import/file/preview

Previews the schema from a zip file. Only users with the Standard Registry role are allowed to make the request.

Request Body

Name
Type
Description

*

A zip file containing the schema to be viewed

{
    content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Schema'
}
{
    // Response
}
{
    // Response
}
{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
}

Export message IDs of Schema

EXPORTING HEDERA MESSAGED IDS OF PUBLISHED SCHEMA

Hedera message IDs of published schemas

POST /schemas/{schemaId}/export/message

Returns Hedera message IDs of the published schemas, these messages contain IPFS CIDs of these schema files. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

schemaID*

String

Selected schema ID

{
    content:
            application/json:
              schema:
                $ref: "#/components/schemas/ExportSchema"
}
{
    // Response
}
{
    // Response
}
{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
}

Export Files from Schema

EXPORTING SCHEMA FILES FOR THE SCHEMA

Return zip file with schemas

POST /schemas/{schemaId}/export/file

Returns schema files for the schemas. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

schemaID*

String

Selected schema ID

{
   
}
{
    // Response
}
{
    // Response
}
{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
}

Creation of Schema related to the topic

Creates a schema related to the topic (policy)

POST /schemas/{topicId}

Creates new schema. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

topicId*

String

Topic ID

Request Body

Name
Type
Description

*

Object

Object that contains a valid schema

{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
}

Returns all Schemas related to the topic

Returns schemas related to the topic (policy)

GET /schemas/{topicId}

Returns all schemas by topicId.

Path Parameters

Name
Type
Description

topicId*

Integer

Topic ID

Query Parameters

Name
Type
Description

pageIndex

Integer

The number of pages to skip before starting to collect the result set

pageSize

Integer

The numbers of items to return

{
    headers:
            x-total-count:
              schema:
                type: integer
              description: Total items in the collection.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Schema'
}
{
    // Response
}
{
    // Response
}
{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
}

Importing Zip file containing Schema

Imports schemas from a file for the selected topic (policy)

POST /schemas/{topicId}/import/file

Imports new schema from a zip file into the local DB. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

topicId*

Integer

Topic ID

Request Body

Name
Type
Description

*

file

A zip file containing schema to be imported

{
    // Response
}
{
    // Response
}
{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
}
{
    content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Schema'
}

Import schema from Zip

IMPORTING SCHEMA FROM .ZIP FILE

Imports new schema from a zip file

POST /schemas/import/file

Imports new schema from a zip file into the local DB. Only users with the Standard Registry role are allowed to make the request.

Request Body

Name
Type
Description

*

.zip file

A zip file containing schema to be imported

{
    content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Schema'
}
{
    // Response
}
{
    // Response
}
{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
}

Returning Schema by SchemaID

Returns schema by schema ID

GET /schema/{schemaId}

Returns schema by schema ID

Path Parameters

Name
Type
Description

schemaId*

String

Schema ID

{
      content:
            application/json:
              schema:
                  $ref: '#/components/schemas/Schema'
}
{
    // Response
}
{
    // Response
}
{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
}