Returns Schemas

PreviousReturns Module as per MessageID NextReturns Schema as per MessageID

Last updated 20 days ago

Was this helpful?

Get schemas

Returns schemas

get

/entities/schemas

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","x-gitbook-description-html":"<p>Ascending ordering</p>"}

keywordsstring

Keywords to search

Example:

{"description":"Search schemas, which are related to specific topic identifier","value":"[\"0.0.1960\"]","x-gitbook-description-html":"<p>Search schemas, which are related to specific topic identifier</p>"}

topicIdstring

Policy topic identifier

Example: 0.0.1960

options.ownerstring

Schema owner

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

Responses

application/json

cURL

JavaScript

Python

HTTP

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

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",
      "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"
        ]
      },
      "type": "Schema",
      "action": "publish-schema",
      "files": [
        "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
      ],
      "topics": [
        "0.0.4481265"
      ],
      "tokens": [
        "0.0.4481265"
      ]
    }
  ]
}

Schemas