Update selected modifiable participant-local attributes of a party details resource

PATCH /v2/parties/{party}

Request

curl --request PATCH \
  --url 'http://localhost:7575/v2/parties/{party}' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"partyDetails":{"party":"string","isLocal":false,"localMetadata":{},"identityProviderId":"string"},"updateMask":{"paths":["string"],"unknownFields":{}}}'

200 response

{
  "partyDetails": {
    "party": "string",
    "isLocal": false,
    "localMetadata": {},
    "identityProviderId": "string"
  }
}

JSON Ledger API

Update selected modifiable participant-local attributes of a party details resource

OpenAPISince 3.4Changed 3.5

Update selected modifiable participant-local attributes of a party details resource. Can update the participant’s local information for local parties.

Protocol Details

Inputs

Path parameters

party · string · required

Request body

application/json

partyDetails · object · required

OpenAPI type: PartyDetails.

updateMask · object · required

OpenAPI type: FieldMask.

Outputs

200

application/json

partyDetails · PartyDetails · required

400

text/plain

value · string · required

default

application/json

code · string · required

cause · string · required

correlationId · string

traceId · string

context · Map_String · required

resources · Tuple2_String_String[]

errorCategory · integer (int32) · required

grpcCodeValue · integer (int32)

retryInfo · string

definiteAnswer · boolean

History

Changed3.5

The PATCH /v2/parties/{party} operation changed in this snapshot.

Introduced3.4

Request

curl --request PATCH \
  --url 'http://localhost:7575/v2/parties/{party}' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"partyDetails":{"party":"string","isLocal":false,"localMetadata":{},"identityProviderId":"string"},"updateMask":{"paths":["string"],"unknownFields":{}}}'

200 response

{
  "partyDetails": {
    "party": "string",
    "isLocal": false,
    "localMetadata": {},
    "identityProviderId": "string"
  }
}