ATataccama
Generic Metadata Entities

Create entity

Create a new entity of any concrete type defined in the metadata model.

The body must specify the concreteType, the parentProperty that holds child entities of this type on the parent, and any initial properties defined in the metadata model.

The response returns the HTTP status code 201 Created with the created entity.

post/catalog/v1/entities

Request

Request body

concreteTypestring required

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

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.

parentPropertystring required

Name of the property on the parent that holds child entities of this type, as defined in the metadata model, for example, terms.

propertiesobject

A map of properties to set on the new entity, keyed by property name as defined in the metadata model.

Example request

{
  "concreteType": "businessTerm",
  "parentUrn": null,
  "parentProperty": "terms",
  "properties": {
    "name": "Personally Identifiable Information",
    "abbreviation": "PII",
    "businessDefinition": "Personally Identifiable Information (PII) is any data that can identify, contact, or locate a specific person, either alone or when combined with other data."
  }
}

Response

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