New Release
Guardian 3.7.0
Ctrlk
Release NotesCalendar
youtube
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Schemas

Create and manage JSON schemas for policy data structures.

Return a list of all schemas.

get

Returns all schemas. Add Api-Version: 2 header to use search and searchOptions filters. If category is omitted, the endpoint returns schemas of all categories matching the standard owner/non-system/non-readonly filters. Published tool schemas that do not match the current owner are only included when category=TOOL.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pageIndexnumberOptional

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

Example: 0
pageSizenumberOptional

The numbers of items to return

Example: 20
categorystring · enumOptional

Schema category. If omitted, schemas of all categories matching the standard owner/non-system/non-readonly filters are returned. Published tool schemas without owner match are only included when category=TOOL.

Possible values:
policyIdstringOptional

Policy id

Example: 69aeb71ef8c5b278e3bab4e5
moduleIdstringOptional

Module id

Example: 69aeb71ef8c5b278e3bab4e5
toolIdstringOptional

Tool id

Example: 69aeb71ef8c5b278e3bab4e5
templateIdstringOptional

Schema template id

Example: 69aeb71ef8c5b278e3bab4e5
topicIdstringOptional

Topic id. Use not-binded to return policy schemas not bound to any policy topic.

Example: 0.0.6046379
searchstringOptional

Search

Example: text
templateSchemasOnlystringRequired
unusedInPolicyOnlystringRequired
Responses
200

Successful operation.

application/json
get/schemas
GET /api/v1/schemas?templateSchemasOnly=text&unusedInPolicyOnly=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "f3b2a9c1e4d5678901234567",
    "uuid": "f3b2a9c1e4d5678901234567",
    "name": "Schema name",
    "description": "Description",
    "entity": "string",
    "iri": "string",
    "status": "string",
    "topicId": "f3b2a9c1e4d5678901234567",
    "version": "1.0.0",
    "owner": "string",
    "messageId": "f3b2a9c1e4d5678901234567",
    "category": "string",
    "documentURL": "https://example.com",
    "contextURL": "https://example.com",
    "document": {},
    "context": {}
  }
]

Updates the schema.

put

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
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:
templateIdstring · nullableOptionalExample: 69aeb71ef8c5b278e3bab4e5
templateSchemaIdstring · nullableOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
documentURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
contextURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
documentone ofRequired
or
stringOptionalExample: innerSchemaConfigurationInText
contextone ofRequired
or
stringOptionalExample: jsonLdContextInText
readonlyboolean · nullableOptionalExample: false
systemboolean · nullableOptionalExample: false
activeboolean · nullableOptionalExample: false
codeVersionstring · nullableOptionalExample: 1.2.0
iwaVersionstring · nullableOptional

IWA dMRV specification version the field properties are authored against. Absent means v1.

Example: 3.0.0
topicCountnumber · nullableOptionalExample: 1
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:
templateIdstring · nullableOptionalExample: 69aeb71ef8c5b278e3bab4e5
templateSchemaIdstring · nullableOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
documentURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
contextURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
documentone ofRequired
or
stringOptionalExample: innerSchemaConfigurationInText
contextone ofRequired
or
stringOptionalExample: jsonLdContextInText
readonlyboolean · nullableOptionalExample: false
systemboolean · nullableOptionalExample: false
activeboolean · nullableOptionalExample: false
codeVersionstring · nullableOptionalExample: 1.2.0
iwaVersionstring · nullableOptional

IWA dMRV specification version the field properties are authored against. Absent means v1.

Example: 3.0.0
topicCountnumber · nullableOptionalExample: 1
put/schemas
PUT /api/v1/schemas HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1102

{
  "id": "69c95d972df024260a5079ca",
  "uuid": "9af962d2-d595-488d-a9ce-bb600882d5df",
  "hash": "",
  "name": "TestVC",
  "description": "",
  "entity": "VC",
  "status": "DRAFT",
  "readonly": false,
  "document": {
    "$id": "#9af962d2-d595-488d-a9ce-bb600882d5df&1.0.1",
    "$comment": "{ \"@id\": \"schema:9af962d2-d595-488d-a9ce-bb600882d5df#9af962d2-d595-488d-a9ce-bb600882d5df&1.0.1\", \"term\": \"9af962d2-d595-488d-a9ce-bb600882d5df&1.0.1\" }",
    "title": "TestVC",
    "description": "",
    "type": "object",
    "properties": {},
    "required": [],
    "additionalProperties": false,
    "$defs": {}
  },
  "context": null,
  "version": "1.0.1",
  "sourceVersion": "",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8417999",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8417999",
  "topicId": "0.0.8428661",
  "messageId": "",
  "documentURL": "",
  "contextURL": "schema:9af962d2-d595-488d-a9ce-bb600882d5df",
  "iri": "#9af962d2-d595-488d-a9ce-bb600882d5df&1.0.1",
  "type": "9af962d2-d595-488d-a9ce-bb600882d5df&1.0.1",
  "fields": [],
  "conditions": [],
  "active": false,
  "system": false,
  "category": "POLICY",
  "errors": [],
  "userDID": null,
  "codeVersion": "1.2.0"
}
[
  {
    "id": "f3b2a9c1e4d5678901234567",
    "uuid": "f3b2a9c1e4d5678901234567",
    "name": "Schema name",
    "description": "Description",
    "entity": "string",
    "iri": "string",
    "status": "string",
    "topicId": "f3b2a9c1e4d5678901234567",
    "version": "1.0.0",
    "owner": "string",
    "messageId": "f3b2a9c1e4d5678901234567",
    "category": "string",
    "documentURL": "https://example.com",
    "contextURL": "https://example.com",
    "document": {},
    "context": {}
  }
]

Return a list of all schemas.

get

Returns schemas for the provided topic id. If category is omitted, the endpoint returns schemas of all categories for that topic within the standard owner/non-system/non-readonly filters.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
topicIdstringRequired

Topic Id

Example: 0.0.6046379
Query parameters
pageIndexnumberOptional

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

Example: 0
pageSizenumberOptional

The numbers of items to return

Example: 20
categorystring · enumOptional

Schema category. If omitted, schemas of all categories matching the standard owner/non-system/non-readonly filters for the provided topic are returned. Published tool schemas without owner match are only included when category=TOOL.

Possible values:
Responses
200

Successful operation.

application/json
get/schemas/{topicId}
GET /api/v1/schemas/{topicId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "f3b2a9c1e4d5678901234567",
    "uuid": "f3b2a9c1e4d5678901234567",
    "name": "Schema name",
    "description": "Description",
    "entity": "string",
    "iri": "string",
    "status": "string",
    "topicId": "f3b2a9c1e4d5678901234567",
    "version": "1.0.0",
    "owner": "string",
    "messageId": "f3b2a9c1e4d5678901234567",
    "category": "string",
    "documentURL": "https://example.com",
    "contextURL": "https://example.com",
    "document": {},
    "context": {}
  }
]

Creates a new schema.

post

Creates a new schema under the provided topic 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
topicIdstringRequired

Target Hedera topic id for the created schema.

Example: 0.0.6046379
Body
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:
templateIdstring · nullableOptionalExample: 69aeb71ef8c5b278e3bab4e5
templateSchemaIdstring · nullableOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
documentURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
contextURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
documentone ofRequired
or
stringOptionalExample: innerSchemaConfigurationInText
contextone ofRequired
or
stringOptionalExample: jsonLdContextInText
readonlyboolean · nullableOptionalExample: false
systemboolean · nullableOptionalExample: false
activeboolean · nullableOptionalExample: false
codeVersionstring · nullableOptionalExample: 1.2.0
iwaVersionstring · nullableOptional

IWA dMRV specification version the field properties are authored against. Absent means v1.

Example: 3.0.0
topicCountnumber · nullableOptionalExample: 1
Responses
201

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:
templateIdstring · nullableOptionalExample: 69aeb71ef8c5b278e3bab4e5
templateSchemaIdstring · nullableOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
documentURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
contextURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
documentone ofRequired
or
stringOptionalExample: innerSchemaConfigurationInText
contextone ofRequired
or
stringOptionalExample: jsonLdContextInText
readonlyboolean · nullableOptionalExample: false
systemboolean · nullableOptionalExample: false
activeboolean · nullableOptionalExample: false
codeVersionstring · nullableOptionalExample: 1.2.0
iwaVersionstring · nullableOptional

IWA dMRV specification version the field properties are authored against. Absent means v1.

