Documentation

Back to package com.daml.ledger.javaapi.data Variant Java Package com.daml.ledger.javaapi.data Upstream docs Open Javadoc Signature public final class Variant extends Value Members Member | Lifecycle | Upstream docs | Variant(Identifier, String, Value) | - | Open | Varia

Back to package com.daml.ledger.javaapi.data WorkflowEvent A Ledger event regarding a workflow identified by the getWorkflowId(). Java Package com.daml.ledger.javaapi.data Upstream docs Open Javadoc Signature public interface WorkflowEvent Members Member | Lifecycle | Upstream

Back to package com.daml.ledger.javaapi.data Value Java Package com.daml.ledger.javaapi.data Upstream docs Open Javadoc Signature public abstract class Value extends Object Members Member | Lifecycle | Upstream docs | Value() | - | Open | asBool() | - | Open | asCont

Back to overview AsyncAPI Channel /v2/updates Read the ledger’s filtered update stream for the specified contents and filters. It returns the event types in accordance with the stream contents selected. Also the selection c… WebSocket Updated 3.5 Channel /v2/updates Actions publish, subscrib

Back to overview AsyncAPI Channel /v2/commands/command-completions Subscribe to command completion events. This streaming endpoint provides more flexibility in filtering than the predecessor CompletionStream. WebSocket Added 3.5 Channel /v2/commands/command-completions Actions publish, sub

Back to package com.daml.ledger.javaapi.data User.Right.IdentityProviderAdmin Java Package com.daml.ledger.javaapi.data Upstream docs Open Javadoc Signature public static final class User.Right.IdentityProviderAdmin extends User.Right Members Member | Lifecycle | Upstream docs

Back to package com.daml.ledger.javaapi.data User.Right.ParticipantAdmin Java Package com.daml.ledger.javaapi.data Upstream docs Open Javadoc Signature public static final class User.Right.ParticipantAdmin extends User.Right Members Member | Lifecycle | Upstream docs | INSTA

