Schema

Schema operations on individual schema objects.

Returns schema by schema ID.

get

Returns schema by schema ID. Only users with the Standard Registry role are allowed to make the request.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

schemaIdstringRequired

Schema ID

Example: 69aeb71ef8c5b278e3bab4e5

Responses

200

Successful operation.

application/json

createDatestring · nullableOptionalExample: 2026-03-25T12:40:32.586Z

updateDatestring · nullableOptionalExample: 2026-03-25T12:40:59.908Z

idstringRequiredExample: 69aeb71ef8c5b278e3bab4e5

uuidstringRequiredExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147

namestringRequiredExample: Schema name

descriptionstringRequiredExample: Description

entitystring · enumRequiredExample: POLICYPossible values:

iristringRequiredExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147

statusstring · enumRequiredExample: DRAFTPossible values:

topicIdstringRequiredExample: 0.0.6046379

versionstringRequiredExample: 1.0.0

creatorstring · nullableOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

ownerstringRequiredExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

messageIdstring · nullableOptionalExample: 1773670900.819264517

categorystring · enumRequiredExample: POLICYPossible values:

documentURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA

contextURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA

documentone ofRequired

stringOptionalExample: innerSchemaConfigurationInText

contextone ofRequired

stringOptionalExample: jsonLdContextInText

readonlyboolean · nullableOptionalExample: false

systemboolean · nullableOptionalExample: false

activeboolean · nullableOptionalExample: false

codeVersionstring · nullableOptionalExample: 1.2.0

topicCountnumber · nullableOptionalExample: 1

401

Unauthorized request.

application/json

403

Forbidden

application/json

404

Resource not found.

application/json

500

Internal server error.

application/json

get/schema/{schemaId}

GET /api/v1/schema/{schemaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "createDate": "2026-03-29T12:52:05.192Z",
  "updateDate": "2026-03-29T12:52:52.015Z",
  "uuid": "c5434400-5cca-41cc-b904-1d4d78017a29",
  "hash": "",
  "name": "Project Details",
  "description": "",
  "entity": "NONE",
  "status": "PUBLISHED",
  "version": "1.0.0",
  "sourceVersion": "",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8417999",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8417999",
  "topicId": "0.0.8427214",
  "messageId": "1774788770.467514813",
  "documentURL": "ipfs://bafkreic5fnqunk6x5kr2i45pb4ut2ovevpqpubwyrbrfgscmgvwp7wy2ya",
  "contextURL": "ipfs://bafkreide5ft6pnew5po4rjlsd5m2gqzq25xpih276fnj7hxf56km3wh4am",
  "iri": "#c5434400-5cca-41cc-b904-1d4d78017a29&1.0.0",
  "readonly": false,
  "system": false,
  "active": false,
  "category": "POLICY",
  "codeVersion": "1.2.0",
  "defs": [
    "#GeoJSON",
    "#cecced3d-a673-4bcc-a93c-e3b900181949&1.0.0"
  ],
  "errors": [],
  "document": {},
  "context": {},
  "id": "69c9207581910b160912d32b",
  "isOwner": true,
  "isCreator": true
}

Returns all parent schemas.

get

Returns all parent schemas.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

schemaIdstringRequired

Schema identifier

Example: 69aeb71ef8c5b278e3bab4e5

Responses

200

Successful operation.

application/json

idstringRequiredExample: 69aeb71ef8c5b278e3bab4e5

namestringRequiredExample: Schema name

statusstring · enumRequiredExample: PUBLISHEDPossible values:

versionstringRequiredExample: 1.0.0

sourceVersionstring · nullableOptional

categorystring · enumRequiredExample: POLICYPossible values:

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get/schema/{schemaId}/parents

GET /api/v1/schema/{schemaId}/parents HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "Project Description",
    "status": "PUBLISHED",
    "version": "1.0.0",
    "sourceVersion": "",
    "category": "POLICY",
    "id": "69c9207481910b160912d2ef"
  },
  {
    "name": "Monitoring Report",
    "status": "PUBLISHED",
    "version": "1.0.0",
    "sourceVersion": "",
    "category": "POLICY",
    "id": "69c9207481910b160912d2f9"
  }
]

Returns schema tree.

get

Returns schema tree.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

schemaIdstringRequired

Schema identifier

Example: 69aeb71ef8c5b278e3bab4e5

Responses

200

Successful operation.

application/json

namestringOptional

typestringOptional

childrenobject[]Optional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get/schema/{schemaId}/tree

GET /api/v1/schema/{schemaId}/tree HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "Project Details",
  "type": "#c5434400-5cca-41cc-b904-1d4d78017a29&1.0.0",
  "children": [
    {
      "name": "Date Range",
      "type": "#cecced3d-a673-4bcc-a93c-e3b900181949&1.0.0",
      "children": []
    }
  ]
}

Returns schema tree in PlantUML format.

get

Returns schema tree as exportable PlantUML code.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

schemaIdstringRequired

Schema identifier

Query parameters

includeFieldsbooleanOptional

Include field names and descriptions in classes

includeFormulasbooleanOptional

Include formula components and links

includeDependenciesbooleanOptional

Include dependent formulas referenced by directly linked formulas

Responses

200

Successful operation.

application/json

stringOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get/schema/{schemaId}/tree/export/plantuml

GET /api/v1/schema/{schemaId}/tree/export/plantuml HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

Returns a sample payload for the schema by schema Id.

get

Returns a sample payload for the schema by schema Id.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

schemaIdstringRequired

Schema ID

Example: 69aeb71ef8c5b278e3bab4e5

Responses

200

Successful operation.

application/json

idstringRequired

Generated document identifier

typestringRequired

Schema type without the leading #

@contextstring[]Required

JSON-LD context; first item is the schema IRI

Other propertiesanyOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

404

Resource not found.

application/json

500

Internal server error.

application/json

get/schema/{schemaId}/sample-payload

GET /api/v1/schema/{schemaId}/sample-payload HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "59760e7b-f249-46a6-a39f-d59d861e9690",
  "field0": "example",
  "field1": [
    "example"
  ],
  "field2": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "properties": {},
          "geometry": {
            "type": "Point",
            "coordinates": [
              0,
              0
            ]
          }
        }
      ]
    }
  ],
  "field3": [
    "example@email.com"
  ],
  "type": "c5434400-5cca-41cc-b904-1d4d78017a29&1.0.0",
  "@context": [
    "#c5434400-5cca-41cc-b904-1d4d78017a29&1.0.0"
  ]
}

Last updated 15 days ago