Example: 3.0.0
topicCountnumber · nullableOptionalExample: 1
post/schemas/{topicId}
POST /api/v1/schemas/{topicId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1842

{
  "uuid": "99004913-be86-4e48-bdf8-8e478135a6ce",
  "hash": "",
  "name": "CreateSchema",
  "description": "",
  "entity": "VC",
  "status": "DRAFT",
  "readonly": false,
  "document": {
    "$id": "#99004913-be86-4e48-bdf8-8e478135a6ce",
    "$comment": "{ \"@id\": \"schema:99004913-be86-4e48-bdf8-8e478135a6ce#99004913-be86-4e48-bdf8-8e478135a6ce\", \"term\": \"99004913-be86-4e48-bdf8-8e478135a6ce\" }",
    "title": "CreateSchema",
    "description": "",
    "type": "object",
    "properties": {
      "@context": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        ],
        "readOnly": true
      },
      "type": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        ],
        "readOnly": true
      },
      "id": {
        "type": "string",
        "readOnly": true
      },
      "field0": {
        "title": "field0",
        "description": "TestStringField",
        "readOnly": false,
        "type": "string",
        "$comment": "{\"term\":\"field0\",\"@id\":\"https://www.schema.org/text\",\"isPrivate\":false,\"availableOptions\":[],\"orderPosition\":0}"
      },
      "policyId": {
        "title": "Policy Id",
        "description": "Policy Id",
        "readOnly": true,
        "type": "string",
        "$comment": "{\"term\":\"policyId\",\"@id\":\"https://www.schema.org/text\"}"
      },
      "ref": {
        "title": "Relationships",
        "description": "Relationships",
        "readOnly": true,
        "type": "string",
        "$comment": "{\"term\":\"ref\",\"@id\":\"https://www.schema.org/text\"}"
      },
      "guardianVersion": {
        "title": "Guardian Version",
        "description": "Guardian Version",
        "readOnly": true,
        "type": "string",
        "$comment": "{\"term\":\"guardianVersion\",\"@id\":\"https://www.schema.org/text\"}"
      }
    },
    "required": [
      "@context",
      "type",
      "field0",
      "policyId"
    ],
    "additionalProperties": false,
    "$defs": {}
  },
  "context": null,
  "version": "",
  "sourceVersion": "",
  "creator": "",
  "owner": "",
  "topicId": "0.0.8428661",
  "messageId": "",
  "documentURL": "",
  "contextURL": "schema:99004913-be86-4e48-bdf8-8e478135a6ce",
  "iri": "",
  "fields": [],
  "conditions": [],
  "active": false,
  "system": false,
  "category": "POLICY",
  "errors": [],
  "userDID": null,
  "codeVersion": ""
}
[
  {
    "id": "f3b2a9c1e4d5678901234567",
    "uuid": "f3b2a9c1e4d5678901234567",
    "name": "Schema name",
    "description": "Description",
    "entity": "string",
    "iri": "string",
    "status": "string",
    "topicId": "f3b2a9c1e4d5678901234567",
    "version": "1.0.0",
    "owner": "string",
    "messageId": "f3b2a9c1e4d5678901234567",
    "category": "string",
    "documentURL": "https://example.com",
    "contextURL": "https://example.com",
    "document": {},
    "context": {}
  }
]

Finds the schema by json document type across the whole database.

get

Finds the schema by json document type across the whole database, without restricting the search to the current user.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
schemaTypestringRequired

Schema type without the leading #, usually in the form uuid&version.

Example: cfc8e34f-adae-4009-bb22-1f8c13364cb7&1.0.0
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:
templateIdstring · nullableOptionalExample: 69aeb71ef8c5b278e3bab4e5
templateSchemaIdstring · nullableOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
documentURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
contextURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
documentone ofRequired
or
stringOptionalExample: innerSchemaConfigurationInText
contextone ofRequired
or
stringOptionalExample: jsonLdContextInText
readonlyboolean · nullableOptionalExample: false
systemboolean · nullableOptionalExample: false
activeboolean · nullableOptionalExample: false
codeVersionstring · nullableOptionalExample: 1.2.0
iwaVersionstring · nullableOptional

IWA dMRV specification version the field properties are authored against. Absent means v1.

Example: 3.0.0
topicCountnumber · nullableOptionalExample: 1
get/schemas/type/{schemaType}
GET /api/v1/schemas/type/{schemaType} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "value": {
    "uuid": "cfc8e34f-adae-4009-bb22-1f8c13364cb7",
    "iri": "#cfc8e34f-adae-4009-bb22-1f8c13364cb7&1.0.0",
    "name": "Project Description",
    "version": "1.0.0",
    "document": {
      "$id": "#cfc8e34f-adae-4009-bb22-1f8c13364cb7&1.0.0",
      "$comment": "{ \"@id\": \"#cfc8e34f-adae-4009-bb22-1f8c13364cb7&1.0.0\", \"term\": \"cfc8e34f-adae-4009-bb22-1f8c13364cb7&1.0.0\" }",
      "title": "Project Description",
      "description": "Project Description",
      "type": "object",
      "properties": {},
      "required": [],
      "additionalProperties": false,
      "$defs": {}
    },
    "documentURL": "ipfs://bafkreiefl3543dhxcicjl3v6bmct4uqnuxharci45opopg3jwgqkpdccr4",
    "context": {},
    "contextURL": "ipfs://bafkreidkocws2ks2s5zrm7ef6t4noqu5fylvyjj74yfcgbpmn4q5f2bjzq"
  }
}

Finds the schema by json document type for the current user only.

get

Finds the schema by json document type only among schemas owned by the user on whose behalf the request is made.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
schemaTypestringRequired

Schema type without the leading #, usually in the form uuid&version.

Example: cfc8e34f-adae-4009-bb22-1f8c13364cb7&1.0.0
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:
templateIdstring · nullableOptionalExample: 69aeb71ef8c5b278e3bab4e5
templateSchemaIdstring · nullableOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
documentURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
contextURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
documentone ofRequired
or
stringOptionalExample: innerSchemaConfigurationInText
contextone ofRequired
or
stringOptionalExample: jsonLdContextInText
readonlyboolean · nullableOptionalExample: false
systemboolean · nullableOptionalExample: false
activeboolean · nullableOptionalExample: false
codeVersionstring · nullableOptionalExample: 1.2.0
iwaVersionstring · nullableOptional

IWA dMRV specification version the field properties are authored against. Absent means v1.

Example: 3.0.0
topicCountnumber · nullableOptionalExample: 1
get/schemas/type-by-user/{schemaType}
GET /api/v1/schemas/type-by-user/{schemaType} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "value": {
    "uuid": "cfc8e34f-adae-4009-bb22-1f8c13364cb7",
    "iri": "#cfc8e34f-adae-4009-bb22-1f8c13364cb7&1.0.0",
    "name": "Project Description",
    "version": "1.0.0",
    "document": {
      "$id": "#cfc8e34f-adae-4009-bb22-1f8c13364cb7&1.0.0",
      "$comment": "{ \"@id\": \"#cfc8e34f-adae-4009-bb22-1f8c13364cb7&1.0.0\", \"term\": \"cfc8e34f-adae-4009-bb22-1f8c13364cb7&1.0.0\" }",
      "title": "Project Description",
      "description": "Project Description",
      "type": "object",
      "properties": {},
      "required": [],
      "additionalProperties": false,
      "$defs": {}
    },
    "documentURL": "ipfs://bafkreiefl3543dhxcicjl3v6bmct4uqnuxharci45opopg3jwgqkpdccr4",
    "context": {},
    "contextURL": "ipfs://bafkreidkocws2ks2s5zrm7ef6t4noqu5fylvyjj74yfcgbpmn4q5f2bjzq"
  }
}

Returns the current user's short schema list.

get

Returns a short list of non-system, non-readonly schemas owned by the current Standard Registry user, excluding TAG schemas. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Successful operation.

application/json
idstringRequiredExample: 69aeb71ef8c5b278e3bab4e5
namestringRequiredExample: Project Description
descriptionstringRequiredExample: Project Description
statusstring · enumRequiredExample: PUBLISHEDPossible values:
versionstringRequiredExample: 1.0.0
sourceVersionstring · nullableOptional
topicIdstringRequiredExample: 0.0.6046379
categorystring · enumRequiredExample: POLICYPossible values:
get/schemas/list/all
GET /api/v1/schemas/list/all HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "Project Description",
    "description": "Project Description",
    "status": "PUBLISHED",
    "version": "1.0.0",
    "sourceVersion": "",
    "topicId": "0.0.8425763",
    "category": "POLICY",
    "id": "69c8e13981910b160912c6c8"
  },
  {
    "name": "Monitoring Report",
    "description": "Monitoring Report",
    "status": "PUBLISHED",
    "version": "1.0.0",
    "sourceVersion": "",
    "topicId": "0.0.8425763",
    "category": "POLICY",
    "id": "69c8e13981910b160912c6d2"
  }
]

Returns schemas for the selected topic and related tool topics.

get

Returns schemas for the specified policy, tool, or template topic. Policy topics include related tool schemas discovered from that parent entity. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
categorystring · enumOptional

