--- title: "Update term" method: PATCH path: "/catalog/v1/terms/{urn}" tags: ["Terms"] --- # Update term `PATCH /catalog/v1/terms/{urn}` ## Request - Base URL: `https://your-environment.ataccama.one/api` - URL: `https://your-environment.ataccama.one/api/catalog/v1/terms/{urn}` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Update specific fields of a term 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. The response returns the updated term with all fields, the same structure as [Get term](#tag/terms/GET/catalog/v1/terms/{urn}). Stewardship cannot be changed through this endpoint. To change the group responsible for the entity, use `POST /catalog/v1/stewardship/manage`. ## Path parameters - `urn` 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. ## Request body - TermPatch - `name` string, nullable: Updated name for the term. - `description` string, nullable: Updated description for the term. - `detectionRules` object, nullable: Detection rules configuration for automated term assignment. - `operator` string: @ExtensibleEnum Logical operator for combining rules: `AND` or `OR`. The set is extensible. New values might be added over time, so make sure your integration handles unknown values gracefully. - `ruleAssignments` DetectionRuleAssignment[], nullable: Detection rule assignments. - `detectionRuleUrn` string, uri, required: A URN identifying a detection rule resource in the Catalog API. Format: urn:ata:{tenant}:catalog:detection-rule:{uuid} Example: urn:ata:acme-corp:catalog:detection-rule:123e4567-e89b-12d3-a456-426614174000. - `threshold` number, float: Confidence threshold for the rule match, if the rule supports one. - `attributeToCatalogItemTermRules` object, nullable: Rules for propagating term assignments from attributes to their parent catalog items. - `operator` string: @ExtensibleEnum Logical operator for combining rules: `AND` or `OR`. The set is extensible. New values might be added over time, so make sure your integration handles unknown values gracefully. - `rules` AttributeToCatalogItemTermRule[], nullable - `operator` string: @ExtensibleEnum Logical operator for combining rules: `AND` or `OR`. The set is extensible. New values might be added over time, so make sure your integration handles unknown values gracefully. - `terms` TermAssignment[] - `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. - `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` The updated term, with the same structure as [Get term](#tag/terms/GET/catalog/v1/terms/{urn}). - Term - `urn` 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. - `effectiveStewardship` EffectiveStewardship: The stewardship that applies to an entity: either assigned directly to the entity or inherited from an ancestor, such as the source of a catalog item. Resolving effective stewardship takes additional processing time, so request it only when you need it. - `groupUrn` string, uri, required: A URN identifying a group resource in the IAM API. To find a group's URN, use the Groups endpoints of the IAM API. Format: urn:ata:{tenant}:iam:group:{uuid} Example: urn:ata:acme-corp:iam:group:123e4567-e89b-12d3-a456-426614174000. - `originUrn` string, 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. - `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. - `type` string, required: The exact type of term as defined in the metadata model, for example, `businessTerm` or `securityTerm`. - `name` string, required: Name of the term. - `description` string: Description of the term. - `detectionRules` TermDetectionRules: Detection rules define how the term is automatically assigned to catalog items and attributes. Rule assignments are combined using the logical `operator`; each assignment references a detection rule and an optional confidence `threshold` (0–100) for the rule match. - `operator` string: @ExtensibleEnum Logical operator for combining rules: `AND` or `OR`. The set is extensible. New values might be added over time, so make sure your integration handles unknown values gracefully. - `ruleAssignments` DetectionRuleAssignment[]: Detection rule assignments. - `detectionRuleUrn` string, uri, required: A URN identifying a detection rule resource in the Catalog API. Format: urn:ata:{tenant}:catalog:detection-rule:{uuid} Example: urn:ata:acme-corp:catalog:detection-rule:123e4567-e89b-12d3-a456-426614174000. - `threshold` number, float: Confidence threshold for the rule match, if the rule supports one. - `attributeToCatalogItemTermRules` AttributeToCatalogItemTermRules: Rules for propagating term assignments from attributes to their parent catalog items. - `operator` string: @ExtensibleEnum Logical operator for combining rules: `AND` or `OR`. The set is extensible. New values might be added over time, so make sure your integration handles unknown values gracefully. - `rules` AttributeToCatalogItemTermRule[] - `operator` string: @ExtensibleEnum Logical operator for combining rules: `AND` or `OR`. The set is extensible. New values might be added over time, so make sure your integration handles unknown values gracefully. - `terms` TermAssignment[] - `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. ## 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)