ATataccama
Reference data

Submit draft changes for review

Submit draft changes for review by creating a review task.

Use the review workflow for governed data or changes that require approval, and for sensitive or business-critical reference data.

Optionally accepts a filter to submit only specific records. If no filter is provided, all eligible draft records are submitted.

Submitting copies the matching draft records into a new review dataset, so a table can have more than one open review. When a review is published, the remaining draft records are rebased onto the latest published version.

Save the reviewDatasetUrn returned in the response, as you need it to list, approve, or reject the records under review.

Returns 409 Conflict when the submission cannot proceed in the current state of the draft. The problem type tells why:

  • NO_ELIGIBLE_RECORDS: the draft contains no changes to submit, or the filter matches none.
  • DQ_BLOCKING_RULES_VIOLATED: data quality blocking rules fail, on this table or on a referencing table whose records reference the changed records.
  • EFFECTIVE_DATE_RULES_VIOLATED: records break the effective date rules of the table.
post/reference-data/v1/tables/{tableUrn}/draft/request-review

Request

Path parameters

tableUrnstring uri required

A URN identifying a table resource in the Reference Data API.

Format: urn:ata:{tenant}:reference-data:table:{uuid}

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

Example:urn:ata:acme-corp:reference-data:table:123e4567-e89b-12d3-a456-426614174000

Table URN identifier.

Request body

namestring required

Review task name.

prioritystring required

@ExtensibleEnum Priority level of a review task.

descriptionstring

Detailed description of the changes submitted for review.

Example request

{
  "priority": "LOW",
  "filter": {
    "recordUrn": {
      "equals": "urn:ata:acme-corp:reference-data:table:123e4567-e89b-12d3-a456-426614174000",
      "notEquals": "urn:ata:acme-corp:reference-data:table:123e4567-e89b-12d3-a456-426614174000",
      "in": [
        "urn:ata:acme-corp:reference-data:table:123e4567-e89b-12d3-a456-426614174000"
      ],
      "notIn": [
        "urn:ata:acme-corp:reference-data:table:123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "state": {
      "in": [
        "NEW"
      ],
      "notIn": [
        "NEW"
      ]
    },
    "lastChangedByUrn": {
      "equals": "urn:ata:acme-corp:iam:user:jane.doe@acme-corp.com",
      "notEquals": "urn:ata:acme-corp:iam:user:jane.doe@acme-corp.com",
      "in": [
        "urn:ata:acme-corp:iam:user:jane.doe@acme-corp.com"
      ],
      "notIn": [
        "urn:ata:acme-corp:iam:user:jane.doe@acme-corp.com"
      ]
    }
  }
}

Response

Review created successfully.

reviewDatasetUrnstring uri required

A URN identifying a review dataset resource in the Reference Data API.

Format: urn:ata:{tenant}:reference-data:review:{uuid}

Example: urn:ata:acme-corp:reference-data:review:423e4567-e89b-12d3-a456-426614174003.

createdAtstring date-time required

When the review was created.

createdByUrnstring uri

A URN identifying a user in the IAM API.

Unlike most URNs, the last segment is the user ID as IAM knows it rather than a UUID. A user ID can be any string, for example, an email address, a UUID, or service-account-{client ID} for an API client. Characters that a URN cannot contain, such as spaces, %, or #, are percent-encoded as UTF-8 with uppercase hex digits; all other characters are kept as they are. Users cannot be listed or retrieved through the public API. To find a user's ID, open the user in the web application (Global settings > User management > Users).

Format: urn:ata:{tenant}:iam:user:{user ID}

Example: urn:ata:acme-corp:iam:user:jane.doe@acme-corp.com.

Example response

{
  "reviewDatasetUrn": "urn:ata:acme-corp:reference-data:review:423e4567-e89b-12d3-a456-426614174003",
  "taskMetadata": {
    "priority": "LOW"
  },
  "createdByUrn": "urn:ata:acme-corp:iam:user:jane.doe@acme-corp.com"
}

Changes

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