Determines which parent entity type is used to resolve related schemas. Supported values: POLICY, TOOL, TEMPLATE.

Possible values:
topicIdstringOptional

Topic ID used as the starting point for schema lookup and related tool topic resolution.

Example: 0.0.6046379
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:
templateIdstring · nullableOptionalExample: 69aeb71ef8c5b278e3bab4e5
templateSchemaIdstring · nullableOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
documentURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
contextURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
documentone ofRequired
or
stringOptionalExample: innerSchemaConfigurationInText
contextone ofRequired
or
stringOptionalExample: jsonLdContextInText
readonlyboolean · nullableOptionalExample: false
systemboolean · nullableOptionalExample: false
activeboolean · nullableOptionalExample: false
codeVersionstring · nullableOptionalExample: 1.2.0
iwaVersionstring · nullableOptional

IWA dMRV specification version the field properties are authored against. Absent means v1.

Example: 3.0.0
topicCountnumber · nullableOptionalExample: 1
get/schemas/list/sub
GET /api/v1/schemas/list/sub HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "f3b2a9c1e4d5678901234567",
    "uuid": "f3b2a9c1e4d5678901234567",
    "name": "Schema name",
    "description": "Description",
    "entity": "string",
    "iri": "string",
    "status": "string",
    "topicId": "f3b2a9c1e4d5678901234567",
    "version": "1.0.0",
    "owner": "string",
    "messageId": "f3b2a9c1e4d5678901234567",
    "category": "string",
    "documentURL": "https://example.com",
    "contextURL": "https://example.com",
    "document": {},
    "context": {}
  }
]

Returns the selected schema with sub schemas for the topic and related tool topics.

get

Returns the selected schema by schemaId together with sub schemas resolved from the provided topicId. Related tool topics are resolved from the parent entity type specified by category. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
categorystring · enumOptional

Determines which parent entity type is used to resolve related schemas. Supported values: POLICY, TOOL, TEMPLATE.

Possible values:
topicIdstringOptional

Topic ID used as the starting point for sub-schema lookup and related tool topic resolution.

Example: 0.0.6046379
schemaIdstringOptional

Optional schema ID of the primary schema to return in the schema field. If omitted, only subSchemas are resolved.

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
get/schemas/schema-with-sub-schemas
GET /api/v1/schemas/schema-with-sub-schemas HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "schema": {
    "createDate": "2026-03-29T08:22:17.965Z",
    "updateDate": "2026-03-29T08:55:59.633Z",
    "uuid": "da24858f-0ce0-44ef-b5b4-3689960d00c7",
    "hash": "",
    "name": "VVB",
    "description": "VVB",
    "entity": "VC",
    "status": "PUBLISHED",
    "documentFileId": "69c8e91f81910b160912cda8",
    "contextFileId": "69c8e91f81910b160912cdaa",
    "version": "1.0.0",
    "sourceVersion": "",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8417999",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8417999",
    "topicId": "0.0.8425763",
    "messageId": "1774774558.160429342",
    "documentURL": "ipfs://bafkreiefl3543dhxcicjl3v6bmct4uqnuxharci45opopg3jwgqkpdccr4",
    "contextURL": "ipfs://bafkreidkocws2ks2s5zrm7ef6t4noqu5fylvyjj74yfcgbpmn4q5f2bjzq",
    "iri": "#da24858f-0ce0-44ef-b5b4-3689960d00c7&1.0.0",
    "readonly": false,
    "system": false,
    "active": false,
    "category": "POLICY",
    "codeVersion": "1.2.0",
    "defs": [],
    "errors": [],
    "document": {},
    "context": {},
    "id": "69c8e13981910b160912c6d7"
  },
  "subSchemas": [
    {
      "createDate": "2026-03-29T08:22:17.738Z",
      "updateDate": "2026-03-29T08:55:59.069Z",
      "uuid": "cfc8e34f-adae-4009-bb22-1f8c13364cb7",
      "hash": "",
      "name": "Project Description",
      "description": "Project Description",
      "entity": "VC",
      "status": "PUBLISHED",
      "documentFileId": "69c8e91f81910b160912cd78",
      "contextFileId": "69c8e91f81910b160912cd7a",
      "version": "1.0.0",
      "sourceVersion": "",
      "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8417999",
      "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8417999",
      "topicId": "0.0.8425763",
      "messageId": "1774774558.160429342",
      "documentURL": "ipfs://bafkreiefl3543dhxcicjl3v6bmct4uqnuxharci45opopg3jwgqkpdccr4",
      "contextURL": "ipfs://bafkreidkocws2ks2s5zrm7ef6t4noqu5fylvyjj74yfcgbpmn4q5f2bjzq",
      "iri": "#cfc8e34f-adae-4009-bb22-1f8c13364cb7&1.0.0",
      "readonly": false,
      "system": false,
      "active": false,
      "category": "POLICY",
      "codeVersion": "1.2.0",
      "defs": [],
      "errors": [],
      "document": {},
      "context": {},
      "__component": "Current",
      "id": "69c8e13981910b160912c6c8"
    },
    {
      "createDate": "2026-03-29T08:22:17.819Z",
      "updateDate": "2026-03-29T08:55:59.542Z",
      "uuid": "eb36a762-feaa-4511-9ae6-be255a88fff7",
      "hash": "",
      "name": "PP",
      "description": "",
      "entity": "VC",
      "status": "PUBLISHED",
      "documentFileId": "69c8e91f81910b160912cda0",
      "contextFileId": "69c8e91f81910b160912cda2",
      "version": "1.0.0",
      "sourceVersion": "",
      "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8417999",
      "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8417999",
      "topicId": "0.0.8425763",
      "messageId": "1774774558.160429342",
      "documentURL": "ipfs://bafkreiefl3543dhxcicjl3v6bmct4uqnuxharci45opopg3jwgqkpdccr4",
      "contextURL": "ipfs://bafkreidkocws2ks2s5zrm7ef6t4noqu5fylvyjj74yfcgbpmn4q5f2bjzq",
      "iri": "#eb36a762-feaa-4511-9ae6-be255a88fff7&1.0.0",
      "readonly": false,
      "system": false,
      "active": false,
      "category": "POLICY",
      "codeVersion": "1.2.0",
      "defs": [],
      "errors": [],
      "document": {},
      "context": {},
      "__component": "Current",
      "id": "69c8e13981910b160912c6cd"
    }
  ]
}

Starts asynchronous schema copy.

post

Starts asynchronous copying of a schema to the target topic using the provided source IRI, new name, and copyNested option, and returns a task. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
topicIdstringRequired

Target Hedera topic id for the copied schema.

Example: 0.0.6046379
namestringRequired

Display name for the copied schema.

Example: Project lamp type and charging method copy
iristringRequired

