Folder

Type of the catalog object. For folders, the entityType is folder.

Example folder

Unique identifier of the folder. The ID can be a UUID like 1acab7b3-ee82-44c1-abcc-e86d56078d4d or a text path like dremio:/Samples/samples.dremio.com/zip_lookup.csv.

Example d4c2a8ba-a972-4db4-8deb-67e1ade684d1

Path of the folder within Dremio, expressed as an array. The path consists of the source or space, followed by any folder and subfolders, followed by the target folder itself as the last item in the array.

Example [ "Samples", "samples.dremio.com" ]

Unique identifier of the version of the folder. Dremio changes the tag whenever the folder changes and uses the tag to ensure that PUT requests apply to the most recent version of the folder.

Example pRmJ0BQ9SFw=

Information about each catalog object in the folder.

Example [ { "id": "dremio:/Samples/samples.dremio.com/zip_lookup.csv", "path": [ "Samples", "samples.dremio.com", "zip_lookup.csv" ], "type": "FILE" }, { "id": "dremio:/Samples/samples.dremio.com/NYC-taxi-trips-iceberg", "path": [ "Samples", "samples.dremio.com", "NYC-taxi-trips-iceberg" ], "type": "CONTAINER", "containerType": "FOLDER" }, { "id": "1acab7b3-ee82-44c1-abcc-e86d56078d4d", "path": [ "Samples", "samples.dremio.com", "NYC-taxi-trips" ], "type": "DATASET", "datasetType": "PROMOTED" } ]

Enterprise-only. Information about users and roles with access to the folder and the specific privileges each user or role has. May include an array of users, an array of roles, or both, depending on the configured access and privileges. The accessControlList array is empty if folder-specific access control privileges are not set.

Example { "users": [ { "id": "737a038f-c6cd-4fd3-a77a-59f692727ba5", "permissions": [ "SELECT", "ALTER" ] } ], "roles": [ { "id": "0f2d94e0-bb5e-4c03-8c6f-62d379d10889", "permissions": [ "SELECT" ] } ] }

Enterprise-only. List of the privileges that you have on the folder. Only appears in the response if the request URL includes the permissions query parameter. For more information, read Privileges.

Example [ "READ", "WRITE", "ALTER_REFLECTION", "SELECT", "ALTER", "VIEW_REFLECTION", "MODIFY", "MANAGE_GRANTS", "CREATE_TABLE", "DROP", "EXTERNAL_QUERY", "INSERT", "TRUNCATE", "DELETE", "UPDATE", "EXECUTE", "CREATE_SOURCE", "ALL" ]

Information about the folder's owner.

Example { "ownerId": "d01585a2-b267-4d56-9154-31762ab65a43", "ownerType": "USER" }

Unique identifier of the catalog object. The ID can be a UUID like 1acab7b3-ee82-44c1-abcc-e86d56078d4d or a text path like dremio:/Samples/samples.dremio.com/zip_lookup.csv.

Path of the catalog object within Dremio, expressed as an array. The path consists of the source or space, followed by any folder and subfolders, followed by the catalog object itself as the last item in the array.

Example [ "Samples", "samples.dremio.com", "zip_lookup.csv" ]

Type of the catalog object. If the object is saved within a space (including the home space), valid types are CONTAINER and DATASET. If the object is saved within a source, valid types are CONTAINER, FILE, and DATASET.

Example CONTAINER

For catalog objects with the type CONTAINER, the containerType is FOLDER.

Example FOLDER

For catalog objects with the type DATASET, the type of dataset. For tables, the datasetType is PROMOTED. For views, the datasetType is VIRTUAL.

Enum PROMOTED , VIRTUAL

Example VIRTUAL

Date and time that the catalog object was created, in UTC format. The createdAt attribute is included only for DATASET catalog objects that are saved in folders within spaces, not within sources.

Example 2023-01-30T17:54:25.547Z

Enterprise-only. List of users with access to the folder and the specific privileges each user has.

Example [ { "id": "737a038f-c6cd-4fd3-a77a-59f692727ba5", "permissions": [ "SELECT", "ALTER" ] } ]

Enterprise-only. List of roles whose members have access to the folder and the specific privileges each role has.

Example [ { "id": "0f2d94e0-bb5e-4c03-8c6f-62d379d10889", "permissions": [ "SELECT" ] } ]

Unique identifier of the folder's owner.

Example d01585a2-b267-4d56-9154-31762ab65a43

Type of owner of the folder.

Enum USER , ROLE

Example USER

Enterprise-only. Unique identifier of the user or role with access to the folder.

Example 737a038f-c6cd-4fd3-a77a-59f692727ba5

Enterprise-only. List of privileges the user or role has on the folder. For more information, read Privileges.

Enum ALTER_REFLECTION , SELECT , ALTER , VIEW_REFLECTION , MANAGE_GRANTS , ALL

Example [ "SELECT", "ALTER" ]

Type of the catalog object. For folders, the entityType is folder.

Example folder

Path of the location where the folder should be created within Dremio, expressed as an array. The path consists of the space, followed by any folder and subfolders, followed by a name for the target folder itself as the last item in the array.

Example [ "Example-Space", "First-Folder", "New-Folder" ]

