APIs related to Schema Rules

Schema Rules define validation rule sets applied to schema documents within policies. Rules specify field-level constraints, cross-field dependencies, and data quality checks beyond basic JSON Schema validation.

Authentication: All endpoints require a Bearer JWT token (Authorization: Bearer <token>). Obtain a token via POST /accounts/login.

---

Endpoints

Method	Endpoint	Description	Auth Required
POST	/api/v1/schema-rules	Creates a new schema rule	Yes
GET	/api/v1/schema-rules	Returns a paginated list of all schema rules	Yes
GET	/api/v1/schema-rules/{ruleId}	Retrieves a schema rule by ID	Yes
PUT	/api/v1/schema-rules/{ruleId}	Updates a schema rule by ID	Yes
DELETE	/api/v1/schema-rules/{ruleId}	Deletes a schema rule by ID	Yes
PUT	/api/v1/schema-rules/{ruleId}/activate	Activates a schema rule	Yes
PUT	/api/v1/schema-rules/{ruleId}/inactivate	Deactivates a schema rule	Yes
GET	/api/v1/schema-rules/{ruleId}/relationships	Lists all schemas and policies linked to a rule	Yes
POST	/api/v1/schema-rules/data	Retrieves data needed for evaluating rules	Yes
POST	/api/v1/schema-rules/{policyId}/import/file	Imports schema rules from a ZIP file	Yes
GET	/api/v1/schema-rules/{ruleId}/export/file	Exports a schema rule to a ZIP file	Yes
POST	/api/v1/schema-rules/import/file/preview	Previews a schema rule ZIP without saving	Yes

---

Endpoint Details

• Creation of a New Schema Rule

• Retrieve the Schema Rules

• Retrieve the Configuration of the Rule by Its ID

• Update the Configuration of the Rule with the Corresponding ID

• Delete the Rule by Its ID

• Activate the Rule with the Specified ID

• Deactivate the Rule with the Specified ID

• List All Schemas and Policies Relevant to the Rule with the Specified ID

• Retrieve All the Data Needed for Evaluating the Rules

• Create a New Rule from the File

• Export the Selected Rule by ID into the File

• Load the File and Return Its Preview