Navigate

Navigate linked records

get

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

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

200

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.

400

Invalid request. The response is a JSON structure conforming to https://tools.ietf.org/html/rfc7807. It contains an error code and description of the error. - 'errorCode' can be one of: - TX_ID_PARAM_INVALID: Provided transaction id parameter is not a valid blockchain transaction id - LINKS_PARAM_INVALID: Links param is not a nonzero integer or it's absolute value exceeds preconfigured maximum - INVALID_NAVIGATION_TRANSACTION_TYPE: Provided transaction id is not a valid linked record transaction

404

Transaction cannot be read from blockchain. It could either still be in the process of publishing or the miner has rejected it.

500

Internal error occurred. Request should be retried at a later time Response is a JSON structure conforming to https://tools.ietf.org/html/rfc7807

get

GET /api/v1/linkedrecords/{txId}/navigate?links=1 HTTP/1.1
Host: {your-URL}
x-api-key: text
Accept: */*

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