Enterprise-only. Object used to specify which users and roles should have access to the folder and the specific privileges each user or role should have. May include an array of users, an array of roles, or both. Omit if you do not want to configure folder-specific access control privileges.

Example { "users": [ { "id": "737a038f-c6cd-4fd3-a77a-59f692727ba5", "permissions": [ "SELECT", "ALTER" ] } ], "roles": [ { "id": "0f2d94e0-bb5e-4c03-8c6f-62d379d10889", "permissions": [ "SELECT" ] } ] }

Enterprise-only. List of users who should have access to the folder and the specific privileges each user should have.

Example [ { "id": "737a038f-c6cd-4fd3-a77a-59f692727ba5", "permissions": [ "SELECT", "ALTER" ] } ]

Enterprise-only. List of roles whose members should have access to the folder and the specific privileges each role should have.

Example [ { "id": "0f2d94e0-bb5e-4c03-8c6f-62d379d10889", "permissions": [ "SELECT" ] } ]

Enterprise-only. Unique identifier of the user or role who should have access to the folder.

Example 737a038f-c6cd-4fd3-a77a-59f692727ba5

Enterprise-only. List of privileges the user or role should have on the folder. For more information, read Privileges.

Enum ALTER_REFLECTION , SELECT , ALTER , VIEW_REFLECTION , MANAGE_GRANTS , ALL

Example [ "SELECT", "ALTER" ]

Unique identifier of the folder that you want to retrieve. If the ID is a text path, URI-encode the path to replace special characters with their UTF-8 equivalents, such as %3A for a colon; %2F for a forward slash; and %20 for a space. For example, if the ID value is dremio:/Samples/samples.dremio.com/Dremio University, the URI-encoded ID is dremio%3A%2FSamples%2Fsamples.dremio.com%2FDremio%20University.

Example d4c2a8ba-a972-4db4-8deb-67e1ade684d1

Include a non-default attribute in the response. The available value for the include query parameter is permissions. For more information, read include and exclude Query Parameters.

Example ?include=permissions

Exclude a default attribute from the response. The available value for the exclude query parameter is children. For more information, read include and exclude Query Parameters.

Example ?exclude=children

Path of the folder that you want to retrieve, with a forward slash to separate each level of nesting. URI-encode the path to replace special characters in folder names with their UTF-8 equivalents, such as %3A for a colon and %20 for a space (for example, Samples/samples.dremio.com/Dremio%20University).

Example Samples/samples.dremio.com

Include a non-default attribute in the response. The available value for the include query parameter is permissions. For more information, read include and exclude Query Parameters.

Example ?include=permissions

Exclude a default attribute from the response. The available value for the exclude query parameter is children. For more information, read include and exclude Query Parameters.

Example ?exclude=children

Type of the catalog object. For folders, the entityType is folder.

Example folder

Unique identifier of the folder to update.

Example 598697c2-8be0-4050-9731-53563977a17d

Path of the location where the folder is saved within Dremio, expressed as an array. The path consists of the space, followed by any folder and subfolders, followed by the target folder itself as the last item in the array.

Example [ "Example-Space", "First-Folder", "New-Folder" ]

Unique identifier of the version of the folder that you want to update. Dremio uses the tag to ensure that you are requesting to update the most recent version of the folder.

Example R7COubQq8KE=

Enterprise-only. Object used to specify which users and roles should have access to the folder and the specific privileges each user or role should have. If you omit the accessControlList object in a PUT request, Dremio removes all existing user and role access settings from the folder. To keep existing user and role access settings while making other updates, duplicate the existing accessControlList array in the PUT request.

Example { "users": [ { "id": "737a038f-c6cd-4fd3-a77a-59f692727ba5", "permissions": [ "ALL" ] } ], "roles": [ { "id": "0f2d94e0-bb5e-4c03-8c6f-62d379d10889", "permissions": [ "SELECT" ] } ] }

Enterprise-only. List of users who should have access to the folder and the specific privileges each user should have. If you omit the users object in a PUT request, Dremio removes all existing user access settings from the folder. To keep existing user access settings while making other updates, duplicate the existing users array in the PUT request.

Example [ { "id": "737a038f-c6cd-4fd3-a77a-59f692727ba5", "permissions": [ "ALL" ] } ]

Enterprise-only. List of roles whose members should have access to the folder and the specific privileges each role should have. If you omit the roles object in a PUT request, Dremio removes all existing role access settings from the folder. To keep existing role access settings while making other updates, duplicate the existing roles array in the PUT request.

Example [ { "id": "0f2d94e0-bb5e-4c03-8c6f-62d379d10889", "permissions": [ "SELECT" ] } ]

Enterprise-only. Unique identifier of the user or role who should have access to the folder.

Example 737a038f-c6cd-4fd3-a77a-59f692727ba5

Enterprise-only. List of privileges the user or role should have on the folder. For more information, read Privileges.

Enum ALTER_REFLECTION , SELECT , ALTER , VIEW_REFLECTION , MANAGE_GRANTS , ALL

Example [ "ALL" ]

Unique identifier of the folder that you want to delete.

Example 598697c2-8be0-4050-9731-53563977a17d