ATataccama
Generic Metadata Entities

Get entity

Retrieve an entity by URN.

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

get/catalog/v1/entities/{urn}

Request

Path parameters

urnstring uri required

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

URN identifier of the entity, for example, urn:ata:acme-corp:catalog:term:5d2c8a9e-1f47-4b36-8e0a-9c3b7d6f2a41.

Query parameters

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

An entity.

urnstring uri required

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.

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.

rootSuperTypestring required

The root super type of the entity in the metadata model type hierarchy, for example, term.

concreteTypestring required

The concrete (most specific) type of the entity in the metadata model, for example, businessTerm.

propertiesobject

A map of properties defined for the entity in the metadata model. Only the properties you explicitly request through the properties query parameter are included.

Property names must match the metadata model exactly. Supported property value types are scalars (string, number, Boolean), URN references, arrays of those, or null.

Example response

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