ATataccama
Detection Rules

Update detection rule

Update a detection rule using JSON Merge Patch (RFC 7396). You only need to send the fields you want to change.

The rule type cannot be changed, and for METADATA rules, inputs are read-only.

patch/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

Request body

namestring
descriptionstring nullable
variablesobject nullable

Variables keyed by their id (UUID). Omit to leave the collection unchanged; null deletes every variable. Within the map, a new_<id> key creates, a null value deletes that variable, and an object value is merged into the existing one.

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

{
  "input": {
    "dataType": "STRING"
  },
  "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

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