On this page

    View

    Use the Catalog API to retrieve, create, update, 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"
            ]
          }
        ]
      },
      "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": "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

    entityType

    String

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

    Example dataset


    id

    String (UUID)

    Unique identifier of the view.

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


    type

    String

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

    Example VIRTUAL_DATASET


    path

    [String]

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

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


    createdAt

    String

    Date and time that the view was created, in UTC format.

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


    tag

    String (UUID)

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

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


    sql

    String

    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


    sqlContext

    [String]

    Context for the SQL query used to create the view.

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


    accessControlList

    Object

    Enterprise only. Information about users and roles with access to the view 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 view-specific access control privileges are not set.

    Example { "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" ] } ] }


    permissions

    [String]

    Enterprise-only. List of the privileges that you have on the view. 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" ]


    owner

    Object

    Information about the view's owner.

    Example { "ownerId": "30fca499-4abc-4469-7142-fc8dd29acac8", "ownerType": "USER" }


    fields

    Object

    Attributes that represent the dataset schema.

    accessControlList

    users

    [Object]

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

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


    roles

    [Object]

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

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

    users and roles

    id

    String

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

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


    permissions

    [String]

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

    Example [ "SELECT', "ALTER" ]

    owner

    ownerId

    String (UUID)

    Unique identifier of the view's owner.

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


    ownerType

    String

    Type of owner of the view.

    Enum USER , ROLE

    Example USER

    fields

    name

    String

    Name of the view field.

    Example pickup_datetime


    type

    Object

    Information about the view field.

    type

    name

    String

    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


    precision

    Integer

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

    Example 38


    scale

    Integer

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

    Example 2


    subSchema

    [Object]

    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

    name

    String

    Name for the subSchema object.

    Example Parking


    type

    Object

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

    Example { "name": "BOOLEAN" }

    Creating a View

    Create a view from a table in Dremio.

    Method and URL
    POST /api/v3/catalog
    

    Parameters

    entityType

    body

    String

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


    type

    body

    String

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


    path

    body

    [String]

    Path of the location where you want to save the view within Dremio, expressed as an array. The path consists of the space, followed by any folder and subfolders, followed by 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

    body

    String

    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


    sqlContext

    body

    [String]

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

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


    accessControlList

    body

    Object

    Optional

    Enterprise only. Object used to specify which users and roles should have access to the view and the specific privileges each user or role should have. May include an array of users, an array of roles, or both.

    Example { "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" ] } ] }

    accessControlList

    users

    body

    [Object]

    Optional

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

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


    roles

    body

    [Object]

    Optional

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

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

    users and roles

    id

    body

    String

    Optional

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

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


    permissions

    body

    [String]

    Optional

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

    Example [ "SELECT', "ALTER" ]


    Example Request
    curl -X POST 'https://{hostname}/api/v3/catalog/' \
    --header 'Authorization: _dremio{tokenstring}' \
    --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

    200

    OK

    400

    Bad Request

    401

    Unauthorized

    404

    Not Found

    500

    Internal Server Error


    Retrieving a View by ID

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

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

    Parameters

    id

    path

    String (UUID)

    Unique identifier of the view that you want to retrieve.

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


    include

    query

    String

    Optional

    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


    Example Request
    curl -X GET 'https://{hostname}/api/v3/catalog/ef99ab32-89ca-4d1c-9e91-2c8be861bb8a' \
    --header 'Authorization: _dremio{tokenstring}' \
    --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

    200

    OK

    400

    Bad Request

    401

    Unauthorized

    404

    Not Found


    Retrieving a View by Path

    Retrieve a view by specifying the view’s path.

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

    Parameters

    path

    path

    String

    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 equivalent. For example, "Dremio University" should be Dremio%20University in the URL path.

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


    include

    query

    String

    Optional

    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


    Example Request
    curl -X GET 'https://{hostname}/api/v3/catalog/by-path/Business/Transportation/NYC-taxi-trips-short-distance' \
    --header 'Authorization: _dremio{tokenstring}' \
    --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

    200

    OK

    400

    Bad Request

    401

    Unauthorized

    404

    Not Found


    Updating a View

    Update a view in Dremio.

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

    Parameters

    id

    path

    String (UUID)

    Unique identifier of the view that you want to update.

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


    entityType

    body

    String

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


    type

    body

    String

    Type of dataset. For views, type is VIRTUAL_DATASET.


    path

    body

    [String]

    Path of the location where you want to save the updated view within Dremio, expressed as an array. The path consists of the space, followed by any folder and subfolders, followed by 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" ]


    tag

    body

    String (UUID)

    Optional

    Unique identifier of the version of the view that you want to update. If you provide a tag in the request body, Dremio uses the tag 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

    body

    String

    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


    sqlContext

    body

    [String]

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

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


    accessControlList

    body

    Object

    Optional

    Enterprise only. Object used to specify which users and roles should have access to the view and the specific privileges each user or role should have. May include an array of users, an array of roles, or both.

    accessControlList

    users

    body

    [Object]

    Optional

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

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


    roles

    body

    [Object]

    Optional

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

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

    users and roles

    id

    body

    String

    Optional

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

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


    permissions

    body

    [String]

    Optional

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

    Example [ "SELECT', "ALTER" ]


    Example Request
    curl -X PUT 'https://{hostname}/api/v3/catalog/ef99ab32-89ca-4d1c-9e91-2c8be861bb8a' \
    --header 'Authorization: _dremio{tokenstring}' \
    --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

    200

    OK

    400

    Bad Request

    401

    Unauthorized

    404

    Not Found

    500

    Internal Server Error


    Deleting a View

    Delete the specified view.

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

    Parameters

    id

    path

    String (UUID)

    Unique identifier of the view that you want to delete.

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


    Example Request
    curl -X DELETE 'https://{hostname}/api/v3/catalog/ef99ab32-89ca-4d1c-9e91-2c8be861bb8a' \
    -H 'Authorization: _dremio{tokenstring}' \
    -H 'Content-Type: application/json' 
    
    Example Response
    No response
    

    Response Status Codes

    204

    No Content

    400

    Bad Request

    401

    Unauthorized

    404

    Not Found