Documentation/canton-network-docs/Ledger APIProtobufsPackagescom.daml.ledger.api.v2ServicesStateServiceView on canton-network-docs ↗
canton-network-docs/Ledger APIProtobufsPackagescom.daml.ledger.api.v2ServicesStateService

GetActiveContracts

Ledger API›Protobuf›com.daml.ledger.api.v2›GetActiveContracts

com.daml.ledger.api.v2

​
GetActiveContracts

gRPCSince 3.4.0
RPC/com.daml.ledger.api.v2.StateService/GetActiveContracts

​
Protocol Details

​
Inputs

​
GetActiveContractsRequest

active_at_offsetint64
event_formatEventFormat
stream_continuation_tokenbytes

​
Outputs

​
GetActiveContractsResponse

workflow_idstring
active_contractActiveContract
incomplete_unassignedIncompleteUnassigned
incomplete_assignedIncompleteAssigned
stream_continuation_tokenbytes

​
Lifecycle Changes

3.4.0introduced

com.daml.ledger.api.v2.GetActiveContractsRequest

active_at_offsetint64
event_formatEventFormat
stream_continuation_tokenbytes

com.daml.ledger.api.v2.EventFormat

filters_by_partyrepeated map
filters_for_any_partyFilters
verbosebool

com.daml.ledger.api.v2.Filters

cumulativerepeated CumulativeFilter

com.daml.ledger.api.v2.CumulativeFilter

wildcard_filterWildcardFilter
interface_filterInterfaceFilter
template_filterTemplateFilter

com.daml.ledger.api.v2.WildcardFilter

include_created_event_blobbool

com.daml.ledger.api.v2.InterfaceFilter

interface_idIdentifier
include_interface_viewbool
include_created_event_blobbool

com.daml.ledger.api.v2.Identifier

package_idstring
module_namestring
entity_namestring

com.daml.ledger.api.v2.TemplateFilter

template_idIdentifier
include_created_event_blobbool

com.daml.ledger.api.v2.GetActiveContractsResponse

workflow_idstring
active_contractActiveContract
incomplete_unassignedIncompleteUnassigned
incomplete_assignedIncompleteAssigned
stream_continuation_tokenbytes

com.daml.ledger.api.v2.ActiveContract

created_eventCreatedEvent
synchronizer_idstring
reassignment_counteruint64

com.daml.ledger.api.v2.CreatedEvent

offsetint64
node_idint32
contract_idstring
template_idIdentifier
contract_keyValue
contract_key_hashbytes
create_argumentsRecord
created_event_blobbytes
interface_viewsrepeated InterfaceView
witness_partiesrepeated string
signatoriesrepeated string
observersrepeated string
created_atTimestamp
package_namestring
acs_deltabool
representative_package_idstring

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.Record

record_idIdentifier
fieldsrepeated RecordField

com.daml.ledger.api.v2.RecordField

labelstring
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.InterfaceView

interface_idIdentifier
view_statusStatus
view_valueRecord
implementation_package_idstring

com.daml.ledger.api.v2.IncompleteUnassigned

created_eventCreatedEvent
unassigned_eventUnassignedEvent

com.daml.ledger.api.v2.UnassignedEvent

reassignment_idstring
contract_idstring
template_idIdentifier
sourcestring
targetstring
submitterstring
reassignment_counteruint64
assignment_exclusivityTimestamp
witness_partiesrepeated string
package_namestring
offsetint64
node_idint32

com.daml.ledger.api.v2.IncompleteAssigned

assigned_eventAssignedEvent

com.daml.ledger.api.v2.AssignedEvent

sourcestring
targetstring
reassignment_idstring
submitterstring
reassignment_counteruint64
created_eventCreatedEvent
grpcurl
grpcurl
# Add -plaintext if the server is not using TLS.
# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed.
grpcurl \
  -d @ \
  <HOST:PORT> \
  com.daml.ledger.api.v2.StateService/GetActiveContracts <<'EOF'
{
  "activeAtOffset": "0",
  "eventFormat": {
    "filtersByParty": [
      {
        "key": {
          "cumulative": [
            {
              "wildcardFilter": {}
            }
          ]
        }
      }
    ],
    "filtersForAnyParty": {
      "cumulative": [
        {
          "wildcardFilter": {}
        }
      ]
    },
    "verbose": true
  },
  "streamContinuationToken": "BASE64_ENCODED_BYTES"
}
EOF
OKapplication/json
OK
{
  "workflowId": "string",
  "activeContract": {
    "createdEvent": {
      "offset": "0",
      "nodeId": 0,
      "contractId": "string",
      "templateId": {
        "packageId": "string",
        "moduleName": "string",
        "entityName": "string"
      },
      "contractKey": {
        "unit": "string"
      },
      "contractKeyHash": "BASE64_ENCODED_BYTES",
      "createArguments": {
        "recordId": {},
        "fields": [
          {}
        ]
      },
      "createdEventBlob": "BASE64_ENCODED_BYTES"
    },
    "synchronizerId": "string",
    "reassignmentCounter": "0"
  },
  "streamContinuationToken": "BASE64_ENCODED_BYTES"
}