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.

Schema Rules

Validation rules and constraints applied to schema fields.

Return a list of all schema rules.

get

Returns a paginated list of schema rules owned by the current user. Optionally filter by policy ID.

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
policyInstanceTopicIdstringOptional

Policy Instance Topic Id

Example: 0.0.6046379
Responses
200

Successful operation. Returns schema rules array and total count in X-Total-Count header.

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

[
  {
    "name": "Test Schema Rule",
    "description": "Description of test schema rule",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "status": "DRAFT",
    "policyId": "69b83f18cd6b7c4adf4139bc",
    "config": {
      "fields": []
    },
    "id": "69c40092810b639b34bae8a2"
  }
]

Creates a new schema rule.

post

Creates a new schema rule linked to a policy. Schema rules define validation and transformation logic applied to documents within the policy.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Tool name
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
Responses
201

Successful operation.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Tool name
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
post/schema-rules
POST /api/v1/schema-rules HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "name": "Test Schema Rule",
  "description": "Description of test schema rule",
  "policyId": "69b83f18cd6b7c4adf4139bc"
}
{
  "createDate": "2026-03-25T15:34:42.540Z",
  "updateDate": "2026-03-25T15:34:42.540Z",
  "uuid": "f11d9161-a429-46de-989d-3d7bdeb32da6",
  "name": "Test Schema Rule",
  "description": "Description of test schema rule",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "status": "DRAFT",
  "policyId": "69b83f18cd6b7c4adf4139bc",
  "policyTopicId": "0.0.8251226",
  "policyInstanceTopicId": "0.0.8372748",
  "config": {
    "fields": []
  },
  "id": "69c40092810b639b34bae8a2"
}

Retrieves schema rule.

get

Retrieves schema rule for the specified ID.

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

Schema rule Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Tool name
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
get/schema-rules/{ruleId}
GET /api/v1/schema-rules/{ruleId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "createDate": "2026-03-25T15:34:42.540Z",
  "updateDate": "2026-03-25T15:34:42.540Z",
  "uuid": "f11d9161-a429-46de-989d-3d7bdeb32da6",
  "name": "Test Schema Rule",
  "description": "Description of test schema rule",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "status": "DRAFT",
  "policyId": "69b83f18cd6b7c4adf4139bc",
  "policyTopicId": "0.0.8251226",
  "policyInstanceTopicId": "0.0.8372748",
  "config": {
    "fields": []
  },
  "id": "69c40092810b639b34bae8a2"
}

Updates schema rule.

put

Updates schema rule configuration for the specified rule ID.

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

Schema Rule Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Body
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Tool name
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
Responses
200

Successful operation.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Tool name
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
put/schema-rules/{ruleId}
PUT /api/v1/schema-rules/{ruleId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "name": "Updated Rule",
  "description": "Updated description",
  "policyId": "69aeb71ef8c5b278e3bab4e5"
}
{
  "createDate": "2026-03-25T15:34:42.540Z",
  "updateDate": "2026-03-25T15:34:42.540Z",
  "uuid": "f11d9161-a429-46de-989d-3d7bdeb32da6",
  "name": "Test Schema Rule",
  "description": "Description of test schema rule",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "status": "DRAFT",
  "policyId": "69b83f18cd6b7c4adf4139bc",
  "policyTopicId": "0.0.8251226",
  "policyInstanceTopicId": "0.0.8372748",
  "config": {
    "fields": []
  },
  "id": "69c40092810b639b34bae8a2"
}

Deletes the schema rule.

delete

Deletes the schema rule with the provided ID.

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

Schema Rule Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

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

true

Activates schema rule.

put

Activates schema rule for the specified rule ID.

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

Schema Rule Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Tool name
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
put/schema-rules/{ruleId}/activate
PUT /api/v1/schema-rules/{ruleId}/activate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "createDate": "2026-03-25T15:34:42.540Z",
  "updateDate": "2026-03-25T15:34:42.540Z",
  "uuid": "f11d9161-a429-46de-989d-3d7bdeb32da6",
  "name": "Test Schema Rule",
  "description": "Description of test schema rule",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "status": "DRAFT",
  "policyId": "69b83f18cd6b7c4adf4139bc",
  "policyTopicId": "0.0.8251226",
  "policyInstanceTopicId": "0.0.8372748",
  "config": {
    "fields": []
  },
  "id": "69c40092810b639b34bae8a2"
}

