ATataccama
Detection Rules

List detection rules

List the detection rules.

Paging is forward-only.

get/catalog/v1/detection-rules

Request

Query parameters

afterstring

Encoded string representing start of the next page. Starts at beginning when omitted.

sizeinteger
searchstring

Full-text query matched against all string properties of the detection rule, such as name and description.

namestring

Filters results by exact match on the detection rule name.

sortstring[]

Comma-separated field names for sorting results, where fields prefixed with a hyphen (-) sort descending. Only name is supported.

Examples:

  • ?sort=name — sort by name ascending
  • ?sort=-name — sort by name descending
[
  "name"
]
typestring

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

Example:DATA

Filter results by detection rule type. When omitted, rules of all types are returned.

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

Paginated list of detection rules.

Example response

{
  "meta": {
    "next": "MjA=",
    "total": 150
  },
  "data": [
    {
      "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.