Entities

Get file

get

Returns file

Path parameters

cidstringRequired

CID

Example: bafybe...3w5sk3m

Responses

200

File

application/json

stringOptional

500

Internal server error

application/json

get/entities/ipfs/{cid}

GET /api/v1/entities/ipfs/{cid} HTTP/1.1
Accept: */*

text

Get standard registries

get

Returns standard registries

Query parameters

pageIndexnumberOptional

Page index

Example: 0

pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp

orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}

keywordsstringOptional

Keywords to search

Example: {"description":"Search registries, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}

topicIdstringOptional

Global topic identifier

Example: 0.0.1960

options.didstringOptional

Registry did

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265

options.registrantTopicIdstringOptional

Registry user topic identifier

Example: 0.0.4481265

options.attributes.OrganizationNamestringOptional

Registry organization name

Example: Example

Responses

200

Registries

application/json

pageIndexnumberRequired

Page index

Example: 0

pageSizenumberRequired

Page size

Example: 10

totalnumberRequired

Total size

Example: 100

orderobjectRequired

Order

500

Internal server error

application/json

get/entities/registries

GET /api/v1/entities/registries HTTP/1.1
Accept: */*

{
  "pageIndex": "0",
  "pageSize": "10",
  "total": "100",
  "order": {},
  "items": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "Standard Registry",
      "action": "Init",
      "options": {
        "did": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "registrantTopicId": "text",
        "lang": "text",
        "attributes": {}
      },
      "analytics": {
        "textSearch": "text"
      }
    }
  ]
}

Get registry

get

Returns registry

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

Registry details

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7

500

Internal server error

application/json

get/entities/registries/{messageId}

GET /api/v1/entities/registries/{messageId} HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0,
    "type": "Standard Registry",
    "action": "Init",
    "options": {
      "did": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
      "registrantTopicId": "text",
      "lang": "text",
      "attributes": {}
    },
    "analytics": {
      "textSearch": "text"
    }
  },
  "row": {
    "id": "667c240639282050117a1985",
    "consensusTimestamp": "1706823227.586179534",
    "topicId": "0.0.4481265",
    "status": "LOADED",
    "lastUpdate": 1716755852055,
    "message": "eyJpZCI6ImVhYTYyOWZmLWM4NmItNDEyZS1iYzYwLWM4NDk2OTJkMDBiYiIsInN0YXR1cyI6IklTU1VFIiwidHlwZSI6IlN0YW5kYXJkIFJlZ2lzdHJ5IiwiYWN0aW9uIjoiSW5pdCIsImxhbmciOiJlbi1VUyIsImRpZCI6ImRpZDpoZWRlcmE6dGVzdG5ldDpBYkd6Q3hpRzRlZ0xibldCUERpaHdMUVIza0tLcnNGNmJnSDdUdmVGYjI3bl8wLjAuMjE3NiIsInRvcGljSWQiOiIwLjAuMjE3NiIsImF0dHJpYnV0ZXMiOnsiZ2VvZ3JhcGh5IjoidGVzdCIsImxhdyI6InRlc3R0ZXMiLCJ0YWdzIjoidGVzdCJ9fQ",
    "sequenceNumber": 2,
    "owner": "0.0.1914",
    "chunkId": "1706817694.014944860",
    "chunkNumber": 1,
    "chunkTotal": 1,
    "type": "Message",
    "data": "`{\"id\":\"eaa629ff-c86b-412e-bc60-c849692d00bb\",\"status\":\"ISSUE\",\"type\":\"Standard Registry\",\"action\":\"Init\",\"lang\":\"en-US\",\"did\":\"did:hedera:testnet:AbGzCxiG4egLbnWBPDihwLQR3kKKrsF6bgH7TveFb27n_0.0.2176\",\"topicId\":\"0.0.2176\",\"attributes\":{\"geography\":\"test\",\"law\":\"testtes\",\"tags\":\"test\"}}`"
  },
  "activity": {
    "vcs": 10,
    "vps": 10,
    "policies": 10,
    "roles": 10,
    "tools": 10,
    "modules": 10,
    "tokens": 10,
    "users": 10,
    "contracts": 10
  }
}

Get registry relationships

get

Returns registry relationships

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

Registry relationships

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

categoriesstring[]Required

Categories

Example: [{"name":"Registry"},{"name":"Policy"},{"name":"Schema"},{"name":"Role"},{"name":"VC"},{"name":"VP"},{"name":"Token"}]

500

Internal server error

application/json

get/entities/registries/{messageId}/relationships

GET /api/v1/entities/registries/{messageId}/relationships HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0
  },
  "target": {
    "id": "1706823227.586179534",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "type": "EVC-Document",
    "category": 1,
    "name": "Monitoring Report Document",
    "tagsCount": 1
  },
  "relationships": [
    {
      "id": "1706823227.586179534",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "type": "EVC-Document",
      "category": 1,
      "name": "Monitoring Report Document",
      "tagsCount": 1
    }
  ],
  "links": [
    {
      "source": "1706823227.586179534",
      "target": "1706823227.586179534"
    }
  ],
  "categories": [
    {
      "name": "Registry"
    },
    {
      "name": "Policy"
    },
    {
      "name": "Schema"
    },
    {
      "name": "Role"
    },
    {
      "name": "VC"
    },
    {
      "name": "VP"
    },
    {
      "name": "Token"
    }
  ]
}

Get registry users

get

Returns registry users

Query parameters

pageIndexnumberOptional

Page index

Example: 0

pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp

orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}

keywordsstringOptional

Keywords to search

Example: {"description":"Search registry users, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}

topicIdstringOptional

User topic identifier

Example: 0.0.1960

Responses

200

Registry users

application/json

pageIndexnumberRequired

Page index

Example: 0

pageSizenumberRequired

Page size

Example: 10

totalnumberRequired

Total size

Example: 100

orderobjectRequired

Order

500

Internal server error

application/json

get/entities/registry-users

GET /api/v1/entities/registry-users HTTP/1.1
Accept: */*

{
  "pageIndex": "0",
  "pageSize": "10",
  "total": "100",
  "order": {},
  "items": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "DID-Document",
      "action": "create-did-document",
      "options": {
        "did": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265"
      },
      "analytics": {
        "textSearch": "text"
      }
    }
  ]
}

Get registry user

get

Returns registry user

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

Registry user details

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7

500

Internal server error

application/json

get/entities/registry-users/{messageId}

GET /api/v1/entities/registry-users/{messageId} HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0,
    "type": "DID-Document",
    "action": "create-did-document",
    "options": {
      "did": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265"
    },
    "analytics": {
      "textSearch": "text"
    },
    "documents": [
      "\"{\"@context\":\"https://www.w3.org/ns/did/v1\",\"id\":\"did:hedera:testnet:C37cfiAMHeToXMiy1V5rAVJdhd182QJRGxwsWQpu2dN2_0.0.1533438\",\"verificationMethod\":[{\"id\":\"did:hedera:testnet:C37cfiAMHeToXMiy1V5rAVJdhd182QJRGxwsWQpu2dN2_0.0.1533438#did-root-key\",\"type\":\"Ed25519VerificationKey2018\",\"controller\":\"did:hedera:testnet:C37cfiAMHeToXMiy1V5rAVJdhd182QJRGxwsWQpu2dN2_0.0.1533438\",\"publicKeyBase58\":\"8WkE4uKLN7i9RnzeoUJfxSH9Jw8M1yTzKk6rtwVa6uGP\"},{\"id\":\"did:hedera:testnet:C37cfiAMHeToXMiy1V5rAVJdhd182QJRGxwsWQpu2dN2_0.0.1533438#did-root-key-bbs\",\"type\":\"Bls12381G2Key2020\",\"controller\":\"did:hedera:testnet:C37cfiAMHeToXMiy1V5rAVJdhd182QJRGxwsWQpu2dN2_0.0.1533438\",\"publicKeyBase58\":\"237NDsUq7LAmSMzE6CEBFyuz9s2sscSz2M6cn4zUKPmJ5Q6rMh6SLRGC3EDdna7vSKwHMCGjhCiLKM6qYU7ZeYKRPNnRMcadoJbSQ44SGAAiyrpmhX8aaoTZpMdHmGFVXdqC\"}],\"authentication\":[\"did:hedera:testnet:C37cfiAMHeToXMiy1V5rAVJdhd182QJRGxwsWQpu2dN2_0.0.1533438#did-root-key\"],\"assertionMethod\":[\"#did-root-key\",\"#did-root-key-bbs\"]}\""
    ]
  },
  "row": {
    "id": "667c240639282050117a1985",
    "consensusTimestamp": "1706823227.586179534",
    "topicId": "0.0.4481265",
    "status": "LOADED",
    "lastUpdate": 1716755852055,
    "message": "eyJpZCI6ImVhYTYyOWZmLWM4NmItNDEyZS1iYzYwLWM4NDk2OTJkMDBiYiIsInN0YXR1cyI6IklTU1VFIiwidHlwZSI6IlN0YW5kYXJkIFJlZ2lzdHJ5IiwiYWN0aW9uIjoiSW5pdCIsImxhbmciOiJlbi1VUyIsImRpZCI6ImRpZDpoZWRlcmE6dGVzdG5ldDpBYkd6Q3hpRzRlZ0xibldCUERpaHdMUVIza0tLcnNGNmJnSDdUdmVGYjI3bl8wLjAuMjE3NiIsInRvcGljSWQiOiIwLjAuMjE3NiIsImF0dHJpYnV0ZXMiOnsiZ2VvZ3JhcGh5IjoidGVzdCIsImxhdyI6InRlc3R0ZXMiLCJ0YWdzIjoidGVzdCJ9fQ",
    "sequenceNumber": 2,
    "owner": "0.0.1914",
    "chunkId": "1706817694.014944860",
    "chunkNumber": 1,
    "chunkTotal": 1,
    "type": "Message",
    "data": "`{\"id\":\"eaa629ff-c86b-412e-bc60-c849692d00bb\",\"status\":\"ISSUE\",\"type\":\"Standard Registry\",\"action\":\"Init\",\"lang\":\"en-US\",\"did\":\"did:hedera:testnet:AbGzCxiG4egLbnWBPDihwLQR3kKKrsF6bgH7TveFb27n_0.0.2176\",\"topicId\":\"0.0.2176\",\"attributes\":{\"geography\":\"test\",\"law\":\"testtes\",\"tags\":\"test\"}}`"
  },
  "activity": {
    "vcs": 10,
    "vps": 10,
    "roles": 10
  }
}

Get policies

get

Returns policies

Query parameters

pageIndexnumberOptional

Page index

Example: 0

pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp

orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}

keywordsstringOptional

Keywords to search

Example: {"description":"Search policies, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}

topicIdstringOptional

Policy topic identifier

Example: 0.0.1960

options.ownerstringOptional

Policy owner

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265

analytics.toolsstringOptional

Tool

Example: 1706823227.586179534

Responses

200

Policies

application/json

pageIndexnumberRequired

Page index

Example: 0

pageSizenumberRequired

Page size

Example: 10

totalnumberRequired

Total size

Example: 100

orderobjectRequired

Order

500

Internal server error

application/json

get/entities/policies

GET /api/v1/entities/policies HTTP/1.1
Accept: */*

{
  "pageIndex": "0",
  "pageSize": "10",
  "total": "100",
  "order": {},
  "items": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "Policy",
      "action": "publish-policy",
      "options": {
        "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
        "name": "Verra REDD",
        "description": "Verra REDD Policy",
        "topicDescription": "Verra REDD Policy Topic",
        "version": "1.0.0",
        "policyTag": "Verra_REDD",
        "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "policyTopicId": "0.0.4481265",
        "instanceTopicId": "0.0.4481265",
        "synchronizationTopicId": "0.0.4481265",
        "commentsTopicId": "0.0.4481265",
        "discontinuedDate": "2024-02-27T16:32:08.513Z"
      },
      "analytics": {
        "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "tokens": [
          "0.0.4481265"
        ],
        "vcCount": 10,
        "vpCount": 10,
        "tokensCount": 10,
        "tags": [
          "iRec"
        ],
        "hash": "DdQweGpEqbWgQUZcQjySQn2qYPd3yACGnSoRXiuLt5or",
        "hashMap": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "tools": [
          "1706823227.586179534"
        ],
        "registryId": "1706823227.586179534",
        "textSearch": "text"
      }
    }
  ]
}

Get policy

get

Returns policy

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

Policy details

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7

500

Internal server error

application/json

get/entities/policies/{messageId}

GET /api/v1/entities/policies/{messageId} HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0,
    "type": "Policy",
    "action": "publish-policy",
    "options": {
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "name": "Verra REDD",
      "description": "Verra REDD Policy",
      "topicDescription": "Verra REDD Policy Topic",
      "version": "1.0.0",
      "policyTag": "Verra_REDD",
      "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
      "policyTopicId": "0.0.4481265",
      "instanceTopicId": "0.0.4481265",
      "synchronizationTopicId": "0.0.4481265",
      "commentsTopicId": "0.0.4481265",
      "discontinuedDate": "2024-02-27T16:32:08.513Z"
    },
    "analytics": {
      "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
      "tokens": [
        "0.0.4481265"
      ],
      "vcCount": 10,
      "vpCount": 10,
      "tokensCount": 10,
      "tags": [
        "iRec"
      ],
      "hash": "DdQweGpEqbWgQUZcQjySQn2qYPd3yACGnSoRXiuLt5or",
      "hashMap": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "tools": [
        "1706823227.586179534"
      ],
      "registryId": "1706823227.586179534",
      "textSearch": "text"
    }
  },
  "row": {
    "id": "667c240639282050117a1985",
    "consensusTimestamp": "1706823227.586179534",
    "topicId": "0.0.4481265",
    "status": "LOADED",
    "lastUpdate": 1716755852055,
    "message": "eyJpZCI6ImVhYTYyOWZmLWM4NmItNDEyZS1iYzYwLWM4NDk2OTJkMDBiYiIsInN0YXR1cyI6IklTU1VFIiwidHlwZSI6IlN0YW5kYXJkIFJlZ2lzdHJ5IiwiYWN0aW9uIjoiSW5pdCIsImxhbmciOiJlbi1VUyIsImRpZCI6ImRpZDpoZWRlcmE6dGVzdG5ldDpBYkd6Q3hpRzRlZ0xibldCUERpaHdMUVIza0tLcnNGNmJnSDdUdmVGYjI3bl8wLjAuMjE3NiIsInRvcGljSWQiOiIwLjAuMjE3NiIsImF0dHJpYnV0ZXMiOnsiZ2VvZ3JhcGh5IjoidGVzdCIsImxhdyI6InRlc3R0ZXMiLCJ0YWdzIjoidGVzdCJ9fQ",
    "sequenceNumber": 2,
    "owner": "0.0.1914",
    "chunkId": "1706817694.014944860",
    "chunkNumber": 1,
    "chunkTotal": 1,
    "type": "Message",
    "data": "`{\"id\":\"eaa629ff-c86b-412e-bc60-c849692d00bb\",\"status\":\"ISSUE\",\"type\":\"Standard Registry\",\"action\":\"Init\",\"lang\":\"en-US\",\"did\":\"did:hedera:testnet:AbGzCxiG4egLbnWBPDihwLQR3kKKrsF6bgH7TveFb27n_0.0.2176\",\"topicId\":\"0.0.2176\",\"attributes\":{\"geography\":\"test\",\"law\":\"testtes\",\"tags\":\"test\"}}`"
  },
  "activity": {
    "schemas": 10,
    "schemaPackages": 10,
    "vcs": 10,
    "vps": 10,
    "roles": 10,
    "formulas": 10
  }
}

