Skip to main content
POST

JSON Ledger API

Get the create and the consuming exercise event for the contract with the provided ID

OpenAPISince 3.4Changed 3.5
Get the create and the consuming exercise event for the contract with the provided ID. No events will be returned for contracts that have been pruned because they have already been archived before the latest pruning offset. If the contract cannot be found for the request, or all the contract-events are filtered, a CONTRACT_EVENTS_NOT_FOUND error will be raised.

Protocol Details

Operation IDpostV2EventsEvents-by-contract-id
AuthenticationBearer token
Published3.5

Inputs

Request body

application/json
string
required
The contract id being queried. Required
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.

Outputs

200

application/json
JsCreated
JsArchived

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

Changed3.5

The POST /v2/events/events-by-contract-id operation changed in this snapshot.

Introduced3.4