Skip to main content
GET

JSON Ledger API

​
Deprecated Use POST version of this endpoint

OpenAPISince 3.5
Deprecated Use POST version of this endpoint

​
Protocol Details

Operation IDgetV2StateActive-contracts-page
AuthenticationBearer token
Published3.5

​
Inputs

​
Request body

application/json
​
number
OpenAPI type: integer (int64).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
​
object
required
OpenAPI type: EventFormat.A format for events which defines both which events should be included and what data should be computed and included for them. Note that some of the filtering behavior depends on the TransactionShape, which is expected to be specified alongside usages of EventFormat.
​
number
OpenAPI type: integer (int32).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
​
string
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

​
Outputs

​
200

application/json
​
JsGetActiveContractsResponse[]
required
The collection of active contracts for this page response. Required: must be non-empty
​
integer (int64)
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
​
string
If not present this is the last page. If present, this token must be used to get the next page. Optional: can be empty

​
400

text/plain
​
string
required

​
default

application/json
​
string
required
​
string
required
​
string
​
string
​
Map_String
required
​
Tuple2_String_String[]
​
integer (int32)
required
​
integer (int32)
​
string
​
boolean

​
History

Deprecated3.5
Introduced3.5