Get policy relationships

get

Returns policy relationships

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

Policy relationships

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

categoriesstring[]Required

Categories

Example: [{"name":"Registry"},{"name":"Policy"},{"name":"Schema"},{"name":"Role"},{"name":"VC"},{"name":"VP"},{"name":"Token"}]

500

Internal server error

application/json

get/entities/policies/{messageId}/relationships

GET /api/v1/entities/policies/{messageId}/relationships HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0
  },
  "target": {
    "id": "1706823227.586179534",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "type": "EVC-Document",
    "category": 1,
    "name": "Monitoring Report Document",
    "tagsCount": 1
  },
  "relationships": [
    {
      "id": "1706823227.586179534",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "type": "EVC-Document",
      "category": 1,
      "name": "Monitoring Report Document",
      "tagsCount": 1
    }
  ],
  "links": [
    {
      "source": "1706823227.586179534",
      "target": "1706823227.586179534"
    }
  ],
  "categories": [
    {
      "name": "Registry"
    },
    {
      "name": "Policy"
    },
    {
      "name": "Schema"
    },
    {
      "name": "Role"
    },
    {
      "name": "VC"
    },
    {
      "name": "VP"
    },
    {
      "name": "Token"
    }
  ]
}

Get tools

get

Returns tools

Query parameters

pageIndexnumberOptional

Page index

Example: 0

pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp

orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}

keywordsstringOptional

Keywords to search

Example: {"description":"Search tools, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}

options.ownerstringOptional

Tool owner

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265

topicIdstringOptional

Topic identifier

Example: 0.0.1960

Responses

200

Tools

application/json

pageIndexnumberRequired

Page index

Example: 0

pageSizenumberRequired

Page size

Example: 10

totalnumberRequired

Total size

Example: 100

orderobjectRequired

Order

500

Internal server error

application/json

get/entities/tools

GET /api/v1/entities/tools HTTP/1.1
Accept: */*

{
  "pageIndex": "0",
  "pageSize": "10",
  "total": "100",
  "order": {},
  "items": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "Tool",
      "action": "publish-tool",
      "options": {
        "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
        "name": "Tool 16",
        "description": "Tool 16",
        "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "hash": "71ZWDSX2cUPsye4AuMUqXUhgk1XBDnpi4Ky1mtjYqYom",
        "toolTopicId": "0.0.4481265",
        "tagsTopicId": "0.0.4481265"
      },
      "analytics": {
        "textSearch": "text"
      }
    }
  ]
}

Get tool

get

Returns tool

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

Tool details

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7

500

Internal server error

application/json

get/entities/tools/{messageId}

GET /api/v1/entities/tools/{messageId} HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0,
    "type": "Tool",
    "action": "publish-tool",
    "options": {
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "name": "Tool 16",
      "description": "Tool 16",
      "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
      "hash": "71ZWDSX2cUPsye4AuMUqXUhgk1XBDnpi4Ky1mtjYqYom",
      "toolTopicId": "0.0.4481265",
      "tagsTopicId": "0.0.4481265"
    },
    "analytics": {
      "textSearch": "text"
    }
  },
  "row": {
    "id": "667c240639282050117a1985",
    "consensusTimestamp": "1706823227.586179534",
    "topicId": "0.0.4481265",
    "status": "LOADED",
    "lastUpdate": 1716755852055,
    "message": "eyJpZCI6ImVhYTYyOWZmLWM4NmItNDEyZS1iYzYwLWM4NDk2OTJkMDBiYiIsInN0YXR1cyI6IklTU1VFIiwidHlwZSI6IlN0YW5kYXJkIFJlZ2lzdHJ5IiwiYWN0aW9uIjoiSW5pdCIsImxhbmciOiJlbi1VUyIsImRpZCI6ImRpZDpoZWRlcmE6dGVzdG5ldDpBYkd6Q3hpRzRlZ0xibldCUERpaHdMUVIza0tLcnNGNmJnSDdUdmVGYjI3bl8wLjAuMjE3NiIsInRvcGljSWQiOiIwLjAuMjE3NiIsImF0dHJpYnV0ZXMiOnsiZ2VvZ3JhcGh5IjoidGVzdCIsImxhdyI6InRlc3R0ZXMiLCJ0YWdzIjoidGVzdCJ9fQ",
    "sequenceNumber": 2,
    "owner": "0.0.1914",
    "chunkId": "1706817694.014944860",
    "chunkNumber": 1,
    "chunkTotal": 1,
    "type": "Message",
    "data": "`{\"id\":\"eaa629ff-c86b-412e-bc60-c849692d00bb\",\"status\":\"ISSUE\",\"type\":\"Standard Registry\",\"action\":\"Init\",\"lang\":\"en-US\",\"did\":\"did:hedera:testnet:AbGzCxiG4egLbnWBPDihwLQR3kKKrsF6bgH7TveFb27n_0.0.2176\",\"topicId\":\"0.0.2176\",\"attributes\":{\"geography\":\"test\",\"law\":\"testtes\",\"tags\":\"test\"}}`"
  },
  "activity": {
    "schemas": 10,
    "policies": 10
  }
}

Get modules

get

Returns modules

Query parameters

pageIndexnumberOptional

Page index

Example: 0

pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp

orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}

keywordsstringOptional

Keywords to search

Example: {"description":"Search modules, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}

options.ownerstringOptional

Module owner

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265

topicIdstringOptional

Topic identifier

Example: 0.0.1960

Responses

200

Modules

application/json

pageIndexnumberRequired

Page index

Example: 0

pageSizenumberRequired

Page size

Example: 10

totalnumberRequired

Total size

Example: 100

orderobjectRequired

Order

500

Internal server error

application/json

get/entities/modules

GET /api/v1/entities/modules HTTP/1.1
Accept: */*

{
  "pageIndex": "0",
  "pageSize": "10",
  "total": "100",
  "order": {},
  "items": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "Module",
      "action": "publish-module",
      "options": {
        "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
        "name": "Grid module",
        "description": "Grid module",
        "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "moduleTopicId": "0.0.4481265"
      },
      "analytics": {
        "textSearch": "text"
      }
    }
  ]
}

Get module

get

Returns module

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

Module details

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7

500

Internal server error

application/json

get/entities/modules/{messageId}

GET /api/v1/entities/modules/{messageId} HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0,
    "type": "Module",
    "action": "publish-module",
    "options": {
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "name": "Grid module",
      "description": "Grid module",
      "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
      "moduleTopicId": "0.0.4481265"
    },
    "analytics": {
      "textSearch": "text"
    }
  },
  "row": {
    "id": "667c240639282050117a1985",
    "consensusTimestamp": "1706823227.586179534",
    "topicId": "0.0.4481265",
    "status": "LOADED",
    "lastUpdate": 1716755852055,
    "message": "eyJpZCI6ImVhYTYyOWZmLWM4NmItNDEyZS1iYzYwLWM4NDk2OTJkMDBiYiIsInN0YXR1cyI6IklTU1VFIiwidHlwZSI6IlN0YW5kYXJkIFJlZ2lzdHJ5IiwiYWN0aW9uIjoiSW5pdCIsImxhbmciOiJlbi1VUyIsImRpZCI6ImRpZDpoZWRlcmE6dGVzdG5ldDpBYkd6Q3hpRzRlZ0xibldCUERpaHdMUVIza0tLcnNGNmJnSDdUdmVGYjI3bl8wLjAuMjE3NiIsInRvcGljSWQiOiIwLjAuMjE3NiIsImF0dHJpYnV0ZXMiOnsiZ2VvZ3JhcGh5IjoidGVzdCIsImxhdyI6InRlc3R0ZXMiLCJ0YWdzIjoidGVzdCJ9fQ",
    "sequenceNumber": 2,
    "owner": "0.0.1914",
    "chunkId": "1706817694.014944860",
    "chunkNumber": 1,
    "chunkTotal": 1,
    "type": "Message",
    "data": "`{\"id\":\"eaa629ff-c86b-412e-bc60-c849692d00bb\",\"status\":\"ISSUE\",\"type\":\"Standard Registry\",\"action\":\"Init\",\"lang\":\"en-US\",\"did\":\"did:hedera:testnet:AbGzCxiG4egLbnWBPDihwLQR3kKKrsF6bgH7TveFb27n_0.0.2176\",\"topicId\":\"0.0.2176\",\"attributes\":{\"geography\":\"test\",\"law\":\"testtes\",\"tags\":\"test\"}}`"
  }
}

Get schemas

get

Returns schemas

Query parameters

pageIndexnumberOptional

Page index

Example: 0

pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp

orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}

keywordsstringOptional

Keywords to search

Example: {"description":"Search schemas, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}

topicIdstringOptional

Policy topic identifier

Example: 0.0.1960

options.ownerstringOptional

Schema owner

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265

Responses

200

Schemas

application/json

pageIndexnumberRequired

Page index

Example: 0

pageSizenumberRequired

Page size

Example: 10

totalnumberRequired

Total size

Example: 100

orderobjectRequired

Order

500

Internal server error

application/json

get/entities/schemas

GET /api/v1/entities/schemas HTTP/1.1
Accept: */*

{
  "pageIndex": "0",
  "pageSize": "10",
  "total": "100",
  "order": {},
  "items": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "Schema",
      "action": "publish-schema",
      "options": {
        "name": "Monitoring report",
        "description": "Monitoring report schema",
        "entity": "VC",
        "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
        "version": "1.0.0",
        "codeVersion": "1.0.0",
        "relationships": [
          "1706823227.586179534"
        ]
      }
    }
  ]
}

Get schema

get

Returns schema

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

Schema details

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7

500

Internal server error

application/json

get/entities/schemas/{messageId}

GET /api/v1/entities/schemas/{messageId} HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0,
    "type": "Schema",
    "action": "publish-schema",
    "options": {
      "name": "Monitoring report",
      "description": "Monitoring report schema",
      "entity": "VC",
      "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "version": "1.0.0",
      "codeVersion": "1.0.0",
      "relationships": [
        "1706823227.586179534"
      ]
    },
    "analytics": {
      "policyIds": [
        "1706823227.586179534"
      ],
      "childSchemas": {
        "id": "1706823227.586179534",
        "name": "Project Details"
      },
      "properties": [
        "ActivityImpactModule.projectScope"
      ],
      "textSearch": "text"
    },
    "documents": [
      "{\"$id\":\"#d0e99e70-3511-486668e-bf6f-10041e9a0cb7669080&1.0.0\",\"$comment\":\"{ \\\"@id\\\": \\\"#d0e99e70-3511-486668e-bf6f-10041e9a0cb7669080&1.0.0\\\", \\\"term\\\": \\\"d0e99e70-3511-486668e-bf6f-10041e9a0cb7669080&1.0.0\\\" }\",\"title\":\"tagSchemaAPI339404\",\"description\":\"tagSchemaAPI339404\",\"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}},\"required\":[\"@context\",\"type\"],\"additionalProperties\":false,\"$defs\":{}}",
      "{\"@context\":{\"@version\":1.1,\"@vocab\":\"https://w3id.org/traceability/#undefinedTerm\",\"id\":\"@id\",\"type\":\"@type\",\"d0e99e70-3511-486668e-bf6f-10041e9a0cb7669080&1.0.0\":{\"@id\":\"#d0e99e70-3511-486668e-bf6f-10041e9a0cb7669080&1.0.0\",\"@context\":{}}}}"
    ]
  },
  "row": {
    "id": "667c240639282050117a1985",
    "consensusTimestamp": "1706823227.586179534",
    "topicId": "0.0.4481265",
    "status": "LOADED",
    "lastUpdate": 1716755852055,
    "message": "eyJpZCI6ImVhYTYyOWZmLWM4NmItNDEyZS1iYzYwLWM4NDk2OTJkMDBiYiIsInN0YXR1cyI6IklTU1VFIiwidHlwZSI6IlN0YW5kYXJkIFJlZ2lzdHJ5IiwiYWN0aW9uIjoiSW5pdCIsImxhbmciOiJlbi1VUyIsImRpZCI6ImRpZDpoZWRlcmE6dGVzdG5ldDpBYkd6Q3hpRzRlZ0xibldCUERpaHdMUVIza0tLcnNGNmJnSDdUdmVGYjI3bl8wLjAuMjE3NiIsInRvcGljSWQiOiIwLjAuMjE3NiIsImF0dHJpYnV0ZXMiOnsiZ2VvZ3JhcGh5IjoidGVzdCIsImxhdyI6InRlc3R0ZXMiLCJ0YWdzIjoidGVzdCJ9fQ",
    "sequenceNumber": 2,
    "owner": "0.0.1914",
    "chunkId": "1706817694.014944860",
    "chunkNumber": 1,
    "chunkTotal": 1,
    "type": "Message",
    "data": "`{\"id\":\"eaa629ff-c86b-412e-bc60-c849692d00bb\",\"status\":\"ISSUE\",\"type\":\"Standard Registry\",\"action\":\"Init\",\"lang\":\"en-US\",\"did\":\"did:hedera:testnet:AbGzCxiG4egLbnWBPDihwLQR3kKKrsF6bgH7TveFb27n_0.0.2176\",\"topicId\":\"0.0.2176\",\"attributes\":{\"geography\":\"test\",\"law\":\"testtes\",\"tags\":\"test\"}}`"
  },
  "activity": {
    "vcs": 10,
    "vps": 10
  }
}

Get schema tree

get

Returns schema tree

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

Schema tree

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

500

Internal server error

application/json

get/entities/schemas/{messageId}/tree

GET /api/v1/entities/schemas/{messageId}/tree HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0,
    "type": "Schema",
    "action": "publish-schema",
    "options": {
      "name": "Monitoring report",
      "description": "Monitoring report schema",
      "entity": "VC",
      "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "version": "1.0.0",
      "codeVersion": "1.0.0",
      "relationships": [
        "1706823227.586179534"
      ]
    }
  },
  "root": {
    "label": "Monitoring Report",
    "expanded": true,
    "data": {
      "id": "1706823227.586179534",
      "color": "#FFFFFF"
    },
    "children": []
  }
}

Get schemas packages

get

Returns schemas packages

Query parameters

pageIndexnumberOptional

Page index

Example: 0

pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp

orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}

keywordsstringOptional

Keywords to search

Example: {"description":"Search schemas packages, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}

topicIdstringOptional

Policy topic identifier

Example: 0.0.1960

options.ownerstringOptional

Schema owner

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265

Responses

200

Schemas

application/json

pageIndexnumberRequired

Page index

Example: 0

pageSizenumberRequired

Page size

Example: 10

totalnumberRequired

Total size

Example: 100

orderobjectRequired

Order

500

Internal server error

application/json

get/entities/schemas-packages

GET /api/v1/entities/schemas-packages HTTP/1.1
Accept: */*

{
  "pageIndex": "0",
  "pageSize": "10",
  "total": "100",
  "order": {},
  "items": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "Schema",
      "action": "publish-schema",
      "options": {
        "name": "Monitoring report",
        "description": "Monitoring report schema",
        "entity": "VC",
        "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
        "version": "1.0.0",
        "codeVersion": "1.0.0",
        "relationships": [
          "1706823227.586179534"
        ]
      }
    }
  ]
}

