Skip to main content

Folders

Folders are used to help you organize your spaces. Folders can only be created in either the home space or other spaces. Folders are of entityType: folder.

Folder Object
{
  "entityType": "folder",
  "id": "ffbe8c1d-1db7-48d1-9c58-f452838fedc0",
  "path": [
    "@user@dremio.com",
    "test-folder"
  ],
  "tag": "b79b70f4-d4a7-4fb5-bfbb-dc00b1b29801",
  "children": [
    {
      "id": "1fdcf5c3-5c95-4e50-a7a3-d0aa58056c99",
      "path": [
        "@user@dremio.com",
        "test-folder",
        "view-zip-codes"
      ],
      "tag": "a535d578-7921-4e56-b8c9-ada85d445fe6",
      "type": "DATASET",
      "datasetType": "VIRTUAL",
      "createdAt": "2021-12-01T17:33:07.786Z"
    },
    {
      "id": "f1ec2376-882e-406f-b37d-c97e8804b662",
      "path": [
        "@user@dremio.com",
        "test-folder",
        "test-sub-folder"
      ],
      "tag": "eb3c936d-e476-4bfd-9738-1619e9da4c32",
      "type": "CONTAINER",
      "containerType": "FOLDER"
    },
    {
      "id": "f460cfd7-8c8d-4295-ae3e-99dcc9162500",
      "path": [
        "@user@dremio.com",
        "test-folder",
        "SF-weather"
      ],
      "tag": "75428c7f-7e69-473e-5312-7e5543eb9fda",
      "type": "DATASET",
      "datasetType": "PROMOTED",
      "createdAt": "1970-01-01T00:00:00.000Z"
    }
  ],
  "accessControlList": {
    "users": [
      {
        "id": "63022041-783d-557e-8ead-271f5ea25812",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      }
    ]
  },
  "owner": {
    "ownerId": "a430ed7f-7142-4e1f-ba7d-94173afdc9a3",
    "ownerType": "USER"
  }
}

Folder Attributes​

{{< api-section file="data/api/folders.json" data="folderAttributes" >}}

children​

{{< api-section file="data/api/folders.json" data="children" >}}

accessControlList​

{{< api-section file="data/api/folders.json" data="accessControlList" >}}

owner​

{{< api-section file="data/api/folders.json" data="owner" >}}

users​

{{< api-section file="data/api/folders.json" data="users" >}}

Adding a Folder​

Add a folder under a space.

Adding a Folder
POST  /v0/projects/{project-id}/catalog

Parameters​

{{< api-section file="data/api/folders.json" data="addingFolderParameters" >}}

Example Request
curl -X POST 'https://api.dremio.cloud/v0/projects/02d36975-73eb-47ed-9bb5-de73060380f6/catalog' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json' \
-d '{
    "entityType": "folder",
    "path": ["reporting", "new-folder"]
    }'
Example Response
{
  "entityType": "folder",
  "id": "ffbe8c1d-1db7-48d1-9c58-f452838fedc0",
  "path": ["reporting","new-folder"],
  "tag": "b79b70f4-d4a7-4fb5-bfbb-dc00b1b29801",
  "accessControlList":{},
  "permissions":[],
  "owner": {
    "ownerId": "a430ed7f-7142-4e1f-ba7d-94173afdc9a3",
    "ownerType": "USER"
  }
}

Responses​

{{< api-responses file="data/api/folders.json" data="addingFolderResponses" >}}

Retrieving a Folder​

Get the folder metadata by providing the folder ID.

Retrieving a Folder
GET /v0/projects/{project-id}/catalog/{id}

Parameters​

{{< api-section file="data/api/folders.json" data="retrievingFolderParameters" >}}

Example Request
curl -X GET 'https://api.dremio.cloud/v0/projects/02d36975-73eb-47ed-9bb5-de73060380f6/catalog/ffbe8c1d-1db7-48d1-9c58-f452838fedc0' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'
Example Response
{
  "entityType": "folder",
  "id": "ffbe8c1d-1db7-48d1-9c58-f452838fedc0",
  "path": ["reporting","test-folder"],
  "tag": "b79b70f4-d4a7-4fb5-bfbb-dc00b1b29801",
  "accessControlList":{},
  "permissions":[],
  "owner": {
    "ownerId": "a430ed7f-7142-4e1f-ba7d-94173afdc9a3",
    "ownerType": "USER"
  }
}

Responses​

{{< api-responses file="data/api/folders.json" data="retrievingFolderResponses" >}}

Deleting a Folder​

Delete a folder.

Deleting a Folder
DELETE /v0/projects/{project-id}/catalog/{id}

Parameters​

{{< api-section file="data/api/folders.json" data="deletingFolderParameters" >}}

Example Request
curl -X DELETE 'https://api.dremio.cloud/v0/projects/02d36975-73eb-47ed-9bb5-de73060380f6/catalog/21a74cb1-3fcf-48c6-8f69-94c257ec3da3' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'
Example Response
No response

Responses​

{{< api-responses file="data/api/folders.json" data="deletingFolderResponses" >}}