Not Exists In Check API

This page documents how to create and manage a Not Exists In check via the REST API. The check uses the standard Quality Checks endpoints: set rule to notExistsIn, list exactly one target field under fields, and name the reference container and field under properties. All endpoints share the base URL of your deployment (for example, https://your-instance.qualytics.io/api) and require a Bearer token.

Tip

For complete API documentation, including request and response schemas, visit the API docs.

Permissions

All endpoints require the Member role plus a team permission on the check's datastore: Reporter to read, Author to create or update an Active check, archive, or delete, and Drafter to create or update a Draft. See Permissions for the full matrix.

The `properties` object

Not Exists In carries its rule-specific configuration under properties:

Field	Required	Type	Description
`ref_datastore_id`	No	`int`	Datastore holding the reference container. Omit or send `null` when it lives in the same datastore as the target.
`ref_container_id`	Yes	`int`	The reference container holding the lookup values.
`field_name`	Yes	`string`	The field on the reference container whose values form the forbidden set.
`ref_filter`	No	`string`	SQL `WHERE` expression applied to the reference container before the lookup set is built. Accepts Check Variables.

Create

Endpoint: POST /api/quality-checks

Permission: Member role + Author team permission on the container's datastore (Drafter when status is "Draft").

Create a Not Exists In check (every accepted field)

curl -X POST "https://your-instance.qualytics.io/api/quality-checks" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "description": "Active customers must not appear on the suppression list.",
      "rule": "notExistsIn",
      "fields": ["email"],
      "container_id": 145,
      "coverage": 1,
      "filter": null,
      "properties": {"ref_container_id": 178, "field_name": "email"},
      "tags": ["integrity", "compliance"],
      "additional_metadata": {"jira": "DATA-10001"},
      "anomaly_message_field": null,
      "template_id": null,
      "status": "Active",
      "owner_id": 7,
      "default_anomaly_assignee_id": 12
  }'

Field notes

Field	Required	Notes
`description`	Yes	Free-text description shown in the UI.
`rule`	Yes	Must be `"notExistsIn"`.
`fields`	Yes	Array with exactly one entry: the target field whose values are looked up.
`container_id`	Yes	ID of the container (table or file) the check runs against.
`coverage`	No	Fractional value between `0` and `1` that defines the minimum fraction of evaluated rows that must pass. Defaults to `1`, which requires every row to pass.
`filter`	No	SQL `WHERE` expression. Applied before the evaluation, so only filtered rows are evaluated. Send `null` for no filter.
`properties`	Yes	Object naming the reference container, its field, and the optional reference filter. See above.
`tags`	No	List of tag names applied to the check for filtering and organization.
`additional_metadata`	No	Free-form key-value pairs (typically links to catalog entries, tickets, governance records).
`anomaly_message_field`	No	Name of a source-record field whose value should be used as the Record Anomaly message instead of the default template-generated one. When the named column is null, missing, or empty for a violating row, the standard Record template is used instead. Shape Anomalies always use the fixed template. Send `null` to use the default Record template.
`template_id`	No	ID of a Check Template to associate the check with. `null` if not using a template.
`status`	No	`"Active"` (default) or `"Draft"`. Draft checks are not evaluated by Scans.
`owner_id`	No	ID of the user who owns the check. Defaults to the user creating the check when omitted.
`default_anomaly_assignee_id`	No	ID of the user automatically assigned to anomalies produced by the check.

Read

Endpoint: GET /api/quality-checks/{id}

Permission: Member role + Reporter team permission on the check's datastore.

Retrieve a check by ID

curl -X GET "https://your-instance.qualytics.io/api/quality-checks/101" \
  -H "Authorization: Bearer YOUR_TOKEN"

Update

Endpoint: PUT /api/quality-checks/{id}

Permission: Member role + Author team permission on the check's datastore (Drafter when the check stays Draft).

The PUT endpoint requires description; include the check's current description (or a new one) along with the fields you want to change. Send the whole properties object: partial property updates are not merged.

Point the check at a different reference

curl -X PUT "https://your-instance.qualytics.io/api/quality-checks/101" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Active customers must not appear on the current suppression list.",
    "properties": {
        "ref_container_id": 178,
        "field_name": "email",
        "ref_filter": "suppressed_at >= '2026-01-01'"
    }
  }'

A PUT can update most fields on an existing Not Exists In check. Three values stay immutable: the rule type, the container the check is attached to, and the associated Check Template. If any of these needs to change, delete the check and create a new one.

Editable vs Immutable on PUT

Editable

description
coverage
filter (scopes the target rows)
properties.ref_datastore_id, properties.ref_container_id, properties.field_name, properties.ref_filter
tags
additional_metadata
anomaly_message_field
fields (must remain a single field)
status
owner_id
default_anomaly_assignee_id

Immutable

rule
container_id
template_id

Delete

Endpoint: DELETE /api/quality-checks/{id}

Permission: Member role + Author team permission on the check's datastore.

Three query parameters control what happens, mirroring the two-stage flow in the UI:

Parameter	Default	Description
`archive`	`true`	When `true`, the check is archived and can be restored later. When `false`, the check is permanently deleted.
`status`	`Discarded`	The archive resolution: `Discarded` (no longer relevant) or `Invalid` (wrong and suppressed from future AI generation). Only used when `archive=true`.
`delete_anomalies`	`true`	Whether to permanently delete the anomalies the check produced. A permanent delete (`archive=false`) always removes them.

Archive a check, keeping its anomalies

curl -X DELETE "https://your-instance.qualytics.io/api/quality-checks/101?archive=true&status=Discarded&delete_anomalies=false" \
  -H "Authorization: Bearer YOUR_TOKEN"

Delete a check permanently

curl -X DELETE "https://your-instance.qualytics.io/api/quality-checks/101?archive=false" \
  -H "Authorization: Bearer YOUR_TOKEN"

Error responses

Status	Description
`400 Bad Request`	A business-logic conflict prevents the operation (for example, changing properties while the check is archived, or switching an archived check between `Discarded` and `Invalid`).
`401 Unauthorized`	Missing or invalid API token.
`403 Forbidden`	The caller lacks the required team permission on the check's datastore.
`404 Not Found`	The check ID does not exist, or the payload names something that does not: a `fields` entry that is not a column on `container_id`, or a `properties.ref_datastore_id` or `properties.ref_container_id` that does not exist.
`422 Unprocessable Entity`	The payload fails schema validation (for example, `description` missing on `PUT`, or `properties.ref_container_id` or `properties.field_name` is missing).