Source schema IRI (with # prefix, typically uuid&version).

Example: #b242b108-c226-46ab-b527-7c2bbf1275ea&1.0.0
copyNestedbooleanRequired

When true, nested schemas are copied together with the source.

Example: true
Responses
202

Successful operation.

application/json
taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
expectationnumberRequired

Expected count of task phases

Example: 8
actionstringRequired

Task action

Example: Create tool
userIdstringRequired

User Id

Example: 69bcfd90c98df6ceb05e8a78
post/schemas/push/copy
POST /api/v1/schemas/push/copy HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 147

{
  "topicId": "0.0.8425763",
  "name": "Project lamp type and charging method copy",
  "iri": "#b242b108-c226-46ab-b527-7c2bbf1275ea&1.0.0",
  "copyNested": true
}
{
  "taskId": "89e1e62a-7976-4e24-8dd3-997da02dc81e",
  "expectation": 6,
  "action": "Create schema",
  "userId": "69c2cfc021d39e7b6d15e236"
}

Creates a new schema asynchronously.

post

Starts asynchronous creation of a new schema under the provided topic id and returns a task. 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
topicIdstringRequired

Target Hedera topic id for the created schema.

Example: 0.0.6046379
Body
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:
templateIdstring · nullableOptionalExample: 69aeb71ef8c5b278e3bab4e5
templateSchemaIdstring · nullableOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
documentURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
contextURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
documentone ofRequired
or
stringOptionalExample: innerSchemaConfigurationInText
contextone ofRequired
or
stringOptionalExample: jsonLdContextInText
readonlyboolean · nullableOptionalExample: false
systemboolean · nullableOptionalExample: false
activeboolean · nullableOptionalExample: false
codeVersionstring · nullableOptionalExample: 1.2.0
iwaVersionstring · nullableOptional

IWA dMRV specification version the field properties are authored against. Absent means v1.

Example: 3.0.0
topicCountnumber · nullableOptionalExample: 1
Responses
202

Successful operation.

application/json
taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
expectationnumberRequired

Expected count of task phases

Example: 8
actionstringRequired

Task action

Example: Create tool
userIdstringRequired

User Id

Example: 69bcfd90c98df6ceb05e8a78
post/schemas/push/{topicId}
POST /api/v1/schemas/push/{topicId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1842

{
  "uuid": "99004913-be86-4e48-bdf8-8e478135a6ce",
  "hash": "",
  "name": "CreateSchema",
  "description": "",
  "entity": "VC",
  "status": "DRAFT",
  "readonly": false,
  "document": {
    "$id": "#99004913-be86-4e48-bdf8-8e478135a6ce",
    "$comment": "{ \"@id\": \"schema:99004913-be86-4e48-bdf8-8e478135a6ce#99004913-be86-4e48-bdf8-8e478135a6ce\", \"term\": \"99004913-be86-4e48-bdf8-8e478135a6ce\" }",
    "title": "CreateSchema",
    "description": "",
    "type": "object",
    "properties": {
      "@context": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        ],
        "readOnly": true
      },
      "type": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        ],
        "readOnly": true
      },
      "id": {
        "type": "string",
        "readOnly": true
      },
      "field0": {
        "title": "field0",
        "description": "TestStringField",
        "readOnly": false,
        "type": "string",
        "$comment": "{\"term\":\"field0\",\"@id\":\"https://www.schema.org/text\",\"isPrivate\":false,\"availableOptions\":[],\"orderPosition\":0}"
      },
      "policyId": {
        "title": "Policy Id",
        "description": "Policy Id",
        "readOnly": true,
        "type": "string",
        "$comment": "{\"term\":\"policyId\",\"@id\":\"https://www.schema.org/text\"}"
      },
      "ref": {
        "title": "Relationships",
        "description": "Relationships",
        "readOnly": true,
        "type": "string",
        "$comment": "{\"term\":\"ref\",\"@id\":\"https://www.schema.org/text\"}"
      },
      "guardianVersion": {
        "title": "Guardian Version",
        "description": "Guardian Version",
        "readOnly": true,
        "type": "string",
        "$comment": "{\"term\":\"guardianVersion\",\"@id\":\"https://www.schema.org/text\"}"
      }
    },
    "required": [
      "@context",
      "type",
      "field0",
      "policyId"
    ],
    "additionalProperties": false,
    "$defs": {}
  },
  "context": null,
  "version": "",
  "sourceVersion": "",
  "creator": "",
  "owner": "",
  "topicId": "0.0.8428661",
  "messageId": "",
  "documentURL": "",
  "contextURL": "schema:99004913-be86-4e48-bdf8-8e478135a6ce",
  "iri": "",
  "fields": [],
  "conditions": [],
  "active": false,
  "system": false,
  "category": "POLICY",
  "errors": [],
  "userDID": null,
  "codeVersion": ""
}
{
  "taskId": "89e1e62a-7976-4e24-8dd3-997da02dc81e",
  "expectation": 8,
  "action": "Create schema",
  "userId": "69c2cfc021d39e7b6d15e236"
}

Deletes the schema with the provided schema ID.

delete

Deletes the schema with the provided 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
Query parameters
includeChildrenbooleanOptional

Include child schemas

Responses
200

Successful operation.

application/json
taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
expectationnumberRequired

Expected count of task phases

Example: 8
actionstringRequired

Task action

Example: Create tool
userIdstringRequired

User Id

Example: 69bcfd90c98df6ceb05e8a78
delete/schemas/{schemaId}
DELETE /api/v1/schemas/{schemaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "taskId": "89e1e62a-7976-4e24-8dd3-997da02dc81e",
  "expectation": 2,
  "action": "Delete schemas",
  "userId": "69c2cfc021d39e7b6d15e236"
}

Publishes the schema with the provided schema ID.

put

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.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
schemaIdstringRequired

Schema ID

Example: 69aeb71ef8c5b278e3bab4e5
Body
versionstringRequiredExample: 1.0.0
Responses
200

Successful operation.

application/json
put/schemas/{schemaId}/publish
PUT /api/v1/schemas/{schemaId}/publish HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "version": "1.0.0"
}
[
  {
    "id": "f3b2a9c1e4d5678901234567",
    "uuid": "f3b2a9c1e4d5678901234567",
    "name": "Schema name",
    "description": "Description",
    "entity": "string",
    "iri": "string",
    "status": "string",
    "topicId": "f3b2a9c1e4d5678901234567",
    "version": "1.0.0",
    "owner": "string",
    "messageId": "f3b2a9c1e4d5678901234567",
    "category": "string",
    "documentURL": "https://example.com",
    "contextURL": "https://example.com",
    "document": {},
    "context": {}
  }
]

Asynchronously publishes the schema with the provided schema ID.

put

Asynchronously 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.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
schemaIdstringRequired

Schema ID

Example: 69aeb71ef8c5b278e3bab4e5
Body
versionstringRequiredExample: 1.0.0
Responses
202

Successful operation.

application/json
taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
expectationnumberRequired

Expected count of task phases

Example: 8
actionstringRequired

Task action

Example: Create tool
userIdstringRequired

User Id

Example: 69bcfd90c98df6ceb05e8a78
put/schemas/push/{schemaId}/publish
PUT /api/v1/schemas/push/{schemaId}/publish HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "version": "1.0.0"
}
{
  "taskId": "89e1e62a-7976-4e24-8dd3-997da02dc81e",
  "expectation": 8,
  "action": "Publish schemas",
  "userId": "69c2cfc021d39e7b6d15e236"
}

Previews the schema from IPFS without loading it into the local DB.

post

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.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
messageIdstringRequiredExample: 1773670900.819264517
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:
templateIdstring · nullableOptionalExample: 69aeb71ef8c5b278e3bab4e5
templateSchemaIdstring · nullableOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
documentURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
contextURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
documentone ofRequired
or
stringOptionalExample: innerSchemaConfigurationInText
contextone ofRequired
or
stringOptionalExample: jsonLdContextInText
readonlyboolean · nullableOptionalExample: false
systemboolean · nullableOptionalExample: false
activeboolean · nullableOptionalExample: false
codeVersionstring · nullableOptionalExample: 1.2.0
iwaVersionstring · nullableOptional

IWA dMRV specification version the field properties are authored against. Absent means v1.

Example: 3.0.0
topicCountnumber · nullableOptionalExample: 1
post/schemas/import/message/preview
POST /api/v1/schemas/import/message/preview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "messageId": "1773670900.819264517"
}
[
  {
    "iri": "#7afe4f57-5eee-4dd0-a6f1-94bdba4820f4&1.0.5",
    "uuid": "7afe4f57-5eee-4dd0-a6f1-94bdba4820f4",
    "hash": "",
    "owner": null,
    "messageId": "1774856488.194427000",
    "name": "Contact Details",
    "description": "Contact Details",
    "entity": "NONE",
    "version": "1.0.5",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8417999",
    "topicId": "0.0.8434944",
    "codeVersion": "1.2.0",
    "relationships": [],
    "status": "PUBLISHED",
    "readonly": false,
    "system": false,
    "active": false,
    "document": {},
    "context": {},
    "documentURL": "ipfs://bafkreicekq6bw5v3gfyibvlsjtc4erjo4m6kucumzfdfnz767w5ermtmqe",
    "contextURL": "ipfs://bafkreib5jzeebobcel5p6e4cvrmcgtjlmlh7fx5nayb74eifqnwxevlhsy"
  }
]

Previews the schema from IPFS without loading it into the local DB.

post

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.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
messageIdstringRequiredExample: 1773670900.819264517
Responses
202

Successful operation.

application/json
taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
expectationnumberRequired

Expected count of task phases

Example: 8
actionstringRequired

Task action

Example: Create tool
userIdstringRequired

User Id

Example: 69bcfd90c98df6ceb05e8a78
post/schemas/push/import/message/preview
POST /api/v1/schemas/push/import/message/preview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "messageId": "1773670900.819264517"
}
{
  "taskId": "89e1e62a-7976-4e24-8dd3-997da02dc81e",
  "expectation": 4,
  "action": "Preview schema message",
  "userId": "69c2cfc021d39e7b6d15e236"
}

Previews schemas from an uploaded zip file.

post

Parses the uploaded schema archive without persisting it to the local DB and returns the schemas found in the file. The response may include the main schema together with nested schemas bundled in the archive. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
string · binaryOptional
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:
templateIdstring · nullableOptionalExample: 69aeb71ef8c5b278e3bab4e5
templateSchemaIdstring · nullableOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
documentURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
contextURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
documentone ofRequired
or
stringOptionalExample: innerSchemaConfigurationInText
contextone ofRequired
or
stringOptionalExample: jsonLdContextInText
readonlyboolean · nullableOptionalExample: false
systemboolean · nullableOptionalExample: false
activeboolean · nullableOptionalExample: false
codeVersionstring · nullableOptionalExample: 1.2.0
iwaVersionstring · nullableOptional

