ATataccama
Data Quality Monitors

Create DQ monitor

Create a new DQ monitor for a catalog item.

The monitor is created as a draft (draftType: NEW); publish it to make it live. Finish configuring the draft with Update DQ monitor, then use Publish DQ monitor.

If you send the read-only fields urn, catalogItemUrn, and draftType, they are ignored:

  • urn and draftType: The urn is assigned automatically and draftType is set to NEW.
  • catalogItemUrn: The catalog item is taken from the request path.

A successful request returns 201 Created with the created monitor draft.

post/data-quality/v1/catalog-items/{catalogItemUrn}/dq-monitors

Request

Path parameters

catalogItemUrnstring uri required

A URN identifying a catalog item resource in the Catalog API.

Format: urn:ata:{tenant}:catalog:catalog-item:{uuid}

Example: urn:ata:acme-corp:catalog:catalog-item:123e4567-e89b-12d3-a456-426614174000.

Example:urn:ata:acme-corp:catalog:catalog-item:123e4567-e89b-12d3-a456-426614174000

Catalog item URN.

Request body

namestring

The name of the DQ monitor. Not unique: multiple monitors can share a name. Identify a monitor by its URN, never by its name.

manualRuleInstancesobject nullable

Rule instances applied manually, keyed by their id (UUID).

Each rule instance references the rule it runs (ruleUrn) and contains the following sub-entity collections:

  • mappings: Maps rule input attributes (ruleAttributeUrn) to attributes of the monitor's own catalog item (catalogItemAttributeUrn).
  • connectedMappings: Maps rule input attributes (ruleAttributeUrn) to attributes of joined catalog items (connectedCatalogItemAttributeUrn). Each connected mapping references the join it goes through (see joinConfigurations).
  • dqThresholds: Thresholds used to trigger alert findings for this rule instance.
  • parameterValues: Values assigned to the rule's parameters; each entry references the parameter it sets (ruleParameterUrn).
exportDefinitionsobject nullable

Configured exports for invalid records, keyed by their id (UUID).

overallDqThresholdsobject nullable

Monitor-level thresholds used to trigger alert findings during processing, keyed by their id (UUID).

joinConfigurationsobject nullable

Joins to other catalog items, defined by foreign-key attribute pairs and used to evaluate DQ rules across joined data, keyed by their id (UUID). See Cross-table rules.

A join defines only the connection between the catalog items. The rule input attributes are then mapped onto attributes of the joined catalog item by the connected mappings of each rule instance in manualRuleInstances.

Example request

{
  "schedule": {
    "startAt": "2025-01-15T09:30:00Z",
    "endAt": "2025-01-15T09:30:00Z"
  },
  "profilingConfiguration": {
    "type": "FULL"
  },
  "dataSlice": {
    "label": "Czech and Slovak customers",
    "predicates": [
      {
        "attributeUrn": "urn:ata:acme-corp:catalog:catalog-attribute:123e4567-e89b-12d3-a456-426614174000",
        "operator": "EQ",
        "value": "CZ",
        "listValues": [
          "CZ",
          "SK"
        ],
        "rangeStart": "2026-01-01T00:00:00Z",
        "rangeEnd": "2026-03-31T23:59:59Z"
      }
    ]
  }
}

Response

The created DQ monitor as a draft (draftType=NEW) version.

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

The name of the DQ monitor. Not unique: multiple monitors can share a name. Identify a monitor by its URN, never by its name.

manualRuleInstancesobject nullable

Rule instances applied manually, keyed by their id (UUID).

Each rule instance references the rule it runs (ruleUrn) and contains the following sub-entity collections:

  • mappings: Maps rule input attributes (ruleAttributeUrn) to attributes of the monitor's own catalog item (catalogItemAttributeUrn).
  • connectedMappings: Maps rule input attributes (ruleAttributeUrn) to attributes of joined catalog items (connectedCatalogItemAttributeUrn). Each connected mapping references the join it goes through (see joinConfigurations).
  • dqThresholds: Thresholds used to trigger alert findings for this rule instance.
  • parameterValues: Values assigned to the rule's parameters; each entry references the parameter it sets (ruleParameterUrn).
termRuleInstancesobject

Rule instances applied through glossary terms, as opposed to the manually applied instances in manualRuleInstances, keyed by their id (UUID). They exist only on the catalog item's primary DQ monitor.

Term rule instances cannot be created or modified through this API. To manage them, link rules to terms in the web application. Then assign those terms to attributes, either in the web application or through the Catalog API term-assignment batch endpoint.

exportDefinitionsobject nullable

Configured exports for invalid records, keyed by their id (UUID).

overallDqThresholdsobject nullable

Monitor-level thresholds used to trigger alert findings during processing, keyed by their id (UUID).

joinConfigurationsobject nullable

Joins to other catalog items, defined by foreign-key attribute pairs and used to evaluate DQ rules across joined data, keyed by their id (UUID). See Cross-table rules.

A join defines only the connection between the catalog items. The rule input attributes are then mapped onto attributes of the joined catalog item by the connected mappings of each rule instance in manualRuleInstances.

urnstring uri required

A URN identifying the DQ monitor resource in the Data Quality API.

Format: urn:ata:{tenant}:data-quality:dq-monitor:{uuid}

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

catalogItemUrnstring uri required

A URN identifying a catalog item resource in the Catalog API.

Format: urn:ata:{tenant}:catalog:catalog-item:{uuid}

Example: urn:ata:acme-corp:catalog:catalog-item:123e4567-e89b-12d3-a456-426614174000.

Example response

{
  "draftType": "NEW",
  "schedule": {
    "startAt": "2025-01-15T09:30:00Z",
    "endAt": "2025-01-15T09:30:00Z",
    "nextRun": "2025-01-15T09:30:00Z"
  },
  "profilingConfiguration": {
    "type": "FULL"
  },
  "dataSlice": {
    "label": "Czech and Slovak customers",
    "predicates": [
      {
        "attributeUrn": "urn:ata:acme-corp:catalog:catalog-attribute:123e4567-e89b-12d3-a456-426614174000",
        "operator": "EQ",
        "value": "CZ",
        "listValues": [
          "CZ",
          "SK"
        ],
        "rangeStart": "2026-01-01T00:00:00Z",
        "rangeEnd": "2026-03-31T23:59:59Z",
        "attributeName": "COUNTRY"
      }
    ]
  },
  "urn": "urn:ata:acme-corp:data-quality:dq-monitor:123e4567-e89b-12d3-a456-426614174000",
  "catalogItemUrn": "urn:ata:acme-corp:catalog:catalog-item:123e4567-e89b-12d3-a456-426614174000"
}

Changes

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