ATataccama
Data Quality Monitors

Create DQ monitors in batch

Create up to 100 DQ monitors in a single request.

Each item requires catalogItemUrn and name. If an item includes sub-entities, such as rule instances, store each of them under a temporary key that you choose.

Unlike Create DQ monitor, batch-created monitors skip the draft stage and are created directly as published versions.

The rules referenced by the item's rule instances must exist and have a published version, and the catalog item attributes in their mappings must exist. If any of them are missing, the whole item is rejected with VALIDATION_ERROR and no monitor is created for it.

Each item is processed independently: a failure on one item does not cancel the rest. The response is 207 Multi-Status. It contains a meta summary (total, success, fail) and per-item results. On success, a result carries the URN of the created monitor (rather than the full body, to keep the response small) and, in correlationIds, the key assigned to each sub-entity the item created. On failure, it carries the error instead.

By default, results are paired with the request items by position: the first result belongs to the first item you sent. You can also add your own id to each item; the response returns it in the matching result.

post/data-quality/v1/dq-monitors/batch/create

Request

Request body

Example request

{
  "data": [
    {
      "id": "item-1",
      "name": "Customer table DQ monitor",
      "catalogItemUrn": "urn:ata:acme-corp:catalog:catalog-item:123e4567-e89b-12d3-a456-426614174000",
      "exportDefinitions": {
        "new_44444444-4444-4444-8444-444444444444": {
          "name": "Invalid customer records",
          "type": "INVALID_RECORDS",
          "format": "CSV",
          "enabled": true
        }
      }
    },
    {
      "id": "item-2",
      "name": "Orders table DQ monitor",
      "catalogItemUrn": "urn:ata:acme-corp:catalog:catalog-item:6e5d4c3b-2a19-4f08-9e7d-6c5b4a392817"
    },
    {
      "id": "item-3",
      "name": "Products table DQ monitor",
      "catalogItemUrn": "urn:ata:acme-corp:catalog:catalog-item:00000000-0000-4000-8000-000000000000"
    }
  ]
}

Response

Multi-status batch outcome. Each item in results reports its own outcome: OK with the created monitor's URN and its correlationIds mapping in data, or a non-OK status with error. Inspect meta for the success and failure totals.

In the example, the first result maps the temporary key of the export definition to the key assigned to it. The second result has no correlationIds, because its item created no sub-entities. The third item fails with RESOURCE_NOT_FOUND because its catalog item does not exist: it carries error instead of data, while the other two items are created regardless.

Example response

{
  "meta": {
    "total": 3,
    "success": 2,
    "fail": 1
  },
  "results": [
    {
      "id": "item-1",
      "status": "OK",
      "data": {
        "urn": "urn:ata:acme-corp:data-quality:dq-monitor:5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a80",
        "correlationIds": {
          "new_44444444-4444-4444-8444-444444444444": "123e4567-e89b-12d3-a456-426614174012"
        }
      }
    },
    {
      "id": "item-2",
      "status": "OK",
      "data": {
        "urn": "urn:ata:acme-corp:data-quality:dq-monitor:5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a81"
      }
    },
    {
      "id": "item-3",
      "status": "RESOURCE_NOT_FOUND",
      "error": {
        "type": "RESOURCE_NOT_FOUND",
        "title": "Resource Not Found",
        "detail": "Catalog item 'urn:ata:acme-corp:catalog:catalog-item:00000000-0000-4000-8000-000000000000' was not found"
      }
    }
  ]
}

Changes

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