IWA dMRV specification version the field properties are authored against. Absent means v1.

Example: 3.0.0
topicCountnumber · nullableOptionalExample: 1
post/schemas/import/file/preview
POST /api/v1/schemas/import/file/preview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: binary/octet-stream
Accept: */*
Content-Length: 8

"binary"
[
  {
    "createDate": "2026-03-29T08:22:18.331Z",
    "updateDate": "2026-03-29T08:55:59.184Z",
    "uuid": "4c187317-b5c8-472f-a583-d87e9a1002fa",
    "hash": "",
    "name": "Project Details",
    "description": "",
    "entity": "NONE",
    "status": "PUBLISHED",
    "documentFileId": "69c8e91f81910b160912cd7c",
    "contextFileId": "69c8e91f81910b160912cd7e",
    "version": "1.0.0",
    "sourceVersion": "",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8417999",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8417999",
    "topicId": "0.0.8425763",
    "messageId": "1774774558.160429342",
    "documentURL": "ipfs://bafkreiefl3543dhxcicjl3v6bmct4uqnuxharci45opopg3jwgqkpdccr4",
    "contextURL": "ipfs://bafkreidkocws2ks2s5zrm7ef6t4noqu5fylvyjj74yfcgbpmn4q5f2bjzq",
    "iri": "#4c187317-b5c8-472f-a583-d87e9a1002fa&1.0.0",
    "readonly": false,
    "system": false,
    "active": false,
    "category": "POLICY",
    "codeVersion": "1.2.0",
    "defs": [],
    "errors": [],
    "document": {},
    "context": {},
    "id": "69c8e13a81910b160912c704"
  },
  {
    "createDate": "2026-03-29T08:22:17.989Z",
    "updateDate": "2026-03-29T08:55:59.252Z",
    "uuid": "55892d75-bb2b-411a-a6bc-5fc476762edb",
    "hash": "",
    "name": "Date Range",
    "description": "",
    "entity": "NONE",
    "status": "PUBLISHED",
    "documentFileId": "69c8e91f81910b160912cd80",
    "contextFileId": "69c8e91f81910b160912cd82",
    "version": "1.0.0",
    "sourceVersion": "",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8417999",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8417999",
    "topicId": "0.0.8425763",
    "messageId": "1774774558.160429342",
    "documentURL": "ipfs://bafkreiefl3543dhxcicjl3v6bmct4uqnuxharci45opopg3jwgqkpdccr4",
    "contextURL": "ipfs://bafkreidkocws2ks2s5zrm7ef6t4noqu5fylvyjj74yfcgbpmn4q5f2bjzq",
    "iri": "#55892d75-bb2b-411a-a6bc-5fc476762edb&1.0.0",
    "readonly": false,
    "system": false,
    "active": false,
    "category": "POLICY",
    "codeVersion": "1.2.0",
    "defs": [],
    "errors": [],
    "document": {},
    "context": {},
    "id": "69c8e13981910b160912c6dc"
  }
]

Previews list of schemas duplicates.

post

Previews list of schemas duplicates. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
policyIdstringRequired

Target policy topic id used to search for existing draft schemas that can be replaced.

Example: 0.0.6046379
schemaNamesstring[]Required

Schema names from the imported package to check for duplicates in the target policy topic.

Example: ["Project Details","Date Range"]
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:
templateIdstring · nullableOptionalExample: 69aeb71ef8c5b278e3bab4e5
templateSchemaIdstring · nullableOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
documentURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
contextURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
documentone ofRequired
or
stringOptionalExample: innerSchemaConfigurationInText
contextone ofRequired
or
stringOptionalExample: jsonLdContextInText
readonlyboolean · nullableOptionalExample: false
systemboolean · nullableOptionalExample: false
activeboolean · nullableOptionalExample: false
codeVersionstring · nullableOptionalExample: 1.2.0
iwaVersionstring · nullableOptional

IWA dMRV specification version the field properties are authored against. Absent means v1.

Example: 3.0.0
topicCountnumber · nullableOptionalExample: 1
post/schemas/import/schemas/duplicates
POST /api/v1/schemas/import/schemas/duplicates HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "policyId": "0.0.8425763",
  "schemaNames": [
    "Project Details",
    "Date Range"
  ]
}
{
  "schemasCanBeReplaced": [
    {
      "createDate": "2026-03-30T08:24:18.971Z",
      "updateDate": "2026-03-30T08:24:18.971Z",
      "uuid": "6f4a68b6-5ef6-4145-90a3-a1c88c36b1d4",
      "hash": "",
      "name": "Date Range",
      "description": "",
      "entity": "NONE",
      "status": "DRAFT",
      "documentFileId": "69ca33323c361aeff876bd67",
      "contextFileId": "69ca33323c361aeff876bd69",
      "version": "",
      "sourceVersion": "1.0.0",
      "creator": "did:hedera:testnet:4Rh3aC5jNAzPJwwNtsy95Ava954Thyjk41gREjynY2D9_0.0.8429609",
      "owner": "did:hedera:testnet:4Rh3aC5jNAzPJwwNtsy95Ava954Thyjk41gREjynY2D9_0.0.8429609",
      "topicId": "0.0.8435307",
      "messageId": null,
      "documentURL": null,
      "contextURL": "schema:6f4a68b6-5ef6-4145-90a3-a1c88c36b1d4",
      "iri": "#6f4a68b6-5ef6-4145-90a3-a1c88c36b1d4",
      "readonly": false,
      "system": false,
      "active": false,
      "category": "POLICY",
      "codeVersion": "1.2.0",
      "defs": [],
      "errors": [],
      "document": {},
      "context": {},
      "id": "69ca33323c361aeff876bd66"
    },
    {
      "createDate": "2026-03-30T08:24:19.313Z",
      "updateDate": "2026-03-30T08:24:19.313Z",
      "uuid": "3056f5cf-b904-49af-9cb9-6ad71e6f885b",
      "hash": "",
      "name": "Project Details",
      "description": "",
      "entity": "NONE",
      "status": "DRAFT",
      "documentFileId": "69ca33333c361aeff876bd8f",
      "contextFileId": "69ca33333c361aeff876bd91",
      "version": "",
      "sourceVersion": "1.0.0",
      "creator": "did:hedera:testnet:4Rh3aC5jNAzPJwwNtsy95Ava954Thyjk41gREjynY2D9_0.0.8429609",
      "owner": "did:hedera:testnet:4Rh3aC5jNAzPJwwNtsy95Ava954Thyjk41gREjynY2D9_0.0.8429609",
      "topicId": "0.0.8435307",
      "messageId": null,
      "documentURL": null,
      "contextURL": "schema:3056f5cf-b904-49af-9cb9-6ad71e6f885b",
      "iri": "#3056f5cf-b904-49af-9cb9-6ad71e6f885b",
      "readonly": false,
      "system": false,
      "active": false,
      "category": "POLICY",
      "codeVersion": "1.2.0",
      "defs": [],
      "errors": [],
      "document": {},
      "context": {},
      "id": "69ca33333c361aeff876bd8e"
    }
  ]
}

Imports new schema from IPFS into the local DB.

post

Imports new schema from IPFS into the local DB. 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
topicIdstringRequired

Topic Id

Example: 0.0.6046379
Body
messageIdstringRequiredExample: 1773670900.819264517
Responses
201

Successful operation.

application/json
post/schemas/{topicId}/import/message
POST /api/v1/schemas/{topicId}/import/message HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "messageId": "1773670900.819264517"
}
[
  {
    "id": "f3b2a9c1e4d5678901234567",
    "uuid": "f3b2a9c1e4d5678901234567",
    "name": "Schema name",
    "description": "Description",
    "entity": "string",
    "iri": "string",
    "status": "string",
    "topicId": "f3b2a9c1e4d5678901234567",
    "version": "1.0.0",
    "owner": "string",
    "messageId": "f3b2a9c1e4d5678901234567",
    "category": "string",
    "documentURL": "https://example.com",
    "contextURL": "https://example.com",
    "document": {},
    "context": {}
  }
]

Imports new schema from IPFS into the local DB.

post

Imports new schema from IPFS into the local DB. 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
topicIdstringRequired

Topic Id

Example: 0.0.6046379
Query parameters
schemasstringOptional

Optional comma-separated existing schema ids to replace during import. These ids usually come from /schemas/import/schemas/duplicates (schemasCanBeReplaced[].id).

Example: 69ca33323c361aeff876bd66,69ca33333c361aeff876bd8e
Body
messageIdstringRequiredExample: 1773670900.819264517
Responses
202

Successful operation.

application/json
taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
expectationnumberRequired

Expected count of task phases

Example: 8
actionstringRequired

Task action

Example: Create tool
userIdstringRequired

User Id

Example: 69bcfd90c98df6ceb05e8a78
post/schemas/push/{topicId}/import/message
POST /api/v1/schemas/push/{topicId}/import/message HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "messageId": "1773670900.819264517"
}
{
  "taskId": "89e1e62a-7976-4e24-8dd3-997da02dc81e",
  "expectation": 3,
  "action": "Import schema message",
  "userId": "69c2cfc021d39e7b6d15e236"
}

Imports schemas from an uploaded zip file into the local DB.

post

Imports schemas from the uploaded archive into the local DB under the provided target topic id. The archive may contain the main schema together with nested schemas bundled in the file. 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
topicIdstringRequired

Topic Id

Example: 0.0.6046379
Body
string · binaryOptional
Responses
201

Successful operation.

application/json
post/schemas/{topicId}/import/file
POST /api/v1/schemas/{topicId}/import/file HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: binary/octet-stream
Accept: */*
Content-Length: 8