Inactivates schema rule.

put

Inactivates schema rule for the specified rule ID.

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

Schema Rule Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Tool name
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
put/schema-rules/{ruleId}/inactivate
PUT /api/v1/schema-rules/{ruleId}/inactivate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "createDate": "2026-03-25T15:34:42.540Z",
  "updateDate": "2026-03-25T15:34:42.540Z",
  "uuid": "f11d9161-a429-46de-989d-3d7bdeb32da6",
  "name": "Test Schema Rule",
  "description": "Description of test schema rule",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "status": "DRAFT",
  "policyId": "69b83f18cd6b7c4adf4139bc",
  "policyTopicId": "0.0.8251226",
  "policyInstanceTopicId": "0.0.8372748",
  "config": {
    "fields": []
  },
  "id": "69c40092810b639b34bae8a2"
}

Retrieves schema rule relationships.

get

Retrieves schema rule relationships for the specified ID.

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

Schema Rule Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
get/schema-rules/{ruleId}/relationships
GET /api/v1/schema-rules/{ruleId}/relationships HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "policy": {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
    "name": "Policy name",
    "description": "Description",
    "topicDescription": "Description",
    "policyTag": "Tag",
    "status": "DRAFT",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "topicId": "0.0.6046379",
    "messageId": "1773670900.819264517",
    "codeVersion": "1.0.0",
    "createDate": "2026-03-03T17:25:53.312Z",
    "version": "1.0.0",
    "originalChanged": true,
    "config": {},
    "userRole": "Installer",
    "userRoles": [
      "Installer"
    ],
    "userGroup": {
      "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
      "role": "Installer",
      "groupLabel": "Label",
      "groupName": "Name",
      "active": true
    },
    "userGroups": [
      {
        "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
        "role": "Installer",
        "groupLabel": "Label",
        "groupName": "Name",
        "active": true
      }
    ],
    "policyRoles": [
      "Registrant"
    ],
    "policyNavigation": [
      {
        "role": "Registrant",
        "steps": [
          {
            "block": "Block tag",
            "level": 1,
            "name": "Step name"
          }
        ]
      }
    ],
    "policyTopics": [
      {
        "name": "Project",
        "description": "Project",
        "memoObj": "topic",
        "static": false,
        "type": "any"
      }
    ],
    "policyTokens": [
      {
        "tokenName": "Token name",
        "tokenSymbol": "Token symbol",
        "tokenType": "non-fungible",
        "decimals": "",
        "changeSupply": true,
        "enableAdmin": true,
        "enableFreeze": true,
        "enableKYC": true,
        "enableWipe": true,
        "templateTokenTag": "token_template_0"
      }
    ],
    "policyGroups": [
      {
        "name": "Group name",
        "creator": "Registrant",
        "groupAccessType": "Private",
        "groupRelationshipType": "Multiple",
        "members": [
          "Registrant"
        ]
      }
    ],
    "categories": [
      "string"
    ],
    "projectSchema": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
    "tests": [
      {
        "id": "69aeb71ef8c5b278e3bab4e5",
        "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
        "name": "Test Name",
        "policyId": "69aeb71ef8c5b278e3bab4e5",
        "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
        "status": "NEW",
        "date": "2026-03-03T17:25:53.312Z",
        "duration": 0,
        "progress": 0,
        "resultId": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
        "result": {}
      }
    ],
    "ignoreRules": [
      {
        "code": "string",
        "blockType": "string",
        "property": "string",
        "contains": "string",
        "severity": "warning"
      }
    ]
  },
  "schemas": [
    {
      "id": "69aeb71ef8c5b278e3bab4e5",
      "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
      "name": "Schema name",
      "description": "Description",
      "entity": "POLICY",
      "iri": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
      "status": "DRAFT",
      "topicId": "0.0.6046379",
      "version": "1.0.0",
      "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
      "messageId": "1773670900.819264517",
      "category": "POLICY",
      "documentURL": "ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
      "contextURL": "ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
      "document": {},
      "context": {}
    }
  ]
}

Retrieves schema rule data.

post

Retrieves schema rule data based on the provided options.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
schemaIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
documentIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
parentIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
Responses
201

Successful operation.

