Lookup an update by its ID

POST /v2/updates/update-by-id

Request

curl --request POST \
  --url 'http://localhost:7575/v2/updates/update-by-id' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"updateId":"string","updateFormat":{"includeTransactions":{},"includeReassignments":{},"includeTopologyEvents":{}}}'

200 response

{
  "update": {}
}

JSON Ledger API

Lookup an update by its ID

OpenAPISince 3.4Changed 3.5

Lookup an update by its ID. If there is no update with this ID, or all the events are filtered, an UPDATE_NOT_FOUND error will be raised.

Protocol Details

Inputs

Request body

application/json

updateId · string · required

The ID of a particular update. Must be a valid LedgerString (as described in value.proto). Required

updateFormat · object · required

OpenAPI type: UpdateFormat.

A format specifying what updates to include and how to render them.

Outputs

200

application/json

update · Update

400

text/plain

value · string · required

default

application/json

code · string · required

cause · string · required

correlationId · string

traceId · string

context · Map_String · required

resources · Tuple2_String_String[]

errorCategory · integer (int32) · required

grpcCodeValue · integer (int32)

retryInfo · string

definiteAnswer · boolean

History

Changed3.5

The POST /v2/updates/update-by-id operation changed in this snapshot.

Introduced3.4

Request

curl --request POST \
  --url 'http://localhost:7575/v2/updates/update-by-id' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"updateId":"string","updateFormat":{"includeTransactions":{},"includeReassignments":{},"includeTopologyEvents":{}}}'

200 response

{
  "update": {}
}