Skip to main content
POST

Scan API

​
Acs snapshot at v2

OpenAPIAdded 0.7.5
Returns the ACS in creation date ascending order, paged, for a given migration id and record time. Unlike /v0/state/acs, every contract is identified by an (optional) update_id (as opposed to the event ID in /v0/state/acs, which was not BFT-safe). The update_id is the ID of the update in which the contract was created, and can be used to correlate with updates returned by /v2/updates.

​
Protocol Details

Operation IDgetAcsSnapshotAtV2
Published0.7.5
SpecificationDownload OpenAPI

​
Inputs

​
Request body

application/json
​
number
required
OpenAPI type: integer (int64).The migration id for which to return the ACS.
​
string
required
OpenAPI type: string (date-time).The timestamp at which the contract set was active. This needs to be an exact timestamp, i.e., needs to correspond to a timestamp reported by /v0/state/acs/snapshot-timestamp if record_time_match is set to exact (which is the default). If record_time_match is set to at_or_before, this can be any timestamp, and the most recent snapshot at or before the given record_time will be returned.
​
string
default:"exact"
How to match the record_time. “exact” requires the record_time to match exactly. “at_or_before” finds the most recent snapshot at or before the given record_time.
​
string
Pagination token for the next page of results. For this to be valid, this must be the next_page_token from a prior request with identical parameters aside from after and page_size; the response may be invalid otherwise. This token is opaque and not meant to be edited by users.
​
number
required
OpenAPI type: integer (int32).The maximum number of created events returned for this request.
​
string[]
Filters the ACS by contracts in which these party IDs are stakeholders.
​
string[]
Filters the ACS by contracts with these template IDs, specified as “PACKAGE_NAME:MODULE_NAME:ENTITY_NAME”.

​
Outputs

​
200

application/json
​
string (date-time)
required
The same record_time as in the request.
​
integer (int64)
required
The same migration_id as in the request.
​
ActiveContract[]
required
Up to page_size contracts in the ACS. create_arguments are always encoded as compact_json.
​
string
When requesting the next page of results, pass this as after to the AcsRequestV2 or HoldingsStateRequestV2. Will be absent when there are no more pages. This token is opaque and not meant to be edited by users.

​
400

application/json
​
string
required

​
404

application/json
​
string
required

​
500

application/json
​
string
required

​
History

Added0.7.5