ATataccama
Detection Rules

Get detection rule

Retrieve a detection rule by URN.

get/catalog/v1/detection-rules/{urn}

Request

Path parameters

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.

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

Query parameters

extraPropertiesstring[]

Comma-separated list of extra property names to include in the extraProperties field of the response. When omitted, no extra properties are returned.

The property names must exactly match the property names defined in the metadata model. Only scalars, references and their arrays are supported.

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, dataProduct for data products, dataProductStatus for data product statuses, domain for domains, and the term's own type (for example, businessTerm) for terms. Extra properties cannot be used as filter criteria.

[
  "isPii",
  "community",
  "domains"
]

Response

The 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.

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 nullable

Variables derived from the rule's input(s) and reused within the rule expression, keyed by their id (UUID).

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 response

{
  "urn": "urn:ata:acme-corp:catalog:detection-rule:123e4567-e89b-12d3-a456-426614174000",
  "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"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.