ATataccama
Generic Metadata Entities

List entities

List the entities of a given type.

To return the entity properties, list the property names you need in the properties parameter. When omitted, no properties are returned.

Paging is forward-only.

get/catalog/v1/entities

Request

Query parameters

entityTypestring required

Entity type to list, matching the value of rootSuperType or concreteType returned in entity responses. The available types are defined in the metadata model.

Examples: term, businessTerm, catalogItem.

parentUrnstring uri

A URN identifying a resource in any realm of the Public API. URNs follow RFC 8141.

Format: urn:ata:{tenant}:{realm}:{resource-type}:{uuid}

Components:

  • urn — fixed scheme
  • ata — Ataccama namespace
  • {tenant} — tenant identifier from the authentication context
  • {realm} — API realm, for example catalog or reference-data
  • {resource-type} — resource type within the realm, for example catalog-item or table
  • {uuid} — UUID (v4 or v7) of the resource

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

Filter entities by parent URN. When omitted, entities are not filtered by parent.

searchstring

Full-text query matched against all string properties of the entity.

namestring

Filters results by exact match on the display name. The display name is governed by the core:displayName trait and defaults to the property named displayName or name, in that order.

afterstring

Cursor for forward pagination. Use the value from meta.next in the previous response.

sizeinteger

Number of entities to return per page.

sortstring[]

Comma-separated property names for sorting results, where fields prefixed with a hyphen (-) sort descending. Any scalar property defined for the entity in the metadata model can be used as a sort key.

Examples:

  • ?sort=name — sort by name ascending
  • ?sort=-name,abbreviation — sort by name descending, then abbreviation ascending
[
  "-name",
  "abbreviation"
]
propertiesstring[]

Comma-separated list of property names to include in the properties field of the response. When omitted, no properties are returned.

Property names must match the metadata model exactly. Only scalar properties, references, and their arrays are supported.

To discover which properties an entity type supports, use the Metadata model entities endpoints.

[
  "name",
  "abbreviation"
]
includestring[]

Comma-separated list of related resources to include in the response. When omitted, none of them are returned.

Supported values: effectiveStewardship. Any value outside the supported set is rejected with 400 VALIDATION_ERROR. Resolving included resources takes additional processing time. Request them only when you need them.

A supported value that the requested entity type does not carry as a trait is not an error; the corresponding field is simply absent from the response.

[
  "effectiveStewardship"
]

Response

Paginated list of entities.

Example response

{
  "meta": {
    "next": "MjA=",
    "total": 150
  },
  "data": [
    {
      "urn": "urn:ata:acme-corp:catalog:term:5d2c8a9e-1f47-4b36-8e0a-9c3b7d6f2a41",
      "rootSuperType": "term",
      "concreteType": "businessTerm",
      "properties": {
        "name": "Supplier",
        "abbreviation": "SUP",
        "securityClassification": null
      }
    }
  ]
}

Changes

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