# Equal To Field Check API

Source: https://userguide.qualytics.io/data-quality-checks/equal-to-field/api/

This page documents how to create and manage an Equal To Field check via the REST API. The check uses the standard Quality Checks endpoints: set `rule` to `equalToField`, list the evaluated field under `fields`, and name the compared column 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](https://userguide.qualytics.io/api/docs).

> **Note: 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](https://userguide.qualytics.io/data-quality-checks/equal-to-field/deep-dive/permissions/) for the full matrix.

## The `properties` object

Equal To Field carries its rule-specific configuration under `properties`:

| Field | Required | Type | Description |
| --- | --- | --- | --- |
| `field_name` | Yes | `string` | The other column on the same row that the evaluated field must equal. |
| `string_comparator` | No | `object` | Optional normalization applied when comparing text. Accepts one key, `ignore_whitespace`: when `true`, both sides are trimmed and any run of internal whitespace is collapsed to a single space before the comparison. Text comparison is always case-sensitive. |
| `duration_comparator` | No | `object` | Optional tolerance applied when comparing dates and timestamps. |
| `numeric_comparator` | No | `object` | Optional tolerance applied when comparing numbers. Accepts an absolute margin or a percentage of the compared value. |

## Create

**Endpoint:** `POST /api/quality-checks`

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

> **Example: Create an Equal To Field check (every accepted field)**
>
> ```bash
> curl -X POST "https://your-instance.qualytics.io/api/quality-checks" \
>   -H "Authorization: Bearer YOUR_TOKEN" \
>   -H "Content-Type: application/json" \
>   -d '{
>       "description": "The shipping city must match the billing city.",
>       "rule": "equalToField",
>       "fields": ["shipping_city"],
>       "container_id": 145,
>       "coverage": 1,
>       "filter": null,
>       "properties": {"field_name": "billing_city"},
>       "tags": ["consistency", "denormalization"],
>       "additional_metadata": {"jira": "DATA-10210"},
>       "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 `"equalToField"`. |
| `fields` | Yes | Array with a single field name: the field the check evaluates. The compared column is named under `properties.field_name`. |
| `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 compared column and the optional comparators. See [above](https://userguide.qualytics.io/data-quality-checks/equal-to-field/api/#the-properties-object). |
| `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, and when it is masked the message reads `<masked>`. 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.

> **Example: Retrieve a check by ID**
>
> ```bash
> 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` and `properties`, plus `fields` unless the request also sends `"status": "Draft"` (this also makes the check a Draft; a Draft update that omits `fields` keeps the stored ones). Include the check's current values (or new ones), along with anything else you want to change. Send the whole `properties` object: partial property updates are not merged.

> **Example: Ignore whitespace when comparing the two columns**
>
> ```bash
> curl -X PUT "https://your-instance.qualytics.io/api/quality-checks/101" \
>   -H "Authorization: Bearer YOUR_TOKEN" \
>   -H "Content-Type: application/json" \
>   -d '{
>     "description": "The shipping city must match the billing city.",
>     "fields": ["shipping_city"],
>     "properties": {
>         "field_name": "billing_city",
>         "string_comparator": {"ignore_whitespace": true}
>     }
>   }'
> ```

A `PUT` can update most fields on an existing Equal To Field 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.

> **Info: Editable vs Immutable on PUT**
>
> **Editable**
>
> - `description`
> - `coverage`
> - `filter`
> - `properties.field_name`
> - `properties.string_comparator`, `properties.duration_comparator`, `properties.numeric_comparator`
> - `tags`
> - `additional_metadata`
> - `anomaly_message_field`
> - `fields` (the evaluated 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. |

> **Example: Archive a check, keeping its anomalies**
>
> ```bash
> curl -X DELETE "https://your-instance.qualytics.io/api/quality-checks/101?archive=true&status=Discarded&delete_anomalies=false" \
>   -H "Authorization: Bearer YOUR_TOKEN"
> ```

> **Example: Delete a check permanently**
>
> ```bash
> 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 a name in `fields` is not a field of the container. |
| `409 Conflict` | A field named in `fields` exists but is not active, or the check overlaps an existing one. |
| `422 Unprocessable Entity` | The payload fails validation: `description` or `fields` missing on `PUT`, `properties.field_name` missing or not a field of the container, the evaluated field and the compared field of different types, a field type outside the accepted list, or a comparator set for a type it does not apply to. |

*Last updated: November 10, 2026.*
