ATataccama
Data Quality Rules

Publish rule

Publish the current draft, promoting it to the latest published version.

What publishing amounts to depends on the draftType:

  • NEW: Create a new DQ rule (promotes the draft to the first published version).
  • CHANGE: Change an existing DQ rule (promotes the draft to the latest published version).
  • DELETE: Delete an existing DQ rule.
  • RESURRECT: Resurrect a deleted DQ rule.

The response returns the published rule. If the rule has no current draft, the request still succeeds and returns the currently published version.

For NEW and CHANGE, the rule must meet the following requirements; otherwise, the publish request fails with a 400 error listing what is missing:

  • name is set.
  • implementation is set, contains at least one condition, and every condition has a non-empty expression.
  • inputGroups contains at least one group with joined: false.

DELETE and RESURRECT drafts are created in the web application only; the API never creates them, but you can retrieve them (?version=DRAFT) and publish them like any other draft. To delete a rule through the API, use Delete rule instead: it deletes the rule immediately, without a draft.

post/data-quality/v1/rules/{ruleUrn}/publish

Request

Path parameters

ruleUrnstring uri required

A URN identifying the data quality rule resource in the Data Quality API.

Format: urn:ata:{tenant}:data-quality:rule:{uuid}

Example: urn:ata:acme-corp:data-quality:rule:123e4567-e89b-12d3-a456-426614174000.

Example:urn:ata:acme-corp:data-quality:rule:123e4567-e89b-12d3-a456-426614174000

Rule URN.

Response

The published rule. Sub-entities are keyed by their id, the UUID part of their urn.

draftTypestring required

@ExtensibleEnum The type of the DRAFT version (NONE indicates a PUBLISHED version). It specifies what will happen to the entity if the DRAFT is published.

Possible values:

  • NEW — draft proposal to create a new object.
  • CHANGE — draft proposal to change an existing object.
  • DELETE — draft proposal to delete an existing object.
  • RESURRECT — draft proposal to resurrect an already deleted object.
  • NONE — placeholder for a non-existent draft; represents a published version.

The value describes the version that was returned, not the entity as a whole: a PUBLISHED version always reports NONE, even when an unpublished draft is waiting. Fetch it with ?version=DRAFT to see the pending change. An entity that exists only as a draft is not listed and answers a default (published) read with 404.

namestring

Human-readable name of the rule. Not unique: multiple rules can share a name. Identify a rule by its URN, never by its name. None of the rule fields is required to create a draft; name is required to publish it.

descriptionstring nullable

Optional description of the rule.

inputGroupsobject nullable

Groups of input attributes the rule consumes, keyed by their id (UUID). Each input attribute has a name and data type (for example, STRING, INTEGER, or DATE). For cross-table rules, a child input group is marked joined: true.

parametersobject nullable

Parameters that configure the rule, keyed by their id (UUID).

variablesobject nullable

Variables derived from inputs and reused within the rule logic, keyed by their id (UUID). A variable is computed either from an expression or by applying transformations to an input attribute.

urnstring uri required

A URN identifying the data quality rule resource in the Data Quality API.

Format: urn:ata:{tenant}:data-quality:rule:{uuid}

Example: urn:ata:acme-corp:data-quality:rule:123e4567-e89b-12d3-a456-426614174000.

Example response

{
  "draftType": "NEW",
  "defaultDqThreshold": {
    "severity": "WARNING",
    "urn": "urn:ata:acme-corp:data-quality:dq-threshold:123e4567-e89b-12d3-a456-426614174000",
    "correlationId": "new_email"
  },
  "stewardship": {
    "groupUrn": "urn:ata:acme-corp:iam:group:123e4567-e89b-12d3-a456-426614174000"
  },
  "implementation": {
    "ruleType": "SINGLE_TABLE",
    "dqDimensionUrn": "urn:ata:acme-corp:data-quality:dq-dimension:123e4567-e89b-12d3-a456-426614174000",
    "fallback": {
      "resultUrn": "urn:ata:acme-corp:data-quality:dq-dimension-result:123e4567-e89b-12d3-a456-426614174000"
    }
  },
  "urn": "urn:ata:acme-corp:data-quality:rule:123e4567-e89b-12d3-a456-426614174000"
}

Changes

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