Alerts3

Catalog Attributes7

Catalog Items6

Data Products4

Data Quality Dashboards4

Data Quality Dimensions1

Data Quality Monitor Processing7

Data Quality Monitors7

Data Quality Rules8

Data Quality Transformations1

Datasets2

Detection Rules5

Documentation Flow2

Domains2

Findings3

Folders5

Generic Metadata Entities8

Groups4

Jobs2

Metadata Model Entities2

Orchestrators2

Pipeline Jobs2

Reference data16

Sources5

Stewardship2

Terms5

Transformation Plans1

Workflows3

Detection Rules

Create detection rule

Create a detection rule.

For DATA rules, exactly one input must be supplied. For METADATA rules, inputs are determined by the system and must not be supplied.

post/catalog/v1/detection-rules

Request

Base URL
https://your-environment.ataccama.one/api
Auth
HTTP bearer
TypeScript
https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/docs/catalog/v1/detection-rules/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring required

descriptionstring

typestring required

The type of a detection rule. DATA rules evaluate a single input; METADATA rules evaluate a predefined set of system inputs.

variablesobject

Variables derived from the rule's input(s) and reused within the rule expression. Every key must be a temporary new_<id> key, since no variable exists yet; each is returned as correlationId on the created variable.

extraPropertiesExtraProperties

A map of properties associated with the entity defined in the metadata model. Only scalar and reference properties are supported, including arrays.

In responses, only properties explicitly requested via the extraProperties query parameter are included.

In PATCH requests, only the properties listed in the body are modified; set a property to null (for scalars) or [] (for reference arrays) to clear its value.

To find which extra properties are available for an entity, retrieve its entity definition through the Metadata model entities endpoints: catalogItem for catalog items, attribute for catalog attributes, source for sources, folder for folders, and the term's own type (for example, businessTerm) for terms.

Example request

{
  "type": "DATA",
  "extraProperties": {
    "isPii": true,
    "community": "Customer Solutions",
    "status": "urn:ata:acme-corp:catalog:completeness-status:10bae762-0000-8010-8000-000001eb0070",
    "domains": [
      "urn:ata:acme-corp:catalog:domain:10bae762-0000-8010-8000-000001eb0065",
      "urn:ata:acme-corp:catalog:domain:10bae762-0000-8010-8000-000001eb0066"
    ]
  }
}

Response

Created detection rule.

urnstring uri required

A URN identifying a detection rule resource in the Catalog API.

Format: urn:ata:{tenant}:catalog:detection-rule:{uuid}

Example: urn:ata:acme-corp:catalog:detection-rule:123e4567-e89b-12d3-a456-426614174000.