ATataccama
Reference data

Publish draft changes

Publish all draft changes to make them available in the published dataset.

Publishing creates a new immutable published dataset. After publishing, records remain in draft with state UNCHANGED, and the published dataset contains the new version. Records approved in a review are not published automatically; publish them with this operation.

Optionally accepts a filter to publish only specific records. If no filter is provided, all eligible draft records are published. Send an empty object ({}) or no request body at all to publish everything. Instead of publishing all changes at once, use a filter to publish specific records or changes. This provides better control over what gets published.

Publishing is an asynchronous operation that might take a few seconds. Implement polling or verification logic to confirm publication before proceeding. If the records do not appear in the published dataset straight away, wait a moment and retry fetching them.

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

  • NO_ELIGIBLE_RECORDS: the draft contains no changes to publish, 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/publish

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

Example request

{
  "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

Changes published successfully.

publishedDatasetUrnstring uri required

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

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

Example: urn:ata:acme-corp:reference-data:published:323e4567-e89b-12d3-a456-426614174002.

publishedAtstring date-time required

Timestamp when the dataset was published.

Example response

{
  "publishedDatasetUrn": "urn:ata:acme-corp:reference-data:published:323e4567-e89b-12d3-a456-426614174002"
}

Changes

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