Documentation/canton-network-docs/Admin APIgRPC APIPackagescom.digitalasset.canton.admin.participant.v30ServicesPartyManagementServiceView on canton-network-docs ↗
canton-network-docs/Admin APIgRPC APIPackagescom.digitalasset.canton.admin.participant.v30ServicesPartyManagementService

GetAddPartyStatus

Participant Administration›Protobuf›com.digitalasset.canton.admin.participant.v30›GetAddPartyStatus

com.digitalasset.canton.admin.participant.v30

​
GetAddPartyStatus

gRPCSince 3.4.0
RPC/com.digitalasset.canton.admin.participant.v30.PartyManagementService/GetAddPartyStatus

​
Protocol Details

​
Inputs

​
GetAddPartyStatusRequest

add_party_request_idstring

​
Outputs

​
GetAddPartyStatusResponse

statusPartyReplicationStatus

​
Lifecycle Changes

3.4.0introduced

com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusRequest

add_party_request_idstring

com.digitalasset.canton.admin.participant.v30.GetAddPartyStatusResponse

statusPartyReplicationStatus

com.digitalasset.canton.admin.participant.v30.PartyReplicationStatus

parametersReplicationParameters
agreementSequencerChannelAgreement
authorizationPartyReplicationAuthorization
replicationAcsReplicationProgress
indexingAcsIndexingProgress
has_completedbool
error_messagePartyReplicationError

com.digitalasset.canton.admin.participant.v30.PartyReplicationStatus.ReplicationParameters

request_idstring
party_idstring
synchronizer_idstring
source_participant_uidstring
target_participant_uidstring
topology_serialuint32

com.digitalasset.canton.admin.participant.v30.PartyReplicationStatus.SequencerChannelAgreement

sequencer_uidstring

com.digitalasset.canton.admin.participant.v30.PartyReplicationStatus.PartyReplicationAuthorization

onboarding_atTimestamp
is_onboarding_flag_clearedbool

com.digitalasset.canton.admin.participant.v30.PartyReplicationStatus.AcsReplicationProgress

processed_contract_countuint64
fully_processed_acsbool

com.digitalasset.canton.admin.participant.v30.PartyReplicationStatus.AcsIndexingProgress

com.digitalasset.canton.admin.participant.v30.PartyReplicationStatus.PartyReplicationError

error_messagestring
grpcurl
grpcurl
# Add -plaintext if the server is not using TLS.
grpcurl \
  -d @ \
  <HOST:PORT> \
  com.digitalasset.canton.admin.participant.v30.PartyManagementService/GetAddPartyStatus <<'EOF'
{
  "addPartyRequestId": "string"
}
EOF
OKapplication/json
OK
{
  "status": {
    "parameters": {
      "requestId": "string",
      "partyId": "string",
      "synchronizerId": "string",
      "sourceParticipantUid": "string",
      "targetParticipantUid": "string",
      "topologySerial": 0
    },
    "agreement": {
      "sequencerUid": "string"
    },
    "authorization": {
      "onboardingAt": "string",
      "isOnboardingFlagCleared": true
    },
    "replication": {
      "processedContractCount": "0",
      "fullyProcessedAcs": true
    },
    "indexing": {},
    "hasCompleted": true,
    "errorMessage": {
      "errorMessage": "string"
    }
  }
}