CCPEDIAby Unity Nodes
Documentation/Canton Network Docs/Ledger APIProtobufsPackagescom.daml.ledger.api.v2.adminServicesPartyManagementAlphaServiceView on Canton Network Docs ↗

GetAddPartyStatus

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

com.daml.ledger.api.v2.admin

​
GetAddPartyStatus

gRPCAdded 3.6.1
RPC/com.daml.ledger.api.v2.admin.PartyManagementAlphaService/GetAddPartyStatus

​
Protocol Details

ProtocolgRPC
ServicePartyManagementAlphaService
RPCGetAddPartyStatus
Client streamNo
Server streamNo

​
Inputs

​
GetAddPartyStatusRequest

Messagecom.daml.ledger.api.v2.admin.GetAddPartyStatusRequest
Client streamNo
party_idstring
synchronizer_idstring
target_participant_uidstring

​
Outputs

​
GetAddPartyStatusResponse

Messagecom.daml.ledger.api.v2.admin.GetAddPartyStatusResponse
Server streamNo
statusPartyReplicationStatus

com.daml.ledger.api.v2.admin.GetAddPartyStatusRequest

party_idstring
synchronizer_idstring
target_participant_uidstring

com.daml.ledger.api.v2.admin.GetAddPartyStatusResponse

statusPartyReplicationStatus

com.daml.ledger.api.v2.admin.PartyReplicationStatus

currentState
errorErrorDetails

com.daml.ledger.api.v2.admin.PartyReplicationStatus.State

  • STATE_UNSPECIFIED
  • STATE_IN_PROGRESS
  • STATE_COMPLETED
  • STATE_FAILED

com.daml.ledger.api.v2.admin.PartyReplicationStatus.ErrorDetails

messagestring

​
History

Added3.6.1
grpcurl
grpcurl
# Add -plaintext if the server is not using TLS.
grpcurl \
  -d @ \
  <HOST:PORT> \
  com.daml.ledger.api.v2.admin.PartyManagementAlphaService/GetAddPartyStatus <<'EOF'
{
  "partyId": "string",
  "synchronizerId": "string",
  "targetParticipantUid": "string"
}
EOF
OKapplication/json
OK
{
  "status": {
    "current": "STATE_UNSPECIFIED",
    "error": {
      "message": "string"
    }
  }
}