For the complete documentation index, see llms.txt. This page is also available as Markdown.

Schema Templates

Returns schema templates.

get

Returns schema templates visible to the current user. 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
pageIndexnumberOptionalExample: 0
pageSizenumberOptionalExample: 20
searchstringOptional
excludeIdsstringOptional

Comma-separated template ids to leave out, so a picker's count and pages match what it shows.

Responses
200

Schema templates page.

application/json
Responseobject[]
get/schema-templates
GET /api/v1/schema-templates HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
  {}
]

Creates a new schema template.

post

Creates a new schema template and a dedicated template topic. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestringOptional
descriptionstringOptional
versionstringOptional
configobjectOptional
Responses
201

Created schema template.

application/json
objectOptional
post/schema-templates
POST /api/v1/schema-templates HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "name": "text",
  "description": "text",
  "version": "text",
  "config": {}
}
{}

Creates a new schema template asynchronously.

post

Creates a new schema template and a dedicated template topic asynchronously. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestringOptional
descriptionstringOptional
configobjectOptional
Responses
202

Task created.

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/schema-templates/push
POST /api/v1/schema-templates/push HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "name": "text",
  "description": "text",
  "config": {}
}
{
  "taskId": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "expectation": 8,
  "action": "Create tool",
  "userId": "69bcfd90c98df6ceb05e8a78"
}

Creates a new draft version of a schema template asynchronously.

post

Copies a published schema template and its schemas into a new editable draft version. 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
templateIdstringRequired
Responses
202

Task created.

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/schema-templates/{templateId}/push/new-version
POST /api/v1/schema-templates/{templateId}/push/new-version HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "taskId": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "expectation": 8,
  "action": "Create tool",
  "userId": "69bcfd90c98df6ceb05e8a78"
}

Exports schema template as a file.

get

Exports schema template metadata, configuration, and schemas as a zip-based *.template 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
templateIdstringRequired
Responses
401

Unauthorized request.

application/json
statusCodenumberRequiredExample: 401
messagestringRequiredExample: Unauthorized request
get/schema-templates/{templateId}/export/file
GET /api/v1/schema-templates/{templateId}/export/file HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "statusCode": 401,
  "message": "Unauthorized request"
}

Returns schema template identity and Hedera message id for export.

get

Returns template metadata and message id when the template has been published. 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
templateIdstringRequired
Responses
401

Unauthorized request.

application/json
statusCodenumberRequiredExample: 401
messagestringRequiredExample: Unauthorized request
get/schema-templates/{templateId}/export/message
GET /api/v1/schema-templates/{templateId}/export/message HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "statusCode": 401,
  "message": "Unauthorized request"
}

Checks schema template message availability.

get

Checks whether a schema template message is available locally or from Hedera/IPFS. 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
messageIdstringRequired
Responses
401

Unauthorized request.

application/json
statusCodenumberRequiredExample: 401
messagestringRequiredExample: Unauthorized request
get/schema-templates/check/{messageId}
GET /api/v1/schema-templates/check/{messageId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "statusCode": 401,
  "message": "Unauthorized request"
}

Previews schema template package from uploaded file.

post

Parses a schema template archive without persisting it. Only users with the Standard Registry role are allowed to make the request.

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

Unauthorized request.

application/json
statusCodenumberRequiredExample: 401
messagestringRequiredExample: Unauthorized request
post/schema-templates/import/file/preview
POST /api/v1/schema-templates/import/file/preview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "statusCode": 401,
  "message": "Unauthorized request"
}

Previews schema template package from message.

post

Loads a schema template package from a Hedera message/IPFS and parses it without persisting. Only users with the Standard Registry role are allowed to make the request.

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

Unauthorized request.

application/json
statusCodenumberRequiredExample: 401
messagestringRequiredExample: Unauthorized request
post/schema-templates/import/message/preview
POST /api/v1/schema-templates/import/message/preview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "statusCode": 401,
  "message": "Unauthorized request"
}

Imports schema template from uploaded file asynchronously.

post

Imports schema template metadata, configuration, and schemas from a local archive. Only users with the Standard Registry role are allowed to make the request.

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

Unauthorized request.

application/json
statusCodenumberRequiredExample: 401
messagestringRequiredExample: Unauthorized request
post/schema-templates/push/import/file
POST /api/v1/schema-templates/push/import/file HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "statusCode": 401,
  "message": "Unauthorized request"
}

Imports schema template from message asynchronously.

post

Imports schema template metadata, configuration, and schemas from a Hedera message/IPFS archive. Only users with the Standard Registry role are allowed to make the request.

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

Unauthorized request.

