View

Use the Catalog API to retrieve, create, update, refresh, and delete views.

View Object

{
  "entityType": "dataset",
  "id": "ef99ab32-89ca-4d1c-9e91-2c8be861bb8a",
  "type": "VIRTUAL_DATASET",
  "path": [
    "Business",
    "Transportation",
    "NYC-taxi-trips-short-distance"
  ],
  "createdAt": "2022-11-17T18:31:23.236Z",
  "tag": "f90d1526-e64b-47b1-9ab0-d25df5247cab",
  "sql": "SELECT * FROM \"NYC-taxi-trips\" WHERE trip_distance_mi <= 2.0 ORDER BY trip_distance_mi ASC",
  "sqlContext": [
    "Samples",
    "samples.dremio.com"
  ],
  "accessControlList": {
    "users": [
      {
        "id": "c590ed7f-b2b4-4e1f-ba7d-94173afdc9a3",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      },
      {
        "id": "30fca499-4abc-4469-7142-fc8dd29acac8",
        "permissions": [
          "SELECT",
          "ALTER",
          "MANAGE_GRANTS"
        ]
      }
    ],
    "roles": [
      {
        "id": "76a9884b-aea5-46d5-a73a-000edf23f390",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      }
    ]
  },
  "owner": {
    "ownerId": "30fca499-4abc-4469-7142-fc8dd29acac8",
    "ownerType": "USER"
  },
  "fields": [
    {
      "name": "pickup_datetime",
      "type": {
        "name": "TIMESTAMP"
      }
    },
    {
      "name": "passenger_count",
      "type": {
        "name": "BIGINT"
      }
    },
    {
      "name": "passenger_payment_method",
      "type": {
        "name": "STRUCT",
        "subSchema": [
          {
            "name": "cash",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "credit-debit",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "payment-app",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "other",
            "type": {
              "name": "BOOLEAN"
            }
          }
        ]
      }
    },
    {
      "name": "trip_distance_mi",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "fare_amount",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "tip_amount",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "total_amount",
      "type": {
        "name": "DOUBLE"
      }
    }
  ]
}

View Attributes

Type of catalog entity. For views, the entityType is dataset.

Example dataset

Unique identifier for the view.

Example ef99ab32-89ca-4d1c-9e91-2c8be861bb8a

Type of dataset. For views, the type is VIRTUAL_DATASET.

Example VIRTUAL_DATASET

Path to the view within Dremio, expressed in an array. The path lists each level of heirarchy in order, from outer to inner: source or space first, then folder and subfolders, then the view itself as the last item in the array.

Example [ "Business", "Transportation", "NYC-taxi-trips-short-distance" ]

Date and time that the view was created. In UTC format.

Example 2022-11-17T18:31:23.236Z

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

Example f90d1526-e64b-47b1-9ab0-d25df5247cab

SQL query used to create the view.

Example SELECT * FROM "NYC-taxi-trips" WHERE trip_distance_mi <= 2.0 ORDER BY trip_distance_mi ASC

Context for the SQL query used to create the view.

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

Information about users and roles with access to the view, as well as their specific permissions. May include an array of users, an array of roles, or both, depending on the configured access and permissions. Empty if view-specific access control privileges are not set.

Information about the view's owner.

Attributes that represent the dataset schema.

`accessControlList` Object Attributes

List of users with access to the view and their specific privileges.

Example [ { "id": "c590ed7f-b2b4-4e1f-ba7d-94173afdc9a3", "permissions": [ "SELECT", "ALTER" ] }, { "id": "30fca499-4abc-4469-7142-fc8dd29acac8", "permissions": [ "SELECT", "ALTER", "MANAGE_GRANTS" ] } ]

List of roles whose members have access to the view and the roles' specific privileges.

Example [ { "id": "76a9884b-aea5-46d5-a73a-000edf23f390", "permissions": [ "SELECT", "ALTER" ] } ]

`user` and `role` Object Attributes

Unique identifier for the user or role with access to the view.