Get schemas package

get

Returns schemas package

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

Schemas package details

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7

500

Internal server error

application/json

get/entities/schemas-packages/{messageId}

GET /api/v1/entities/schemas-packages/{messageId} HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0,
    "type": "Schema",
    "action": "publish-schema",
    "options": {
      "name": "Monitoring report",
      "description": "Monitoring report schema",
      "entity": "VC",
      "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "version": "1.0.0",
      "codeVersion": "1.0.0",
      "relationships": [
        "1706823227.586179534"
      ]
    },
    "analytics": {
      "policyIds": [
        "1706823227.586179534"
      ],
      "childSchemas": {
        "id": "1706823227.586179534",
        "name": "Project Details"
      },
      "properties": [
        "ActivityImpactModule.projectScope"
      ],
      "textSearch": "text"
    },
    "documents": [
      "{\"$id\":\"#d0e99e70-3511-486668e-bf6f-10041e9a0cb7669080&1.0.0\",\"$comment\":\"{ \\\"@id\\\": \\\"#d0e99e70-3511-486668e-bf6f-10041e9a0cb7669080&1.0.0\\\", \\\"term\\\": \\\"d0e99e70-3511-486668e-bf6f-10041e9a0cb7669080&1.0.0\\\" }\",\"title\":\"tagSchemaAPI339404\",\"description\":\"tagSchemaAPI339404\",\"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}},\"required\":[\"@context\",\"type\"],\"additionalProperties\":false,\"$defs\":{}}",
      "{\"@context\":{\"@version\":1.1,\"@vocab\":\"https://w3id.org/traceability/#undefinedTerm\",\"id\":\"@id\",\"type\":\"@type\",\"d0e99e70-3511-486668e-bf6f-10041e9a0cb7669080&1.0.0\":{\"@id\":\"#d0e99e70-3511-486668e-bf6f-10041e9a0cb7669080&1.0.0\",\"@context\":{}}}}"
    ]
  },
  "row": {
    "id": "667c240639282050117a1985",
    "consensusTimestamp": "1706823227.586179534",
    "topicId": "0.0.4481265",
    "status": "LOADED",
    "lastUpdate": 1716755852055,
    "message": "eyJpZCI6ImVhYTYyOWZmLWM4NmItNDEyZS1iYzYwLWM4NDk2OTJkMDBiYiIsInN0YXR1cyI6IklTU1VFIiwidHlwZSI6IlN0YW5kYXJkIFJlZ2lzdHJ5IiwiYWN0aW9uIjoiSW5pdCIsImxhbmciOiJlbi1VUyIsImRpZCI6ImRpZDpoZWRlcmE6dGVzdG5ldDpBYkd6Q3hpRzRlZ0xibldCUERpaHdMUVIza0tLcnNGNmJnSDdUdmVGYjI3bl8wLjAuMjE3NiIsInRvcGljSWQiOiIwLjAuMjE3NiIsImF0dHJpYnV0ZXMiOnsiZ2VvZ3JhcGh5IjoidGVzdCIsImxhdyI6InRlc3R0ZXMiLCJ0YWdzIjoidGVzdCJ9fQ",
    "sequenceNumber": 2,
    "owner": "0.0.1914",
    "chunkId": "1706817694.014944860",
    "chunkNumber": 1,
    "chunkTotal": 1,
    "type": "Message",
    "data": "`{\"id\":\"eaa629ff-c86b-412e-bc60-c849692d00bb\",\"status\":\"ISSUE\",\"type\":\"Standard Registry\",\"action\":\"Init\",\"lang\":\"en-US\",\"did\":\"did:hedera:testnet:AbGzCxiG4egLbnWBPDihwLQR3kKKrsF6bgH7TveFb27n_0.0.2176\",\"topicId\":\"0.0.2176\",\"attributes\":{\"geography\":\"test\",\"law\":\"testtes\",\"tags\":\"test\"}}`"
  },
  "activity": {
    "schemas": 10
  }
}

Get tokens

get

Returns tokens

Query parameters

pageIndexnumberOptional

Page index

Example: 0

pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp

orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}

tokenIdstringOptional

Token identifier

Example: 0.0.1960

treasurystringOptional

Treasury

Example: 0.0.1960

topicIdstringOptional

Topic identifier

Example: 0.0.1960

Responses

200

Tokens

application/json

pageIndexnumberRequired

Page index

Example: 0

pageSizenumberRequired

Page size

Example: 10

totalnumberRequired

Total size

Example: 100

orderobjectRequired

Order

500

Internal server error

application/json

get/entities/tokens

GET /api/v1/entities/tokens HTTP/1.1
Accept: */*

{
  "pageIndex": "0",
  "pageSize": "10",
  "total": "100",
  "order": {},
  "items": [
    {
      "id": "667c240639282050117a1985",
      "tokenId": "0.0.4481265",
      "status": "UPDATED",
      "lastUpdate": 1716755852055,
      "serialNumber": 1,
      "hasNext": false,
      "name": "iRec Token",
      "symbol": "iRec",
      "type": "NON_FUNGIBLE_UNIQUE",
      "treasury": "0.0.1",
      "memo": "0.0.2952745",
      "totalSupply": "77",
      "decimals": "2"
    }
  ]
}

Get token

get

Returns token

Path parameters

tokenIdstringRequired

Token identifier

Example: 0.0.1960

Responses

200

Token details

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

500

Internal server error

application/json

get/entities/tokens/{tokenId}

GET /api/v1/entities/tokens/{tokenId} HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "row": {
    "id": "667c240639282050117a1985",
    "tokenId": "0.0.4481265",
    "status": "UPDATED",
    "lastUpdate": 1716755852055,
    "serialNumber": 1,
    "hasNext": false,
    "name": "iRec Token",
    "symbol": "iRec",
    "type": "NON_FUNGIBLE_UNIQUE",
    "treasury": "0.0.1",
    "memo": "0.0.2952745",
    "totalSupply": "77",
    "decimals": "2"
  },
  "labels": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "VP-Document",
      "action": "create-vp-document",
      "options": {
        "issuer": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "relationships": [
          "1706823227.586179534"
        ]
      },
      "analytics": {
        "schemaIds": [
          "1706823227.586179534"
        ],
        "schemaNames": [
          "Monitoring Report"
        ],
        "policyId": "1706823227.586179534",
        "textSearch": "text",
        "issuer": "text",
        "tokenId": "text",
        "tokenAmount": "text",
        "labelName": "text",
        "labels": [
          "text"
        ]
      },
      "documents": [
        "\"{\"id\":\"urn:uuid:2c374b67-fda5-4023-97c2-c0782624573f\",\"type\":[\"VerifiablePresentation\"],\"@context\":[\"https://www.w3.org/2018/credentials/v1\"],\"verifiableCredential\":[{\"id\":\"urn:uuid:ff0aecbd-d358-4e5b-b99b-7a87ba38a3b2\",\"type\":[\"VerifiableCredential\"],\"issuer\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438\",\"issuanceDate\":\"2024-02-06T05:40:37.795Z\",\"@context\":[\"https://www.w3.org/2018/credentials/v1\",\"ipfs://bafkreib6arvz7hltf2yqoyb7iqlkrojur7lqqcsuuhvcfvyrtkncm6pqhi\"],\"credentialSubject\":[{\"finalMintAmount\":5,\"policyId\":\"65bc691d2ae9d0f1ef2db3bc\",\"ref\":\"urn:uuid:11b1ad6f-8b4f-4d61-a63a-cc9e6532625f\",\"@context\":[\"ipfs://bafkreib6arvz7hltf2yqoyb7iqlkrojur7lqqcsuuhvcfvyrtkncm6pqhi\"],\"id\":\"urn:uuid:5d253a1d-456a-4fb1-8b45-257e1db2e668\",\"type\":\"601a68c4-66c3-407c-bc88-1b5841e6d1da&1.0.0\"}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:37Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"assertionMethod\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..UvTeKVUVUxH1SFNNoyu_VXf4kFqDIFzFPJaaq5adiSHrBePLQMQv7dM_Fq23z7UGHSmXlodBen1Ujcdi-am5DQ\"}},{\"id\":\"urn:uuid:b76fbd72-48b7-45fb-b152-7ec13d11eafb\",\"type\":[\"VerifiableCredential\"],\"issuer\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438\",\"issuanceDate\":\"2024-02-06T05:40:45.066Z\",\"@context\":[\"https://www.w3.org/2018/credentials/v1\",\"ipfs://bafkreigd6nhj5auxobzu4qzlakzcaizh6wux2gq43qft4rwpri7msn2geu\"],\"credentialSubject\":[{\"date\":\"2024-02-06T05:40:45.021Z\",\"tokenId\":\"0.0.1621155\",\"amount\":\"5\",\"@context\":[\"ipfs://bafkreigd6nhj5auxobzu4qzlakzcaizh6wux2gq43qft4rwpri7msn2geu\"],\"type\":\"MintToken\"}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:45Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"assertionMethod\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..5hWYO3NA0Q9zI0oS1lLOpofQI-DTQVM0sd4GUQV-UUSlBug3EgYYBm7247LCzlCRt9VpYsUh7SxIrsgHzsSRDA\"}}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:45Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"authentication\",\"challenge\":\"123\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..Mu5BaQ34idnqG6d-aMqufQOXcuWHMkv6N9Z2zhBi9Yfd7jU9FFkwi-Xjyf-Kastr7vVWBNLwGxB-bPRf4UEHAg\"}}\""
      ]
    }
  ]
}

Get roles

get

Returns roles

Query parameters

pageIndexnumberOptional

Page index

Example: 0

pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp

orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}

keywordsstringOptional

Keywords to search

Example: {"description":"Search roles, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}

options.issuerstringOptional

Issuer

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265

options.rolestringRequired

analytics.srstringRequired

topicIdstringOptional

Topic identifier

Example: 0.0.1960

analytics.policyIdstringOptional

Policy identifier

Example: 1706823227.586179534

Responses

200

Roles

application/json

pageIndexnumberRequired

Page index

Example: 0

pageSizenumberRequired

Page size

Example: 10

totalnumberRequired

Total size

Example: 100

orderobjectRequired

Order

500

Internal server error

application/json

get/entities/roles

GET /api/v1/entities/roles?options.role=text&analytics.sr=text HTTP/1.1
Accept: */*

{
  "pageIndex": "0",
  "pageSize": "10",
  "total": "100",
  "order": {},
  "items": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "Role-Document",
      "action": "create-vc-document",
      "options": {
        "role": "Registrant",
        "group": "Registrants",
        "issuer": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265"
      },
      "analytics": {
        "policyId": "1706823227.586179534",
        "textSearch": "text"
      }
    }
  ]
}

Get role

get

Returns role

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

Role details

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7

500

Internal server error

application/json

get/entities/roles/{messageId}

GET /api/v1/entities/roles/{messageId} HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0,
    "type": "Role-Document",
    "action": "create-vc-document",
    "options": {
      "role": "Registrant",
      "group": "Registrants",
      "issuer": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265"
    },
    "analytics": {
      "policyId": "1706823227.586179534",
      "textSearch": "text"
    }
  },
  "row": {
    "id": "667c240639282050117a1985",
    "consensusTimestamp": "1706823227.586179534",
    "topicId": "0.0.4481265",
    "status": "LOADED",
    "lastUpdate": 1716755852055,
    "message": "eyJpZCI6ImVhYTYyOWZmLWM4NmItNDEyZS1iYzYwLWM4NDk2OTJkMDBiYiIsInN0YXR1cyI6IklTU1VFIiwidHlwZSI6IlN0YW5kYXJkIFJlZ2lzdHJ5IiwiYWN0aW9uIjoiSW5pdCIsImxhbmciOiJlbi1VUyIsImRpZCI6ImRpZDpoZWRlcmE6dGVzdG5ldDpBYkd6Q3hpRzRlZ0xibldCUERpaHdMUVIza0tLcnNGNmJnSDdUdmVGYjI3bl8wLjAuMjE3NiIsInRvcGljSWQiOiIwLjAuMjE3NiIsImF0dHJpYnV0ZXMiOnsiZ2VvZ3JhcGh5IjoidGVzdCIsImxhdyI6InRlc3R0ZXMiLCJ0YWdzIjoidGVzdCJ9fQ",
    "sequenceNumber": 2,
    "owner": "0.0.1914",
    "chunkId": "1706817694.014944860",
    "chunkNumber": 1,
    "chunkTotal": 1,
    "type": "Message",
    "data": "`{\"id\":\"eaa629ff-c86b-412e-bc60-c849692d00bb\",\"status\":\"ISSUE\",\"type\":\"Standard Registry\",\"action\":\"Init\",\"lang\":\"en-US\",\"did\":\"did:hedera:testnet:AbGzCxiG4egLbnWBPDihwLQR3kKKrsF6bgH7TveFb27n_0.0.2176\",\"topicId\":\"0.0.2176\",\"attributes\":{\"geography\":\"test\",\"law\":\"testtes\",\"tags\":\"test\"}}`"
  },
  "activity": {
    "vcs": 10
  }
}

Get statistics

get

Returns statistics

Query parameters

pageIndexnumberOptional

Page index

Example: 0

pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp

orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}

keywordsstringOptional

Keywords to search

