ATataccama
Metadata Model Entities

List metadata model entities

List the entity definitions in the metadata model.

Paging is forward-only.

get/catalog/v1/metadata-model/entities

Request

Query parameters

afterstring

Cursor for forward pagination. When omitted, the list starts at the beginning.

sizeinteger

Number of entity definitions to return per page.

searchstring

Full-text query matched against the entity name and description.

namestring

Filters results by exact match on the entity name.

Response

Paginated list of metadata model entities.

Example response

{
  "meta": {
    "next": "MjA=",
    "total": 150
  },
  "data": [
    {
      "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.