Dremio Cloud
Dremio Software
 
On this page

    Space Container

    Represents a space in Dremio. All spaces returned by the REST API will have an entityType of space.

    Space Parameters

    The JSON representation of a space looks like this:

    Space 
    {
  "entityType": "space" [immutable after creation],
  "id": String [immutable, generated by Dremio],
  "name": String [immutable after creation],
  "tag": String [immutable, generated by Dremio],
  "children": [CatalogEntitySummary] [optional] [immutable, generated by Dremio],
  "owner": [object] [immutable, generated by Dremio]
}
    Name Type Description
    id String Source ID. Generated by Dremio, immutable.
    name String Name of the space. Immutable after creation.
    tag String Identifies the instance of the space, changed each time it is modified. Generated by Dremio, immutable.
    createdAt String RFC3339 date (example: 2017-10-27T21:08:22.858Z) representing the creation datetime. Immutable.
    children [CatalogEntitySummary] The children of the space. Optional, immutable.
    owner Object Information about the space’s owner. The owner object includes the owner’s UUID and the type of owner (USER or ROLE). The owner object does not appear if the space is owned by Dremio’s system user.

    Children Parameter

    A summary representation of a catalog entity, used when entities are listed as children.

    Catalog entity listed as children 
    {
  "id": String [immutable, generated by Dremio],
  "path": [String] [immutable, generated by Dremio],
  "tag": String [immutable, generated by Dremio],
  "type": String [DATASET, CONTAINER, FILE],
  "datasetType": [VIRTUAL, PROMOTED, DIRECT] [immutable, optional],
  "containerType": [SPACE, SOURCE, FOLDER, HOME] [immutable, optional]
}
    Name Type Description
    id String Catalog Entity ID. Generated by Dremio, immutable.
    path [String] Catalog Entity path. Immutable.
    tag String Identifies the instance of the entity, changed each time it is modified. Generated by Dremio, immutable.
    type String The entity type, must be either DATASET, CONTAINER or FILE. Generated by Dremio, immutable.
    datasetType String The dataset type, must be either VIRTUAL, PROMOTED or DIRECT. Only present if type is dataset. Generated by Dremio, immutable.
    containerType String The container type, must be either SPACE, SOURCE, FOLDER or HOME. Only present if type is containerType. Generated by Dremio, immutable.