Example: {"description":"Search statistics, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}

topicIdstringOptional

Statistic topic identifier

Example: 0.0.1960

options.ownerstringOptional

Statistic owner

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265

options.policystringOptional

Policy

Example: 1706823227.586179534

Responses

200

Statistics

application/json

pageIndexnumberRequired

Page index

Example: 0

pageSizenumberRequired

Page size

Example: 10

totalnumberRequired

Total size

Example: 100

orderobjectRequired

Order

500

Internal server error

application/json

get/entities/statistics

GET /api/v1/entities/statistics HTTP/1.1
Accept: */*

{
  "pageIndex": "0",
  "pageSize": "10",
  "total": "100",
  "order": {},
  "items": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "Policy-Label",
      "action": "publish-policy-label",
      "options": {
        "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
        "name": "Label Name",
        "description": "Label Description",
        "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "policyTopicId": "0.0.4481265",
        "policyInstanceTopicId": "0.0.4481265"
      },
      "analytics": {}
    }
  ]
}

Get statistic

get

Returns statistic

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

Statistic details

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7

500

Internal server error

application/json

get/entities/statistics/{messageId}

GET /api/v1/entities/statistics/{messageId} HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0,
    "type": "Policy-Label",
    "action": "publish-policy-label",
    "options": {
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "name": "Label Name",
      "description": "Label Description",
      "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
      "policyTopicId": "0.0.4481265",
      "policyInstanceTopicId": "0.0.4481265"
    },
    "analytics": {}
  },
  "row": {
    "id": "667c240639282050117a1985",
    "consensusTimestamp": "1706823227.586179534",
    "topicId": "0.0.4481265",
    "status": "LOADED",
    "lastUpdate": 1716755852055,
    "message": "eyJpZCI6ImVhYTYyOWZmLWM4NmItNDEyZS1iYzYwLWM4NDk2OTJkMDBiYiIsInN0YXR1cyI6IklTU1VFIiwidHlwZSI6IlN0YW5kYXJkIFJlZ2lzdHJ5IiwiYWN0aW9uIjoiSW5pdCIsImxhbmciOiJlbi1VUyIsImRpZCI6ImRpZDpoZWRlcmE6dGVzdG5ldDpBYkd6Q3hpRzRlZ0xibldCUERpaHdMUVIza0tLcnNGNmJnSDdUdmVGYjI3bl8wLjAuMjE3NiIsInRvcGljSWQiOiIwLjAuMjE3NiIsImF0dHJpYnV0ZXMiOnsiZ2VvZ3JhcGh5IjoidGVzdCIsImxhdyI6InRlc3R0ZXMiLCJ0YWdzIjoidGVzdCJ9fQ",
    "sequenceNumber": 2,
    "owner": "0.0.1914",
    "chunkId": "1706817694.014944860",
    "chunkNumber": 1,
    "chunkTotal": 1,
    "type": "Message",
    "data": "`{\"id\":\"eaa629ff-c86b-412e-bc60-c849692d00bb\",\"status\":\"ISSUE\",\"type\":\"Standard Registry\",\"action\":\"Init\",\"lang\":\"en-US\",\"did\":\"did:hedera:testnet:AbGzCxiG4egLbnWBPDihwLQR3kKKrsF6bgH7TveFb27n_0.0.2176\",\"topicId\":\"0.0.2176\",\"attributes\":{\"geography\":\"test\",\"law\":\"testtes\",\"tags\":\"test\"}}`"
  },
  "activity": {
    "schemas": 10,
    "vcs": 10
  }
}

Get VCs

get

Returns VCs

Query parameters

pageIndexnumberOptional

Page index

Example: 0

pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp

orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}

keywordsstringOptional

Keywords to search

Example: {"description":"Search VCs, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}

topicIdstringOptional

Topic identifier

Example: 0.0.1960

options.issuerstringOptional

Issuer

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265

analytics.policyIdstringOptional

Policy identifier

Example: 1706823227.586179534

analytics.schemaIdstringOptional

Schema identifier

Example: 1706823227.586179534

options.relationshipsstringOptional

Relationships

Example: 1706823227.586179534

Responses

200

VCs

application/json

pageIndexnumberRequired

Page index

Example: 0

pageSizenumberRequired

Page size

Example: 10

totalnumberRequired

Total size

Example: 100

orderobjectRequired

Order

500

Internal server error

application/json

get/entities/statistic-documents

GET /api/v1/entities/statistic-documents HTTP/1.1
Accept: */*

{
  "pageIndex": "0",
  "pageSize": "10",
  "total": "100",
  "order": {},
  "items": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "VC-Document",
      "action": "create-vc-document",
      "options": {
        "issuer": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "relationships": [
          "1706823227.586179534"
        ],
        "documentStatus": "Approved",
        "encodedData": true
      },
      "analytics": {
        "policyId": "1706823227.586179534",
        "schemaId": "1706823227.586179534",
        "schemaName": "Monitoring Report",
        "textSearch": "text"
      }
    }
  ]
}

Get labels

get

Returns labels

Query parameters

pageIndexnumberOptional

Page index

Example: 0

pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp

orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}

keywordsstringOptional

Keywords to search

Example: {"description":"Search labels, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}

topicIdstringOptional

Label topic identifier

Example: 0.0.1960

options.ownerstringOptional

Label owner

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265

options.policystringOptional

Policy

Example: 1706823227.586179534

Responses

200

Labels

application/json

pageIndexnumberRequired

Page index

Example: 0

pageSizenumberRequired

Page size

Example: 10

totalnumberRequired

Total size

Example: 100

orderobjectRequired

Order

500

Internal server error

application/json

get/entities/labels

GET /api/v1/entities/labels HTTP/1.1
Accept: */*

{
  "pageIndex": "0",
  "pageSize": "10",
  "total": "100",
  "order": {},
  "items": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "Policy-Label",
      "action": "publish-policy-label",
      "options": {
        "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
        "name": "Label Name",
        "description": "Label Description",
        "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "policyTopicId": "0.0.4481265",
        "policyInstanceTopicId": "0.0.4481265"
      },
      "analytics": {
        "textSearch": "text",
        "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "config": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    }
  ]
}

Get label

get

Returns label

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

Label details

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7

500

Internal server error

application/json

get/entities/labels/{messageId}

GET /api/v1/entities/labels/{messageId} HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0,
    "type": "Policy-Label",
    "action": "publish-policy-label",
    "options": {
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "name": "Label Name",
      "description": "Label Description",
      "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
      "policyTopicId": "0.0.4481265",
      "policyInstanceTopicId": "0.0.4481265"
    },
    "analytics": {
      "textSearch": "text",
      "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  },
  "row": {
    "id": "667c240639282050117a1985",
    "consensusTimestamp": "1706823227.586179534",
    "topicId": "0.0.4481265",
    "status": "LOADED",
    "lastUpdate": 1716755852055,
    "message": "eyJpZCI6ImVhYTYyOWZmLWM4NmItNDEyZS1iYzYwLWM4NDk2OTJkMDBiYiIsInN0YXR1cyI6IklTU1VFIiwidHlwZSI6IlN0YW5kYXJkIFJlZ2lzdHJ5IiwiYWN0aW9uIjoiSW5pdCIsImxhbmciOiJlbi1VUyIsImRpZCI6ImRpZDpoZWRlcmE6dGVzdG5ldDpBYkd6Q3hpRzRlZ0xibldCUERpaHdMUVIza0tLcnNGNmJnSDdUdmVGYjI3bl8wLjAuMjE3NiIsInRvcGljSWQiOiIwLjAuMjE3NiIsImF0dHJpYnV0ZXMiOnsiZ2VvZ3JhcGh5IjoidGVzdCIsImxhdyI6InRlc3R0ZXMiLCJ0YWdzIjoidGVzdCJ9fQ",
    "sequenceNumber": 2,
    "owner": "0.0.1914",
    "chunkId": "1706817694.014944860",
    "chunkNumber": 1,
    "chunkTotal": 1,
    "type": "Message",
    "data": "`{\"id\":\"eaa629ff-c86b-412e-bc60-c849692d00bb\",\"status\":\"ISSUE\",\"type\":\"Standard Registry\",\"action\":\"Init\",\"lang\":\"en-US\",\"did\":\"did:hedera:testnet:AbGzCxiG4egLbnWBPDihwLQR3kKKrsF6bgH7TveFb27n_0.0.2176\",\"topicId\":\"0.0.2176\",\"attributes\":{\"geography\":\"test\",\"law\":\"testtes\",\"tags\":\"test\"}}`"
  },
  "activity": {
    "schemas": 10,
    "vps": 10
  }
}

Get label document

get

Returns label document

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

Label document details

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7

500

Internal server error

application/json

get/entities/label-documents/{messageId}

GET /api/v1/entities/label-documents/{messageId} HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0,
    "type": "VP-Document",
    "action": "create-vp-document",
    "options": {
      "issuer": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
      "relationships": [
        "1706823227.586179534"
      ]
    },
    "analytics": {
      "schemaIds": [
        "1706823227.586179534"
      ],
      "schemaNames": [
        "Monitoring Report"
      ],
      "policyId": "1706823227.586179534",
      "textSearch": "text",
      "issuer": "text",
      "tokenId": "text",
      "tokenAmount": "text",
      "labelName": "text",
      "labels": [
        "text"
      ]
    },
    "documents": [
      "\"{\"id\":\"urn:uuid:2c374b67-fda5-4023-97c2-c0782624573f\",\"type\":[\"VerifiablePresentation\"],\"@context\":[\"https://www.w3.org/2018/credentials/v1\"],\"verifiableCredential\":[{\"id\":\"urn:uuid:ff0aecbd-d358-4e5b-b99b-7a87ba38a3b2\",\"type\":[\"VerifiableCredential\"],\"issuer\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438\",\"issuanceDate\":\"2024-02-06T05:40:37.795Z\",\"@context\":[\"https://www.w3.org/2018/credentials/v1\",\"ipfs://bafkreib6arvz7hltf2yqoyb7iqlkrojur7lqqcsuuhvcfvyrtkncm6pqhi\"],\"credentialSubject\":[{\"finalMintAmount\":5,\"policyId\":\"65bc691d2ae9d0f1ef2db3bc\",\"ref\":\"urn:uuid:11b1ad6f-8b4f-4d61-a63a-cc9e6532625f\",\"@context\":[\"ipfs://bafkreib6arvz7hltf2yqoyb7iqlkrojur7lqqcsuuhvcfvyrtkncm6pqhi\"],\"id\":\"urn:uuid:5d253a1d-456a-4fb1-8b45-257e1db2e668\",\"type\":\"601a68c4-66c3-407c-bc88-1b5841e6d1da&1.0.0\"}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:37Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"assertionMethod\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..UvTeKVUVUxH1SFNNoyu_VXf4kFqDIFzFPJaaq5adiSHrBePLQMQv7dM_Fq23z7UGHSmXlodBen1Ujcdi-am5DQ\"}},{\"id\":\"urn:uuid:b76fbd72-48b7-45fb-b152-7ec13d11eafb\",\"type\":[\"VerifiableCredential\"],\"issuer\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438\",\"issuanceDate\":\"2024-02-06T05:40:45.066Z\",\"@context\":[\"https://www.w3.org/2018/credentials/v1\",\"ipfs://bafkreigd6nhj5auxobzu4qzlakzcaizh6wux2gq43qft4rwpri7msn2geu\"],\"credentialSubject\":[{\"date\":\"2024-02-06T05:40:45.021Z\",\"tokenId\":\"0.0.1621155\",\"amount\":\"5\",\"@context\":[\"ipfs://bafkreigd6nhj5auxobzu4qzlakzcaizh6wux2gq43qft4rwpri7msn2geu\"],\"type\":\"MintToken\"}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:45Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"assertionMethod\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..5hWYO3NA0Q9zI0oS1lLOpofQI-DTQVM0sd4GUQV-UUSlBug3EgYYBm7247LCzlCRt9VpYsUh7SxIrsgHzsSRDA\"}}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:45Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"authentication\",\"challenge\":\"123\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..Mu5BaQ34idnqG6d-aMqufQOXcuWHMkv6N9Z2zhBi9Yfd7jU9FFkwi-Xjyf-Kastr7vVWBNLwGxB-bPRf4UEHAg\"}}\""
    ]
  },
  "row": {
    "id": "667c240639282050117a1985",
    "consensusTimestamp": "1706823227.586179534",
    "topicId": "0.0.4481265",
    "status": "LOADED",
    "lastUpdate": 1716755852055,
    "message": "eyJpZCI6ImVhYTYyOWZmLWM4NmItNDEyZS1iYzYwLWM4NDk2OTJkMDBiYiIsInN0YXR1cyI6IklTU1VFIiwidHlwZSI6IlN0YW5kYXJkIFJlZ2lzdHJ5IiwiYWN0aW9uIjoiSW5pdCIsImxhbmciOiJlbi1VUyIsImRpZCI6ImRpZDpoZWRlcmE6dGVzdG5ldDpBYkd6Q3hpRzRlZ0xibldCUERpaHdMUVIza0tLcnNGNmJnSDdUdmVGYjI3bl8wLjAuMjE3NiIsInRvcGljSWQiOiIwLjAuMjE3NiIsImF0dHJpYnV0ZXMiOnsiZ2VvZ3JhcGh5IjoidGVzdCIsImxhdyI6InRlc3R0ZXMiLCJ0YWdzIjoidGVzdCJ9fQ",
    "sequenceNumber": 2,
    "owner": "0.0.1914",
    "chunkId": "1706817694.014944860",
    "chunkNumber": 1,
    "chunkTotal": 1,
    "type": "Message",
    "data": "`{\"id\":\"eaa629ff-c86b-412e-bc60-c849692d00bb\",\"status\":\"ISSUE\",\"type\":\"Standard Registry\",\"action\":\"Init\",\"lang\":\"en-US\",\"did\":\"did:hedera:testnet:AbGzCxiG4egLbnWBPDihwLQR3kKKrsF6bgH7TveFb27n_0.0.2176\",\"topicId\":\"0.0.2176\",\"attributes\":{\"geography\":\"test\",\"law\":\"testtes\",\"tags\":\"test\"}}`"
  },
  "history": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "VP-Document",
      "action": "create-vp-document",
      "options": {
        "issuer": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "relationships": [
          "1706823227.586179534"
        ]
      },
      "analytics": {
        "schemaIds": [
          "1706823227.586179534"
        ],
        "schemaNames": [
          "Monitoring Report"
        ],
        "policyId": "1706823227.586179534",
        "textSearch": "text",
        "issuer": "text",
        "tokenId": "text",
        "tokenAmount": "text",
        "labelName": "text",
        "labels": [
          "text"
        ]
      },
      "documents": [
        "\"{\"id\":\"urn:uuid:2c374b67-fda5-4023-97c2-c0782624573f\",\"type\":[\"VerifiablePresentation\"],\"@context\":[\"https://www.w3.org/2018/credentials/v1\"],\"verifiableCredential\":[{\"id\":\"urn:uuid:ff0aecbd-d358-4e5b-b99b-7a87ba38a3b2\",\"type\":[\"VerifiableCredential\"],\"issuer\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438\",\"issuanceDate\":\"2024-02-06T05:40:37.795Z\",\"@context\":[\"https://www.w3.org/2018/credentials/v1\",\"ipfs://bafkreib6arvz7hltf2yqoyb7iqlkrojur7lqqcsuuhvcfvyrtkncm6pqhi\"],\"credentialSubject\":[{\"finalMintAmount\":5,\"policyId\":\"65bc691d2ae9d0f1ef2db3bc\",\"ref\":\"urn:uuid:11b1ad6f-8b4f-4d61-a63a-cc9e6532625f\",\"@context\":[\"ipfs://bafkreib6arvz7hltf2yqoyb7iqlkrojur7lqqcsuuhvcfvyrtkncm6pqhi\"],\"id\":\"urn:uuid:5d253a1d-456a-4fb1-8b45-257e1db2e668\",\"type\":\"601a68c4-66c3-407c-bc88-1b5841e6d1da&1.0.0\"}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:37Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"assertionMethod\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..UvTeKVUVUxH1SFNNoyu_VXf4kFqDIFzFPJaaq5adiSHrBePLQMQv7dM_Fq23z7UGHSmXlodBen1Ujcdi-am5DQ\"}},{\"id\":\"urn:uuid:b76fbd72-48b7-45fb-b152-7ec13d11eafb\",\"type\":[\"VerifiableCredential\"],\"issuer\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438\",\"issuanceDate\":\"2024-02-06T05:40:45.066Z\",\"@context\":[\"https://www.w3.org/2018/credentials/v1\",\"ipfs://bafkreigd6nhj5auxobzu4qzlakzcaizh6wux2gq43qft4rwpri7msn2geu\"],\"credentialSubject\":[{\"date\":\"2024-02-06T05:40:45.021Z\",\"tokenId\":\"0.0.1621155\",\"amount\":\"5\",\"@context\":[\"ipfs://bafkreigd6nhj5auxobzu4qzlakzcaizh6wux2gq43qft4rwpri7msn2geu\"],\"type\":\"MintToken\"}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:45Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"assertionMethod\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..5hWYO3NA0Q9zI0oS1lLOpofQI-DTQVM0sd4GUQV-UUSlBug3EgYYBm7247LCzlCRt9VpYsUh7SxIrsgHzsSRDA\"}}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:45Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"authentication\",\"challenge\":\"123\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..Mu5BaQ34idnqG6d-aMqufQOXcuWHMkv6N9Z2zhBi9Yfd7jU9FFkwi-Xjyf-Kastr7vVWBNLwGxB-bPRf4UEHAg\"}}\""
      ]
    }
  ],
  "label": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "VP-Document",
      "action": "create-vp-document",
      "options": {
        "issuer": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "relationships": [
          "1706823227.586179534"
        ]
      },
      "analytics": {
        "schemaIds": [
          "1706823227.586179534"
        ],
        "schemaNames": [
          "Monitoring Report"
        ],
        "policyId": "1706823227.586179534",
        "textSearch": "text",
        "issuer": "text",
        "tokenId": "text",
        "tokenAmount": "text",
        "labelName": "text",
        "labels": [
          "text"
        ]
      },
      "documents": [
        "\"{\"id\":\"urn:uuid:2c374b67-fda5-4023-97c2-c0782624573f\",\"type\":[\"VerifiablePresentation\"],\"@context\":[\"https://www.w3.org/2018/credentials/v1\"],\"verifiableCredential\":[{\"id\":\"urn:uuid:ff0aecbd-d358-4e5b-b99b-7a87ba38a3b2\",\"type\":[\"VerifiableCredential\"],\"issuer\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438\",\"issuanceDate\":\"2024-02-06T05:40:37.795Z\",\"@context\":[\"https://www.w3.org/2018/credentials/v1\",\"ipfs://bafkreib6arvz7hltf2yqoyb7iqlkrojur7lqqcsuuhvcfvyrtkncm6pqhi\"],\"credentialSubject\":[{\"finalMintAmount\":5,\"policyId\":\"65bc691d2ae9d0f1ef2db3bc\",\"ref\":\"urn:uuid:11b1ad6f-8b4f-4d61-a63a-cc9e6532625f\",\"@context\":[\"ipfs://bafkreib6arvz7hltf2yqoyb7iqlkrojur7lqqcsuuhvcfvyrtkncm6pqhi\"],\"id\":\"urn:uuid:5d253a1d-456a-4fb1-8b45-257e1db2e668\",\"type\":\"601a68c4-66c3-407c-bc88-1b5841e6d1da&1.0.0\"}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:37Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"assertionMethod\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..UvTeKVUVUxH1SFNNoyu_VXf4kFqDIFzFPJaaq5adiSHrBePLQMQv7dM_Fq23z7UGHSmXlodBen1Ujcdi-am5DQ\"}},{\"id\":\"urn:uuid:b76fbd72-48b7-45fb-b152-7ec13d11eafb\",\"type\":[\"VerifiableCredential\"],\"issuer\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438\",\"issuanceDate\":\"2024-02-06T05:40:45.066Z\",\"@context\":[\"https://www.w3.org/2018/credentials/v1\",\"ipfs://bafkreigd6nhj5auxobzu4qzlakzcaizh6wux2gq43qft4rwpri7msn2geu\"],\"credentialSubject\":[{\"date\":\"2024-02-06T05:40:45.021Z\",\"tokenId\":\"0.0.1621155\",\"amount\":\"5\",\"@context\":[\"ipfs://bafkreigd6nhj5auxobzu4qzlakzcaizh6wux2gq43qft4rwpri7msn2geu\"],\"type\":\"MintToken\"}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:45Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"assertionMethod\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..5hWYO3NA0Q9zI0oS1lLOpofQI-DTQVM0sd4GUQV-UUSlBug3EgYYBm7247LCzlCRt9VpYsUh7SxIrsgHzsSRDA\"}}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:45Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"authentication\",\"challenge\":\"123\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..Mu5BaQ34idnqG6d-aMqufQOXcuWHMkv6N9Z2zhBi9Yfd7jU9FFkwi-Xjyf-Kastr7vVWBNLwGxB-bPRf4UEHAg\"}}\""
      ]
    }
  ]
}

Get Label Documents

get

Returns Label Documents

Query parameters

pageIndexnumberOptional

Page index

Example: 0

pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp

orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}

keywordsstringOptional

Keywords to search

Example: {"description":"Search VPs, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}

topicIdstringOptional

Topic identifier

Example: 0.0.1960

options.issuerstringOptional

Issuer

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265

analytics.policyIdstringOptional

Policy identifier

Example: 1706823227.586179534

analytics.schemaIdsstringOptional

Schema identifier

Example: 1706823227.586179534

Responses

200

Label Documents

application/json

pageIndexnumberRequired

Page index

Example: 0

pageSizenumberRequired

Page size

Example: 10

totalnumberRequired

Total size

Example: 100

orderobjectRequired

Order

500

Internal server error

application/json

get/entities/label-documents

GET /api/v1/entities/label-documents HTTP/1.1
Accept: */*

{
  "pageIndex": "0",
  "pageSize": "10",
  "total": "100",
  "order": {},
  "items": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "VP-Document",
      "action": "create-vp-document",
      "options": {
        "issuer": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "relationships": [
          "1706823227.586179534"
        ]
      }
    }
  ]
}