Example c590ed7f-b2b4-4e1f-ba7d-94173afdc9a3

List of privileges the user or role has for the view. For more information, read Dataset Privileges.

Example [ "SELECT', "ALTER" ]

`owner` Object Attributes

Unique identifier for the view's owner.

Example 30fca499-4abc-4469-7142-fc8dd29acac8

Type of owner for the view.

Enum USER , ROLE

Example USER

`fields` Object Attributes

Name of the view field.

Example pickup_datetime

Information about the view field.

`type` Object Attributes

Name of the view field's type.

Enum STRUCT , LIST , UNION , INTEGER , BIGINT , FLOAT , DOUBLE , VARCHAR , VARBINARY , BOOLEAN , DECIMAL , TIME , DATE , TIMESTAMP , INTERVAL DAY TO SECOND , INTERVAL YEAR TO MONTH

Example TIMESTAMP

Total number of digits in the number. Included only for the DECIMAL type.

Example 38

Number of digits to the right of the decimal point. Included only for the DECIMAL type.

Example 2

List of objects that represent the field's composition. For example, a field composed of data about a restaurant might have a subSchema with an object for parking options, another for payment methods, and so on. subSchemas may be nested within other subSchemas. subSchema is listed only for the STRUCT, LIST, and UNION types.

`subSchema` Array Attributes

Name for the subSchema object.

Example Parking

Object that contains a name attribute that provides the field's type.

Example { "name": "BOOLEAN" }

Create a View

Create a view from a table in Dremio.

Method and URL

POST /projects/{project-id}/catalog/

Parameters

Unique identifier for the project where you want to create the view.

Example 1df71752-69b7-47d9-9e6c-990e6b194aa4

Type of catalog entity. For views, the entityType is dataset.

Type of dataset. For views, the type is VIRTUAL_DATASET.

Path to the location where the view should be created within Dremio, expressed in an array. The path lists each level of heirarchy in order, from outer to inner: space first, then folder and subfolders, then a name for the view itself as the last item in the array. Views can only be created in spaces.

Example [ "Business", "Transportation", "NYC-taxi-trips-short-distance" ]

SQL query to use to create the view.

Example SELECT * FROM "NYC-taxi-trips" WHERE trip_distance_mi <= 2.0 ORDER BY trip_distance_mi ASC

Context for the SQL query to use to create the view.

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

Object used to specify which users and roles should have access to the view, as well as their specific permissions for the view. May include an array of users, an array of roles, or both. Omit if you want the view to inherit access and permissions. For more information, read Understanding Inheritance, Scope, and Ownership.

`accessControlList` Object Parameters

List of users who should have access to the view and their specific privileges.

List of roles whose members should have access to the view and the roles' specific privileges.

Example [ { "id": "76a9884b-aea5-46d5-a73a-000edf23f390", "permissions": [ "SELECT", "ALTER" ] } ]

`user` and `role` Object Parameters

Unique identifier for the user or role who should have access to the view.

Example c590ed7f-b2b4-4e1f-ba7d-94173afdc9a3

List of privileges the user or role should have for the view. For more information, read Dataset Privileges.

Example [ "SELECT', "ALTER" ]

Example Request

curl -X POST 'https://api.dremio.cloud/v0/projects/1df71752-69b7-47d9-9e6c-990e6b194aa4/catalog/' \
--header 'Authorization: Bearer <PersonalAccessToken>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "entityType": "dataset",
  "path": [
    "Business",
    "Transportation",
    "NYC-taxi-trips-short-distance"
  ],
  "type": "VIRTUAL_DATASET",
  "sql": "SELECT * FROM \"NYC-taxi-trips\" WHERE trip_distance_mi <= 2.0 ORDER BY trip_distance_mi ASC",
  "sqlContext": [
    "Samples",
    "samples.dremio.com"
  ],
  "accessControlList": {
    "users": [
      {
        "id": "c590ed7f-b2b4-4e1f-ba7d-94173afdc9a3",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      },
      {
        "id": "30fca499-4abc-4469-7142-fc8dd29acac8",
        "permissions": [
          "SELECT",
          "ALTER",
          "MANAGE_GRANTS"
        ]
      }
    ],
    "roles": [
      {
        "id": "76a9884b-aea5-46d5-a73a-000edf23f390",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      }
    ]
  }
}'

Example Response

{
  "entityType": "dataset",
  "id": "ef99ab32-89ca-4d1c-9e91-2c8be861bb8a",
  "type": "VIRTUAL_DATASET",
  "path": [
    "Business",
    "Transportation",
    "NYC-taxi-trips-short-distance"
  ],
  "createdAt": "2022-11-17T18:31:23.236Z",
  "tag": "f90d1526-e64b-47b1-9ab0-d25df5247cab",
  "sql": "SELECT * FROM \"NYC-taxi-trips\" WHERE trip_distance_mi <= 2.0 ORDER BY trip_distance_mi ASC",
  "sqlContext": [
    "Samples",
    "samples.dremio.com"
  ],
  "accessControlList": {
    "users": [
      {
        "id": "c590ed7f-b2b4-4e1f-ba7d-94173afdc9a3",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      },
      {
        "id": "30fca499-4abc-4469-7142-fc8dd29acac8",
        "permissions": [
          "SELECT",
          "ALTER",
          "MANAGE_GRANTS"
        ]
      }
    ],
    "roles": [
      {
        "id": "76a9884b-aea5-46d5-a73a-000edf23f390",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      }
    ]
  },
  "owner": {
    "ownerId": "30fca499-4abc-4469-7142-fc8dd29acac8",
    "ownerType": "USER"
  },
  "fields": [
    {
      "name": "pickup_datetime",
      "type": {
        "name": "TIMESTAMP"
      }
    },
    {
      "name": "passenger_count",
      "type": {
        "name": "BIGINT"
      }
    },
    {
      "name": "passenger_payment_method",
      "type": {
        "name": "STRUCT",
        "subSchema": [
          {
            "name": "cash",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "credit-debit",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "payment-app",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "other",
            "type": {
              "name": "BOOLEAN"
            }
          }
        ]
      }
    },
    {
      "name": "trip_distance_mi",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "fare_amount",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "tip_amount",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "total_amount",
      "type": {
        "name": "DOUBLE"
      }
    }
  ]
}

Response Status Codes

Retrieve a View by ID

Retrieve a view by specifying the view’s id value.

Method and URL

POST /v0/projects/{project-id}/catalog/{id}

Parameters

Unique identifier for the project that contains the view you want to retrieve.

Example 1df71752-69b7-47d9-9e6c-990e6b194aa4

Unique identifier for the view you want to retrieve.

Example ef99ab32-89ca-4d1c-9e91-2c8be861bb8a

Example Request

curl -X GET 'https://api.dremio.cloud/v0/projects/1df71752-69b7-47d9-9e6c-990e6b194aa4/catalog/ef99ab32-89ca-4d1c-9e91-2c8be861bb8a' \
--header 'Authorization: Bearer <PersonalAccessToken>' \
--header 'Content-Type: application/json'

Example Response

{
  "entityType": "dataset",
  "id": "ef99ab32-89ca-4d1c-9e91-2c8be861bb8a",
  "type": "VIRTUAL_DATASET",
  "path": [
    "Business",
    "Transportation",
    "NYC-taxi-trips-short-distance"
  ],
  "createdAt": "2022-11-17T18:31:23.236Z",
  "tag": "f90d1526-e64b-47b1-9ab0-d25df5247cab",
  "sql": "SELECT * FROM \"NYC-taxi-trips\" WHERE trip_distance_mi <= 2.0 ORDER BY trip_distance_mi ASC",
  "sqlContext": [
    "Samples",
    "samples.dremio.com"
  ],
  "accessControlList": {
    "users": [
      {
        "id": "c590ed7f-b2b4-4e1f-ba7d-94173afdc9a3",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      },
      {
        "id": "30fca499-4abc-4469-7142-fc8dd29acac8",
        "permissions": [
          "SELECT",
          "ALTER",
          "MANAGE_GRANTS"
        ]
      }
    ],
    "roles": [
      {
        "id": "76a9884b-aea5-46d5-a73a-000edf23f390",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      }
    ]
  },
  "owner": {
    "ownerId": "30fca499-4abc-4469-7142-fc8dd29acac8",
    "ownerType": "USER"
  },
  "fields": [
    {
      "name": "pickup_datetime",
      "type": {
        "name": "TIMESTAMP"
      }
    },
    {
      "name": "passenger_count",
      "type": {
        "name": "BIGINT"
      }
    },
    {
      "name": "passenger_payment_method",
      "type": {
        "name": "STRUCT",
        "subSchema": [
          {
            "name": "cash",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "credit-debit",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "payment-app",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "other",
            "type": {
              "name": "BOOLEAN"
            }
          }
        ]
      }
    },
    {
      "name": "trip_distance_mi",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "fare_amount",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "tip_amount",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "total_amount",
      "type": {
        "name": "DOUBLE"
      }
    }
  ]
}

Response Status Codes

Retrieve a View by Path

Retrieve a view by specifying the view’s path.

Method and URL

GET /v0/projects/{project-id}/catalog/by-path/{path}

Parameters

Unique identifier for the project that contains the view you want to retrieve.

Example 1df71752-69b7-47d9-9e6c-990e6b194aa4

View's location within Dremio, using forward slashes as separators. For example, for the "NYC-taxi-trips" view in the "samples.dremio.com" folder within the space "Transportation," the path is Transportation/samples.dremio.com/NYC-taxi-trips. If the name of any component in the path includes a special character for URLs, such as a space, replace the special character with its UTF-8 character. For example, "Dremio University" should be Dremio%20University in the URL path.

Example Business/Transportation/NYC-taxi-trips-short-distance

Example Request

curl -X GET 'https://api.dremio.cloud/v0/projects/1df71752-69b7-47d9-9e6c-990e6b194aa4/catalog/by-path/Business/Transportation/NYC-taxi-trips-short-distance' \
--header 'Authorization: Bearer <PersonalAccessToken>' \
--header 'Content-Type: application/json'

Example Response

{
  "entityType": "dataset",
  "id": "ef99ab32-89ca-4d1c-9e91-2c8be861bb8a",
  "type": "VIRTUAL_DATASET",
  "path": [
    "Business",
    "Transportation",
    "NYC-taxi-trips-short-distance"
  ],
  "createdAt": "2022-11-17T18:31:23.236Z",
  "tag": "f90d1526-e64b-47b1-9ab0-d25df5247cab",
  "sql": "SELECT * FROM \"NYC-taxi-trips\" WHERE trip_distance_mi <= 2.0 ORDER BY trip_distance_mi ASC",
  "sqlContext": [
    "Samples",
    "samples.dremio.com"
  ],
  "accessControlList": {
    "users": [
      {
        "id": "c590ed7f-b2b4-4e1f-ba7d-94173afdc9a3",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      },
      {
        "id": "30fca499-4abc-4469-7142-fc8dd29acac8",
        "permissions": [
          "SELECT",
          "ALTER",
          "MANAGE_GRANTS"
        ]
      }
    ],
    "roles": [
      {
        "id": "76a9884b-aea5-46d5-a73a-000edf23f390",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      }
    ]
  },
  "owner": {
    "ownerId": "30fca499-4abc-4469-7142-fc8dd29acac8",
    "ownerType": "USER"
  },
  "fields": [
    {
      "name": "pickup_datetime",
      "type": {
        "name": "TIMESTAMP"
      }
    },
    {
      "name": "passenger_count",
      "type": {
        "name": "BIGINT"
      }
    },
    {
      "name": "passenger_payment_method",
      "type": {
        "name": "STRUCT",
        "subSchema": [
          {
            "name": "cash",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "credit-debit",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "payment-app",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "other",
            "type": {
              "name": "BOOLEAN"
            }
          }
        ]
      }
    },
    {
      "name": "trip_distance_mi",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "fare_amount",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "tip_amount",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "total_amount",
      "type": {
        "name": "DOUBLE"
      }
    }
  ]
}

Response Status Codes

Update a View

Update a view in Dremio.

Method and URL

PUT /projects/{project-id}/catalog/{id}

Parameters

Unique identifier for the project that contains the view you want to update.

Example 1df71752-69b7-47d9-9e6c-990e6b194aa4

Unique identifier for the view you want to update.

Example ef99ab32-89ca-4d1c-9e91-2c8be861bb8a

Type of catalog entity. For views, the entityType is dataset.

Type of dataset. For views, type is VIRTUAL_DATASET.

Path to the location where the updated view should be saved within Dremio, expressed in an array. The path lists each level of heirarchy in order, from outer to inner: space first, then folder and subfolders, then the name for the view itself as the last item in the array. Views can only be saved in spaces.

Example [ "Business", "Transportation", "NYC-taxi-trips-short-distance" ]

Unique identifier for the version of the view you want to update. If you provide a tag in the request body, Dremio uses the tag value to ensure that you are requesting to update the most recent version of the view. If you do not provide a tag, Dremio automatically updates the most recent version of the view.

Example f90d1526-e64b-47b1-9ab0-d25df5247cab

SQL query to use to update the view.

Example SELECT * FROM "NYC-taxi-trips" WHERE trip_distance_mi <= 2.0 ORDER BY trip_distance_mi DESC

Context for the SQL query to use for the updated view.

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

`accessControlList` Object Parameters

List of users who should have access to the view and their specific privileges.

List of roles whose members should have access to the view and the roles' specific privileges.

Example [ { "id": "76a9884b-aea5-46d5-a73a-000edf23f390", "permissions": [ "SELECT", "ALTER" ] } ]

`user` and `role` Object Parameters

Unique identifier for the user or role who should have access to the view.

Example c590ed7f-b2b4-4e1f-ba7d-94173afdc9a3

List of privileges the user or role should have for the view. For more information, read Dataset Privileges.

Example [ "SELECT', "ALTER" ]

Example Request

curl -X PUT 'https://api.dremio.cloud/v0/projects/1df71752-69b7-47d9-9e6c-990e6b194aa4/catalog/ef99ab32-89ca-4d1c-9e91-2c8be861bb8a' \
--header 'Authorization: Bearer <PersonalAccessToken>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "entityType": "dataset",
  "id": "ef99ab32-89ca-4d1c-9e91-2c8be861bb8a",
  "path": [
    "Business",
    "Transportation",
    "NYC-taxi-trips-short-distance"
  ],
  "type": "VIRTUAL_DATASET",
  "tag": "f90d1526-e64b-47b1-9ab0-d25df5247cab",
  "sql": "SELECT trip_distance_mi, fare_amount, tip_amount FROM \"NYC-taxi-trips\" WHERE trip_distance_mi <= 2.0 ORDER BY trip_distance_mi DESC",
  "sqlContext": [
    "Samples",
    "samples.dremio.com"
  ]
}'

Example Response

{
  "entityType": "dataset",
  "id": "ef99ab32-89ca-4d1c-9e91-2c8be861bb8a",
  "type": "VIRTUAL_DATASET",
  "path": [
    "Business",
    "Transportation",
    "NYC-taxi-trips-by-distance"
  ],
  "createdAt": "2023-01-20T15:26:39.780Z",
  "tag": "7cab1a42-8835-4d31-827b-fedee1ad38d1",
  "sql": "SELECT trip_distance_mi, fare_amount, tip_amount FROM \"NYC-taxi-trips\" WHERE trip_distance_mi <= 2.0 ORDER BY trip_distance_mi DESC",
  "sqlContext": [
    "Samples",
    "samples.dremio.com"
  ],
  "accessControlList": {
    "users": [
      {
        "id": "c590ed7f-b2b4-4e1f-ba7d-94173afdc9a3",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      },
      {
        "id": "30fca499-4abc-4469-7142-fc8dd29acac8",
        "permissions": [
          "SELECT",
          "ALTER",
          "MANAGE_GRANTS"
        ]
      }
    ],
    "roles": [
      {
        "id": "76a9884b-aea5-46d5-a73a-000edf23f390",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      }
    ]
  },
  "owner": {
    "ownerId": "30fca499-4abc-4469-7142-fc8dd29acac8",
    "ownerType": "USER"
  },
  "fields": [
    {
      "name": "pickup_datetime",
      "type": {
        "name": "TIMESTAMP"
      }
    },
    {
      "name": "passenger_count",
      "type": {
        "name": "BIGINT"
      }
    },
    {
      "name": "passenger_payment_method",
      "type": {
        "name": "STRUCT",
        "subSchema": [
          {
            "name": "cash",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "credit-debit",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "payment-app",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "other",
            "type": {
              "name": "BOOLEAN"
            }
          }
        ]
      }
    },
    {
      "name": "trip_distance_mi",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "fare_amount",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "tip_amount",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "total_amount",
      "type": {
        "name": "DOUBLE"
      }
    }
  ]
}

Response Status Codes

Refresh a View

Refresh the data stored in the specified view and the reflections associated with the view.

Read Refreshing Reflections to learn how refreshing works.

Method and URL

POST /v0/projects/{project-id}/catalog/{id}/refresh

Parameters

Unique identifier for the project that contains the view you want to refresh.

Example 1df71752-69b7-47d9-9e6c-990e6b194aa4

Unique identifier for the view you want to refresh.

Example ef99ab32-89ca-4d1c-9e91-2c8be861bb8a

Example Request

curl -X POST 'https://api.dremio.cloud/v0/projects/1df71752-69b7-47d9-9e6c-990e6b194aa4/catalog/ef99ab32-89ca-4d1c-9e91-2c8be861bb8a/refresh' \
-H 'Authorization: Bearer <PersonalAccessToken>' \
-H 'Content-Type: application/json'

Example Response

No response

Response Status Codes

Delete a View

Delete the specified view.

Method and URL

DELETE /v0/projects/{project-id}/catalog/{id}

Parameters

Unique identifier for the project that contains the view you want to delete.

Example 1df71752-69b7-47d9-9e6c-990e6b194aa4

Unique identifier for the view you want to delete.

Example ef99ab32-89ca-4d1c-9e91-2c8be861bb8a

Example Request

curl -X DELETE 'https://api.dremio.cloud/v0/projects/1df71752-69b7-47d9-9e6c-990e6b194aa4/catalog/ef99ab32-89ca-4d1c-9e91-2c8be861bb8a' \
-H 'Authorization: Bearer <PersonalAccessToken>' \
-H 'Content-Type: application/json'

Example Response

No response

Response Status Codes

Was this page helpful?

Glad to hear it! Thank you for your feedback. Sorry to hear that. Thank you for your feedback.

View

View Attributes

accessControlList Object Attributes

user and role Object Attributes

owner Object Attributes

fields Object Attributes

type Object Attributes

subSchema Array Attributes

Create a View

Parameters

accessControlList Object Parameters

user and role Object Parameters

Response Status Codes

Retrieve a View by ID

Parameters

Response Status Codes

Retrieve a View by Path

Parameters

Response Status Codes

Update a View

Parameters

accessControlList Object Parameters

user and role Object Parameters

Response Status Codes

Refresh a View

Parameters

Response Status Codes

Delete a View

Parameters

Response Status Codes

`accessControlList` Object Attributes

`user` and `role` Object Attributes

`owner` Object Attributes

`fields` Object Attributes

`type` Object Attributes

`subSchema` Array Attributes

`accessControlList` Object Parameters

`user` and `role` Object Parameters

`accessControlList` Object Parameters

`user` and `role` Object Parameters