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.

Formulas

Calculation formulas for quantifying environmental impact.

Return a list of all formulas.

get

Returns a paginated list of formulas 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
policyIdstringOptional

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

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

application/json
get/formulas
GET /api/v1/formulas HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "Test 3",
    "description": "",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "status": "PUBLISHED",
    "policyId": "69b83f18cd6b7c4adf4139bc",
    "policyTopicId": "0.0.8251226",
    "policyInstanceTopicId": "0.0.8372748",
    "id": "69b83f56cd6b7c4adf413a1e"
  }
]

Creates a new formula.

post

Creates a new formula linked to a policy. The formula defines calculation logic using variables, constants, and mathematical expressions that reference schema fields.

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
messageIdstringOptionalExample: 1773670900.819264517
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
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
post/formulas
POST /api/v1/formulas HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "name": "New Formula",
  "description": "Formula description",
  "policyId": "69b83f18cd6b7c4adf4139bc"
}
{
  "createDate": "2026-03-16T17:35:18.617Z",
  "updateDate": "2026-03-25T14:40:22.393Z",
  "uuid": "fb7980f1-f347-47f3-9c1d-698b60162aba",
  "name": "Test 3",
  "description": "",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "status": "PUBLISHED",
  "messageId": "1774449622.177353801",
  "policyId": "69b83f18cd6b7c4adf4139bc",
  "policyTopicId": "0.0.8251226",
  "policyInstanceTopicId": "0.0.8372748",
  "id": "69b83f56cd6b7c4adf413a1e"
}

Retrieves formula by ID.

get

Returns the full formula object including config with variables, constants, and expressions. Returns additional fields compared to the list endpoint (uuid, createDate, updateDate, messageId, config).

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

Formula 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
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
get/formulas/{formulaId}
GET /api/v1/formulas/{formulaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "createDate": "2026-03-16T17:35:18.617Z",
  "updateDate": "2026-03-25T14:40:22.393Z",
  "uuid": "fb7980f1-f347-47f3-9c1d-698b60162aba",
  "name": "Test 3",
  "description": "",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "status": "PUBLISHED",
  "messageId": "1774449622.177353801",
  "policyId": "69b83f18cd6b7c4adf4139bc",
  "policyTopicId": "0.0.8251226",
  "policyInstanceTopicId": "0.0.8372748",
  "id": "69b83f56cd6b7c4adf413a1e"
}

Updates formula.

put

Updates formula configuration for the specified formula ID.

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

Formula 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
messageIdstringOptionalExample: 1773670900.819264517
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
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
put/formulas/{formulaId}
PUT /api/v1/formulas/{formulaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "name": "Updated Formula",
  "description": "Updated formula description",
  "policyId": "69aeb71ef8c5b278e3bab4e5"
}
{
  "createDate": "2026-03-16T17:35:18.617Z",
  "updateDate": "2026-03-25T14:40:22.393Z",
  "uuid": "fb7980f1-f347-47f3-9c1d-698b60162aba",
  "name": "Test 3",
  "description": "",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "status": "PUBLISHED",
  "messageId": "1774449622.177353801",
  "policyId": "69b83f18cd6b7c4adf4139bc",
  "policyTopicId": "0.0.8251226",
  "policyInstanceTopicId": "0.0.8372748",
  "id": "69b83f56cd6b7c4adf413a1e"
}

Deletes the formula.

delete

Deletes the formula with the provided ID.

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

Formula Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
booleanOptional
delete/formulas/{formulaId}
DELETE /api/v1/formulas/{formulaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Retrieves Formula relationships.

get

Retrieves Formula relationships for the specified ID.

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

Formula Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
get/formulas/{formulaId}/relationships
GET /api/v1/formulas/{formulaId}/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": {}
    }
  ],
  "formulas": [
    {
      "id": "69aeb71ef8c5b278e3bab4e5",
      "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
      "name": "Emission Formula",
      "description": "Description",
      "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
      "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
      "messageId": "1773670900.819264517",
      "policyId": "69aeb71ef8c5b278e3bab4e5",
      "policyTopicId": "0.0.6046379",
      "policyInstanceTopicId": "0.0.6046379",
      "status": "DRAFT",
      "config": {}
    }
  ]
}

Imports new formula from a zip file.

post

Imports new formula 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
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
post/formulas/{policyId}/import/file
POST /api/v1/formulas/{policyId}/import/file HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
{
  "createDate": "2026-03-16T17:35:18.617Z",
  "updateDate": "2026-03-25T14:40:22.393Z",
  "uuid": "fb7980f1-f347-47f3-9c1d-698b60162aba",
  "name": "Test 3",
  "description": "",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "status": "PUBLISHED",
  "messageId": "1774449622.177353801",
  "policyId": "69b83f18cd6b7c4adf4139bc",
  "policyTopicId": "0.0.8251226",
  "policyInstanceTopicId": "0.0.8372748",
  "id": "69b83f56cd6b7c4adf413a1e"
}

Returns a zip file containing formula.

get

Returns a zip file containing formula.

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

Formula Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation. Response zip file.

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

{
  "result": "ok"
}

Imports a zip file containing formula.

post

Imports a zip file containing formula.

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

Formula 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
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
post/formulas/import/file/preview
POST /api/v1/formulas/import/file/preview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
{
  "createDate": "2026-03-16T17:35:18.617Z",
  "updateDate": "2026-03-25T14:40:22.393Z",
  "uuid": "fb7980f1-f347-47f3-9c1d-698b60162aba",
  "name": "Test 3",
  "description": "",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "status": "PUBLISHED",
  "messageId": "1774449622.177353801",
  "policyId": "69b83f18cd6b7c4adf4139bc",
  "policyTopicId": "0.0.8251226",
  "policyInstanceTopicId": "0.0.8372748",
  "id": "69b83f56cd6b7c4adf413a1e"
}

