Skip to main content
GET

Returns the update with the given update_id. Unlike /v0/updates/{update_id}, this endpoint returns responses that are consistent across different scan instances. Event ids returned by this endpoint are not comparable to event ids returned by /v0/updates. The order of items in events_by_id is not defined.

Path parameters

string
required

Query parameters

object
OpenAPI type: DamlValueEncoding.How daml values should be encoded in the response. “compact_json” is a compact, human-readable JSON encoding. It is the same encoding as the one used in the HTTP JSON API or the JavaScript codegen. “protobuf_json” is a verbose JSON encoding that is more difficult to parse, but contains type information, i.e., the values can be parsed losslessly without having access to the Daml source code. Optional and defaults to “compact_json”.Allowed values: compact_json, protobuf_json.

Responses

200

ok
application/json
UpdateHistoryItem
required
An individual item in the update history. May be a transaction or a contract reassignment.

400

bad request
application/json
string
required

404

not found
application/json
string
required

500

internal server error
application/json
string
required

History

Updated0.6.0

The GET /v1/updates/{update_id} operation changed in this snapshot.

Updated0.5.17

The GET /v1/updates/{update_id} operation changed in this snapshot.

Deprecated0.5.10
Added0.5.10