"binary"
[
  {
    "id": "f3b2a9c1e4d5678901234567",
    "uuid": "f3b2a9c1e4d5678901234567",
    "name": "Schema name",
    "description": "Description",
    "entity": "string",
    "iri": "string",
    "status": "string",
    "topicId": "f3b2a9c1e4d5678901234567",
    "version": "1.0.0",
    "owner": "string",
    "messageId": "f3b2a9c1e4d5678901234567",
    "category": "string",
    "documentURL": "https://example.com",
    "contextURL": "https://example.com",
    "document": {},
    "context": {}
  }
]

Starts asynchronous schema import from an uploaded zip file.

post

Starts asynchronous import of schemas from the uploaded archive into the local DB under the provided target topic id. The archive may contain the main schema together with nested schemas bundled in the file; the endpoint returns a task handle. 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
topicIdstringRequired

Topic Id

Example: 0.0.6046379
Query parameters
schemasstringOptional

Optional comma-separated existing schema ids to replace during import. These ids usually come from /schemas/import/schemas/duplicates (schemasCanBeReplaced[].id).

Example: 69ca33323c361aeff876bd66,69ca33333c361aeff876bd8e
Body
string · binaryOptional
Responses
202

Successful operation.

application/json
taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
expectationnumberRequired

Expected count of task phases

Example: 8
actionstringRequired

Task action

Example: Create tool
userIdstringRequired

User Id

Example: 69bcfd90c98df6ceb05e8a78
post/schemas/push/{topicId}/import/file
POST /api/v1/schemas/push/{topicId}/import/file HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: binary/octet-stream
Accept: */*
Content-Length: 8

"binary"
{
  "taskId": "89e1e62a-7976-4e24-8dd3-997da02dc81e",
  "expectation": 3,
  "action": "Import schema file",
  "userId": "69c2cfc021d39e7b6d15e236"
}

Returns Hedera message IDs of the published schemas.

get

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.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
schemaIdstringRequired

Schema ID

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
idstringRequiredExample: 69aeb71ef8c5b278e3bab4e5
namestringRequiredExample: Schema name
descriptionstringRequiredExample: Description
versionstringRequiredExample: 1.0.0
ownerstringRequiredExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
messageIdstringRequiredExample: 1773670900.819264517
get/schemas/{schemaId}/export/message
GET /api/v1/schemas/{schemaId}/export/message HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "69c8e13a81910b160912c704",
  "name": "Project Details",
  "description": "",
  "version": "1.0.0",
  "messageId": "1774774558.160429342",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8417999"
}

Returns the specified schema in a zip file format.

get

Returns a zip file containing the specified schema and related export artifacts. 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

Binary ZIP archive (Content-Type: application/zip, Content-Disposition: attachment). Not JSON.

application/zip
string · binaryOptional
get/schemas/{schemaId}/export/file
GET /api/v1/schemas/{schemaId}/export/file HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Return a list of all system schemas.

get

Returns all system schemas. 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
usernamestringRequired

Present for URL compatibility with existing clients. The server does not use this value when resolving the response; the returned system schemas are determined by the authenticated user and query parameters.

Example: StandardRegistry
Query parameters
pageIndexnumberOptional

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

Example: 0
pageSizenumberOptional

The numbers of items to return

Example: 20
Header parameters
Api-VersionstringRequired

API version header. Use 2 for this endpoint variant.

Example: 2
Responses
200

Successful operation.

application/json
get/schemas/system/{username}
GET /api/v1/schemas/system/{username} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Api-Version: 2
Accept: */*

[
  {
    "id": "f3b2a9c1e4d5678901234567",
    "uuid": "f3b2a9c1e4d5678901234567",
    "name": "Schema name",
    "description": "Description",
    "entity": "string",
    "iri": "string",
    "status": "string",
    "topicId": "f3b2a9c1e4d5678901234567",
    "version": "1.0.0",
    "owner": "string",
    "messageId": "f3b2a9c1e4d5678901234567",
    "category": "string",
    "documentURL": "https://example.com",
    "contextURL": "https://example.com",
    "document": {},
    "context": {}
  }
]

Creates a new system schema.

post

Creates a new system schema. 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
usernamestringRequired

Present for URL compatibility with existing clients. The server does not use this value when resolving the response; the returned system schemas are determined by the authenticated user and query parameters.

Example: StandardRegistry
Body
namestringRequiredExample: Schema name
entitystring · enumRequiredExample: STANDARD_REGISTRYPossible values:
Responses
201

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:
templateIdstring · nullableOptionalExample: 69aeb71ef8c5b278e3bab4e5
templateSchemaIdstring · nullableOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
documentURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
contextURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
documentone ofRequired
or
stringOptionalExample: innerSchemaConfigurationInText
contextone ofRequired
or
stringOptionalExample: jsonLdContextInText
readonlyboolean · nullableOptionalExample: false
systemboolean · nullableOptionalExample: false
activeboolean · nullableOptionalExample: false
codeVersionstring · nullableOptionalExample: 1.2.0
iwaVersionstring · nullableOptional

IWA dMRV specification version the field properties are authored against. Absent means v1.

Example: 3.0.0
topicCountnumber · nullableOptionalExample: 1
post/schemas/system/{username}
POST /api/v1/schemas/system/{username} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1349

{
  "uuid": "1f3fa1e2-1579-4fcd-98ab-906fcca02972",
  "hash": "",
  "name": "NewStandardRegistrySystemSchema",
  "description": "Example of description",
  "entity": "STANDARD_REGISTRY",
  "status": "DRAFT",
  "readonly": false,
  "document": {
    "$id": "#1f3fa1e2-1579-4fcd-98ab-906fcca02972",
    "$comment": "{ \"@id\": \"schema:1f3fa1e2-1579-4fcd-98ab-906fcca02972#1f3fa1e2-1579-4fcd-98ab-906fcca02972\", \"term\": \"1f3fa1e2-1579-4fcd-98ab-906fcca02972\" }",
    "title": "NewStandardRegistrySystemSchema",
    "description": "Example of description",
    "type": "object",
    "properties": {
      "@context": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        ],
        "readOnly": true
      },
      "type": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        ],
        "readOnly": true
      },
      "id": {
        "type": "string",
        "readOnly": true
      },
      "field0": {
        "title": "field0",
        "description": "ExampleOfNumberField",
        "readOnly": false,
        "type": "number",
        "$comment": "{\"term\":\"field0\",\"@id\":\"https://www.schema.org/text\",\"availableOptions\":[],\"orderPosition\":0}"
      }
    },
    "required": [
      "@context",
      "type"
    ],
    "additionalProperties": false,
    "$defs": {}
  },
  "context": null,
  "version": "",
  "sourceVersion": "",
  "creator": "",
  "owner": "",
  "messageId": "",
  "documentURL": "",
  "contextURL": "schema:1f3fa1e2-1579-4fcd-98ab-906fcca02972",
  "iri": "",
  "fields": [],
  "conditions": [],
  "active": false,
  "system": true,
  "category": "SYSTEM",
  "errors": [],
  "userDID": null,
  "codeVersion": ""
}
{
  "id": "f3b2a9c1e4d5678901234567",
  "uuid": "f3b2a9c1e4d5678901234567",
  "name": "Schema name",
  "description": "Description",
  "entity": "string",
  "iri": "string",
  "status": "string",
  "topicId": "f3b2a9c1e4d5678901234567",
  "version": "1.0.0",
  "owner": "string",
  "messageId": "f3b2a9c1e4d5678901234567",
  "category": "string",
  "documentURL": "https://example.com",
  "contextURL": "https://example.com",
  "document": {},
  "context": {}
}

Updates the specified system schema if the caller is its creator.

put

