For the complete documentation index, see llms.txt. This page is also available as Markdown.

Retrieve the configuration of the rule by its ID

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

Retrieves the schema rule configuration for the specified rule ID.

Authentication: Bearer token required (Authorization: Bearer <token>)

Permission: Permissions.SCHEMAS_RULE_READ


Request

Path Parameters

Parameter
Type
Required
Description

ruleId

string

Yes

Schema rule identifier (MongoDB ObjectId)


Response

Success Response

Status: 200 OK

{
  "id": "63e3e5e8a01b3c001234abcd",
  "uuid": "3b4e1c2d-5f6a-7890-abcd-ef1234567890",
  "name": "MRV Data Quality Rules",
  "description": "Validation rules for MRV schema fields",
  "creator": "did:hedera:testnet:zHcDLGFNymFAJiMBKnpbHDgjvTn6yZnwkPPeFhtJBECH_0.0.4532001",
  "owner": "did:hedera:testnet:zHcDLGFNymFAJiMBKnpbHDgjvTn6yZnwkPPeFhtJBECH_0.0.4532001",
  "policyId": "63e3e5e8a01b3c001234abcd",
  "policyTopicId": "0.0.4532001",
  "policyInstanceTopicId": "0.0.4532002",
  "status": "ACTIVE",
  "config": {}
}

Error Responses

Status
Description

401 Unauthorized

Missing or invalid token

403 Forbidden

Insufficient permissions

404 Not Found

No rule exists with the given ruleId

422 Unprocessable Entity

ruleId parameter is missing or empty

500 Internal Server Error

Unexpected server failure

Last updated