Get formulas

get

Returns formulas

Query parameters

pageIndexnumberOptional

Page index

Example: 0

pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp

orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}

keywordsstringOptional

Keywords to search

Example: {"description":"Search formulas, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}

topicIdstringOptional

Policy topic identifier

Example: 0.0.1960

options.ownerstringOptional

formula owner

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265

Responses

200

formulas

application/json

pageIndexnumberRequired

Page index

Example: 0

pageSizenumberRequired

Page size

Example: 10

totalnumberRequired

Total size

Example: 100

orderobjectRequired

Order

500

Internal server error

application/json

get/entities/formulas

GET /api/v1/entities/formulas HTTP/1.1
Accept: */*

{
  "pageIndex": "0",
  "pageSize": "10",
  "total": "100",
  "order": {},
  "items": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "Formula",
      "action": "publish-formula",
      "options": {
        "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
        "name": "Formula Name",
        "description": "Formula Description",
        "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "policyTopicId": "0.0.4481265",
        "policyInstanceTopicId": "0.0.4481265"
      },
      "analytics": {
        "textSearch": "text",
        "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "config": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    }
  ]
}

Get formula

get

Returns formula

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

Formula details

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7

500

Internal server error

application/json

get/entities/formulas/{messageId}

GET /api/v1/entities/formulas/{messageId} HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0,
    "type": "Formula",
    "action": "publish-formula",
    "options": {
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "name": "Formula Name",
      "description": "Formula Description",
      "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
      "policyTopicId": "0.0.4481265",
      "policyInstanceTopicId": "0.0.4481265"
    },
    "analytics": {
      "textSearch": "text",
      "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  },
  "row": {
    "id": "667c240639282050117a1985",
    "consensusTimestamp": "1706823227.586179534",
    "topicId": "0.0.4481265",
    "status": "LOADED",
    "lastUpdate": 1716755852055,
    "message": "eyJpZCI6ImVhYTYyOWZmLWM4NmItNDEyZS1iYzYwLWM4NDk2OTJkMDBiYiIsInN0YXR1cyI6IklTU1VFIiwidHlwZSI6IlN0YW5kYXJkIFJlZ2lzdHJ5IiwiYWN0aW9uIjoiSW5pdCIsImxhbmciOiJlbi1VUyIsImRpZCI6ImRpZDpoZWRlcmE6dGVzdG5ldDpBYkd6Q3hpRzRlZ0xibldCUERpaHdMUVIza0tLcnNGNmJnSDdUdmVGYjI3bl8wLjAuMjE3NiIsInRvcGljSWQiOiIwLjAuMjE3NiIsImF0dHJpYnV0ZXMiOnsiZ2VvZ3JhcGh5IjoidGVzdCIsImxhdyI6InRlc3R0ZXMiLCJ0YWdzIjoidGVzdCJ9fQ",
    "sequenceNumber": 2,
    "owner": "0.0.1914",
    "chunkId": "1706817694.014944860",
    "chunkNumber": 1,
    "chunkTotal": 1,
    "type": "Message",
    "data": "`{\"id\":\"eaa629ff-c86b-412e-bc60-c849692d00bb\",\"status\":\"ISSUE\",\"type\":\"Standard Registry\",\"action\":\"Init\",\"lang\":\"en-US\",\"did\":\"did:hedera:testnet:AbGzCxiG4egLbnWBPDihwLQR3kKKrsF6bgH7TveFb27n_0.0.2176\",\"topicId\":\"0.0.2176\",\"attributes\":{\"geography\":\"test\",\"law\":\"testtes\",\"tags\":\"test\"}}`"
  },
  "activity": {
    "schemas": 10,
    "vps": 10
  }
}

Get formula relationships

get

Returns formula relationships

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

Formula relationships

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

500

Internal server error

application/json

get/entities/formulas/{messageId}/relationships

GET /api/v1/entities/formulas/{messageId}/relationships HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0
  },
  "schemas": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0
    }
  ],
  "formulas": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0
    }
  ]
}

Get DIDs

get

Returns DIDs

Query parameters

pageIndexnumberOptional

Page index

Example: 0

pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp

orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}

keywordsstringOptional

Keywords to search

Example: {"description":"Search DIDs, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}

topicIdstringOptional

Topic identifier

Example: 0.0.1960

options.didstringOptional

DID

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265

Responses

200

DIDs

application/json

pageIndexnumberRequired

Page index

Example: 0

pageSizenumberRequired

Page size

Example: 10

totalnumberRequired

Total size

Example: 100

orderobjectRequired

Order

500

Internal server error

application/json

get/entities/did-documents

GET /api/v1/entities/did-documents HTTP/1.1
Accept: */*

{
  "pageIndex": "0",
  "pageSize": "10",
  "total": "100",
  "order": {},
  "items": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "DID-Document",
      "action": "create-did-document",
      "options": {
        "relationships": [
          "1706823227.586179534"
        ],
        "did": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265"
      },
      "analytics": {
        "textSearch": "text"
      }
    }
  ]
}

Get DID

get

Returns DID

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

DID details

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7

500

Internal server error

application/json

get/entities/did-documents/{messageId}

GET /api/v1/entities/did-documents/{messageId} HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0,
    "type": "DID-Document",
    "action": "create-did-document",
    "options": {
      "relationships": [
        "1706823227.586179534"
      ],
      "did": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265"
    },
    "analytics": {
      "textSearch": "text"
    },
    "documents": [
      "\"{\"@context\":\"https://www.w3.org/ns/did/v1\",\"id\":\"did:hedera:testnet:C37cfiAMHeToXMiy1V5rAVJdhd182QJRGxwsWQpu2dN2_0.0.1533438\",\"verificationMethod\":[{\"id\":\"did:hedera:testnet:C37cfiAMHeToXMiy1V5rAVJdhd182QJRGxwsWQpu2dN2_0.0.1533438#did-root-key\",\"type\":\"Ed25519VerificationKey2018\",\"controller\":\"did:hedera:testnet:C37cfiAMHeToXMiy1V5rAVJdhd182QJRGxwsWQpu2dN2_0.0.1533438\",\"publicKeyBase58\":\"8WkE4uKLN7i9RnzeoUJfxSH9Jw8M1yTzKk6rtwVa6uGP\"},{\"id\":\"did:hedera:testnet:C37cfiAMHeToXMiy1V5rAVJdhd182QJRGxwsWQpu2dN2_0.0.1533438#did-root-key-bbs\",\"type\":\"Bls12381G2Key2020\",\"controller\":\"did:hedera:testnet:C37cfiAMHeToXMiy1V5rAVJdhd182QJRGxwsWQpu2dN2_0.0.1533438\",\"publicKeyBase58\":\"237NDsUq7LAmSMzE6CEBFyuz9s2sscSz2M6cn4zUKPmJ5Q6rMh6SLRGC3EDdna7vSKwHMCGjhCiLKM6qYU7ZeYKRPNnRMcadoJbSQ44SGAAiyrpmhX8aaoTZpMdHmGFVXdqC\"}],\"authentication\":[\"did:hedera:testnet:C37cfiAMHeToXMiy1V5rAVJdhd182QJRGxwsWQpu2dN2_0.0.1533438#did-root-key\"],\"assertionMethod\":[\"#did-root-key\",\"#did-root-key-bbs\"]}\""
    ]
  },
  "row": {
    "id": "667c240639282050117a1985",
    "consensusTimestamp": "1706823227.586179534",
    "topicId": "0.0.4481265",
    "status": "LOADED",
    "lastUpdate": 1716755852055,
    "message": "eyJpZCI6ImVhYTYyOWZmLWM4NmItNDEyZS1iYzYwLWM4NDk2OTJkMDBiYiIsInN0YXR1cyI6IklTU1VFIiwidHlwZSI6IlN0YW5kYXJkIFJlZ2lzdHJ5IiwiYWN0aW9uIjoiSW5pdCIsImxhbmciOiJlbi1VUyIsImRpZCI6ImRpZDpoZWRlcmE6dGVzdG5ldDpBYkd6Q3hpRzRlZ0xibldCUERpaHdMUVIza0tLcnNGNmJnSDdUdmVGYjI3bl8wLjAuMjE3NiIsInRvcGljSWQiOiIwLjAuMjE3NiIsImF0dHJpYnV0ZXMiOnsiZ2VvZ3JhcGh5IjoidGVzdCIsImxhdyI6InRlc3R0ZXMiLCJ0YWdzIjoidGVzdCJ9fQ",
    "sequenceNumber": 2,
    "owner": "0.0.1914",
    "chunkId": "1706817694.014944860",
    "chunkNumber": 1,
    "chunkTotal": 1,
    "type": "Message",
    "data": "`{\"id\":\"eaa629ff-c86b-412e-bc60-c849692d00bb\",\"status\":\"ISSUE\",\"type\":\"Standard Registry\",\"action\":\"Init\",\"lang\":\"en-US\",\"did\":\"did:hedera:testnet:AbGzCxiG4egLbnWBPDihwLQR3kKKrsF6bgH7TveFb27n_0.0.2176\",\"topicId\":\"0.0.2176\",\"attributes\":{\"geography\":\"test\",\"law\":\"testtes\",\"tags\":\"test\"}}`"
  },
  "history": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "DID-Document",
      "action": "create-did-document",
      "options": {
        "relationships": [
          "1706823227.586179534"
        ],
        "did": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265"
      },
      "analytics": {
        "textSearch": "text"
      },
      "documents": [
        "\"{\"@context\":\"https://www.w3.org/ns/did/v1\",\"id\":\"did:hedera:testnet:C37cfiAMHeToXMiy1V5rAVJdhd182QJRGxwsWQpu2dN2_0.0.1533438\",\"verificationMethod\":[{\"id\":\"did:hedera:testnet:C37cfiAMHeToXMiy1V5rAVJdhd182QJRGxwsWQpu2dN2_0.0.1533438#did-root-key\",\"type\":\"Ed25519VerificationKey2018\",\"controller\":\"did:hedera:testnet:C37cfiAMHeToXMiy1V5rAVJdhd182QJRGxwsWQpu2dN2_0.0.1533438\",\"publicKeyBase58\":\"8WkE4uKLN7i9RnzeoUJfxSH9Jw8M1yTzKk6rtwVa6uGP\"},{\"id\":\"did:hedera:testnet:C37cfiAMHeToXMiy1V5rAVJdhd182QJRGxwsWQpu2dN2_0.0.1533438#did-root-key-bbs\",\"type\":\"Bls12381G2Key2020\",\"controller\":\"did:hedera:testnet:C37cfiAMHeToXMiy1V5rAVJdhd182QJRGxwsWQpu2dN2_0.0.1533438\",\"publicKeyBase58\":\"237NDsUq7LAmSMzE6CEBFyuz9s2sscSz2M6cn4zUKPmJ5Q6rMh6SLRGC3EDdna7vSKwHMCGjhCiLKM6qYU7ZeYKRPNnRMcadoJbSQ44SGAAiyrpmhX8aaoTZpMdHmGFVXdqC\"}],\"authentication\":[\"did:hedera:testnet:C37cfiAMHeToXMiy1V5rAVJdhd182QJRGxwsWQpu2dN2_0.0.1533438#did-root-key\"],\"assertionMethod\":[\"#did-root-key\",\"#did-root-key-bbs\"]}\""
      ]
    }
  ]
}

