Get transaction tree by offset

GET /v2/updates/transaction-tree-by-offset/{offset}

Request

curl --request GET \
  --url 'http://localhost:7575/v2/updates/transaction-tree-by-offset/{offset}' \
  --header 'Authorization: Bearer $TOKEN'

200 response

{
  "transaction": {
    "updateId": "string",
    "commandId": "string",
    "workflowId": "string",
    "effectiveAt": "string",
    "offset": 0,
    "eventsById": {},
    "synchronizerId": "string",
    "traceContext": {},
    "recordTime": "string"
  }
}

JSON Ledger API

Get transaction tree by offset

OpenAPISince 3.4Changed 3.5Remove as of 3.5.0

Get transaction tree by offset. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates/update-by-offset instead.

Protocol Details

Operation IDgetV2UpdatesTransaction-tree-by-offsetOffset

AuthenticationBearer token

Published3.5

Inputs

Path parameters

offset · number · required

OpenAPI type: integer (int64).

Query parameters

parties · string[]

Outputs

200

application/json

transaction · JsTransactionTree · required

Provided for backwards compatibility, it will be removed in the Canton version 3.5.0. Complete view of an on-ledger transaction.

400

text/plain

value · string · required

default

application/json

code · string · required

cause · string · required

correlationId · string

traceId · string

context · Map_String · required

resources · Tuple2_String_String[]

errorCategory · integer (int32) · required

grpcCodeValue · integer (int32)

retryInfo · string

definiteAnswer · boolean

History

Remove as of3.5.0

Changed3.5

The GET /v2/updates/transaction-tree-by-offset/{offset} operation changed in this snapshot.

Deprecated3.4

Introduced3.4

Request

curl --request GET \
  --url 'http://localhost:7575/v2/updates/transaction-tree-by-offset/{offset}' \
  --header 'Authorization: Bearer $TOKEN'

200 response

{
  "transaction": {
    "updateId": "string",
    "commandId": "string",
    "workflowId": "string",
    "effectiveAt": "string",
    "offset": 0,
    "eventsById": {},
    "synchronizerId": "string",
    "traceContext": {},
    "recordTime": "string"
  }
}