ATataccama
Metadata Model Entities

Get metadata model entity

Retrieve a single entity definition by its name.

If no entity definition with the given name exists, the endpoint returns 404 Not Found.

get/catalog/v1/metadata-model/entities/{name}

Request

Path parameters

namestring required

The entity-type identifier, matching the name field of the entity definition. For example, term, businessTerm, or catalogItem.

Response

A metadata model entity.

namestring required

The unique entity-type identifier, for example, businessTerm. Use it as the path parameter when retrieving a single entity definition.

descriptionstring

A human-readable description of the entity type.

nodePathsstring[] required

The node paths under which entities of this type are located in the metadata model.

superEntitiesstring[] required

The names of the entity types this type extends, ordered from the direct parent up to the root type. The chain is complete.

subEntitiesstring[] required

The names of the entity types that directly extend this type.

editableboolean required

Whether entities of this type can be created, updated, or deleted. If false, entities of this type are read-only because they are managed by Ataccama.

Example response

{
  "name": "businessTerm",
  "description": "A term that captures business meaning attached to catalog data.",
  "nodePaths": [
    "/catalog/terms"
  ],
  "superEntities": [
    "term"
  ],
  "subEntities": [],
  "properties": [
    {
      "name": "isPii",
      "description": "Whether the term denotes personally identifiable information.",
      "type": "SCALAR",
      "scalarType": "boolean",
      "editable": true
    },
    {
      "name": "parent",
      "description": "Parent business term in the term hierarchy.",
      "type": "SINGLE_REFERENCE",
      "entityName": "term",
      "editable": true
    },
    {
      "name": "aliases",
      "description": "Aliases of this business term.",
      "type": "ARRAY_EMBEDDED",
      "entityName": "catalogAlias",
      "editable": true
    },
    {
      "name": "parentName",
      "description": "Name of the parent business term. Delegated to `parent.name`.",
      "type": "SCALAR",
      "scalarType": "string",
      "editable": false
    }
  ],
  "editable": true
}

Changes

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