Skip to main content
Version: 0.0.1

Space

Use the Catalog API to retrieve information about spaces and the child objects they contain, as well as to create, update, and delete spaces.

{{< codeheader "Space Object" >}}

{
  "entityType": "space",
  "id": "5442c00a-ada1-48c6-82fc-bb804b2e04e0",
  "name": "Example-Space",
  "tag": "zzOQfjY9lU0=",
  "createdAt": "2023-01-12T18:44:43.237Z",
  "children": [
    {
      "id": "8da037a1-8e50-422b-9a2b-cafb03f57c71",
      "path": [
        "Example-Space",
        "testfolder"
      ],
      "tag": "0McuCL4MzBU=",
      "type": "CONTAINER",
      "containerType": "FOLDER"
    },
    {
      "id": "f32dfe85-32e2-4c31-b2b4-bfd62ab3f473",
      "path": [
        "Example-Space",
        "travel_testing"
      ],
      "tag": "i4mnlSmHqVM=",
      "type": "DATASET",
      "datasetType": "VIRTUAL",
      "createdAt": "2023-01-30T17:54:25.547Z"
    },
    {
      "id": "7f1c4660-cd7b-40d0-97d1-b8a6f431cbda",
      "path": [
        "Example-Space",
        "zips"
      ],
      "tag": "ITlp8+qyIMQ=",
      "type": "DATASET",
      "datasetType": "VIRTUAL",
      "createdAt": "2023-02-08T16:24:25.084Z"
    }
  ],
  "accessControlList": {
    "users": [
      {
        "id": "737a038f-c6cd-4fd3-a77a-59f692727ba5",
        "permissions": [
          "MODIFY"
        ]
      }
    ],
    "roles": [
      {
        "id": "0f2d94e0-bb5e-4c03-8c6f-62d379d10889",
        "permissions": [
          "MODIFY"
        ]
      }
    ]
  },
  "permissions": [
    "READ",
    "WRITE",
    "ALTER_REFLECTION",
    "SELECT",
    "ALTER",
    "VIEW_REFLECTION",
    "MODIFY",
    "MANAGE_GRANTS",
    "CREATE_TABLE",
    "DROP",
    "EXTERNAL_QUERY",
    "INSERT",
    "TRUNCATE",
    "DELETE",
    "UPDATE",
    "EXECUTE",
    "CREATE_SOURCE",
    "ALL"
  ],
  "owner": {
    "ownerId": "d01585a2-b267-4d56-9154-31762ab65a43",
    "ownerType": "USER"
  }
}

Space Attributes​

{{< api-section file="data/software-api/space.json" data="spaceAttributes" >}}

children​

{{< api-section file="data/software-api/space.json" data="childrenAttributes" >}}

accessControlList​

{{< api-section file="data/software-api/space.json" data="accessControlListAttributes" >}}

owner​

{{< api-section file="data/software-api/space.json" data="ownerAttributes" >}}

users and roles​

{{< api-section file="data/software-api/space.json" data="usersRolesAccessControlAttributes" >}}

Creating a Space​

Create a new space.

{{< codeheader "Method and URL" >}}

POST /api/v3/catalog

Parameters​

{{< api-section file="data/software-api/space.json" data="createSpaceParameters" >}}

accessControlList​

{{< api-section file="data/software-api/space.json" data="createAccessControlListParameters" >}}

users and roles​

{{< api-section file="data/software-api/space.json" data="createUsersRolesParameters" >}}


{{< codeheader "Example Request" >}}

curl -X POST 'https://{hostname}/api/v3/catalog' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "entityType": "space",
  "name": "Example-Space",
  "accessControlList": {
    "users": [
      {
        "id": "737a038f-c6cd-4fd3-a77a-59f692727ba5",
        "permissions": [
          "MODIFY"
        ]
      }
    ],
    "roles": [
      {
        "id": "0f2d94e0-bb5e-4c03-8c6f-62d379d10889",
        "permissions": [
          "MODIFY"
        ]
      }
    ]
  }
}'

{{< codeheader "Example Response" >}}

{
  "entityType": "space",
  "id": "5442c00a-ada1-48c6-82fc-bb804b2e04e0",
  "name": "Example-Space",
  "tag": "zzOQfjY9lU0=",
  "createdAt": "2023-01-12T18:44:43.237Z",
  "accessControlList": {
    "users": [
      {
        "id": "737a038f-c6cd-4fd3-a77a-59f692727ba5",
        "permissions": [
          "MODIFY"
        ]
      }
    ],
    "roles": [
      {
        "id": "0f2d94e0-bb5e-4c03-8c6f-62d379d10889",
        "permissions": [
          "MODIFY"
        ]
      }
    ]
  },
  "permissions": [],
  "owner": {
    "ownerId": "d01585a2-b267-4d56-9154-31762ab65a43",
    "ownerType": "USER"
  }
}