application/json
post/schema-rules/data
POST /api/v1/schema-rules/data HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "schemaId": "69aeb71ef8c5b278e3bab4e5",
  "documentId": "69aeb71ef8c5b278e3bab4e5"
}
[
  {
    "rules": {
      "id": "69aeb71ef8c5b278e3bab4e5",
      "uuid": "69aeb71ef8c5b278e3bab4e5",
      "name": "Validation Rule",
      "description": "Description",
      "creator": "string",
      "owner": "string",
      "policyId": "69aeb71ef8c5b278e3bab4e5",
      "policyTopicId": "69aeb71ef8c5b278e3bab4e5",
      "policyInstanceTopicId": "69aeb71ef8c5b278e3bab4e5",
      "status": "string",
      "config": {}
    },
    "document": {
      "id": "69aeb71ef8c5b278e3bab4e5",
      "policyId": "69aeb71ef8c5b278e3bab4e5",
      "hash": "hash",
      "signature": 0,
      "status": "NEW",
      "tag": "Block tag",
      "type": "Document type",
      "createDate": "string",
      "updateDate": "string",
      "owner": "string",
      "document": {
        "id": "69aeb71ef8c5b278e3bab4e5",
        "type": [
          "string"
        ],
        "credentialSubject": {},
        "issuer": {},
        "issuanceDate": "string",
        "proof": {
          "type": "string",
          "created": "string",
          "verificationMethod": "string",
          "proofPurpose": "string",
          "jws": "string"
        }
      }
    },
    "relationships": [
      {
        "id": "69aeb71ef8c5b278e3bab4e5",
        "policyId": "69aeb71ef8c5b278e3bab4e5",
        "hash": "hash",
        "signature": 0,
        "status": "NEW",
        "tag": "Block tag",
        "type": "Document type",
        "createDate": "string",
        "updateDate": "string",
        "owner": "string",
        "document": {
          "id": "69aeb71ef8c5b278e3bab4e5",
          "type": [
            {}
          ],
          "credentialSubject": {},
          "issuer": {},
          "issuanceDate": "string",
          "proof": {
            "type": {},
            "created": {},
            "verificationMethod": {},
            "proofPurpose": {},
            "jws": {}
          }
        }
      }
    ]
  }
]

Imports new rules from a zip file.

post

Imports new rules from the provided zip file into the local DB.

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

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5
Body
stringOptional
Responses
201

Successful operation.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Tool name
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
post/schema-rules/{policyId}/import/file
POST /api/v1/schema-rules/{policyId}/import/file HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
{
  "createDate": "2026-03-25T15:34:42.540Z",
  "updateDate": "2026-03-25T15:34:42.540Z",
  "uuid": "f11d9161-a429-46de-989d-3d7bdeb32da6",
  "name": "Test Schema Rule",
  "description": "Description of test schema rule",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "status": "DRAFT",
  "policyId": "69b83f18cd6b7c4adf4139bc",
  "policyTopicId": "0.0.8251226",
  "policyInstanceTopicId": "0.0.8372748",
  "config": {
    "fields": []
  },
  "id": "69c40092810b639b34bae8a2"
}

Returns a zip file containing rules.

get

Returns a zip file containing rules.

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

Schema Rule Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation. Response zip file.

application/zip
string · binaryOptional
get/schema-rules/{ruleId}/export/file
GET /api/v1/schema-rules/{ruleId}/export/file HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "result": "ok"
}

Imports a zip file containing rules.

post

Imports a zip file containing rules.

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

Schema rule preview.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Tool name
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
post/schema-rules/import/file/preview
POST /api/v1/schema-rules/import/file/preview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
{
  "createDate": "2026-03-25T15:34:42.540Z",
  "updateDate": "2026-03-25T15:34:42.540Z",
  "uuid": "f11d9161-a429-46de-989d-3d7bdeb32da6",
  "name": "Test Schema Rule",
  "description": "Description of test schema rule",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "status": "DRAFT",
  "policyId": "69b83f18cd6b7c4adf4139bc",
  "policyTopicId": "0.0.8251226",
  "policyInstanceTopicId": "0.0.8372748",
  "config": {
    "fields": []
  },
  "id": "69c40092810b639b34bae8a2"
}
PreviousSchema
NextPolicies

Last updated

Was this helpful?