Return formula to editing.

put

Return formula to editing for the specified formula ID.

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

Formula 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
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
put/formulas/{formulaId}/draft
PUT /api/v1/formulas/{formulaId}/draft HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "createDate": "2026-03-16T17:35:18.617Z",
  "updateDate": "2026-03-25T14:40:22.393Z",
  "uuid": "fb7980f1-f347-47f3-9c1d-698b60162aba",
  "name": "Test 3",
  "description": "",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "status": "PUBLISHED",
  "messageId": "1774449622.177353801",
  "policyId": "69b83f18cd6b7c4adf4139bc",
  "policyTopicId": "0.0.8251226",
  "policyInstanceTopicId": "0.0.8372748",
  "id": "69b83f56cd6b7c4adf413a1e"
}

Dry Run formula.

put

Run formula without making any persistent changes or executing transaction.

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

Formula 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
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
put/formulas/{formulaId}/dry-run
PUT /api/v1/formulas/{formulaId}/dry-run HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "createDate": "2026-03-16T17:35:18.617Z",
  "updateDate": "2026-03-25T14:40:22.393Z",
  "uuid": "fb7980f1-f347-47f3-9c1d-698b60162aba",
  "name": "Test 3",
  "description": "",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "status": "PUBLISHED",
  "messageId": "1774449622.177353801",
  "policyId": "69b83f18cd6b7c4adf4139bc",
  "policyTopicId": "0.0.8251226",
  "policyInstanceTopicId": "0.0.8372748",
  "id": "69b83f56cd6b7c4adf413a1e"
}

Publishes formula.

put

Publishes formula for the specified formula ID.

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

Formula 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
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
put/formulas/{formulaId}/publish
PUT /api/v1/formulas/{formulaId}/publish HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "createDate": "2026-03-16T17:35:18.617Z",
  "updateDate": "2026-03-25T14:40:22.393Z",
  "uuid": "fb7980f1-f347-47f3-9c1d-698b60162aba",
  "name": "Test 3",
  "description": "",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "status": "PUBLISHED",
  "messageId": "1774449622.177353801",
  "policyId": "69b83f18cd6b7c4adf4139bc",
  "policyTopicId": "0.0.8251226",
  "policyInstanceTopicId": "0.0.8372748",
  "id": "69b83f56cd6b7c4adf413a1e"
}

Retrieves formulas and associated data.

post

Retrieves formulas and their associated 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/formulas/data
POST /api/v1/formulas/data HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "schemaId": "69aeb71ef8c5b278e3bab4e5",
  "documentId": "69aeb71ef8c5b278e3bab4e5"
}
{
  "formulas": [
    {
      "createDate": "2026-03-16T17:35:18.617Z",
      "updateDate": "2026-03-25T14:40:22.393Z",
      "uuid": "fb7980f1-f347-47f3-9c1d-698b60162aba",
      "name": "Test 3",
      "description": "",
      "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
      "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
      "status": "PUBLISHED",
      "messageId": "1774449622.177353801",
      "policyId": "69b83f18cd6b7c4adf4139bc",
      "policyTopicId": "0.0.8251226",
      "policyInstanceTopicId": "0.0.8372748",
      "id": "69b83f56cd6b7c4adf413a1e"
    }
  ],
  "document": {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "policyId": "69aeb71ef8c5b278e3bab4e5",
    "hash": "GcDE9NsPJc7oCZvSVJySCZHxTxvjc3ZAMgtKozP1r1Eh",
    "signature": 0,
    "status": "NEW",
    "tag": "Block tag",
    "type": "Document type",
    "createDate": "2026-03-03T17:25:53.312Z",
    "updateDate": "2026-03-03T17:25:53.312Z",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "document": {
      "id": "69aeb71ef8c5b278e3bab4e5",
      "type": [
        "string"
      ],
      "credentialSubject": {},
      "issuer": {},
      "issuanceDate": "2026-03-03T17:25:53.312Z",
      "proof": {
        "type": "string",
        "created": "2026-03-03T17:25:53.312Z",
        "verificationMethod": "string",
        "proofPurpose": "string",
        "jws": "string"
      }
    }
  },
  "relationships": [
    {
      "id": "69aeb71ef8c5b278e3bab4e5",
      "policyId": "69aeb71ef8c5b278e3bab4e5",
      "hash": "GcDE9NsPJc7oCZvSVJySCZHxTxvjc3ZAMgtKozP1r1Eh",
      "signature": 0,
      "status": "NEW",
      "tag": "Block tag",
      "type": "Document type",
      "createDate": "2026-03-03T17:25:53.312Z",
      "updateDate": "2026-03-03T17:25:53.312Z",
      "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
      "document": {
        "id": "69aeb71ef8c5b278e3bab4e5",
        "type": [
          {}
        ],
        "credentialSubject": {},
        "issuer": {},
        "issuanceDate": "2026-03-03T17:25:53.312Z",
        "proof": {
          "type": {},
          "created": {},
          "verificationMethod": {},
          "proofPurpose": {},
          "jws": {}
        }
      }
    }
  ],
  "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": {}
    }
  ]
}
PreviousModules
NextArtifacts

Last updated

Was this helpful?