Get DID relationships

get

Returns DID relationships

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

DID relationships

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

categoriesstring[]Required

Categories

Example: [{"name":"Registry"},{"name":"Policy"},{"name":"Schema"},{"name":"Role"},{"name":"VC"},{"name":"VP"},{"name":"Token"}]

500

Internal server error

application/json

get/entities/did-documents/{messageId}/relationships

GET /api/v1/entities/did-documents/{messageId}/relationships HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0
  },
  "target": {
    "id": "1706823227.586179534",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "type": "EVC-Document",
    "category": 1,
    "name": "Monitoring Report Document",
    "tagsCount": 1
  },
  "relationships": [
    {
      "id": "1706823227.586179534",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "type": "EVC-Document",
      "category": 1,
      "name": "Monitoring Report Document",
      "tagsCount": 1
    }
  ],
  "links": [
    {
      "source": "1706823227.586179534",
      "target": "1706823227.586179534"
    }
  ],
  "categories": [
    {
      "name": "Registry"
    },
    {
      "name": "Policy"
    },
    {
      "name": "Schema"
    },
    {
      "name": "Role"
    },
    {
      "name": "VC"
    },
    {
      "name": "VP"
    },
    {
      "name": "Token"
    }
  ]
}

Get VPs

get

Returns VPs

Query parameters

pageIndexnumberOptional

Page index

Example: 0

pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp

orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}

keywordsstringOptional

Keywords to search

Example: {"description":"Search VPs, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}

topicIdstringOptional

Topic identifier

Example: 0.0.1960

options.issuerstringOptional

Issuer

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265

analytics.policyIdstringOptional

Policy identifier

Example: 1706823227.586179534

analytics.schemaIdsstringOptional

Schema identifier

Example: 1706823227.586179534

Responses

200

VPs

application/json

pageIndexnumberRequired

Page index

Example: 0

pageSizenumberRequired

Page size

Example: 10

totalnumberRequired

Total size

Example: 100

orderobjectRequired

Order

500

Internal server error

application/json

get/entities/vp-documents

GET /api/v1/entities/vp-documents HTTP/1.1
Accept: */*

{
  "pageIndex": "0",
  "pageSize": "10",
  "total": "100",
  "order": {},
  "items": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "VP-Document",
      "action": "create-vp-document",
      "options": {
        "issuer": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "relationships": [
          "1706823227.586179534"
        ]
      }
    }
  ]
}

Get VP

get

Returns VP

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

VP details

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7

500

Internal server error

application/json

get/entities/vp-documents/{messageId}

GET /api/v1/entities/vp-documents/{messageId} HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0,
    "type": "VP-Document",
    "action": "create-vp-document",
    "options": {
      "issuer": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
      "relationships": [
        "1706823227.586179534"
      ]
    },
    "analytics": {
      "schemaIds": [
        "1706823227.586179534"
      ],
      "schemaNames": [
        "Monitoring Report"
      ],
      "policyId": "1706823227.586179534",
      "textSearch": "text",
      "issuer": "text",
      "tokenId": "text",
      "tokenAmount": "text",
      "labelName": "text",
      "labels": [
        "text"
      ]
    },
    "documents": [
      "\"{\"id\":\"urn:uuid:2c374b67-fda5-4023-97c2-c0782624573f\",\"type\":[\"VerifiablePresentation\"],\"@context\":[\"https://www.w3.org/2018/credentials/v1\"],\"verifiableCredential\":[{\"id\":\"urn:uuid:ff0aecbd-d358-4e5b-b99b-7a87ba38a3b2\",\"type\":[\"VerifiableCredential\"],\"issuer\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438\",\"issuanceDate\":\"2024-02-06T05:40:37.795Z\",\"@context\":[\"https://www.w3.org/2018/credentials/v1\",\"ipfs://bafkreib6arvz7hltf2yqoyb7iqlkrojur7lqqcsuuhvcfvyrtkncm6pqhi\"],\"credentialSubject\":[{\"finalMintAmount\":5,\"policyId\":\"65bc691d2ae9d0f1ef2db3bc\",\"ref\":\"urn:uuid:11b1ad6f-8b4f-4d61-a63a-cc9e6532625f\",\"@context\":[\"ipfs://bafkreib6arvz7hltf2yqoyb7iqlkrojur7lqqcsuuhvcfvyrtkncm6pqhi\"],\"id\":\"urn:uuid:5d253a1d-456a-4fb1-8b45-257e1db2e668\",\"type\":\"601a68c4-66c3-407c-bc88-1b5841e6d1da&1.0.0\"}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:37Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"assertionMethod\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..UvTeKVUVUxH1SFNNoyu_VXf4kFqDIFzFPJaaq5adiSHrBePLQMQv7dM_Fq23z7UGHSmXlodBen1Ujcdi-am5DQ\"}},{\"id\":\"urn:uuid:b76fbd72-48b7-45fb-b152-7ec13d11eafb\",\"type\":[\"VerifiableCredential\"],\"issuer\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438\",\"issuanceDate\":\"2024-02-06T05:40:45.066Z\",\"@context\":[\"https://www.w3.org/2018/credentials/v1\",\"ipfs://bafkreigd6nhj5auxobzu4qzlakzcaizh6wux2gq43qft4rwpri7msn2geu\"],\"credentialSubject\":[{\"date\":\"2024-02-06T05:40:45.021Z\",\"tokenId\":\"0.0.1621155\",\"amount\":\"5\",\"@context\":[\"ipfs://bafkreigd6nhj5auxobzu4qzlakzcaizh6wux2gq43qft4rwpri7msn2geu\"],\"type\":\"MintToken\"}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:45Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"assertionMethod\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..5hWYO3NA0Q9zI0oS1lLOpofQI-DTQVM0sd4GUQV-UUSlBug3EgYYBm7247LCzlCRt9VpYsUh7SxIrsgHzsSRDA\"}}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:45Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"authentication\",\"challenge\":\"123\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..Mu5BaQ34idnqG6d-aMqufQOXcuWHMkv6N9Z2zhBi9Yfd7jU9FFkwi-Xjyf-Kastr7vVWBNLwGxB-bPRf4UEHAg\"}}\""
    ]
  },
  "row": {
    "id": "667c240639282050117a1985",
    "consensusTimestamp": "1706823227.586179534",
    "topicId": "0.0.4481265",
    "status": "LOADED",
    "lastUpdate": 1716755852055,
    "message": "eyJpZCI6ImVhYTYyOWZmLWM4NmItNDEyZS1iYzYwLWM4NDk2OTJkMDBiYiIsInN0YXR1cyI6IklTU1VFIiwidHlwZSI6IlN0YW5kYXJkIFJlZ2lzdHJ5IiwiYWN0aW9uIjoiSW5pdCIsImxhbmciOiJlbi1VUyIsImRpZCI6ImRpZDpoZWRlcmE6dGVzdG5ldDpBYkd6Q3hpRzRlZ0xibldCUERpaHdMUVIza0tLcnNGNmJnSDdUdmVGYjI3bl8wLjAuMjE3NiIsInRvcGljSWQiOiIwLjAuMjE3NiIsImF0dHJpYnV0ZXMiOnsiZ2VvZ3JhcGh5IjoidGVzdCIsImxhdyI6InRlc3R0ZXMiLCJ0YWdzIjoidGVzdCJ9fQ",
    "sequenceNumber": 2,
    "owner": "0.0.1914",
    "chunkId": "1706817694.014944860",
    "chunkNumber": 1,
    "chunkTotal": 1,
    "type": "Message",
    "data": "`{\"id\":\"eaa629ff-c86b-412e-bc60-c849692d00bb\",\"status\":\"ISSUE\",\"type\":\"Standard Registry\",\"action\":\"Init\",\"lang\":\"en-US\",\"did\":\"did:hedera:testnet:AbGzCxiG4egLbnWBPDihwLQR3kKKrsF6bgH7TveFb27n_0.0.2176\",\"topicId\":\"0.0.2176\",\"attributes\":{\"geography\":\"test\",\"law\":\"testtes\",\"tags\":\"test\"}}`"
  },
  "history": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "VP-Document",
      "action": "create-vp-document",
      "options": {
        "issuer": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "relationships": [
          "1706823227.586179534"
        ]
      },
      "analytics": {
        "schemaIds": [
          "1706823227.586179534"
        ],
        "schemaNames": [
          "Monitoring Report"
        ],
        "policyId": "1706823227.586179534",
        "textSearch": "text",
        "issuer": "text",
        "tokenId": "text",
        "tokenAmount": "text",
        "labelName": "text",
        "labels": [
          "text"
        ]
      },
      "documents": [
        "\"{\"id\":\"urn:uuid:2c374b67-fda5-4023-97c2-c0782624573f\",\"type\":[\"VerifiablePresentation\"],\"@context\":[\"https://www.w3.org/2018/credentials/v1\"],\"verifiableCredential\":[{\"id\":\"urn:uuid:ff0aecbd-d358-4e5b-b99b-7a87ba38a3b2\",\"type\":[\"VerifiableCredential\"],\"issuer\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438\",\"issuanceDate\":\"2024-02-06T05:40:37.795Z\",\"@context\":[\"https://www.w3.org/2018/credentials/v1\",\"ipfs://bafkreib6arvz7hltf2yqoyb7iqlkrojur7lqqcsuuhvcfvyrtkncm6pqhi\"],\"credentialSubject\":[{\"finalMintAmount\":5,\"policyId\":\"65bc691d2ae9d0f1ef2db3bc\",\"ref\":\"urn:uuid:11b1ad6f-8b4f-4d61-a63a-cc9e6532625f\",\"@context\":[\"ipfs://bafkreib6arvz7hltf2yqoyb7iqlkrojur7lqqcsuuhvcfvyrtkncm6pqhi\"],\"id\":\"urn:uuid:5d253a1d-456a-4fb1-8b45-257e1db2e668\",\"type\":\"601a68c4-66c3-407c-bc88-1b5841e6d1da&1.0.0\"}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:37Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"assertionMethod\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..UvTeKVUVUxH1SFNNoyu_VXf4kFqDIFzFPJaaq5adiSHrBePLQMQv7dM_Fq23z7UGHSmXlodBen1Ujcdi-am5DQ\"}},{\"id\":\"urn:uuid:b76fbd72-48b7-45fb-b152-7ec13d11eafb\",\"type\":[\"VerifiableCredential\"],\"issuer\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438\",\"issuanceDate\":\"2024-02-06T05:40:45.066Z\",\"@context\":[\"https://www.w3.org/2018/credentials/v1\",\"ipfs://bafkreigd6nhj5auxobzu4qzlakzcaizh6wux2gq43qft4rwpri7msn2geu\"],\"credentialSubject\":[{\"date\":\"2024-02-06T05:40:45.021Z\",\"tokenId\":\"0.0.1621155\",\"amount\":\"5\",\"@context\":[\"ipfs://bafkreigd6nhj5auxobzu4qzlakzcaizh6wux2gq43qft4rwpri7msn2geu\"],\"type\":\"MintToken\"}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:45Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"assertionMethod\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..5hWYO3NA0Q9zI0oS1lLOpofQI-DTQVM0sd4GUQV-UUSlBug3EgYYBm7247LCzlCRt9VpYsUh7SxIrsgHzsSRDA\"}}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:45Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"authentication\",\"challenge\":\"123\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..Mu5BaQ34idnqG6d-aMqufQOXcuWHMkv6N9Z2zhBi9Yfd7jU9FFkwi-Xjyf-Kastr7vVWBNLwGxB-bPRf4UEHAg\"}}\""
      ]
    }
  ],
  "labels": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "VP-Document",
      "action": "create-vp-document",
      "options": {
        "issuer": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "relationships": [
          "1706823227.586179534"
        ]
      },
      "analytics": {
        "schemaIds": [
          "1706823227.586179534"
        ],
        "schemaNames": [
          "Monitoring Report"
        ],
        "policyId": "1706823227.586179534",
        "textSearch": "text",
        "issuer": "text",
        "tokenId": "text",
        "tokenAmount": "text",
        "labelName": "text",
        "labels": [
          "text"
        ]
      },
      "documents": [
        "\"{\"id\":\"urn:uuid:2c374b67-fda5-4023-97c2-c0782624573f\",\"type\":[\"VerifiablePresentation\"],\"@context\":[\"https://www.w3.org/2018/credentials/v1\"],\"verifiableCredential\":[{\"id\":\"urn:uuid:ff0aecbd-d358-4e5b-b99b-7a87ba38a3b2\",\"type\":[\"VerifiableCredential\"],\"issuer\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438\",\"issuanceDate\":\"2024-02-06T05:40:37.795Z\",\"@context\":[\"https://www.w3.org/2018/credentials/v1\",\"ipfs://bafkreib6arvz7hltf2yqoyb7iqlkrojur7lqqcsuuhvcfvyrtkncm6pqhi\"],\"credentialSubject\":[{\"finalMintAmount\":5,\"policyId\":\"65bc691d2ae9d0f1ef2db3bc\",\"ref\":\"urn:uuid:11b1ad6f-8b4f-4d61-a63a-cc9e6532625f\",\"@context\":[\"ipfs://bafkreib6arvz7hltf2yqoyb7iqlkrojur7lqqcsuuhvcfvyrtkncm6pqhi\"],\"id\":\"urn:uuid:5d253a1d-456a-4fb1-8b45-257e1db2e668\",\"type\":\"601a68c4-66c3-407c-bc88-1b5841e6d1da&1.0.0\"}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:37Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"assertionMethod\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..UvTeKVUVUxH1SFNNoyu_VXf4kFqDIFzFPJaaq5adiSHrBePLQMQv7dM_Fq23z7UGHSmXlodBen1Ujcdi-am5DQ\"}},{\"id\":\"urn:uuid:b76fbd72-48b7-45fb-b152-7ec13d11eafb\",\"type\":[\"VerifiableCredential\"],\"issuer\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438\",\"issuanceDate\":\"2024-02-06T05:40:45.066Z\",\"@context\":[\"https://www.w3.org/2018/credentials/v1\",\"ipfs://bafkreigd6nhj5auxobzu4qzlakzcaizh6wux2gq43qft4rwpri7msn2geu\"],\"credentialSubject\":[{\"date\":\"2024-02-06T05:40:45.021Z\",\"tokenId\":\"0.0.1621155\",\"amount\":\"5\",\"@context\":[\"ipfs://bafkreigd6nhj5auxobzu4qzlakzcaizh6wux2gq43qft4rwpri7msn2geu\"],\"type\":\"MintToken\"}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:45Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"assertionMethod\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..5hWYO3NA0Q9zI0oS1lLOpofQI-DTQVM0sd4GUQV-UUSlBug3EgYYBm7247LCzlCRt9VpYsUh7SxIrsgHzsSRDA\"}}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:45Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"authentication\",\"challenge\":\"123\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..Mu5BaQ34idnqG6d-aMqufQOXcuWHMkv6N9Z2zhBi9Yfd7jU9FFkwi-Xjyf-Kastr7vVWBNLwGxB-bPRf4UEHAg\"}}\""
      ]
    }
  ]
}

Get VP relationships

get

Returns VP relationships

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

VP relationships

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

categoriesstring[]Required

Categories

Example: [{"name":"Registry"},{"name":"Policy"},{"name":"Schema"},{"name":"Role"},{"name":"VC"},{"name":"VP"},{"name":"Token"}]

500

Internal server error

application/json

get/entities/vp-documents/{messageId}/relationships

GET /api/v1/entities/vp-documents/{messageId}/relationships HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0
  },
  "target": {
    "id": "1706823227.586179534",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "type": "EVC-Document",
    "category": 1,
    "name": "Monitoring Report Document",
    "tagsCount": 1
  },
  "relationships": [
    {
      "id": "1706823227.586179534",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "type": "EVC-Document",
      "category": 1,
      "name": "Monitoring Report Document",
      "tagsCount": 1
    }
  ],
  "links": [
    {
      "source": "1706823227.586179534",
      "target": "1706823227.586179534"
    }
  ],
  "categories": [
    {
      "name": "Registry"
    },
    {
      "name": "Policy"
    },
    {
      "name": "Schema"
    },
    {
      "name": "Role"
    },
    {
      "name": "VC"
    },
    {
      "name": "VP"
    },
    {
      "name": "Token"
    }
  ]
}

Get VCs

get

Returns VCs

Query parameters

pageIndexnumberOptional

Page index

Example: 0

pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp

orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}

keywordsstringOptional

Keywords to search

Example: {"description":"Search VCs, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}

topicIdstringOptional

Topic identifier

Example: 0.0.1960

options.issuerstringOptional

Issuer

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265

analytics.policyIdstringOptional

Policy identifier

Example: 1706823227.586179534

analytics.schemaIdstringOptional

Schema identifier

Example: 1706823227.586179534

options.relationshipsstringOptional

Relationships

Example: 1706823227.586179534

Responses

200

VCs

application/json

pageIndexnumberRequired

Page index

Example: 0

pageSizenumberRequired

Page size

Example: 10

totalnumberRequired

Total size

Example: 100

orderobjectRequired

Order

500

Internal server error

application/json

get/entities/vc-documents

GET /api/v1/entities/vc-documents HTTP/1.1
Accept: */*

{
  "pageIndex": "0",
  "pageSize": "10",
  "total": "100",
  "order": {},
  "items": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "VC-Document",
      "action": "create-vc-document",
      "options": {
        "issuer": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "relationships": [
          "1706823227.586179534"
        ],
        "documentStatus": "Approved",
        "encodedData": true
      },
      "analytics": {
        "policyId": "1706823227.586179534",
        "schemaId": "1706823227.586179534",
        "schemaName": "Monitoring Report",
        "textSearch": "text"
      }
    }
  ]
}