Response Status Codes​

{{< api-responses file="data/software-api/space.json" data="createSpaceResponseCodes" >}}

Retrieving a Space by ID​

Retrieve a space and information about its contents by specifying the space's ID.

{{< codeheader "Method and URL" >}}

GET /api/v3/catalog/{id}

Parameters​

{{< api-section file="data/software-api/space.json" data="retrieveSpaceIdParameters" >}}


{{< codeheader "Example Request" >}}

curl -X GET 'https://{hostname}/api/v3/catalog/5442c00a-ada1-48c6-82fc-bb804b2e04e0' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json'

{{< codeheader "Example Response" >}}

{
  "entityType": "space",
  "id": "5442c00a-ada1-48c6-82fc-bb804b2e04e0",
  "name": "Example-Space",
  "tag": "zzOQfjY9lU0=",
  "createdAt": "2023-01-12T18:44:43.237Z",
  "children": [
    {
      "id": "8da037a1-8e50-422b-9a2b-cafb03f57c71",
      "path": [
        "Example-Space",
        "testfolder"
      ],
      "tag": "0McuCL4MzBU=",
      "type": "CONTAINER",
      "containerType": "FOLDER"
    },
    {
      "id": "f32dfe85-32e2-4c31-b2b4-bfd62ab3f473",
      "path": [
        "Example-Space",
        "travel_testing"
      ],
      "tag": "i4mnlSmHqVM=",
      "type": "DATASET",
      "datasetType": "VIRTUAL",
      "createdAt": "2023-01-30T17:54:25.547Z"
    },
    {
      "id": "7f1c4660-cd7b-40d0-97d1-b8a6f431cbda",
      "path": [
        "Example-Space",
        "zips"
      ],
      "tag": "ITlp8+qyIMQ=",
      "type": "DATASET",
      "datasetType": "VIRTUAL",
      "createdAt": "2023-02-08T16:24:25.084Z"
    }
  ],
  "accessControlList": {
    "users": [
      {
        "id": "737a038f-c6cd-4fd3-a77a-59f692727ba5",
        "permissions": [
          "MODIFY"
        ]
      }
    ],
    "roles": [
      {
        "id": "0f2d94e0-bb5e-4c03-8c6f-62d379d10889",
        "permissions": [
          "MODIFY"
        ]
      }
    ]
  },
  "owner": {
    "ownerId": "d01585a2-b267-4d56-9154-31762ab65a43",
    "ownerType": "USER"
  }
}

Response Status Codes​

{{< api-responses file="data/software-api/space.json" data="retrieveSpaceIdResponseCodes" >}}

Retrieving a Space by Path​

Retrieve a space and information about its contents by specifying the space's path.

{{< codeheader "Method and URL" >}}

GET /api/v3/catalog/by-path/{path}

Parameters​

{{< api-section file="data/software-api/space.json" data="retrieveSpacePathParameters" >}}


{{< codeheader "Example Request" >}}

curl -X GET 'https://{hostname}/api/v3/catalog/by-path/Example-Space' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json'

{{< codeheader "Example Response" >}}

{
  "entityType": "space",
  "id": "5442c00a-ada1-48c6-82fc-bb804b2e04e0",
  "name": "Example-Space",
  "tag": "zzOQfjY9lU0=",
  "createdAt": "2023-01-12T18:44:43.237Z",
  "children": [
    {
      "id": "8da037a1-8e50-422b-9a2b-cafb03f57c71",
      "path": [
        "Example-Space",
        "testfolder"
      ],
      "tag": "0McuCL4MzBU=",
      "type": "CONTAINER",
      "containerType": "FOLDER"
    },
    {
      "id": "f32dfe85-32e2-4c31-b2b4-bfd62ab3f473",
      "path": [
        "Example-Space",
        "travel_testing"
      ],
      "tag": "i4mnlSmHqVM=",
      "type": "DATASET",
      "datasetType": "VIRTUAL",
      "createdAt": "2023-01-30T17:54:25.547Z"
    },
    {
      "id": "7f1c4660-cd7b-40d0-97d1-b8a6f431cbda",
      "path": [
        "Example-Space",
        "zips"
      ],
      "tag": "ITlp8+qyIMQ=",
      "type": "DATASET",
      "datasetType": "VIRTUAL",
      "createdAt": "2023-02-08T16:24:25.084Z"
    }
  ],
  "accessControlList": {
    "users": [
      {
        "id": "737a038f-c6cd-4fd3-a77a-59f692727ba5",
        "permissions": [
          "MODIFY"
        ]
      }
    ],
    "roles": [
      {
        "id": "0f2d94e0-bb5e-4c03-8c6f-62d379d10889",
        "permissions": [
          "MODIFY"
        ]
      }
    ]
  },
  "owner": {
    "ownerId": "d01585a2-b267-4d56-9154-31762ab65a43",
    "ownerType": "USER"
  }
}

