ATataccama
Catalog Attributes

Update catalog attribute

Update the description or extra properties of a catalog attribute using JSON Merge Patch (RFC 7396). You only need to specify the fields you want to change.

Assigned terms cannot be changed through this endpoint. To assign or unassign terms, use the term-assignment batch endpoints POST /catalog/v1/attributes/term-assignments/batch/assign and POST /catalog/v1/attributes/term-assignments/batch/unassign.

patch/catalog/v1/attributes/{urn}

Request

Path parameters

urnstring uri required

A URN identifying a catalog attribute resource in the Catalog API.

Format: urn:ata:{tenant}:catalog:catalog-attribute:{uuid}

Example: urn:ata:acme-corp:catalog:catalog-attribute:123e4567-e89b-12d3-a456-426614174000.

Example:urn:ata:acme-corp:catalog:catalog-attribute:123e4567-e89b-12d3-a456-426614174000

URN identifier of the catalog attribute.

Request body

descriptionstring nullable

Updated description for the catalog attribute.

extraPropertiesExtraProperties

A map of properties associated with the entity defined in the metadata model. Only scalar and reference properties are supported, including arrays.

In responses, only properties explicitly requested via the extraProperties query parameter are included.

In PATCH requests, only the properties listed in the body are modified; set a property to null (for scalars) or [] (for reference arrays) to clear its value.

To find which extra properties are available for an entity, retrieve its entity definition through the Metadata model entities endpoints: catalogItem for catalog items, attribute for catalog attributes, source for sources, folder for folders, and the term's own type (for example, businessTerm) for terms.

Example request

{
  "description": "This column contains the full names of customers",
  "extraProperties": {
    "isPii": true,
    "sensitivity": "HIGH"
  }
}

Response

Catalog attribute updated.

catalogItemUrnstring uri

A URN identifying a catalog item resource in the Catalog API.

Format: urn:ata:{tenant}:catalog:catalog-item:{uuid}

Example: urn:ata:acme-corp:catalog:catalog-item:123e4567-e89b-12d3-a456-426614174000.

urnstring uri required

A URN identifying a catalog attribute resource in the Catalog API.

Format: urn:ata:{tenant}:catalog:catalog-attribute:{uuid}

Example: urn:ata:acme-corp:catalog:catalog-attribute:123e4567-e89b-12d3-a456-426614174000.

namestring required
descriptionstring
columnTypestring
dataTypestring
commentstring
extraPropertiesExtraProperties

A map of properties associated with the entity defined in the metadata model. Only scalar and reference properties are supported, including arrays.

In responses, only properties explicitly requested via the extraProperties query parameter are included.

In PATCH requests, only the properties listed in the body are modified; set a property to null (for scalars) or [] (for reference arrays) to clear its value.

To find which extra properties are available for an entity, retrieve its entity definition through the Metadata model entities endpoints: catalogItem for catalog items, attribute for catalog attributes, source for sources, folder for folders, and the term's own type (for example, businessTerm) for terms.

Example response

{
  "catalogItemUrn": "urn:ata:acme-corp:catalog:catalog-item:7764f356-1b8c-43f4-8e15-651feacfca1c",
  "urn": "urn:ata:acme-corp:catalog:catalog-attribute:7764f356-1b8c-43f4-8e15-651feacfca1d",
  "name": "customername",
  "dataType": "STRING",
  "columnType": "varchar",
  "description": "This column contains the full names of customers",
  "termAssignments": [
    {
      "termUrn": "urn:ata:acme-corp:catalog:term:3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "source": "MANUAL"
    },
    {
      "termUrn": "urn:ata:acme-corp:catalog:term:1ede1262-f76b-4d00-9929-e92c15d8a5ba",
      "source": "TERM_DETECTION"
    }
  ],
  "termDetectionDenylist": [
    {
      "termUrn": "urn:ata:acme-corp:catalog:term:7c9e6679-7425-40de-944b-e07fc1f90ae7"
    }
  ],
  "effectiveCriticality": {
    "isCritical": true
  },
  "extraProperties": {
    "isPii": true,
    "sensitivity": "HIGH"
  }
}

Changes

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