Documentation/canton-network-docs/Ledger APIProtobufsPackagescom.daml.ledger.api.v2.adminServicesCommandInspectionServiceView on canton-network-docs ↗
canton-network-docs/Ledger APIProtobufsPackagescom.daml.ledger.api.v2.adminServicesCommandInspectionService

GetCommandStatus

Ledger API›Protobuf›com.daml.ledger.api.v2.admin›GetCommandStatus

com.daml.ledger.api.v2.admin

​
GetCommandStatus

gRPCSince 3.4.0
RPC/com.daml.ledger.api.v2.admin.CommandInspectionService/GetCommandStatus

​
Protocol Details

​
Inputs

​
GetCommandStatusRequest

command_id_prefixstring
stateCommandState
limituint32

​
Outputs

​
GetCommandStatusResponse

command_statusrepeated CommandStatus

​
Lifecycle Changes

3.4.0introduced

com.daml.ledger.api.v2.admin.GetCommandStatusRequest

command_id_prefixstring
stateCommandState
limituint32

com.daml.ledger.api.v2.admin.CommandState

  • COMMAND_STATE_UNSPECIFIED
  • COMMAND_STATE_PENDING
  • COMMAND_STATE_SUCCEEDED
  • COMMAND_STATE_FAILED

com.daml.ledger.api.v2.admin.GetCommandStatusResponse

command_statusrepeated CommandStatus

com.daml.ledger.api.v2.admin.CommandStatus

startedTimestamp
completedTimestamp
completionCompletion
stateCommandState
commandsrepeated Command
request_statisticsRequestStatistics
updatesCommandUpdates
synchronizer_idstring
timingsrepeated Timing

com.daml.ledger.api.v2.Completion

command_idstring
statusStatus
update_idstring
user_idstring
act_asrepeated string
submission_idstring
deduplication_offsetint64
deduplication_durationDuration
trace_contextTraceContext
offsetint64
synchronizer_timeSynchronizerTime
paid_traffic_costint64

com.daml.ledger.api.v2.TraceContext

traceparentstring
tracestatestring

com.daml.ledger.api.v2.SynchronizerTime

synchronizer_idstring
record_timeTimestamp

com.daml.ledger.api.v2.Command

createCreateCommand
exerciseExerciseCommand
exercise_by_keyExerciseByKeyCommand
create_and_exerciseCreateAndExerciseCommand

com.daml.ledger.api.v2.CreateCommand

template_idIdentifier
create_argumentsRecord

com.daml.ledger.api.v2.Identifier

package_idstring
module_namestring
entity_namestring

com.daml.ledger.api.v2.Record

record_idIdentifier
fieldsrepeated RecordField

com.daml.ledger.api.v2.RecordField

labelstring
valueValue

com.daml.ledger.api.v2.Value

unitEmpty
boolbool
int64sint64
dateint32
timestampsfixed64
numericstring
partystring
textstring
contract_idstring
optionalOptional
listList
text_mapTextMap
gen_mapGenMap
recordRecord
variantVariant
enumEnum

com.daml.ledger.api.v2.Optional

valueValue

com.daml.ledger.api.v2.List

elementsrepeated Value

com.daml.ledger.api.v2.TextMap

entriesrepeated Entry

com.daml.ledger.api.v2.TextMap.Entry

keystring
valueValue

com.daml.ledger.api.v2.GenMap

entriesrepeated Entry

com.daml.ledger.api.v2.GenMap.Entry

keyValue
valueValue

com.daml.ledger.api.v2.Variant

variant_idIdentifier
constructorstring
valueValue

com.daml.ledger.api.v2.Enum

enum_idIdentifier
constructorstring

com.daml.ledger.api.v2.ExerciseCommand

template_idIdentifier
contract_idstring
choicestring
choice_argumentValue

com.daml.ledger.api.v2.ExerciseByKeyCommand

template_idIdentifier
contract_keyValue
choicestring
choice_argumentValue

com.daml.ledger.api.v2.CreateAndExerciseCommand

template_idIdentifier
create_argumentsRecord
choicestring
choice_argumentValue

com.daml.ledger.api.v2.admin.RequestStatistics

envelopesuint32
request_sizeuint32
recipientsuint32

com.daml.ledger.api.v2.admin.CommandUpdates

createdrepeated Contract
archivedrepeated Contract
exerciseduint32
fetcheduint32
looked_up_by_keyuint32

com.daml.ledger.api.v2.admin.Contract

template_idIdentifier
contract_idstring
contract_keyValue

com.daml.ledger.api.v2.admin.Timing

descriptionstring
duration_msuint32
grpcurl
grpcurl
# Add -plaintext if the server is not using TLS.
grpcurl \
  -d @ \
  <HOST:PORT> \
  com.daml.ledger.api.v2.admin.CommandInspectionService/GetCommandStatus <<'EOF'
{
  "commandIdPrefix": "string",
  "state": "COMMAND_STATE_UNSPECIFIED",
  "limit": 0
}
EOF
OKapplication/json
OK
{
  "commandStatus": [
    {
      "started": "string",
      "completed": "string",
      "completion": {
        "commandId": "string",
        "status": "string",
        "updateId": "string",
        "userId": "string",
        "actAs": [
          "string"
        ],
        "submissionId": "string",
        "deduplicationOffset": "0"
      },
      "state": "COMMAND_STATE_UNSPECIFIED",
      "commands": [
        {
          "create": {
            "templateId": {},
            "createArguments": {}
          }
        }
      ],
      "requestStatistics": {
        "envelopes": 0,
        "requestSize": 0,
        "recipients": 0
      },
      "updates": {
        "created": [
          {
            "templateId": {},
            "contractId": "string",
            "contractKey": {}
          }
        ],
        "archived": [
          {
            "templateId": {},
            "contractId": "string",
            "contractKey": {}
          }
        ],
        "exercised": 0,
        "fetched": 0,
        "lookedUpByKey": 0
      },
      "synchronizerId": "string"
    }
  ]
}