ATataccama
Catalog Items

Update catalog item

Update specific fields of a published catalog item using JSON Merge Patch (RFC 7396). You only need to specify the fields you want to change.

For SQL catalog items, query updates the SQL query. The type and folder of an SQL catalog item can't be changed.

Stewardship cannot be updated through this endpoint. To change the group responsible for the catalog item, use POST /catalog/v1/stewardship/manage.

patch/catalog/v1/catalog-items/{urn}

Request

Path parameters

urnstring uri required

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.

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

URN identifier of the catalog item.

Request body

descriptionstring nullable

Updated description for the catalog item.

querystring

Updated SQL query of an SQL catalog item. Applicable only to SQL catalog items (dslQueryCatalogItem).

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": "Updated description for the customer table",
  "aliases": [
    {
      "type": "COLLIBRA_ASSET_ID",
      "value": "a23e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "extraProperties": {
    "isPii": true,
    "community": "Customer Solutions",
    "domains": [
      "urn:ata:acme-corp:catalog:domain:10bae762-0000-8010-8000-000001eb0065"
    ]
  }
}

Response

Catalog item updated.

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

namestring required

Name of the catalog item.

descriptionstring

Description of the catalog item.

originPathstring

Origin path of the catalog item in the source system.

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

{
  "urn": "urn:ata:acme-corp:catalog:catalog-item:fde84300-7a83-4d24-8c88-30ada80b0b54",
  "name": "customers",
  "description": "This table contains information about our customers",
  "originPath": "public/customers",
  "connection": {
    "urn": "urn:ata:acme-corp:processing:connection:b812d964-f94e-4be7-85c3-0073742ade09"
  },
  "termAssignments": [
    {
      "termUrn": "urn:ata:acme-corp:catalog:term:1ede1262-f76b-4d00-9929-e92c15d8a5ba"
    },
    {
      "termUrn": "urn:ata:acme-corp:catalog:term:3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "locations": [
    {
      "urn": "urn:ata:acme-corp:catalog:location:2b9d1f0a-3c4e-4a5b-9c8d-7e6f5a4b3c2d",
      "name": "public"
    },
    {
      "urn": "urn:ata:acme-corp:catalog:location:3c0e2a1b-4d5f-4b6c-8d9e-1f2a3b4c5d6e",
      "name": "CustomerDB"
    }
  ],
  "source": {
    "urn": "urn:ata:acme-corp:catalog:source:28e3ca71-635b-43c4-9d1b-bc9cc642721f"
  },
  "effectiveStewardship": {
    "groupUrn": "urn:ata:acme-corp:iam:group:b3c4d5e6-f7a8-4b9c-8d0e-1f2a3b4c5d6e",
    "originUrn": "urn:ata:acme-corp:catalog:source:28e3ca71-635b-43c4-9d1b-bc9cc642721f"
  },
  "effectiveCriticality": {
    "isCritical": true
  },
  "primaryDqMonitor": {
    "urn": "urn:ata:acme-corp:data-quality:dq-monitor:3c9e6679-7425-40de-944b-e07fc1f90ae7"
  },
  "aliases": [
    {
      "type": "COLLIBRA_ASSET_ID",
      "value": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "extraProperties": {
    "isPii": true,
    "community": "Customer Solutions",
    "domains": [
      "urn:ata:acme-corp:catalog:domain:10bae762-0000-8010-8000-000001eb0065"
    ]
  }
}

Changes

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