Update history v1

POST /api/scan/v1/updates

Request

curl --request POST \
  --url 'https://scan.sv-1.global.canton.network.sync.global/api/scan/v1/updates' \
  --header 'Content-Type: application/json' \
  --data '{"after":{"after_migration_id":0,"after_record_time":"string"},"page_size":0,"daml_value_encoding":"compact_json"}'

200 response

{
  "transactions": [
    {}
  ]
}

Scan API

Update history v1

OpenAPISince 0.5.10Changed 0.6.0

Returns the update history in ascending order, paged, from ledger begin or optionally starting after a record time. 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. Updates are ordered lexicographically by (migration id, record time). For a given migration id, each update has a unique record time.

Protocol Details

Operation IDgetUpdateHistoryV1

Published0.7.4

SpecificationDownload OpenAPI

Inputs

Request body

application/json

after · object

OpenAPI type: UpdateHistoryRequestAfter.

page_size · number · required

OpenAPI type: integer (int32).

The maximum number of transactions returned for this request.

daml_value_encoding · 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”.

Outputs

200

application/json

transactions · UpdateHistoryItem[] · required

400

application/json

error · string · required

500

application/json

error · string · required

History

Changed0.6.0

The POST /v1/updates operation changed in this snapshot.

Changed0.5.17

The POST /v1/updates operation changed in this snapshot.

Deprecated0.5.10

Introduced0.5.10

Request

curl --request POST \
  --url 'https://scan.sv-1.global.canton.network.sync.global/api/scan/v1/updates' \
  --header 'Content-Type: application/json' \
  --data '{"after":{"after_migration_id":0,"after_record_time":"string"},"page_size":0,"daml_value_encoding":"compact_json"}'

200 response

{
  "transactions": [
    {}
  ]
}