--- title: "Update catalog attribute" method: PATCH path: "/catalog/v1/attributes/{urn}" tags: ["Catalog Attributes"] --- # Update catalog attribute `PATCH /catalog/v1/attributes/{urn}` ## Request - Base URL: `https://your-environment.ataccama.one/api` - URL: `https://your-environment.ataccama.one/api/catalog/v1/attributes/{urn}` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Update the description or extra properties of a catalog attribute using JSON Merge Patch ([RFC 7396](https://www.rfc-editor.org/rfc/rfc7396.html)). 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`. ## Path parameters - `urn` string, 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. ## Request body - CatalogAttributePatch - `description` string, nullable: Updated description for the catalog attribute. - `extraProperties` ExtraProperties: 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. ## Response `200` Catalog attribute updated. - CatalogAttribute - `catalogItemUrn` string, 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. - `urn` string, 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. - `name` string, required - `description` string - `columnType` string - `dataType` string - `comment` string - `termAssignments` AttributeTermAssignment[]: The terms assigned to the attribute. Each entry contains the `termUrn` of the term and the `source`, which tells you how the term was assigned. Manage assignments with the `POST /catalog/v1/attributes/term-assignments/batch/assign` and `.../batch/unassign` endpoints. - `termUrn` string, uri, required: A URN identifying a term resource in the Catalog API. Format: urn:ata:{tenant}:catalog:term:{uuid} Example: urn:ata:acme-corp:catalog:term:123e4567-e89b-12d3-a456-426614174000. - `source` string: @ExtensibleEnum How the term was assigned to the attribute. - `MANUAL`: The term was assigned by a user in the web application or through this API. - `TERM_DETECTION`: The term was assigned automatically by term detection. Other values can be added in future releases. - `termDetectionDenylist` TermDetectionDenylistEntry[]: The terms that term detection must never assign to the attribute automatically. Each entry contains only the `termUrn`. Manage the denylist with the `POST /catalog/v1/attributes/term-assignments/denylist/batch/add` and `.../batch/remove` endpoints. - `termUrn` string, uri, required: A URN identifying a term resource in the Catalog API. Format: urn:ata:{tenant}:catalog:term:{uuid} Example: urn:ata:acme-corp:catalog:term:123e4567-e89b-12d3-a456-426614174000. - `effectiveCriticality` EffectiveCriticality: Effective criticality of this resource, either set directly on it or inherited. Critical resources are the critical data elements (CDEs) of the catalog. Criticality propagates along the chain business process → term → attribute → catalog item. A resource that has no criticality of its own is critical whenever at least one of the resources it inherits from is effectively critical; a value set directly on the resource always overrides what it would inherit. Which relations propagate criticality is configurable, see [Define critical data elements](https://docs.ataccama.com/ataccama-one-agentic/latest/data-catalog/define-critical-data-elements.html). Returned only when requested with `include=effectiveCriticality`. The value is `null` when no criticality is set on the resource and none is inherited. The response does not show which resource the criticality is inherited from. Criticality cannot be set or used as a filter criterion through the Catalog API. It is managed in the web application. - `isCritical` boolean, required: Whether the resource is critical. - `extraProperties` ExtraProperties: 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. ## Other responses - `400`: Bad request. The request parameters or body are invalid. - `403`: Forbidden. You do not have permission to access the requested resource. - `404`: Not found. The requested resource does not exist. --- [API](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api.md) - [All operations](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/revisions/46f16e0487f8?raw)