Returns Roles

PreviousReturns Token as per TokenID NextReturns Role as per MessageID

Last updated 3 months ago

Get roles

Returns roles

get

/entities/roles

Query parameters

pageIndexnumber

Page index

Example: 0

pageSizenumber · max: 100

Page size

Example: 10

orderFieldstring

Order field

Example: consensusTimestamp

orderDirstring

Order direction

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

keywordsstring

Keywords to search

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

options.issuerstring

Issuer

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

topicIdstring

Topic identifier

Example: 0.0.1960

analytics.policyIdstring

Policy identifier

Example: 1706823227.586179534

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/entities/roles'

200

500

{
  "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",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ],
      "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"
      }
    }
  ]
}

Roles