Reference data

Approve review records

After review, approve the changes to move them back to draft for publishing.

Optionally accepts a filter to approve only specific records. If no filter is provided, all records in the review are approved.

Approval does not publish the records. Publishing is a separate, still-required step. Use the Publish draft changes operation to make approved changes visible in the published dataset.

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

  • NO_ELIGIBLE_RECORDS: no records of the review match the request.
  • EFFECTIVE_DATE_RULES_VIOLATED: records break the effective date rules of the table.
post/reference-data/v1/reviews/{reviewDatasetUrn}/approve

Request

Path parameters

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.

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

Review dataset 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

Records approved successfully.

affectedRecordCountinteger required

Number of records that were approved or rejected.

Changes

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