Sign in

POST /v2/state/active-contracts-page

Returns a page of the snapshot of the active contracts and incomplete (un)assignments at a ledger offset. Once all pages are fetched by repeated calls to GetActiveContractsPage, the client SHOULD begin retrieving updates from the update service, starting at the GetActiveContractsPageResponse.active_at_offset specified in this request. Clients SHOULD NOT assume that the set of active contracts they receive reflects the state at the ledger end.

post/v2/state/active-contracts-page

Request body

activeAtOffsetinteger

The offset at which the snapshot of the active contracts will be computed. Must be no greater than the current ledger end offset. Must be greater than or equal to the last pruning offset. Optional, if defined, it must be a valid absolute offset (positive integer) or ledger begin offset (zero). If zero, the empty set will be returned. If not defined, the current ledger end will be used and it will be populated in the response.

Optional

maxPageSizeinteger

The result page will contain at most max_page_size entries of the respective active contract snapshot. The server might reject max_page_size breaching the server-specified limit. Optional, if not defined, the default will be determined by the server.

Optional

pageTokenstring

To get the next page of the active contracts snapshot, the page_token should be set to the next_page_token of the last GetActiveContractsPageResponse. The page token only works if subsequent requests:

  • are executed on the same participant,
  • use the same active_at_offset and event_format,
  • and the participant's store was not pruned to after the active_at_offset.

If not specified, the first page of the active contracts snapshot will be returned.

Optional: can be empty

Response

activeAtOffsetinteger required

The active_at_offset which was specified in the request, or the calculated active_at_offset from the actual ledger end from at the evaluation of the request.

Required

nextPageTokenstring

If not present this is the last page. If present, this token must be used to get the next page.

Optional: can be empty

Changes

No recorded changes to this endpoint across all 1 revision of this API.