Skip to main content
Version: current

Home

Use the Catalog API to retrieve information about the home space and the child objects it contains.

Home Object
{
  "entityType": "home",
  "id": "87049e43-8564-4ee7-8bb6-5bdaf5bd0959",
  "name": "@user@dremio.com",
  "tag": "8S9cTZ5IsWo=",
  "children": [
    {
      "id": "1e16c0e5-c890-4f87-b1a6-ac9325aafa2c",
      "path": [
        "@user@dremio.com",
        "Business"
      ],
      "tag": "KgFBPW3+Cyc=",
      "type": "CONTAINER",
      "containerType": "FOLDER"
    },
    {
      "id": "a59815d0-3c21-41ad-b9bc-2ba105251fa6",
      "path": [
        "@user@dremio.com",
        "meeting_rooms_lookup"
      ],
      "tag": "OaQT64frevc=",
      "type": "DATASET",
      "datasetType": "PROMOTED",
      "createdAt": "1970-01-01T00:00:00.000Z"
    },
    {
      "id": "37401663-8666-4e00-bc03-668abb43ccd7",
      "path": [
        "@user@dremio.com",
        "NYC-trips-quarterly"
      ],
      "tag": "+H5TpLYoosY=",
      "type": "DATASET",
      "datasetType": "VIRTUAL",
      "createdAt": "2023-02-07T21:26:14.385Z"
    }
  ]
}

Home Attributes​

{{< api-section file="data/software-api/home.json" data="homeAttributes" >}}

children​

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

Retrieving the Home Space by ID​

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

Method and URL
GET /api/v3/catalog/{id}

Parameters​

{{< api-section file="data/software-api/home.json" data="retrieveHomeIdParameters" >}}


Example Request
curl -X GET 'https://{hostname}/api/v3/catalog/63505c60-bc86-42aa-a622-24e5f22ce50b' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json'
Example Response
{
  "entityType": "home",
  "id": "87049e43-8564-4ee7-8bb6-5bdaf5bd0959",
  "name": "@user@dremio.com",
  "tag": "8S9cTZ5IsWo=",
  "children": [
    {
      "id": "1e16c0e5-c890-4f87-b1a6-ac9325aafa2c",
      "path": [
        "@user@dremio.com",
        "Business"
      ],
      "tag": "KgFBPW3+Cyc=",
      "type": "CONTAINER",
      "containerType": "FOLDER"
    },
    {
      "id": "a59815d0-3c21-41ad-b9bc-2ba105251fa6",
      "path": [
        "@user@dremio.com",
        "meeting_rooms_lookup"
      ],
      "tag": "OaQT64frevc=",
      "type": "DATASET",
      "datasetType": "PROMOTED",
      "createdAt": "1970-01-01T00:00:00.000Z"
    },
    {
      "id": "37401663-8666-4e00-bc03-668abb43ccd7",
      "path": [
        "@user@dremio.com",
        "NYC-trips-quarterly"
      ],
      "tag": "+H5TpLYoosY=",
      "type": "DATASET",
      "datasetType": "VIRTUAL",
      "createdAt": "2023-02-07T21:26:14.385Z"
    }
  ]
}

Response Status Codes​

{{< api-responses file="data/software-api/home.json" data="retrieveHomeIdResponseCodes" >}}

Retrieving the Home Space by Path​

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

Method and URL
GET /api/v3/catalog/by-path/{path}

Parameters​

{{< api-section file="data/software-api/home.json" data="retrieveHomePathParameters" >}}


Example Request
curl -X GET 'https://{hostname}/api/v3/catalog/by-path/@user@dremio.com' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json'
Example Response
{
  "entityType": "home",
  "id": "87049e43-8564-4ee7-8bb6-5bdaf5bd0959",
  "name": "@user@dremio.com",
  "tag": "8S9cTZ5IsWo=",
  "children": [
    {
      "id": "1e16c0e5-c890-4f87-b1a6-ac9325aafa2c",
      "path": [
        "@user@dremio.com",
        "Business"
      ],
      "tag": "KgFBPW3+Cyc=",
      "type": "CONTAINER",
      "containerType": "FOLDER"
    },
    {
      "id": "a59815d0-3c21-41ad-b9bc-2ba105251fa6",
      "path": [
        "@user@dremio.com",
        "meeting_rooms_lookup"
      ],
      "tag": "OaQT64frevc=",
      "type": "DATASET",
      "datasetType": "PROMOTED",
      "createdAt": "1970-01-01T00:00:00.000Z"
    },
    {
      "id": "37401663-8666-4e00-bc03-668abb43ccd7",
      "path": [
        "@user@dremio.com",
        "NYC-trips-quarterly"
      ],
      "tag": "+H5TpLYoosY=",
      "type": "DATASET",
      "datasetType": "VIRTUAL",
      "createdAt": "2023-02-07T21:26:14.385Z"
    }
  ]
}

Response Status Codes​

{{< api-responses file="data/software-api/home.json" data="retrieveHomePathResponseCodes" >}}