Schema Templates
Returns schema templates visible to the current user. Only users with the Standard Registry role are allowed to make the request.
020Comma-separated template ids to leave out, so a picker's count and pages match what it shows.
Schema templates page.
Unauthorized request.
Forbidden
Internal server error.
GET /api/v1/schema-templates HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{}
]Creates a new schema template and a dedicated template topic. Only users with the Standard Registry role are allowed to make the request.
Created schema template.
Unauthorized request.
Forbidden
Internal server error.
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 and a dedicated template topic asynchronously. Only users with the Standard Registry role are allowed to make the request.
Task created.
Task Id
9db028d2-03ad-4d49-a178-cf4b67f8c147Expected count of task phases
8Task action
Create toolUser Id
69bcfd90c98df6ceb05e8a78Unauthorized request.
Forbidden
Internal server error.
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"
}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.
Task created.
Task Id
9db028d2-03ad-4d49-a178-cf4b67f8c147Expected count of task phases
8Task action
Create toolUser Id
69bcfd90c98df6ceb05e8a78Unauthorized request.
Forbidden
Internal server error.
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 metadata, configuration, and schemas as a zip-based *.template file. Only users with the Standard Registry role are allowed to make the request.
Unauthorized request.
401Unauthorized requestForbidden
GET /api/v1/schema-templates/{templateId}/export/file HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"statusCode": 401,
"message": "Unauthorized request"
}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.
Unauthorized request.
401Unauthorized requestForbidden
GET /api/v1/schema-templates/{templateId}/export/message HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"statusCode": 401,
"message": "Unauthorized request"
}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.
Unauthorized request.
401Unauthorized requestForbidden
GET /api/v1/schema-templates/check/{messageId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"statusCode": 401,
"message": "Unauthorized request"
}Parses a schema template archive without persisting it. Only users with the Standard Registry role are allowed to make the request.
Unauthorized request.
401Unauthorized requestForbidden
POST /api/v1/schema-templates/import/file/preview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"statusCode": 401,
"message": "Unauthorized request"
}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.
Unauthorized request.
401Unauthorized requestForbidden
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 metadata, configuration, and schemas from a local archive. Only users with the Standard Registry role are allowed to make the request.
Unauthorized request.
401Unauthorized requestForbidden
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 metadata, configuration, and schemas from a Hedera message/IPFS archive. Only users with the Standard Registry role are allowed to make the request.
Unauthorized request.
401Unauthorized requestForbidden
POST /api/v1/schema-templates/push/import/message HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"statusCode": 401,
"message": "Unauthorized request"
}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.
Applied schema template state, one entry per applied template.
Unauthorized request.
Forbidden
Internal server error.
GET /api/v1/schema-templates/policies/topic/{topicId}/applied HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{}
]Returns schema template by internal id. Only users with the Standard Registry role are allowed to make the request.
Schema template.
Unauthorized request.
Forbidden
Internal server error.
GET /api/v1/schema-templates/{templateId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{}Updates schema template metadata and configuration. Only users with the Standard Registry role are allowed to make the request.
Updated schema template.
Unauthorized request.
Forbidden
Internal server error.
PUT /api/v1/schema-templates/{templateId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2
{}{}Deletes draft schema template and its draft schemas. Only users with the Standard Registry role are allowed to make the request.
Operation result.
Unauthorized request.
Forbidden
Internal server error.
DELETE /api/v1/schema-templates/{templateId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
trueDeletes draft schema template and its draft schemas asynchronously. Only users with the Standard Registry role are allowed to make the request.
Task created.
Task Id
9db028d2-03ad-4d49-a178-cf4b67f8c147Expected count of task phases
8Task action
Create toolUser Id
69bcfd90c98df6ceb05e8a78Unauthorized request.
Forbidden
Internal server error.
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 package with metadata, configuration, and schemas. Only users with the Standard Registry role are allowed to make the request.
1.0.0Task created.
Task Id
9db028d2-03ad-4d49-a178-cf4b67f8c147Expected count of task phases
8Task action
Create toolUser Id
69bcfd90c98df6ceb05e8a78Unauthorized request.
Forbidden
Internal server error.
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"
}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.
Task created.
Task Id
9db028d2-03ad-4d49-a178-cf4b67f8c147Expected count of task phases
8Task action
Create toolUser Id
69bcfd90c98df6ceb05e8a78Unauthorized request.
Forbidden
Internal server error.
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"
}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.
Schema template detach preview.
No content
Unauthorized request.
Forbidden
Internal server error.
GET /api/v1/schema-templates/{templateId}/policies/{policyId}/detach/preview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
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.
Preview switching the binding to a different template instead of refreshing the same one.
Schema template update preview.
No content
Unauthorized request.
Forbidden
Internal server error.
GET /api/v1/schema-templates/{templateId}/policies/{policyId}/update/preview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
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.
Task created.
Task Id
9db028d2-03ad-4d49-a178-cf4b67f8c147Expected count of task phases
8Task action
Create toolUser Id
69bcfd90c98df6ceb05e8a78Unauthorized request.
Forbidden
Internal server error.
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"
}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.
Task created.
Task Id
9db028d2-03ad-4d49-a178-cf4b67f8c147Expected count of task phases
8Task action
Create toolUser Id
69bcfd90c98df6ceb05e8a78Unauthorized request.
Forbidden
Internal server error.
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?