ATataccama
Folders

List folders

List the folders.

To list the catalog items placed in a folder, use List catalog items with the parentUrn query parameter.

Paging is forward-only.

get/catalog/v1/folders

Request

Query parameters

afterstring

Cursor for forward pagination. Use the value from meta.next in the previous response. Starts at the beginning when omitted.

sizeinteger

Number of folders to return.

parentUrnstring uri

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
Example:urn:ata:acme-corp:catalog:source:28e3ca71-635b-43c4-9d1b-bc9cc642721f

Filter folders by their parent: a source URN or a folder URN. Use it to browse a single level of the folder hierarchy. When omitted, folders are not filtered by parent.

searchstring

Full-text query matched against all string properties of the folder, such as name and description.

namestring

Filter folders by exact match on the name.

sortstring[]

Comma-separated field names for sorting results; prefix with a hyphen (-) for descending order. Only name is supported.

Examples:

  • ?sort=name — sort by name ascending
  • ?sort=-name — sort by name descending
[
  "name"
]
extraPropertiesstring[]

Comma-separated list of extra property names to include in the extraProperties field of the response. When omitted, no extra properties are returned.

The property names must exactly match the property names defined in the metadata model. Only scalars, references and their arrays are supported.

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, dataProduct for data products, dataProductStatus for data product statuses, domain for domains, and the term's own type (for example, businessTerm) for terms. Extra properties cannot be used as filter criteria.

[
  "isPii",
  "community",
  "domains"
]

Response

Paginated list of folders.

Example response

{
  "meta": {
    "next": "MjA=",
    "total": 150
  },
  "data": [
    {
      "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.