Get VC

get

Returns VC

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

VC details

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7

formulasDataobjectRequired

Formulas data

500

Internal server error

application/json

get/entities/vc-documents/{messageId}

GET /api/v1/entities/vc-documents/{messageId} HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0,
    "type": "VC-Document",
    "action": "create-vc-document",
    "options": {
      "issuer": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
      "relationships": [
        "1706823227.586179534"
      ],
      "documentStatus": "Approved",
      "encodedData": true
    },
    "analytics": {
      "policyId": "1706823227.586179534",
      "schemaId": "1706823227.586179534",
      "schemaName": "Monitoring Report",
      "textSearch": "text"
    },
    "documents": [
      "\"{\"id\":\"urn:uuid:229f8416-db6b-4d68-90da-38a5355126f5\",\"type\":[\"VerifiableCredential\"],\"issuer\":\"did:hedera:testnet:4dKeEsD5qLq5DB5KhA6qyh61XMHtm94FdQFTJsDYRaSa_0.0.2195223\",\"issuanceDate\":\"2024-02-02T10:06:53.300Z\",\"@context\":[\"https://www.w3.org/2018/credentials/v1\",\"ipfs://bafkreiam7a2vox6q7yweh4xsebpp4vnonasxlzcdsaxt2cicviax4f7ruq\"],\"credentialSubject\":[{\"@context\":[\"ipfs://bafkreiam7a2vox6q7yweh4xsebpp4vnonasxlzcdsaxt2cicviax4f7ruq\"],\"id\":\"did:hedera:testnet:4dKeEsD5qLq5DB5KhA6qyh61XMHtm94FdQFTJsDYRaSa_0.0.2195223\",\"type\":\"StandardRegistry\"}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-02T10:06:53Z\",\"verificationMethod\":\"did:hedera:testnet:4dKeEsD5qLq5DB5KhA6qyh61XMHtm94FdQFTJsDYRaSa_0.0.2195223#did-root-key\",\"proofPurpose\":\"assertionMethod\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..YElNPdCNkj8wzABUNgWYo3Yge0qrGA2KbxBWDKBzACJJe70ItIZsgbIQUHMnFbcKpXB1cSnHQ-H5WH_7uZ_3CQ\"}}\""
    ]
  },
  "row": {
    "id": "667c240639282050117a1985",
    "consensusTimestamp": "1706823227.586179534",
    "topicId": "0.0.4481265",
    "status": "LOADED",
    "lastUpdate": 1716755852055,
    "message": "eyJpZCI6ImVhYTYyOWZmLWM4NmItNDEyZS1iYzYwLWM4NDk2OTJkMDBiYiIsInN0YXR1cyI6IklTU1VFIiwidHlwZSI6IlN0YW5kYXJkIFJlZ2lzdHJ5IiwiYWN0aW9uIjoiSW5pdCIsImxhbmciOiJlbi1VUyIsImRpZCI6ImRpZDpoZWRlcmE6dGVzdG5ldDpBYkd6Q3hpRzRlZ0xibldCUERpaHdMUVIza0tLcnNGNmJnSDdUdmVGYjI3bl8wLjAuMjE3NiIsInRvcGljSWQiOiIwLjAuMjE3NiIsImF0dHJpYnV0ZXMiOnsiZ2VvZ3JhcGh5IjoidGVzdCIsImxhdyI6InRlc3R0ZXMiLCJ0YWdzIjoidGVzdCJ9fQ",
    "sequenceNumber": 2,
    "owner": "0.0.1914",
    "chunkId": "1706817694.014944860",
    "chunkNumber": 1,
    "chunkTotal": 1,
    "type": "Message",
    "data": "`{\"id\":\"eaa629ff-c86b-412e-bc60-c849692d00bb\",\"status\":\"ISSUE\",\"type\":\"Standard Registry\",\"action\":\"Init\",\"lang\":\"en-US\",\"did\":\"did:hedera:testnet:AbGzCxiG4egLbnWBPDihwLQR3kKKrsF6bgH7TveFb27n_0.0.2176\",\"topicId\":\"0.0.2176\",\"attributes\":{\"geography\":\"test\",\"law\":\"testtes\",\"tags\":\"test\"}}`"
  },
  "history": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "VC-Document",
      "action": "create-vc-document",
      "options": {
        "issuer": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "relationships": [
          "1706823227.586179534"
        ],
        "documentStatus": "Approved",
        "encodedData": true
      },
      "analytics": {
        "policyId": "1706823227.586179534",
        "schemaId": "1706823227.586179534",
        "schemaName": "Monitoring Report",
        "textSearch": "text"
      },
      "documents": [
        "\"{\"id\":\"urn:uuid:229f8416-db6b-4d68-90da-38a5355126f5\",\"type\":[\"VerifiableCredential\"],\"issuer\":\"did:hedera:testnet:4dKeEsD5qLq5DB5KhA6qyh61XMHtm94FdQFTJsDYRaSa_0.0.2195223\",\"issuanceDate\":\"2024-02-02T10:06:53.300Z\",\"@context\":[\"https://www.w3.org/2018/credentials/v1\",\"ipfs://bafkreiam7a2vox6q7yweh4xsebpp4vnonasxlzcdsaxt2cicviax4f7ruq\"],\"credentialSubject\":[{\"@context\":[\"ipfs://bafkreiam7a2vox6q7yweh4xsebpp4vnonasxlzcdsaxt2cicviax4f7ruq\"],\"id\":\"did:hedera:testnet:4dKeEsD5qLq5DB5KhA6qyh61XMHtm94FdQFTJsDYRaSa_0.0.2195223\",\"type\":\"StandardRegistry\"}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-02T10:06:53Z\",\"verificationMethod\":\"did:hedera:testnet:4dKeEsD5qLq5DB5KhA6qyh61XMHtm94FdQFTJsDYRaSa_0.0.2195223#did-root-key\",\"proofPurpose\":\"assertionMethod\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..YElNPdCNkj8wzABUNgWYo3Yge0qrGA2KbxBWDKBzACJJe70ItIZsgbIQUHMnFbcKpXB1cSnHQ-H5WH_7uZ_3CQ\"}}\""
      ]
    }
  ],
  "schema": {
    "$id": "#StandardRegistry",
    "$comment": "{ \"@id\": \"#StandardRegistry\", \"term\": \"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
      },
      "geography": {
        "$comment": "{\"term\": \"geography\", \"@id\": \"https://www.schema.org/text\"}",
        "title": "geography",
        "description": "geography",
        "type": "string",
        "readOnly": false
      },
      "law": {
        "$comment": "{\"term\": \"law\", \"@id\": \"https://www.schema.org/text\"}",
        "title": "law",
        "description": "law",
        "type": "string",
        "readOnly": false
      },
      "tags": {
        "$comment": "{\"term\": \"tags\", \"@id\": \"https://www.schema.org/text\"}",
        "title": "tags",
        "description": "tags",
        "type": "string",
        "readOnly": false
      },
      "ISIC": {
        "$comment": "{\"term\": \"ISIC\", \"@id\": \"https://www.schema.org/text\"}",
        "title": "ISIC",
        "description": "ISIC",
        "type": "string",
        "readOnly": false
      }
    },
    "required": [
      "geography",
      "law",
      "tags"
    ],
    "additionalProperties": false
  },
  "formulasData": {}
}

Get VC relationships

get

Returns VC relationships

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

VC relationships

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

categoriesstring[]Required

Categories

Example: [{"name":"Registry"},{"name":"Policy"},{"name":"Schema"},{"name":"Role"},{"name":"VC"},{"name":"VP"},{"name":"Token"}]

500

Internal server error

application/json

get/entities/vc-documents/{messageId}/relationships

GET /api/v1/entities/vc-documents/{messageId}/relationships HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0
  },
  "target": {
    "id": "1706823227.586179534",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "type": "EVC-Document",
    "category": 1,
    "name": "Monitoring Report Document",
    "tagsCount": 1
  },
  "relationships": [
    {
      "id": "1706823227.586179534",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "type": "EVC-Document",
      "category": 1,
      "name": "Monitoring Report Document",
      "tagsCount": 1
    }
  ],
  "links": [
    {
      "source": "1706823227.586179534",
      "target": "1706823227.586179534"
    }
  ],
  "categories": [
    {
      "name": "Registry"
    },
    {
      "name": "Policy"
    },
    {
      "name": "Schema"
    },
    {
      "name": "Role"
    },
    {
      "name": "VC"
    },
    {
      "name": "VP"
    },
    {
      "name": "Token"
    }
  ]
}

Get VC comments

get

Returns VC comments

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

VC comments

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

categoriesstring[]Required

Categories

Example: [{"name":"Registry"},{"name":"Policy"},{"name":"Schema"},{"name":"Role"},{"name":"VC"},{"name":"VP"},{"name":"Token"}]

500

Internal server error

application/json

get/entities/vc-documents/{messageId}/discussions

GET /api/v1/entities/vc-documents/{messageId}/discussions HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0
  },
  "target": {
    "id": "1706823227.586179534",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "type": "EVC-Document",
    "category": 1,
    "name": "Monitoring Report Document",
    "tagsCount": 1
  },
  "relationships": [
    {
      "id": "1706823227.586179534",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "type": "EVC-Document",
      "category": 1,
      "name": "Monitoring Report Document",
      "tagsCount": 1
    }
  ],
  "links": [
    {
      "source": "1706823227.586179534",
      "target": "1706823227.586179534"
    }
  ],
  "categories": [
    {
      "name": "Registry"
    },
    {
      "name": "Policy"
    },
    {
      "name": "Schema"
    },
    {
      "name": "Role"
    },
    {
      "name": "VC"
    },
    {
      "name": "VP"
    },
    {
      "name": "Token"
    }
  ]
}

Get VC comments

get

Returns VC comments

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

discussionIdstringRequired

Message identifier

Example: 1706823227.586179534