application/json
statusCodenumberRequiredExample: 401
messagestringRequiredExample: Unauthorized request
post/schema-templates/push/import/message
POST /api/v1/schema-templates/push/import/message HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "statusCode": 401,
  "message": "Unauthorized request"
}

Returns effective applied schema template state by policy topic.

get

Returns policy-specific schema template state. Snapshot configuration is used when available. 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
Responses
200

Applied schema template state, one entry per applied template.

application/json
object[]Optional
get/schema-templates/policies/topic/{topicId}/applied
GET /api/v1/schema-templates/policies/topic/{topicId}/applied HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
  {}
]

Returns schema template by id.

get

Returns schema template by internal 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
templateIdstringRequired
Responses
200

Schema template.

application/json
objectOptional
get/schema-templates/{templateId}
GET /api/v1/schema-templates/{templateId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{}

Updates schema template.

put

Updates schema template metadata and configuration. 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
templateIdstringRequired
Body
objectOptional
Responses
200

Updated schema template.

application/json
objectOptional
put/schema-templates/{templateId}
PUT /api/v1/schema-templates/{templateId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{}

Deletes schema template.

delete

Deletes draft schema template and its draft 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
templateIdstringRequired
Responses
200

Operation result.

application/json
booleanOptional
delete/schema-templates/{templateId}
DELETE /api/v1/schema-templates/{templateId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
true

Deletes schema template asynchronously.

delete

Deletes draft schema template and its draft schemas asynchronously. 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
templateIdstringRequired
Responses
202

Task created.

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/schema-templates/push/{templateId}
DELETE /api/v1/schema-templates/push/{templateId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "taskId": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "expectation": 8,
  "action": "Create tool",
  "userId": "69bcfd90c98df6ceb05e8a78"
}

Publishes schema template asynchronously.

put

Publishes schema template package with metadata, configuration, and 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
templateIdstringRequired
Body
templateVersionstringOptionalExample: 1.0.0
Responses
202

Task created.

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/schema-templates/{templateId}/push/publish
PUT /api/v1/schema-templates/{templateId}/push/publish HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "templateVersion": "1.0.0"
}
{
  "taskId": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "expectation": 8,
  "action": "Create tool",
  "userId": "69bcfd90c98df6ceb05e8a78"
}

Applies schema template to policy asynchronously.

post

Copies template schemas into the selected draft policy and stores template binding metadata on the policy. 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
templateIdstringRequired
policyIdstringRequired
Responses
202

Task created.

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/schema-templates/{templateId}/policies/{policyId}/push/apply
POST /api/v1/schema-templates/{templateId}/policies/{policyId}/push/apply HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "taskId": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "expectation": 8,
  "action": "Create tool",
  "userId": "69bcfd90c98df6ceb05e8a78"
}

Previews detaching an applied schema template.

get

Lists the copied schemas a detach would delete, and the ones it would keep because another schema still references them. 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
templateIdstringRequired
policyIdstringRequired
Responses
200

Schema template detach preview.

No content

get/schema-templates/{templateId}/policies/{policyId}/detach/preview
GET /api/v1/schema-templates/{templateId}/policies/{policyId}/detach/preview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Previews applied schema template update.

get

Calculates schema and field changes before updating the template applied to a draft policy. 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
templateIdstringRequired
policyIdstringRequired
Query parameters
targetTemplateIdstringOptional

Preview switching the binding to a different template instead of refreshing the same one.

Responses
200

Schema template update preview.

No content

get/schema-templates/{templateId}/policies/{policyId}/update/preview
GET /api/v1/schema-templates/{templateId}/policies/{policyId}/update/preview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Updates applied schema template on policy asynchronously.

post

Applies a newer schema template version to a draft policy and refreshes the policy snapshot. 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
templateIdstringRequired
policyIdstringRequired
Responses
202

Task created.

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/schema-templates/{templateId}/policies/{policyId}/push/update
POST /api/v1/schema-templates/{templateId}/policies/{policyId}/push/update HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "taskId": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "expectation": 8,
  "action": "Create tool",
  "userId": "69bcfd90c98df6ceb05e8a78"
}

Detaches schema template from policy asynchronously.

post

Removes template binding metadata from the selected draft policy and turns copied template schemas into regular policy 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
templateIdstringRequired
policyIdstringRequired
Responses
202

Task created.

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/schema-templates/{templateId}/policies/{policyId}/push/detach
POST /api/v1/schema-templates/{templateId}/policies/{policyId}/push/detach HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "taskId": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "expectation": 8,
  "action": "Create tool",
  "userId": "69bcfd90c98df6ceb05e8a78"
}

Last updated

Was this helpful?