Updates the specified system schema. Access is restricted to the authenticated creator of that system schema; other Standard Registry users receive 403 Forbidden with message: "Invalid creator.". 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
Body
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:
templateIdstring · nullableOptionalExample: 69aeb71ef8c5b278e3bab4e5
templateSchemaIdstring · nullableOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
documentURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
contextURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
documentone ofRequired
or
stringOptionalExample: innerSchemaConfigurationInText
contextone ofRequired
or
stringOptionalExample: jsonLdContextInText
readonlyboolean · nullableOptionalExample: false
systemboolean · nullableOptionalExample: false
activeboolean · nullableOptionalExample: false
codeVersionstring · nullableOptionalExample: 1.2.0
iwaVersionstring · nullableOptional

IWA dMRV specification version the field properties are authored against. Absent means v1.

Example: 3.0.0
topicCountnumber · nullableOptionalExample: 1
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:
templateIdstring · nullableOptionalExample: 69aeb71ef8c5b278e3bab4e5
templateSchemaIdstring · nullableOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
documentURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
contextURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
documentone ofRequired
or
stringOptionalExample: innerSchemaConfigurationInText
contextone ofRequired
or
stringOptionalExample: jsonLdContextInText
readonlyboolean · nullableOptionalExample: false
systemboolean · nullableOptionalExample: false
activeboolean · nullableOptionalExample: false
codeVersionstring · nullableOptionalExample: 1.2.0
iwaVersionstring · nullableOptional

IWA dMRV specification version the field properties are authored against. Absent means v1.

Example: 3.0.0
topicCountnumber · nullableOptionalExample: 1
put/schemas/system/{schemaId}
PUT /api/v1/schemas/system/{schemaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1656

{
  "id": "69ca4e053c361aeff876bde7",
  "uuid": "1f3fa1e2-1579-4fcd-98ab-906fcca02972",
  "hash": "",
  "name": "NewStandardRegistrySystemSchemaUPDATED",
  "description": "Example of description UPDATED",
  "entity": "STANDARD_REGISTRY",
  "status": "DRAFT",
  "readonly": false,
  "document": {
    "$id": "#1f3fa1e2-1579-4fcd-98ab-906fcca02972",
    "$comment": "{ \"@id\": \"schema:1f3fa1e2-1579-4fcd-98ab-906fcca02972#1f3fa1e2-1579-4fcd-98ab-906fcca02972\", \"term\": \"1f3fa1e2-1579-4fcd-98ab-906fcca02972\" }",
    "title": "NewStandardRegistrySystemSchemaUPDATED",
    "description": "Example of description UPDATED",
    "type": "object",
    "properties": {
      "@context": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        ],
        "readOnly": true
      },
      "type": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        ],
        "readOnly": true
      },
      "id": {
        "type": "string",
        "readOnly": true
      },
      "field0": {
        "title": "field0",
        "description": "ExampleOfNumberFieldUPDATED",
        "readOnly": false,
        "type": "number",
        "$comment": "{\"term\":\"field0\",\"@id\":\"https://www.schema.org/text\",\"availableOptions\":[],\"orderPosition\":0}"
      }
    },
    "required": [
      "@context",
      "type"
    ],
    "additionalProperties": false,
    "$defs": {}
  },
  "context": null,
  "version": "",
  "sourceVersion": "",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8417999",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8417999",
  "messageId": "",
  "documentURL": "",
  "contextURL": "schema:1f3fa1e2-1579-4fcd-98ab-906fcca02972",
  "iri": "#1f3fa1e2-1579-4fcd-98ab-906fcca02972",
  "type": "1f3fa1e2-1579-4fcd-98ab-906fcca02972",
  "fields": [],
  "conditions": [],
  "active": false,
  "system": true,
  "category": "SYSTEM",
  "errors": [],
  "userDID": null,
  "codeVersion": "1.2.0"
}
[
  {
    "id": "f3b2a9c1e4d5678901234567",
    "uuid": "f3b2a9c1e4d5678901234567",
    "name": "Schema name",
    "description": "Description",
    "entity": "string",
    "iri": "string",
    "status": "string",
    "topicId": "f3b2a9c1e4d5678901234567",
    "version": "1.0.0",
    "owner": "string",
    "messageId": "f3b2a9c1e4d5678901234567",
    "category": "string",
    "documentURL": "https://example.com",
    "contextURL": "https://example.com",
    "document": {},
    "context": {}
  }
]

Deletes the specified system schema if the caller is its creator.

delete

Deletes the specified system schema. Access is restricted to the authenticated creator of that system schema; other Standard Registry users receive 403 Forbidden with message: "Invalid creator.". 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
taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
expectationnumberRequired

Expected count of task phases

Example: 8
actionstringRequired

Task action

Example: Create tool
userIdstringRequired

User Id

Example: 69bcfd90c98df6ceb05e8a78
delete/schemas/system/{schemaId}
DELETE /api/v1/schemas/system/{schemaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "taskId": "89e1e62a-7976-4e24-8dd3-997da02dc81e",
  "expectation": 2,
  "action": "Delete schemas",
  "userId": "69c2cfc021d39e7b6d15e236"
}

Makes the selected scheme active. Other schemes of the same type become inactive

put

Makes the selected scheme active. Other schemes of the same type become inactive 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
object · nullableOptional
put/schemas/system/{schemaId}/active
PUT /api/v1/schemas/system/{schemaId}/active HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Finds the schema using the schema type.

get

Finds the schema using the schema type.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
schemaEntitystring · enumRequired

Entity name

Possible values:
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:
templateIdstring · nullableOptionalExample: 69aeb71ef8c5b278e3bab4e5
templateSchemaIdstring · nullableOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
documentURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
contextURLstringRequiredExample: ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
documentone ofRequired
or
stringOptionalExample: innerSchemaConfigurationInText
contextone ofRequired
or
stringOptionalExample: jsonLdContextInText
readonlyboolean · nullableOptionalExample: false
systemboolean · nullableOptionalExample: false
activeboolean · nullableOptionalExample: false
codeVersionstring · nullableOptionalExample: 1.2.0
iwaVersionstring · nullableOptional

IWA dMRV specification version the field properties are authored against. Absent means v1.

Example: 3.0.0
topicCountnumber · nullableOptionalExample: 1
get/schemas/system/entity/{schemaEntity}
GET /api/v1/schemas/system/entity/{schemaEntity} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "uuid": "StandardRegistry",
  "iri": "StandardRegistry",
  "name": "StandardRegistry",
  "document": {
    "$id": "#StandardRegistry",
    "$comment": "{ \"term\": \"StandardRegistry\", \"@id\": \"#StandardRegistry\" }",
    "title": "StandardRegistry",
    "description": "StandardRegistry",
    "type": "object",
    "properties": {
      "@context": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        ],
        "readOnly": true
      },
      "type": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        ],
        "readOnly": true
      },
      "id": {
        "type": "string",
        "readOnly": true
      },
      "OrganizationName": {
        "title": "OrganizationName",
        "description": "OrganizationName",
        "readOnly": false,
        "type": "string",
        "$comment": "{\"term\":\"OrganizationName\",\"@id\":\"https://www.schema.org/text\",\"orderPosition\":0}"
      },
      "Website": {
        "title": "Website",
        "description": "Website",
        "readOnly": false,
        "type": "string",
        "$comment": "{\"term\":\"Website\",\"@id\":\"https://www.schema.org/text\",\"orderPosition\":1}"
      },
      "Tags": {
        "title": "Tags",
        "description": "Tags",
        "readOnly": false,
        "type": "string",
        "$comment": "{\"term\":\"Tags\",\"@id\":\"https://www.schema.org/text\",\"orderPosition\":2}"
      }
    },
    "required": [
      "OrganizationName",
      "Website",
      "Tags"
    ],
    "additionalProperties": false
  }
}

Returns the specified schema in an XLSX export format.

get

Returns an XLSX export file for the specified schema. 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

Binary file download (Content-Type: application/zip, Content-Disposition: attachment). Not JSON.

application/zip
string · binaryOptional
get/schemas/{schemaId}/export/xlsx
GET /api/v1/schemas/{schemaId}/export/xlsx HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Imports schemas from an XLSX file into the local DB.

post

Imports one or more schemas parsed from the uploaded XLSX file into the local DB for the specified topic. 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
topicIdstringRequired

Topic Id

Example: 0.0.6046379
Body
string · binaryOptional
Responses
201

Successful operation.

