Skip to main content
GET

Scan API

Returns the update with the given update_id

OpenAPISince 0.5.10Changed 0.6.0
Returns the update with the given update_id. Unlike /v0/updates/, 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.

Protocol Details

Operation IDgetUpdateByIdV1
Published0.7.4
SpecificationDownload OpenAPI

Inputs

Path parameters

string
required

Query parameters

object
OpenAPI type: DamlValueEncoding.

Outputs

200

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

400

application/json
string
required

404

application/json
string
required

500

application/json
string
required

History

Changed0.6.0

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

Changed0.5.17

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

Deprecated0.5.10
Introduced0.5.10