Response Status Codes​

{{< api-responses file="data/software-api/space.json" data="retrieveSpacePathResponseCodes" >}}

Updating a Space​

Update the specified space.

{{< codeheader "Method and URL" >}}

PUT /api/v3/catalog/{id}

Parameters​

{{< api-section file="data/software-api/space.json" data="updateSpaceParameters" >}}

accessControlList​

{{< api-section file="data/software-api/space.json" data="updateAccessControlListParameters" >}}

users and roles​

{{< api-section file="data/software-api/space.json" data="updateUsersRolesParameters" >}}


{{< codeheader "Example Request" >}}

curl -X PUT 'https://{hostname}/api/v3/catalog/5442c00a-ada1-48c6-82fc-bb804b2e04e0' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "entityType": "space",
  "id": "5442c00a-ada1-48c6-82fc-bb804b2e04e0",
  "name": "Example-Space",
  "tag": "zzOQfjY9lU0=",
  "accessControlList": {
    "users": [
      {
        "id": "737a038f-c6cd-4fd3-a77a-59f692727ba5",
        "permissions": [
          "ALL"
        ]
      }
    ],
    "roles": [
      {
        "id": "0f2d94e0-bb5e-4c03-8c6f-62d379d10889",
        "permissions": [
          "MODIFY"
        ]
      }
    ]
  }
}'

{{< codeheader "Example Response" >}}

{
  "entityType": "space",
  "id": "5442c00a-ada1-48c6-82fc-bb804b2e04e0",
  "name": "Example-Space",
  "tag": "PwZ6e/axHUY=",
  "createdAt": "2023-01-12T18:44:43.237Z",
  "children": [
    {
      "id": "8da037a1-8e50-422b-9a2b-cafb03f57c71",
      "path": [
        "Example-Space",
        "testfolder"
      ],
      "tag": "0McuCL4MzBU=",
      "type": "CONTAINER",
      "containerType": "FOLDER"
    },
    {
      "id": "f32dfe85-32e2-4c31-b2b4-bfd62ab3f473",
      "path": [
        "Example-Space",
        "travel_testing"
      ],
      "tag": "i4mnlSmHqVM=",
      "type": "DATASET",
      "datasetType": "VIRTUAL",
      "createdAt": "2023-01-30T17:54:25.547Z"
    },
    {
      "id": "7f1c4660-cd7b-40d0-97d1-b8a6f431cbda",
      "path": [
        "Example-Space",
        "zips"
      ],
      "tag": "ITlp8+qyIMQ=",
      "type": "DATASET",
      "datasetType": "VIRTUAL",
      "createdAt": "2023-02-08T16:24:25.084Z"
    }
  ],
  "accessControlList": {
    "users": [
      {
        "id": "737a038f-c6cd-4fd3-a77a-59f692727ba5",
        "permissions": [
          "ALTER_REFLECTION",
          "MODIFY",
          "ALTER",
          "MANAGE_GRANTS",
          "VIEW_REFLECTION",
          "SELECT"
        ]
      }
    ],
    "roles": [
      {
        "id": "0f2d94e0-bb5e-4c03-8c6f-62d379d10889",
        "permissions": [
          "MODIFY"
        ]
      }
    ]
  },
  "owner": {
    "ownerId": "d01585a2-b267-4d56-9154-31762ab65a43",
    "ownerType": "USER"
  }
}

Deleting a Space​

Delete the specified space, including all of the space's contents.

{{< codeheader "Method and URL" >}}

DELETE /api/v3/catalog/{id}

Parameters​

{{< api-section file="data/software-api/space.json" data="deleteSpaceParameters" >}}


{{< codeheader "Example Request" >}}

curl -X DELETE 'https://{hostname}/api/v3/catalog/5442c00a-ada1-48c6-82fc-bb804b2e04e0' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json'

{{< codeheader "Example Response" >}}

No response

Response Status Codes​

{{< api-responses file="data/software-api/space.json" data="deleteSpaceResponseCodes" >}}