ATataccama
Generic Metadata Entities

Update entity

Update the properties of an entity using JSON Merge Patch (RFC 7396). Only the properties listed in properties are modified. properties is optional: a request without it succeeds without changing the entity.

Set a property to null (for scalars) or [] (for reference arrays) to clear its value. Properties not listed are left untouched.

The response returns the updated entity with the properties you changed.

patch/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.

Request body

propertiesobject

A map of properties to merge into the entity, keyed by property name as defined in the metadata model.

Example request

{
  "properties": {
    "abbreviation": "SUPP",
    "securityClassification": null
  }
}

Response

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