application/json
post/schemas/{topicId}/import/xlsx
POST /api/v1/schemas/{topicId}/import/xlsx HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: binary/octet-stream
Accept: */*
Content-Length: 8

"binary"
[
  {
    "id": "f3b2a9c1e4d5678901234567",
    "uuid": "f3b2a9c1e4d5678901234567",
    "name": "Schema name",
    "description": "Description",
    "entity": "string",
    "iri": "string",
    "status": "string",
    "topicId": "f3b2a9c1e4d5678901234567",
    "version": "1.0.0",
    "owner": "string",
    "messageId": "f3b2a9c1e4d5678901234567",
    "category": "string",
    "documentURL": "https://example.com",
    "contextURL": "https://example.com",
    "document": {},
    "context": {}
  }
]

Starts asynchronous import of schemas from an XLSX file into the local DB.

post

Queues asynchronous import of one or more schemas parsed from the uploaded XLSX file into the local DB for the specified topic. 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
topicIdstringRequired

Topic Id

Example: 0.0.1
Query parameters
schemasstringOptional

Optional comma-separated list of schema IDs to import from the uploaded XLSX file.

Example: 69c38f81462c9c1141de2df2,69c38f81462c9c1141de2df3
Body
string · binaryOptional
Responses
202

Successful operation.

application/json
objectOptional
post/schemas/push/{topicId}/import/xlsx
POST /api/v1/schemas/push/{topicId}/import/xlsx HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: binary/octet-stream
Accept: */*
Content-Length: 8

"binary"
{
  "taskId": "89e1e62a-7976-4e24-8dd3-997da02dc81e",
  "expectation": 3,
  "action": "Import schema file",
  "userId": "69c2cfc021d39e7b6d15e236"
}

Previews the schema from a xlsx file.

post

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
string · binaryOptional
Responses
200

Successful operation.

application/json
objectOptional
post/schemas/import/xlsx/preview
POST /api/v1/schemas/import/xlsx/preview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: binary/octet-stream
Accept: */*
Content-Length: 8

"binary"
{
  "schemas": [
    {
      "iri": "#10deca32-b66e-43c0-b744-bc0ed15d4917",
      "name": "Monitoring Report",
      "description": "Monitoring Report",
      "version": "",
      "status": "DRAFT"
    },
    {
      "iri": "#3b92df74-ad23-4a73-8297-108437900d16",
      "name": "Project Description",
      "description": "Project Description",
      "version": "",
      "status": "DRAFT"
    },
    {
      "iri": "#ece2072e-e031-4bf8-9fd6-9c1be591c598",
      "name": "VVB",
      "description": "VVB",
      "version": "",
      "status": "DRAFT"
    },
    {
      "iri": "#af17530b-47e6-4eb1-b35e-9e515920ebb2",
      "name": "PP",
      "description": null,
      "version": "",
      "status": "DRAFT"
    },
    {
      "iri": "#aabea446-e5e0-49f9-b5ab-9b0aa4df31c9",
      "name": "Date Range",
      "description": null,
      "version": "",
      "status": "DRAFT"
    },
    {
      "iri": "#356d60fc-3199-470f-8452-cfdf10e77355",
      "name": "Baseline Emissions Per Lamp Type and Charging Method",
      "description": null,
      "version": "",
      "status": "DRAFT"
    },
    {
      "iri": "#40e36ff6-6938-49af-9e20-b80d8ac16ce3",
      "name": "Emissions Reduction (for all project lamp types and charging methods)",
      "description": null,
      "version": "",
      "status": "DRAFT"
    },
    {
      "iri": "#aab7e58c-94a7-43e3-aae6-128c5f439b41",
      "name": "Default Annual Baseline Emissions Factor",
      "description": null,
      "version": "",
      "status": "DRAFT"
    },
    {
      "iri": "#284ad979-321c-4faf-a56f-25586b8edd8f",
      "name": "Additionality Determination",
      "description": null,
      "version": "",
      "status": "DRAFT"
    },
    {
      "iri": "#faa9b06a-fede-4cca-97c9-47541b2f02ae",
      "name": "Minimum Requirements for the Design Specifications of Project Lamps",
      "description": null,
      "version": "",
      "status": "DRAFT"
    },
    {
      "iri": "#98607eef-e463-4301-ac34-1582ff902d7e",
      "name": "Project Emissions Per Lamp Type and Charging Method",
      "description": null,
      "version": "",
      "status": "DRAFT"
    },
    {
      "iri": "#88bbf6fc-c828-4b42-a7bc-cb43f096ea7e",
      "name": "Project lamp type and charging method",
      "description": null,
      "version": "",
      "status": "DRAFT"
    },
    {
      "iri": "#33379ea8-8d6c-4559-bdb4-79d72ac1596a",
      "name": "Project Details",
      "description": null,
      "version": "",
      "status": "DRAFT"
    }
  ],
  "tools": [
    {
      "uuid": "aed9799a-1273-41cd-a7a1-3e4fae066f71",
      "name": "Tool 07",
      "messageId": "1706867530.884259218"
    },
    {
      "uuid": "0edcecb5-743d-4d83-ac0f-1a9f102db873",
      "name": "Tool 19",
      "messageId": "1706869798.177938003"
    },
    {
      "uuid": "01356919-66ef-435e-ab58-3648c19ee2e2",
      "name": "Tool 21",
      "messageId": "1706873385.455822873"
    },
    {
      "uuid": "8772ca4b-4efe-4517-93ae-6c63a4281257",
      "name": "Tool 33",
      "messageId": "1726593517.484578000"
    }
  ],
  "errors": []
}

Downloads the schema XLSX template file.

get

Returns the XLSX template file used as a starting point for schema import/export workflows. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Binary file download (Content-Type: application/zip, Content-Disposition: attachment). Not JSON.

application/json
string · binaryOptional
get/schemas/export/template
GET /api/v1/schemas/export/template HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Deletes all schemas by topic id.

delete

Deletes all schemas by topic 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
topicIdstringRequired

Topic Id

Example: 0.0.1
Responses
200

Successful operation.

application/json
booleanOptionalExample: true
delete/schemas/topic/{topicId}
DELETE /api/v1/schemas/topic/{topicId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Previews remapping a draft schema from IWA v1 to v3.

get

Reports, per field, which IWA property paths would stay the same, which would be renamed, and which v3 removed. Does not modify the schema.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
schemaIdstringRequired

Schema Id

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Per-field remap report.

No content
get/schemas/{schemaId}/iwa-upgrade/preview
GET /api/v1/schemas/{schemaId}/iwa-upgrade/preview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Remaps a draft schema from IWA v1 to v3.

post

Rewrites every field property to its IWA v3 equivalent and tags the schema as v3. Properties v3 removed are cleared and reported. Draft schemas only — a published schema must get a new version first.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
schemaIdstringRequired

Schema Id

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Remap report and the updated schema.

No content
post/schemas/{schemaId}/iwa-upgrade
POST /api/v1/schemas/{schemaId}/iwa-upgrade HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Returns all child schemas.

post

Returns all child schemas.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
schemaIdsstring[]RequiredExample: ["69aeb71ef8c5b278e3bab4e5","69b8115f3dc0fa022156fb89"]
Responses
200

Schema deletion preview.

application/json
post/schemas/deletionPreview
POST /api/v1/schemas/deletionPreview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "schemaIds": [
    "69aeb71ef8c5b278e3bab4e5",
    "69b8115f3dc0fa022156fb89"
  ]
}
{
  "deletableChildren": [
    {
      "name": "Energy Sources",
      "status": "DRAFT",
      "version": "",
      "sourceVersion": "1.0.0",
      "iri": "#c0040849-87bc-4173-9301-d84af5adfd92",
      "category": "POLICY",
      "id": "69ca5ccd89551902666683e0"
    }
  ],
  "blockedChildren": [
    {
      "schema": "Contact Details",
      "blockingSchemas": [
        "I-REC Registrant & Participant App",
        "I-REC Issue Request"
      ]
    },
    {
      "schema": "Production Device",
      "blockingSchemas": [
        "I-REC Issue Request"
      ]
    }
  ]
}

Deletes the schema with the provided schema ID.

post

Deletes the schema with the provided 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>.
Query parameters
includeChildrenbooleanOptional

Include child schemas

Example: false
Body
schemaIdsstring[]RequiredExample: ["69aeb71ef8c5b278e3bab4e5","69b8115f3dc0fa022156fb89"]
Responses
200

Successful operation.

application/json
taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147
expectationnumberRequired

Expected count of task phases

Example: 8
actionstringRequired

Task action

Example: Create tool
userIdstringRequired

User Id

Example: 69bcfd90c98df6ceb05e8a78
post/schemas/delete-multiple
POST /api/v1/schemas/delete-multiple HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "schemaIds": [
    "69aeb71ef8c5b278e3bab4e5",
    "69b8115f3dc0fa022156fb89"
  ]
}
{
  "taskId": "89e1e62a-7976-4e24-8dd3-997da02dc81e",
  "expectation": 3,
  "action": "Delete schemas",
  "userId": "69c2cfc021d39e7b6d15e236"
}
NextSchema

Last updated

Was this helpful?