ATataccama
Reference data

Get table

Retrieve a reference data table by URN.

The response contains the table name and description, its attributes, the total number of published records, and the URNs of any reviews pending for the table.

get/reference-data/v1/tables/{tableUrn}

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.

Response

A table object.

urnstring 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.

namestring required
descriptionstring

Description of the table (rich text).

totalRecordsCountinteger required
reviewUrnsReviewUrn[]

Array of review URN strings representing pending reviews for this table.

createdAtstring date-time required
lastPublishedAtstring date-time

When the table was last published. The table is also published when it is created, when its attributes change, and when a table it references is published, so this time can move even if none of its own records changed. Absent when no publish is recorded for the table.

lastPublishedByUrnstring 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

{
  "urn": "urn:ata:acme-corp:reference-data:table:123e4567-e89b-12d3-a456-426614174000",
  "attributes": [
    {
      "urn": "urn:ata:acme-corp:reference-data:table-attribute:123e4567-e89b-12d3-a456-426614174000/623e4567-e89b-12d3-a456-426614174005"
    }
  ],
  "reviewUrns": [
    "urn:ata:acme-corp:reference-data:review:423e4567-e89b-12d3-a456-426614174003"
  ],
  "lastPublishedByUrn": "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.