Submits a single composite command, waits for its result, and returns the transaction

POST /v2/commands/submit-and-wait-for-transaction

Request

curl --request POST \
  --url 'http://localhost:7575/v2/commands/submit-and-wait-for-transaction' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"commands":{"commands":[{}],"commandId":"string","actAs":["string"],"userId":"string","readAs":["string"],"workflowId":"string","deduplicationPeriod":{},"minLedgerTimeAbs":"string","minLedgerTimeRel":{},"submissionId":"string","disclosedContracts":[{}],"synchronizerId":"string","packageIdSelectionPreference":["string"],"prefetchContractKeys":[{}],"tapsMaxPasses":0},"transactionFormat":{"eventFormat":{},"transactionShape":"TRANSACTION_SHAPE_UNSPECIFIED"}}'

200 response

{
  "transaction": {
    "updateId": "string",
    "commandId": "string",
    "workflowId": "string",
    "effectiveAt": "string",
    "events": [
      {}
    ],
    "offset": 0,
    "synchronizerId": "string",
    "traceContext": {},
    "recordTime": "string",
    "externalTransactionHash": "string",
    "paidTrafficCost": 0
  }
}

JSON Ledger API

Submits a single composite command, waits for its result, and returns the transaction

OpenAPISince 3.4Changed 3.5

Submits a single composite command, waits for its result, and returns the transaction. Propagates the gRPC error of failed submissions including Daml interpretation errors.

Protocol Details

Inputs

Request body

application/json

commands · object · required

OpenAPI type: JsCommands.

A composite command that groups multiple commands together.

transactionFormat · object

OpenAPI type: TransactionFormat.

A format that specifies what events to include in Daml transactions and what data to compute and include for them.

Outputs

200

application/json

transaction · JsTransaction · required

Filtered view of an on-ledger transaction’s create and archive events.

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

Changed3.5

The POST /v2/commands/submit-and-wait-for-transaction operation changed in this snapshot.

Introduced3.4

Request

curl --request POST \
  --url 'http://localhost:7575/v2/commands/submit-and-wait-for-transaction' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"commands":{"commands":[{}],"commandId":"string","actAs":["string"],"userId":"string","readAs":["string"],"workflowId":"string","deduplicationPeriod":{},"minLedgerTimeAbs":"string","minLedgerTimeRel":{},"submissionId":"string","disclosedContracts":[{}],"synchronizerId":"string","packageIdSelectionPreference":["string"],"prefetchContractKeys":[{}],"tapsMaxPasses":0},"transactionFormat":{"eventFormat":{},"transactionShape":"TRANSACTION_SHAPE_UNSPECIFIED"}}'

200 response

{
  "transaction": {
    "updateId": "string",
    "commandId": "string",
    "workflowId": "string",
    "effectiveAt": "string",
    "events": [
      {}
    ],
    "offset": 0,
    "synchronizerId": "string",
    "traceContext": {},
    "recordTime": "string",
    "externalTransactionHash": "string",
    "paidTrafficCost": 0
  }
}