GetCommandStatus
Documentation Index
Fetch the complete documentation index at: https://docs.canton.network/llms.txt Use this file to discover all available pages before exploring further.
GetCommandStatus
Ledger API
<span class="x2mdx-ref-breadcrumb-separator">›</span>
<a href="/docs/canton/reference-grpc-ledger-api-reference-details">gRPC API</a>
<span class="x2mdx-ref-breadcrumb-separator">›</span>
<a href="/docs/canton/reference-grpc-ledger-api-reference-com-daml-ledger-api-v2-admin">v2.admin</a>
<span class="x2mdx-ref-breadcrumb-separator">›</span>
<span>GetCommandStatus</span>
</div>
<div class="x2mdx-ref-hero">
<p class="x2mdx-ref-eyebrow">com.daml.ledger.api.v2.admin</p>
<h1 class="x2mdx-ref-title">GetCommandStatus</h1>
<div class="x2mdx-ref-badges">
<span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>
<span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
</div>
</div>
<div class="x2mdx-ref-operation-bar">
<span class="x2mdx-ref-operation-method x2mdx-ref-operation-method--rpc">RPC</span>
<code>/com.daml.ledger.api.v2.admin.CommandInspectionService/GetCommandStatus</code>
</div>
## Protocol Details
<dl class="x2mdx-ref-meta-grid">
<div class="x2mdx-ref-meta-item">
<dt>Protocol</dt>
<dd>gRPC</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Service</dt>
<dd>CommandInspectionService</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>RPC</dt>
<dd>GetCommandStatus</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Client stream</dt>
<dd>No</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Server stream</dt>
<dd>No</dd>
</div>
</dl>
## Inputs
<div class="x2mdx-ref-panel">
<div class="x2mdx-ref-panel-head">
<h3>GetCommandStatusRequest</h3>
</div>
<dl class="x2mdx-ref-meta-grid">
<div class="x2mdx-ref-meta-item">
<dt>Message</dt>
<dd>com.daml.ledger.api.v2.admin.GetCommandStatusRequest</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Client stream</dt>
<dd>No</dd>
</div>
</dl>
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">command\_id\_prefix</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">state</code>
<span class="x2mdx-ref-type-badge">CommandState</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">limit</code>
<span class="x2mdx-ref-type-badge">uint32</span>
</div>
</div>
</div>
</div>
## Outputs
<div class="x2mdx-ref-panel">
<div class="x2mdx-ref-panel-head">
<h3>GetCommandStatusResponse</h3>
</div>
<dl class="x2mdx-ref-meta-grid">
<div class="x2mdx-ref-meta-item">
<dt>Message</dt>
<dd>com.daml.ledger.api.v2.admin.GetCommandStatusResponse</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Server stream</dt>
<dd>No</dd>
</div>
</dl>
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">command\_status</code>
<span class="x2mdx-ref-type-badge">repeated CommandStatus</span>
</div>
</div>
</div>
</div>
## Lifecycle Changes
<div class="x2mdx-ref-change-list">
<div class="x2mdx-ref-change-item">
<span class="x2mdx-ref-change-version">3.4.4</span>
<span class="x2mdx-ref-change-detail">introduced</span>
</div>
</div>
## Related Schemas
<AccordionGroup>
<Accordion title="com.daml.ledger.api.v2.admin.GetCommandStatusRequest">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-admin-getcommandstatusrequest">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">command\_id\_prefix</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">state</code>
<span class="x2mdx-ref-type-badge">CommandState</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">limit</code>
<span class="x2mdx-ref-type-badge">uint32</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.admin.CommandState">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-admin-commandstate">
<ul class="x2mdx-ref-enum-list">
<li><code>COMMAND\_STATE\_UNSPECIFIED</code></li>
<li><code>COMMAND\_STATE\_PENDING</code></li>
<li><code>COMMAND\_STATE\_SUCCEEDED</code></li>
<li><code>COMMAND\_STATE\_FAILED</code></li>
</ul>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.admin.GetCommandStatusResponse">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-admin-getcommandstatusresponse">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">command\_status</code>
<span class="x2mdx-ref-type-badge">repeated CommandStatus</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.admin.CommandStatus">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-admin-commandstatus">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">started</code>
<span class="x2mdx-ref-type-badge">Timestamp</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">completed</code>
<span class="x2mdx-ref-type-badge">Timestamp</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">completion</code>
<span class="x2mdx-ref-type-badge">Completion</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">state</code>
<span class="x2mdx-ref-type-badge">CommandState</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">commands</code>
<span class="x2mdx-ref-type-badge">repeated Command</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">request\_statistics</code>
<span class="x2mdx-ref-type-badge">RequestStatistics</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">updates</code>
<span class="x2mdx-ref-type-badge">CommandUpdates</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">synchronizer\_id</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">timings</code>
<span class="x2mdx-ref-type-badge">repeated Timing</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.Completion">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-completion">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">command\_id</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">status</code>
<span class="x2mdx-ref-type-badge">Status</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">update\_id</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">user\_id</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">act\_as</code>
<span class="x2mdx-ref-type-badge">repeated string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">submission\_id</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">deduplication\_offset</code>
<span class="x2mdx-ref-type-badge">int64</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">deduplication\_duration</code>
<span class="x2mdx-ref-type-badge">Duration</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">trace\_context</code>
<span class="x2mdx-ref-type-badge">TraceContext</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">offset</code>
<span class="x2mdx-ref-type-badge">int64</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">synchronizer\_time</code>
<span class="x2mdx-ref-type-badge">SynchronizerTime</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">paid\_traffic\_cost</code>
<span class="x2mdx-ref-type-badge">int64</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.TraceContext">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-tracecontext">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">traceparent</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">tracestate</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.SynchronizerTime">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-synchronizertime">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">synchronizer\_id</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">record\_time</code>
<span class="x2mdx-ref-type-badge">Timestamp</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.Command">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-command">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">create</code>
<span class="x2mdx-ref-type-badge">CreateCommand</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">exercise</code>
<span class="x2mdx-ref-type-badge">ExerciseCommand</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">exercise\_by\_key</code>
<span class="x2mdx-ref-type-badge">ExerciseByKeyCommand</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">create\_and\_exercise</code>
<span class="x2mdx-ref-type-badge">CreateAndExerciseCommand</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.CreateCommand">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-createcommand">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">template\_id</code>
<span class="x2mdx-ref-type-badge">Identifier</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">create\_arguments</code>
<span class="x2mdx-ref-type-badge">Record</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.Identifier">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-identifier">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">package\_id</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">module\_name</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">entity\_name</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.Record">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-record">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">record\_id</code>
<span class="x2mdx-ref-type-badge">Identifier</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">fields</code>
<span class="x2mdx-ref-type-badge">repeated RecordField</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.RecordField">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-recordfield">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">label</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">value</code>
<span class="x2mdx-ref-type-badge">Value</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.Value">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-value">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">unit</code>
<span class="x2mdx-ref-type-badge">Empty</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">bool</code>
<span class="x2mdx-ref-type-badge">bool</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">int64</code>
<span class="x2mdx-ref-type-badge">sint64</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">date</code>
<span class="x2mdx-ref-type-badge">int32</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">timestamp</code>
<span class="x2mdx-ref-type-badge">sfixed64</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">numeric</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">party</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">text</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">contract\_id</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">optional</code>
<span class="x2mdx-ref-type-badge">Optional</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">list</code>
<span class="x2mdx-ref-type-badge">List</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">text\_map</code>
<span class="x2mdx-ref-type-badge">TextMap</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">gen\_map</code>
<span class="x2mdx-ref-type-badge">GenMap</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">record</code>
<span class="x2mdx-ref-type-badge">Record</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">variant</code>
<span class="x2mdx-ref-type-badge">Variant</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">enum</code>
<span class="x2mdx-ref-type-badge">Enum</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.Optional">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-optional">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">value</code>
<span class="x2mdx-ref-type-badge">Value</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.List">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-list">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">elements</code>
<span class="x2mdx-ref-type-badge">repeated Value</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.TextMap">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-textmap">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">entries</code>
<span class="x2mdx-ref-type-badge">repeated Entry</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.TextMap.Entry">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-textmap-entry">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">key</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">value</code>
<span class="x2mdx-ref-type-badge">Value</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.GenMap">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-genmap">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">entries</code>
<span class="x2mdx-ref-type-badge">repeated Entry</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.GenMap.Entry">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-genmap-entry">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">key</code>
<span class="x2mdx-ref-type-badge">Value</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">value</code>
<span class="x2mdx-ref-type-badge">Value</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.Variant">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-variant">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">variant\_id</code>
<span class="x2mdx-ref-type-badge">Identifier</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">constructor</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">value</code>
<span class="x2mdx-ref-type-badge">Value</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.Enum">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-enum">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">enum\_id</code>
<span class="x2mdx-ref-type-badge">Identifier</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">constructor</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.ExerciseCommand">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-exercisecommand">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">template\_id</code>
<span class="x2mdx-ref-type-badge">Identifier</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">contract\_id</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">choice</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">choice\_argument</code>
<span class="x2mdx-ref-type-badge">Value</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.ExerciseByKeyCommand">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-exercisebykeycommand">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">template\_id</code>
<span class="x2mdx-ref-type-badge">Identifier</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">contract\_key</code>
<span class="x2mdx-ref-type-badge">Value</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">choice</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">choice\_argument</code>
<span class="x2mdx-ref-type-badge">Value</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.CreateAndExerciseCommand">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-createandexercisecommand">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">template\_id</code>
<span class="x2mdx-ref-type-badge">Identifier</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">create\_arguments</code>
<span class="x2mdx-ref-type-badge">Record</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">choice</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">choice\_argument</code>
<span class="x2mdx-ref-type-badge">Value</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.admin.RequestStatistics">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-admin-requeststatistics">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">envelopes</code>
<span class="x2mdx-ref-type-badge">uint32</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">request\_size</code>
<span class="x2mdx-ref-type-badge">uint32</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">recipients</code>
<span class="x2mdx-ref-type-badge">uint32</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.admin.CommandUpdates">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-admin-commandupdates">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">created</code>
<span class="x2mdx-ref-type-badge">repeated Contract</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">archived</code>
<span class="x2mdx-ref-type-badge">repeated Contract</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">exercised</code>
<span class="x2mdx-ref-type-badge">uint32</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">fetched</code>
<span class="x2mdx-ref-type-badge">uint32</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">looked\_up\_by\_key</code>
<span class="x2mdx-ref-type-badge">uint32</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.admin.Contract">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-admin-contract">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">template\_id</code>
<span class="x2mdx-ref-type-badge">Identifier</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">contract\_id</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">contract\_key</code>
<span class="x2mdx-ref-type-badge">Value</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.admin.Timing">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-admin-timing">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">description</code>
<span class="x2mdx-ref-type-badge">string</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">duration\_ms</code>
<span class="x2mdx-ref-type-badge">uint32</span>
</div>
</div>
</div>
</div>
</Accordion>
</AccordionGroup>
grpcurl
```bash grpcurl theme={"theme":{"light":"github-light","dark":"github-dark"}}
# 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
```
</div>
</div>
<div className="x2mdx-ref-rail-panel">
<div className="x2mdx-ref-rail-code x2mdx-ref-rail-code--response">
<div className="x2mdx-ref-rail-head">
<span className="x2mdx-ref-rail-heading">OK</span>
<span className="x2mdx-ref-response-label">application/json</span>
</div>
```json OK theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"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"
}
]
}
```
</div>
</div>Mirrored from Canton Network official documentation (CC-BY-4.0) by CC Privacy Club for learning purposes.