Update Label configuration by ID

Last updated 1 month ago

Updates policy label.

Updates policy label configuration for the specified label ID.

put

/policy-labels/{definitionId}

Authorizations

Path parameters

definitionIdstringrequired

policy label Identifier

Example: 000000000000000000000001

Body

idstring

Example: 000000000000000000000001

uuidstring

Example: 00000000-0000-0000-0000-000000000000

namestringrequired

Example: Tool name

descriptionstring

Example: Description

creatorstring

Example: #did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001

ownerstring

Example: #did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001

topicIdstring

Example: 0.0.1

messageIdstring

Example: 0000000000.000000001

policyIdstring

Example: 000000000000000000000001

policyTopicIdstring

Example: 0.0.1

policyInstanceTopicIdstring

Example: 0.0.1

configobject | nullable

statusstring · enum

Example: DRAFT

Options: DRAFT, PUBLISHED, ERROR, ACTIVE

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v1/policy-labels/{definitionId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"id":"000000000000000000000001","uuid":"00000000-0000-0000-0000-000000000000","name":"Tool name","description":"Description","creator":"#did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001","owner":"#did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001","topicId":"0.0.1","messageId":"0000000000.000000001","policyId":"000000000000000000000001","policyTopicId":"0.0.1","policyInstanceTopicId":"0.0.1","config":{},"status":"DRAFT"}'

200

401

403

500

{
  "id": "000000000000000000000001",
  "uuid": "00000000-0000-0000-0000-000000000000",
  "name": "Tool name",
  "description": "Description",
  "creator": "#did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001",
  "owner": "#did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001",
  "topicId": "0.0.1",
  "messageId": "0000000000.000000001",
  "policyId": "000000000000000000000001",
  "policyTopicId": "0.0.1",
  "policyInstanceTopicId": "0.0.1",
  "config": {},
  "status": "DRAFT"
}

Successful operation.