Searching Policies

PreviousComparing Policies NextExports Comparison results

Last updated 7 months ago

Search policies.

Search policies. Only users with the Standard Registry role are allowed to make the request.

post

/analytics/search/policies

Authorizations

Body

policyIdstring

Example: 000000000000000000000001

typestring · enum

Example: Local

Options: Owned, Local, Global

ownerstring

Example: #did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001

minVcCountnumber

Example: 0

minVpCountnumber

Example: 0

minTokensCountnumber

Example: 0

textstring

Example: Policy name

thresholdnumber · max: 100

Example: 0

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/analytics/search/policies' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "policyId": "000000000000000000000001"
  }'

200

401

403

451

500

{
  "target": {},
  "result": [
    {
      "type": "Local",
      "id": "000000000000000000000001",
      "topicId": "0.0.1",
      "messageId": "0000000000.000000001",
      "uuid": "00000000-0000-0000-0000-000000000000",
      "name": "Policy name",
      "description": "Policy description",
      "version": "1.0.0",
      "status": "DRAFT",
      "owner": "#did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001",
      "tags": "Tag",
      "vcCount": 0,
      "vpCount": 0,
      "tokensCount": 0,
      "rate": 0
    }
  ]
}

Successful operation.