Navigate

Navigate linked records

Get a list of linked record transaction ids, which can be used in GET and VERIFY commands.

get

{your-URL}/api/v1/linkedrecords/{txId}/navigate

Path parameters

txIdstringrequired

The transaction id to navigate from. Using a value other than one returned by the LinkedRecords methods produces undefined behavior.

Query parameters

linksinteger · int32required

The direction and maximum number of links to emit. Positive numbers produce later links, negative number produce earlier links.

Header parameters

x-api-keystringrequired

{your-API-key}

Responses

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '{your-URL}/api/v1/linkedrecords/{txId}/navigate?links=1' \
  --header 'x-api-key: text'

200

400

404

500

200

text/plain

application/json

text/json

text/plain

{
  "endOfLinks": true,
  "txIds": [
    "text"
  ]
}

The response is an application/json structure containing:

• txIds: an array of up to the requested number of transaction ids in the requested direction. Can be empty.
• endOfLinks: true if the last record in the array is the end of the linked records in the requested direction.