Query parameters

pageIndexnumberRequired

pageSizenumberRequired

Responses

200

VC comments

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

categoriesstring[]Required

Categories

Example: [{"name":"Registry"},{"name":"Policy"},{"name":"Schema"},{"name":"Role"},{"name":"VC"},{"name":"VP"},{"name":"Token"}]

500

Internal server error

application/json

get/entities/vc-documents/{messageId}/discussions/{discussionId}/comments

GET /api/v1/entities/vc-documents/{messageId}/discussions/{discussionId}/comments?pageIndex=1&pageSize=1 HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0
  },
  "target": {
    "id": "1706823227.586179534",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "type": "EVC-Document",
    "category": 1,
    "name": "Monitoring Report Document",
    "tagsCount": 1
  },
  "relationships": [
    {
      "id": "1706823227.586179534",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "type": "EVC-Document",
      "category": 1,
      "name": "Monitoring Report Document",
      "tagsCount": 1
    }
  ],
  "links": [
    {
      "source": "1706823227.586179534",
      "target": "1706823227.586179534"
    }
  ],
  "categories": [
    {
      "name": "Registry"
    },
    {
      "name": "Policy"
    },
    {
      "name": "Schema"
    },
    {
      "name": "Role"
    },
    {
      "name": "VC"
    },
    {
      "name": "VP"
    },
    {
      "name": "Token"
    }
  ]
}

Get NFTs

get

Returns NFTs

Query parameters

pageIndexnumberOptional

Page index

Example: 0

pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp

orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}

tokenIdstringOptional

Token identifier

Example: 0.0.1960

Responses

200

NFTs

application/json

pageIndexnumberRequired

Page index

Example: 0

pageSizenumberRequired

Page size

Example: 10

totalnumberRequired

Total size

Example: 100

orderobjectRequired

Order

500

Internal server error

application/json

get/entities/nfts

GET /api/v1/entities/nfts HTTP/1.1
Accept: */*

{
  "pageIndex": "0",
  "pageSize": "10",
  "total": "100",
  "order": {},
  "items": [
    {
      "id": "667c240639282050117a1985",
      "tokenId": "0.0.4481265",
      "lastUpdate": 1716755852055,
      "serialNumber": 1,
      "metadata": "1706823227.586179534"
    }
  ]
}

Get NFT

get

Returns NFT

Path parameters

tokenIdstringRequired

Token identifier

Example: 0.0.1960

serialNumberstringRequired

Serial number

Example: 1

Responses

200

NFT details

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

historyobject[]Required

NFT transaction history

Example: [{"consensus_timestamp":"1707292471.903596642","nonce":0,"transaction_id":"0.0.1533323-1707292459-175375906","type":"CRYPTOTRANSFER","is_approval":false,"receiver_account_id":"0.0.1842221","sender_account_id":"0.0.1533323"},{"consensus_timestamp":"1707292470.199625477","nonce":0,"transaction_id":"0.0.1533323-1707292458-093221893","type":"TOKENMINT","is_approval":false,"receiver_account_id":"0.0.1533323","sender_account_id":null}]

500

Internal server error

application/json

get/entities/nfts/{tokenId}/{serialNumber}

GET /api/v1/entities/nfts/{tokenId}/{serialNumber} HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "row": {
    "id": "667c240639282050117a1985",
    "tokenId": "0.0.4481265",
    "lastUpdate": 1716755852055,
    "serialNumber": 1,
    "metadata": "1706823227.586179534"
  },
  "history": [
    {
      "consensus_timestamp": "1707292471.903596642",
      "nonce": 0,
      "transaction_id": "0.0.1533323-1707292459-175375906",
      "type": "CRYPTOTRANSFER",
      "is_approval": false,
      "receiver_account_id": "0.0.1842221",
      "sender_account_id": "0.0.1533323"
    },
    {
      "consensus_timestamp": "1707292470.199625477",
      "nonce": 0,
      "transaction_id": "0.0.1533323-1707292458-093221893",
      "type": "TOKENMINT",
      "is_approval": false,
      "receiver_account_id": "0.0.1533323",
      "sender_account_id": null
    }
  ],
  "labels": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "VP-Document",
      "action": "create-vp-document",
      "options": {
        "issuer": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "relationships": [
          "1706823227.586179534"
        ]
      },
      "analytics": {
        "schemaIds": [
          "1706823227.586179534"
        ],
        "schemaNames": [
          "Monitoring Report"
        ],
        "policyId": "1706823227.586179534",
        "textSearch": "text",
        "issuer": "text",
        "tokenId": "text",
        "tokenAmount": "text",
        "labelName": "text",
        "labels": [
          "text"
        ]
      },
      "documents": [
        "\"{\"id\":\"urn:uuid:2c374b67-fda5-4023-97c2-c0782624573f\",\"type\":[\"VerifiablePresentation\"],\"@context\":[\"https://www.w3.org/2018/credentials/v1\"],\"verifiableCredential\":[{\"id\":\"urn:uuid:ff0aecbd-d358-4e5b-b99b-7a87ba38a3b2\",\"type\":[\"VerifiableCredential\"],\"issuer\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438\",\"issuanceDate\":\"2024-02-06T05:40:37.795Z\",\"@context\":[\"https://www.w3.org/2018/credentials/v1\",\"ipfs://bafkreib6arvz7hltf2yqoyb7iqlkrojur7lqqcsuuhvcfvyrtkncm6pqhi\"],\"credentialSubject\":[{\"finalMintAmount\":5,\"policyId\":\"65bc691d2ae9d0f1ef2db3bc\",\"ref\":\"urn:uuid:11b1ad6f-8b4f-4d61-a63a-cc9e6532625f\",\"@context\":[\"ipfs://bafkreib6arvz7hltf2yqoyb7iqlkrojur7lqqcsuuhvcfvyrtkncm6pqhi\"],\"id\":\"urn:uuid:5d253a1d-456a-4fb1-8b45-257e1db2e668\",\"type\":\"601a68c4-66c3-407c-bc88-1b5841e6d1da&1.0.0\"}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:37Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"assertionMethod\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..UvTeKVUVUxH1SFNNoyu_VXf4kFqDIFzFPJaaq5adiSHrBePLQMQv7dM_Fq23z7UGHSmXlodBen1Ujcdi-am5DQ\"}},{\"id\":\"urn:uuid:b76fbd72-48b7-45fb-b152-7ec13d11eafb\",\"type\":[\"VerifiableCredential\"],\"issuer\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438\",\"issuanceDate\":\"2024-02-06T05:40:45.066Z\",\"@context\":[\"https://www.w3.org/2018/credentials/v1\",\"ipfs://bafkreigd6nhj5auxobzu4qzlakzcaizh6wux2gq43qft4rwpri7msn2geu\"],\"credentialSubject\":[{\"date\":\"2024-02-06T05:40:45.021Z\",\"tokenId\":\"0.0.1621155\",\"amount\":\"5\",\"@context\":[\"ipfs://bafkreigd6nhj5auxobzu4qzlakzcaizh6wux2gq43qft4rwpri7msn2geu\"],\"type\":\"MintToken\"}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:45Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"assertionMethod\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..5hWYO3NA0Q9zI0oS1lLOpofQI-DTQVM0sd4GUQV-UUSlBug3EgYYBm7247LCzlCRt9VpYsUh7SxIrsgHzsSRDA\"}}],\"proof\":{\"type\":\"Ed25519Signature2018\",\"created\":\"2024-02-06T05:40:45Z\",\"verificationMethod\":\"did:hedera:testnet:C5YaWT128KGmtivag99VbSeKrzxP8P8H7FbL2KQ9VQEB_0.0.1533438#did-root-key\",\"proofPurpose\":\"authentication\",\"challenge\":\"123\",\"jws\":\"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..Mu5BaQ34idnqG6d-aMqufQOXcuWHMkv6N9Z2zhBi9Yfd7jU9FFkwi-Xjyf-Kastr7vVWBNLwGxB-bPRf4UEHAg\"}}\""
      ]
    }
  ]
}

Get topics

get

Returns topics

Query parameters

pageIndexnumberOptional

Page index

Example: 0

pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp

orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}

keywordsstringOptional

Keywords to search

Example: {"description":"Search topics, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}

options.parentIdstringOptional

Parent topic identifier

Example: 0.0.1960

Responses

200

Topics

application/json

pageIndexnumberRequired

Page index

Example: 0

pageSizenumberRequired

Page size

Example: 10

totalnumberRequired

Total size

Example: 100

orderobjectRequired

Order

500

Internal server error

application/json

get/entities/topics

GET /api/v1/entities/topics HTTP/1.1
Accept: */*

{
  "pageIndex": "0",
  "pageSize": "10",
  "total": "100",
  "order": {},
  "items": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "Topic",
      "action": "create-topic",
      "options": {
        "name": "Policy topic",
        "description": "Verra REDD Policy topic",
        "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
        "messageType": "USER_TOPIC",
        "childId": "0.0.4481265",
        "parentId": "0.0.4481265",
        "rationale": "1706895596.736882433"
      },
      "analytics": {
        "textSearch": "text"
      }
    }
  ]
}

Get topic

get

Returns topic

Path parameters

topicIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

Topic details

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7

500

Internal server error

application/json

get/entities/topics/{topicId}

GET /api/v1/entities/topics/{topicId} HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0,
    "type": "Topic",
    "action": "create-topic",
    "options": {
      "name": "Policy topic",
      "description": "Verra REDD Policy topic",
      "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
      "messageType": "USER_TOPIC",
      "childId": "0.0.4481265",
      "parentId": "0.0.4481265",
      "rationale": "1706895596.736882433"
    },
    "analytics": {
      "textSearch": "text"
    }
  },
  "row": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "lastUpdate": 1716755852055,
    "messages": 25,
    "hasNext": false
  },
  "activity": {
    "registries": 10,
    "topics": 10,
    "policies": 10,
    "tools": 10,
    "modules": 10,
    "tokens": 10,
    "dids": 10,
    "contracts": 10,
    "schemas": 10,
    "vcs": 10,
    "vps": 10,
    "roles": 10
  }
}

Get contracts

get

Returns contracts

Query parameters

pageIndexnumberOptional

Page index

Example: 0

pageSizenumber · max: 100Optional

Page size

orderFieldstringOptional

Order field

Example: consensusTimestamp

orderDirstringOptional

Order direction

Example: {"value":"ASC","description":"Ascending ordering"}

keywordsstringOptional

Keywords to search

Example: {"description":"Search contracts, which are related to specific topic identifier","value":"[\"0.0.1960\"]"}

topicIdstringOptional

Topic identifier

Example: 0.0.1960

ownerstringOptional

Owner

Example: 0.0.2160

Responses

200

Contracts

application/json

pageIndexnumberRequired

Page index

Example: 0

pageSizenumberRequired

Page size

Example: 10

totalnumberRequired

Total size

Example: 100

orderobjectRequired

Order

500

Internal server error

application/json

get/entities/contracts

GET /api/v1/entities/contracts HTTP/1.1
Accept: */*

{
  "pageIndex": "0",
  "pageSize": "10",
  "total": "100",
  "order": {},
  "items": [
    {
      "id": "667c240639282050117a1985",
      "topicId": "0.0.4481265",
      "consensusTimestamp": "1706823227.586179534",
      "owner": "0.0.1",
      "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
      "status": "NEW",
      "statusReason": "Revoked",
      "lang": "en-US",
      "responseType": "str",
      "statusMessage": "text",
      "statusOwner": "text",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "sequenceNumber": 0,
      "type": "Contract",
      "action": "create-contract",
      "options": {
        "contractId": "0.0.4481265",
        "description": "Wipe contract",
        "contractType": "WIPE",
        "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265"
      },
      "analytics": {
        "textSearch": "text"
      }
    }
  ]
}

Get contract

get

Returns contract

Path parameters

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

Responses

200

Contract details

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7

500

Internal server error

application/json

get/entities/contracts/{messageId}

GET /api/v1/entities/contracts/{messageId} HTTP/1.1
Accept: */*

{
  "id": "1706823227.586179534",
  "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
  "item": {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0,
    "type": "Contract",
    "action": "create-contract",
    "options": {
      "contractId": "0.0.4481265",
      "description": "Wipe contract",
      "contractType": "WIPE",
      "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265"
    },
    "analytics": {
      "textSearch": "text"
    }
  },
  "row": {
    "id": "667c240639282050117a1985",
    "consensusTimestamp": "1706823227.586179534",
    "topicId": "0.0.4481265",
    "status": "LOADED",
    "lastUpdate": 1716755852055,
    "message": "eyJpZCI6ImVhYTYyOWZmLWM4NmItNDEyZS1iYzYwLWM4NDk2OTJkMDBiYiIsInN0YXR1cyI6IklTU1VFIiwidHlwZSI6IlN0YW5kYXJkIFJlZ2lzdHJ5IiwiYWN0aW9uIjoiSW5pdCIsImxhbmciOiJlbi1VUyIsImRpZCI6ImRpZDpoZWRlcmE6dGVzdG5ldDpBYkd6Q3hpRzRlZ0xibldCUERpaHdMUVIza0tLcnNGNmJnSDdUdmVGYjI3bl8wLjAuMjE3NiIsInRvcGljSWQiOiIwLjAuMjE3NiIsImF0dHJpYnV0ZXMiOnsiZ2VvZ3JhcGh5IjoidGVzdCIsImxhdyI6InRlc3R0ZXMiLCJ0YWdzIjoidGVzdCJ9fQ",
    "sequenceNumber": 2,
    "owner": "0.0.1914",
    "chunkId": "1706817694.014944860",
    "chunkNumber": 1,
    "chunkTotal": 1,
    "type": "Message",
    "data": "`{\"id\":\"eaa629ff-c86b-412e-bc60-c849692d00bb\",\"status\":\"ISSUE\",\"type\":\"Standard Registry\",\"action\":\"Init\",\"lang\":\"en-US\",\"did\":\"did:hedera:testnet:AbGzCxiG4egLbnWBPDihwLQR3kKKrsF6bgH7TveFb27n_0.0.2176\",\"topicId\":\"0.0.2176\",\"attributes\":{\"geography\":\"test\",\"law\":\"testtes\",\"tags\":\"test\"}}`"
  }
}

Try to load ipfs files

post

Returns ipfs files

Body

messageIdstringRequired

Entity Timestamp

Example: 1706823227.586179534

Responses

200

ipfs files

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

500

Internal server error

application/json

post/entities/update-files

POST /api/v1/entities/update-files HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "messageId": "1706823227.586179534"
}

{
  "id": "1706823227.586179534"
}

Try to unpack schemas

post

Returns schemas

Body

messageIdstringRequired

Entity Timestamp

Example: 1706823227.586179534

Responses

200

Try to unpack schemas

application/json

idstringRequired

Message identifier

Example: 1706823227.586179534

500

Internal server error

application/json

post/entities/unpack-schemas

POST /api/v1/entities/unpack-schemas HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "messageId": "1706823227.586179534"
}

{
  "id": "1706823227.586179534"
}