Back to package com.daml.ledger.javaapi.data User Java Package com.daml.ledger.javaapi.data Upstream docs Open Javadoc Signature public final class User extends Object Members Member | Lifecycle | Upstream docs | User(String) | - | Open | User(String, Optional<String>, b

Back to package com.daml.ledger.javaapi.data User.Right Java Package com.daml.ledger.javaapi.data Upstream docs Open Javadoc Signature public abstract static class User.Right extends Object Members Member | Lifecycle | Upstream docs | Right() | - | Open | fromProto(UserM

Back to overview AsyncAPI Channel /v2/commands/completions Deprecated: please use GetCompletions instead. Subscribe to command completion events. WebSocket Updated 3.5 Channel /v2/commands/completions Actions publish, subscribe Actions Deprecated: please use GetCompletions instead. S

Back to package com.daml.ledger.javaapi.data Utils Java Package com.daml.ledger.javaapi.data Upstream docs Open Javadoc Signature public class Utils extends Object Members Member | Lifecycle | Upstream docs | durationFromProto(Duration) | - | Open | durationToProto(Durat

Back to overview AsyncAPI Channel /v2/state/active-contracts Returns a stream of the snapshot of the active contracts and incomplete (un)assignments at a ledger offset. Once the stream of GetActiveContractsResponses completes, the client… WebSocket Updated 3.5 Channel /v2/state/active-contrac

Back to overview AsyncAPI Channel /v2/updates/trees Get update transactions tree stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. WebSocket Updated 3.5 Channel /v2/updates/trees Actions publish, subscribe Actions Get up

JSON API AsyncAPI › /v2/commands/command-completions › subscribe /v2/commands/command-completions Subscribe command completions WebSocket Added 3.5 SUBSCRIBE /v2/commands/command-completions Subscribe to command completion events. This streaming endpoint provides more flexibility in filteri

JSON API AsyncAPI › /v2/commands/command-completions › publish /v2/commands/command-completions Publish command completions WebSocket Added 3.5 PUBLISH /v2/commands/command-completions Subscribe to command completion events. This streaming endpoint provides more flexibility in filtering tha

JSON API AsyncAPI › /v2/commands/completions › publish /v2/commands/completions Publish completions WebSocket Updated 3.5 PUBLISH /v2/commands/completions Deprecated: please use GetCompletions instead. Subscribe to command completion events. Protocol Details Protocol WebSocket Channel

JSON API AsyncAPI › /v2/updates/flats › subscribe /v2/updates/flats Subscribe flats WebSocket Updated 3.5 SUBSCRIBE /v2/updates/flats Get flat transactions update stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. Protocol

AsyncAPI Reference JSON API AsyncAPI Reference Operation-first WebSocket reference pages built from AsyncAPI channel snapshots and lifecycle deltas. AsyncAPI 3.5 Publish version 3.5 AsyncAPI version 2.6.0 Source Canton release bundle JSON Ledger API AsyncAPI fixtures Version filter configure

JSON API AsyncAPI › /v2/updates/flats › publish /v2/updates/flats Publish flats WebSocket Updated 3.5 PUBLISH /v2/updates/flats Get flat transactions update stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. Protocol Detai

Back to overview AsyncAPI Channel /v2/updates/flats Get flat transactions update stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. WebSocket Updated 3.5 Channel /v2/updates/flats Actions publish, subscribe Actions Get fl

JSON API AsyncAPI › /v2/state/active-contracts › publish /v2/state/active-contracts Publish active contracts WebSocket Updated 3.5 PUBLISH /v2/state/active-contracts Returns a stream of the snapshot of the active contracts and incomplete (un)assignments at a ledger offset. Once the stream o

JSON API AsyncAPI › /v2/state/active-contracts › subscribe /v2/state/active-contracts Subscribe active contracts WebSocket Updated 3.5 SUBSCRIBE /v2/state/active-contracts Returns a stream of the snapshot of the active contracts and incomplete (un)assignments at a ledger offset. Once the st

JSON API AsyncAPI › /v2/commands/completions › subscribe /v2/commands/completions Subscribe completions WebSocket Updated 3.5 SUBSCRIBE /v2/commands/completions Deprecated: please use GetCompletions instead. Subscribe to command completion events. Protocol Details Protocol WebSocket C

JSON API AsyncAPI › /v2/updates/trees › publish /v2/updates/trees Publish trees WebSocket Updated 3.5 PUBLISH /v2/updates/trees Get update transactions tree stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. Protocol Detai

Ledger API JSON Ledger API OpenAPI Generated operation reference for the JSON Ledger API, with lifecycle history embedded on each operation page. OpenAPI 3.5 Operations 69 Source Canton release bundle JSON Ledger API specifications Specification Download the published OpenAPI specification

JSON API AsyncAPI › /v2/updates/trees › subscribe /v2/updates/trees Subscribe trees WebSocket Updated 3.5 SUBSCRIBE /v2/updates/trees Get update transactions tree stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. Protocol

JSON API AsyncAPI › /v2/updates › publish /v2/updates Publish updates WebSocket Updated 3.5 PUBLISH /v2/updates Read the ledger’s filtered update stream for the specified contents and filters. It returns the event types in accordance with the stream contents selected. Also the selection cri

JSON API AsyncAPI › /v2/updates › subscribe /v2/updates Subscribe updates WebSocket Updated 3.5 SUBSCRIBE /v2/updates Read the ledger’s filtered update stream for the specified contents and filters. It returns the event types in accordance with the stream contents selected. Also the selecti

Scan API GET /v0/rewards-collected OpenAPI Deprecated 0.5.10 Removed in 0.6.7 GET /v0/rewards-collected Removed in 0.6.7. Historical definition from 0.6.6. Deprecated . Get the total rewards collected ever Protocol Details Operation ID getRewardsCollected Published 0.6.6 Inputs Quer

Scan API GET /v0/top-providers-by-app-rewards OpenAPI Deprecated 0.5.10 Removed in 0.6.6 GET /v0/top-providers-by-app-rewards Removed in 0.6.6. Historical definition from 0.6.5. Deprecated . Get a list of top-earning app providers, and the total earned app rewards for each Protocol Detail