ATataccama
Folders

Update folder

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

The parent of the folder can't be changed.

patch/catalog/v1/folders/{urn}

Request

Path parameters

urnstring uri required

A URN identifying a Folder resource in the Catalog API.

Format: urn:ata:{tenant}:catalog:folder:{uuid}

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

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

URN identifier of the folder.

Request body

namestring

Updated name of the folder.

descriptionstring nullable

Updated description of the folder.

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

{
  "name": "Revenue",
  "description": "Revenue reporting assets curated by the finance team",
  "extraProperties": {
    "isPii": false
  }
}

Response

Folder updated.

urnstring uri required

A URN identifying a Folder resource in the Catalog API.

Format: urn:ata:{tenant}:catalog:folder:{uuid}

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

namestring required

Name of the folder.

descriptionstring

Description of the folder.

parentUrnstring uri required

URN of the folder's parent. A folder is nested either directly under a source or under another folder, forming a recursive hierarchy.

Format: urn:ata:{tenant}:catalog:source:{uuid} or urn:ata:{tenant}:catalog:folder:{uuid}

Example values:

  • urn:ata:acme-corp:catalog:source:28e3ca71-635b-43c4-9d1b-bc9cc642721f
  • urn:ata:acme-corp:catalog:folder:123e4567-e89b-12d3-a456-426614174000
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:folder:9b1c4d2e-6f3a-4c5b-8d7e-1a2b3c4d5e6f",
  "name": "Revenue",
  "description": "Manually curated revenue reporting assets",
  "parentUrn": "urn:ata:acme-corp:catalog:source:28e3ca71-635b-43c4-9d1b-bc9cc642721f",
  "extraProperties": {
    "isPii": true,
    "community": "Customer Solutions"
  }
}

Changes

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