Update the configuration of the rule with the corresponding ID

Updates schema rule.

Updates schema rule configuration for the specified rule ID.

PUT/api/v1/schema-rules/{ruleId}

Authorization

Path parameters

ruleId*string

Schema Rule Identifier

Example: "000000000000000000000001"

Body

Object that contains a configuration.

idstring

Example: "000000000000000000000001"

uuidstring

Example: "00000000-0000-0000-0000-000000000000"

name*string

Example: "Tool name"

descriptionstring

Example: "Description"

creatorstring

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

ownerstring

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

policyIdstring

Example: "000000000000000000000001"

policyTopicIdstring

Example: "0.0.1"

policyInstanceTopicIdstring

Example: "0.0.1"

statusenum

Example: "DRAFT"

DRAFTPUBLISHEDERRORACTIVE

confignullable object

Response

Successful operation.

Body

idstring

Example: "000000000000000000000001"

uuidstring

Example: "00000000-0000-0000-0000-000000000000"

name*string

Example: "Tool name"

descriptionstring

Example: "Description"

creatorstring

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

ownerstring

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

policyIdstring

Example: "000000000000000000000001"

policyTopicIdstring

Example: "0.0.1"

policyInstanceTopicIdstring

Example: "0.0.1"

statusenum

Example: "DRAFT"

DRAFTPUBLISHEDERRORACTIVE

confignullable object

Request

const response = await fetch('/api/v1/schema-rules/{ruleId}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Tool name"
    }),
});
const data = await response.json();

Response

{
  "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",
  "policyId": "000000000000000000000001",
  "policyTopicId": "0.0.1",
  "policyInstanceTopicId": "0.0.1",
  "status": "DRAFT"
}

PreviousRetrieve the configuration of the rule by its ID NextDelete the rule by its ID

Last updated 12 days ago

const response = await fetch('/api/v1/schema-rules/{ruleId}', { method: 'PUT', headers: { "Authorization": "Bearer JWT", "Content-Type": "application/json" }, body: JSON.stringify({ "name": "Tool name" }), }); const data = await response.json();

{ "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", "policyId": "000000000000000000000001", "policyTopicId": "0.0.1", "policyInstanceTopicId": "0.0.1", "status": "DRAFT" }