Documentation/canton-network-docs/Ledger APIgRPC APIPackagesv2ServicesUpdateServiceView on canton-network-docs ↗
canton-network-docs/Ledger APIgRPC APIPackagesv2ServicesUpdateService

GetUpdatesPage

Ledger API›gRPC API›v2›GetUpdatesPage

com.daml.ledger.api.v2

​
GetUpdatesPage

gRPCSince 3.5.1
RPC/com.daml.ledger.api.v2.UpdateService/GetUpdatesPage

​
Protocol Details

​
Inputs

​
GetUpdatesPageRequest

begin_offset_exclusiveint64
end_offset_inclusiveint64
max_page_sizeint32
update_formatUpdateFormat
descending_orderbool
page_tokenbytes

​
Outputs

​
GetUpdatesPageResponse

updatesrepeated GetUpdateResponse
lowest_page_offset_exclusiveint64
highest_page_offset_inclusiveint64
next_page_tokenbytes

​
Lifecycle Changes

3.5.1introduced

com.daml.ledger.api.v2.GetUpdatesPageRequest

begin_offset_exclusiveint64
end_offset_inclusiveint64
max_page_sizeint32
update_formatUpdateFormat
descending_orderbool
page_tokenbytes

com.daml.ledger.api.v2.UpdateFormat

include_transactionsTransactionFormat
include_reassignmentsEventFormat
include_topology_eventsTopologyFormat

com.daml.ledger.api.v2.TransactionFormat

event_formatEventFormat
transaction_shapeTransactionShape

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

  • TRANSACTION_SHAPE_UNSPECIFIED
  • TRANSACTION_SHAPE_ACS_DELTA
  • TRANSACTION_SHAPE_LEDGER_EFFECTS

com.daml.ledger.api.v2.TopologyFormat

include_participant_authorization_eventsParticipantAuthorizationTopologyFormat

com.daml.ledger.api.v2.ParticipantAuthorizationTopologyFormat

partiesrepeated string

com.daml.ledger.api.v2.GetUpdatesPageResponse

updatesrepeated GetUpdateResponse
lowest_page_offset_exclusiveint64
highest_page_offset_inclusiveint64
next_page_tokenbytes

com.daml.ledger.api.v2.GetUpdateResponse

transactionTransaction
reassignmentReassignment
topology_transactionTopologyTransaction

com.daml.ledger.api.v2.Transaction

update_idstring
command_idstring
workflow_idstring
effective_atTimestamp
eventsrepeated Event
offsetint64
synchronizer_idstring
trace_contextTraceContext
record_timeTimestamp
external_transaction_hashbytes
paid_traffic_costint64

com.daml.ledger.api.v2.Event

createdCreatedEvent
archivedArchivedEvent
exercisedExercisedEvent

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

offsetint64
node_idint32
contract_idstring
template_idIdentifier
witness_partiesrepeated string
package_namestring
implemented_interfacesrepeated Identifier

com.daml.ledger.api.v2.ExercisedEvent

offsetint64
node_idint32
contract_idstring
template_idIdentifier
interface_idIdentifier
choicestring
choice_argumentValue
acting_partiesrepeated string
consumingbool
witness_partiesrepeated string
last_descendant_node_idint32
exercise_resultValue
package_namestring
implemented_interfacesrepeated Identifier
acs_deltabool

com.daml.ledger.api.v2.TraceContext

traceparentstring
tracestatestring

com.daml.ledger.api.v2.Reassignment

update_idstring
command_idstring
workflow_idstring
offsetint64
eventsrepeated ReassignmentEvent
trace_contextTraceContext
record_timeTimestamp
synchronizer_idstring
paid_traffic_costint64

com.daml.ledger.api.v2.ReassignmentEvent

unassignedUnassignedEvent
assignedAssignedEvent

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

sourcestring
targetstring
reassignment_idstring
submitterstring
reassignment_counteruint64
created_eventCreatedEvent

com.daml.ledger.api.v2.TopologyTransaction

update_idstring
offsetint64
synchronizer_idstring
record_timeTimestamp
eventsrepeated TopologyEvent
trace_contextTraceContext

com.daml.ledger.api.v2.TopologyEvent

participant_authorization_changedParticipantAuthorizationChanged
participant_authorization_revokedParticipantAuthorizationRevoked
participant_authorization_addedParticipantAuthorizationAdded
participant_authorization_onboardingParticipantAuthorizationOnboarding

com.daml.ledger.api.v2.ParticipantAuthorizationChanged

party_idstring
participant_idstring
participant_permissionParticipantPermission

com.daml.ledger.api.v2.ParticipantPermission

  • PARTICIPANT_PERMISSION_UNSPECIFIED
  • PARTICIPANT_PERMISSION_SUBMISSION
  • PARTICIPANT_PERMISSION_CONFIRMATION
  • PARTICIPANT_PERMISSION_OBSERVATION

com.daml.ledger.api.v2.ParticipantAuthorizationRevoked

party_idstring
participant_idstring

com.daml.ledger.api.v2.ParticipantAuthorizationAdded

party_idstring
participant_idstring
participant_permissionParticipantPermission

com.daml.ledger.api.v2.ParticipantAuthorizationOnboarding

party_idstring
participant_idstring
participant_permissionParticipantPermission
grpcurl
grpcurl
# Add -plaintext if the server is not using TLS.
grpcurl \
  -d @ \
  <HOST:PORT> \
  com.daml.ledger.api.v2.UpdateService/GetUpdatesPage <<'EOF'
{
  "beginOffsetExclusive": "0",
  "endOffsetInclusive": "0",
  "maxPageSize": 0,
  "updateFormat": {
    "includeTransactions": {
      "eventFormat": {
        "filtersByParty": [
          {
            "key": {}
          }
        ],
        "filtersForAnyParty": {},
        "verbose": true
      },
      "transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
    },
    "includeReassignments": {
      "filtersByParty": [
        {
          "key": {
            "cumulative": [
              {}
            ]
          }
        }
      ],
      "filtersForAnyParty": {
        "cumulative": [
          {}
        ]
      },
      "verbose": true
    },
    "includeTopologyEvents": {
      "includeParticipantAuthorizationEvents": {
        "parties": [
          "string"
        ]
      }
    }
  },
  "descendingOrder": true,
  "pageToken": "BASE64_ENCODED_BYTES"
}
EOF
OKapplication/json
OK
{
  "updates": [
    {
      "transaction": {
        "updateId": "string",
        "commandId": "string",
        "workflowId": "string",
        "effectiveAt": "string",
        "events": [
          {
            "created": {}
          }
        ],
        "offset": "0",
        "synchronizerId": "string",
        "traceContext": {
          "traceparent": "string",
          "tracestate": "string"
        }
      }
    }
  ],
  "lowestPageOffsetExclusive": "0",
  "highestPageOffsetInclusive": "0",
  "nextPageToken": "BASE64_ENCODED_BYTES"
}