This project has retired. For details please refer to its Attic page.
Lens Server: MetastoreResource

MetastoreResource Resource

metastore resource api

This provides api for all things metastore.

GET /metastore

API to know if metastore service is up and running

Response Body
media type data type description
text/plain (custom) Simple text saying it up

GET /metastore/databases

Get all databases in the metastore

Request Parameters
name type description
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json StringList (JSON) StringList consisting of all database names.
application/json StringList (JSON)
application/xml stringList (XML)

GET /metastore/databases/current

Get the current database

Request Parameters
name type description
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json string (JSON) The current db name
application/json string (JSON)
application/xml string (XML)

PUT /metastore/databases/current

Set the current db

Request Parameters
name type description
sessionid query The sessionid in which user is working
Request Body
media type data type description
application/json string (JSON) The db name
application/json string (JSON)
application/xml string (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if set was successful. APIResult with state Status#FAILED, if set has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

DELETE /metastore/databases/{dbName}

Delete the db specified by name. Deleting underlying tables is optional. If db does not exist, delete is ignored.

Request Parameters
name type description constraints
dbName path The db name  
cascade query if true, all the tables inside the db will also be dropped. boolean
sessionid query The sessionid in which user is working  
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if delete was successful. APIResult with state Status#FAILED, if delete has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

POST /metastore/databases

Create a new database

Request Parameters
name type description default constraints
ignoreIfExisting query If true, create will be ignored if db already exists, otherwise it fails. true boolean
sessionid query The sessionid in which user is working    
Request Body
media type data type description
application/json string (JSON) The db name
application/json string (JSON)
application/xml string (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if create was successful. APIResult with state Status#FAILED, if create has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

GET /metastore/nativetables

Get all native tables.

Request Parameters
name type description
dbName query The db name. If not empty, the tables in the db will be returned
dbOption query The options available are 'current' and 'all'. If option is current, gives all tables from current db. If option is all, gives all tables from all databases. If dbname is passed, dbOption is ignored. If no dbOption or dbname are passed, then default is to get tables from current db.
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json StringList (JSON) StringList consisting of all table names.
application/json StringList (JSON)
application/xml stringList (XML)

GET /metastore/nativetables/{tableName}

Get the native table passed in name

Request Parameters
name type description
tableName path The native table name
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json object (JSON) JAXB representation of XNativeTable
application/json object (JSON)
application/xml anyType (XML)

GET /metastore/cubes

Get all cubes in the metastores, of the specified type

Request Parameters
name type description default
sessionid query The sessionid in which user is working  
type query The type of cubes. Accepted values are 'all' or 'base' or 'derived' or 'queryable' all
Response Body
media type data type description
application/json StringList (JSON) StringList consisting of all cubes names
application/json StringList (JSON)
application/xml stringList (XML)

DELETE /metastore/cubes

Delete all cubes

Request Parameters
name type description
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED in case of successful delete. APIResult with state in case of delete failure. APIResult with state Status#PARTIAL in case of partial delete.
application/json APIResult (JSON)
application/xml APIResult (XML)

POST /metastore/cubes

Create a new cube

Request Parameters
name type description
sessionid query The sessionid in which user is working
Request Body
media type data type description
application/json XCube (JSON) The XCube representation of the cube definition
application/json XCube (JSON)
application/xml x_cube (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if create was successful. APIResult with state Status#FAILED, if create has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

PUT /metastore/cubes/{cubeName}

Update cube definition

Request Parameters
name type description
cubeName path The cube name
sessionid query The sessionid in which user is working
Request Body
media type data type description
application/json XCube (JSON) The XCube representation of the updated cube definition
application/json XCube (JSON)
application/xml x_cube (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if update was successful. APIResult with state Status#FAILED, if update has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

GET /metastore/cubes/{cubeName}

Get the cube specified by name

Request Parameters
name type description
cubeName path The cube name
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json object (JSON) JAXB representation of XCube
application/json object (JSON)
application/xml anyType (XML)

DELETE /metastore/cubes/{cubeName}

Drop the cube, specified by name

Request Parameters
name type description
cubeName path The cube name
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

GET /metastore/storages

Get all storages in the metastore

Request Parameters
name type description
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json StringList (JSON) StringList consisting of all the storage names
application/json StringList (JSON)
application/xml stringList (XML)

POST /metastore/storages

Create new storage

Request Parameters
name type description
sessionid query The sessionid in which user is working
Request Body
media type data type description
application/json XStorage (JSON) The XStorage representation of storage
application/json XStorage (JSON)
application/xml x_storage (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if create was successful. APIResult with state Status#FAILED, if create has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

DELETE /metastore/storages

Delete all storages in metastore

Request Parameters
name type description
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED in case of successful delete. APIResult with state in case of delete failure. APIResult with state Status#PARTIAL in case of partial delete.
application/json APIResult (JSON)
application/xml APIResult (XML)

PUT /metastore/storages/{storageName}

Update storage definition

Request Parameters
name type description
storageName path The storage name
sessionid query The sessionid in which user is working
Request Body
media type data type description
application/json XStorage (JSON) The XStorage representation of the updated storage definition
application/json XStorage (JSON)
application/xml x_storage (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if update was successful. APIResult with state Status#FAILED, if update has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

GET /metastore/storages/{storage}

Get the storage specified by name

Request Parameters
name type description
storage path The storage name
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json object (JSON) JAXB representation of XStorage
application/json object (JSON)
application/xml anyType (XML)

DELETE /metastore/storages/{storage}

Drop the storage, specified by name

Request Parameters
name type description
storage path The storage name
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

GET /metastore/dimensions

Get all dimensions in the metastore

Request Parameters
name type description
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json StringList (JSON) StringList consisting of all the dimension names
application/json StringList (JSON)
application/xml stringList (XML)

POST /metastore/dimensions

Create new dimension

Request Parameters
name type description
sessionid query The sessionid in which user is working
Request Body
media type data type description
application/json XDimension (JSON) The XDimension representation of dimension
application/json XDimension (JSON)
application/xml x_dimension (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if create was successful. APIResult with state Status#FAILED, if create has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

DELETE /metastore/dimensions

Delete all dimensions in metastore

Request Parameters
name type description
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED in case of successful delete. APIResult with state in case of delete failure. APIResult with state Status#PARTIAL in case of partial delete.
application/json APIResult (JSON)
application/xml APIResult (XML)

PUT /metastore/dimensions/{dimName}

Update dimension definition

Request Parameters
name type description
dimName path The dimension name
sessionid query The sessionid in which user is working
Request Body
media type data type description
application/json XDimension (JSON) The XDimension representation of the updated dimension definition
application/json XDimension (JSON)
application/xml x_dimension (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if update was successful. APIResult with state Status#FAILED, if update has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

GET /metastore/dimensions/{dimName}

Get the dimension specified by name

Request Parameters
name type description
dimName path The dimension name
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json object (JSON) JAXB representation of XDimension
application/json object (JSON)
application/xml anyType (XML)

DELETE /metastore/dimensions/{dimName}

Drop the dimension, specified by name

Request Parameters
name type description
dimName path The dimension name
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

GET /metastore/dimensions/{dimName}/dimtables

Get all dimtables that belong to a dimension in the metastore

Request Parameters
name type description
dimName path name of the dimension
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json StringList (JSON) List of XDimensionTable objects
application/json StringList (JSON)
application/xml stringList (XML)

GET /metastore/cubes/{cubeName}/facts

Get all facts that belong to a cube in the metastore

Request Parameters
name type description
cubeName path name of the base cube or derived cube
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json StringList (JSON) StringList consisting of all the fact names in the given cube
application/json StringList (JSON)
application/xml stringList (XML)

GET /metastore/cubes/{cubeName}/segmentations

Get all segmentations that belong to a cube in the metastore

Request Parameters
name type description
cubeName path name of the base cube or derived cube
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json StringList (JSON) List of XSegmentation objects
application/json StringList (JSON)
application/xml stringList (XML)

GET /metastore/facts

Get all fact tables in the metastore in the current database

Request Parameters
name type description
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json StringList (JSON) StringList consisting of all fact table names
application/json StringList (JSON)
application/xml stringList (XML)

GET /metastore/segmentations

Get all segmentations in the current database

Request Parameters
name type description
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json StringList (JSON) StringList consisting of all segmentations
application/json StringList (JSON)
application/xml stringList (XML)

DELETE /metastore/facts

Delete all fact tables

Request Parameters
name type description default constraints
cascade query if set to true, all the underlying tables will be dropped, if set to false, only the fact table will be dropped false boolean
sessionid query The sessionid in which user is working    
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED in case of successful delete. APIResult with state in case of delete failure. APIResult with state Status#PARTIAL in case of partial delete.
application/json APIResult (JSON)
application/xml APIResult (XML)

DELETE /metastore/segmentations

Delete all segmentations

Request Parameters
name type description
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED in case of successful delete. APIResult with state in case of delete failure. APIResult with state Status#PARTIAL in case of partial delete.
application/json APIResult (JSON)
application/xml APIResult (XML)

GET /metastore/facts/{factName}

Get the fact table specified by name

Request Parameters
name type description
factName path The fact table name
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json object (JSON) JAXB representation of XFactTable
application/json object (JSON)
application/xml anyType (XML)

GET /metastore/segmentations/{segmentationName}

Get the segmentation specified by name

Request Parameters
name type description
segmentationName path The segmentation name
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json object (JSON) JAXB representation of XSegmentation
application/json object (JSON)
application/xml anyType (XML)

POST /metastore/facts

Create a new fact tabble

Request Parameters
name type description
sessionid query The sessionid in which user is working
Request Body
media type data type description
application/json XFactTable (JSON) The XFactTable representation of the fact table definition
application/json XFactTable (JSON)
application/xml x_fact_table (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if create was successful. APIResult with state Status#FAILED, if create has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

POST /metastore/segmentations

Create a new segmentation

Request Parameters
name type description
sessionid query The sessionid in which user is working
Request Body
media type data type description
application/json XSegmentation (JSON) The XSegmentation representation of the segmentation
application/json XSegmentation (JSON)
application/xml x_segmentation (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if create was successful. APIResult with state Status#FAILED, if create has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

PUT /metastore/facts/{factName}

Update fact table definition

Request Parameters
name type description
factName path name of the fact table
sessionid query The sessionid in which user is working
Request Body
media type data type description
application/json XFactTable (JSON) The XFactTable representation of the updated fact table definition
application/json XFactTable (JSON)
application/xml x_fact_table (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if update was successful. APIResult with state Status#FAILED, if update has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

PUT /metastore/segmentations/{segmentationName}

Update segmentation

Request Parameters
name type description
segmentationName path name of segmentation
sessionid query The sessionid in which user is working
Request Body
media type data type description
application/json XSegmentation (JSON) The XSegmentation representation of the updated fact table definition
application/json XSegmentation (JSON)
application/xml x_segmentation (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if update was successful. APIResult with state Status#FAILED, if update has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

DELETE /metastore/facts/{factName}

Drop the fact table, specified by name

Request Parameters
name type description default constraints
factName path The fact table name    
cascade query If true, all the storage tables of the fact will also be dropped false boolean
sessionid query The sessionid in which user is working    
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

DELETE /metastore/segmentations/{segmentationName}

Drop the segmentation, specified by name

Request Parameters
name type description
segmentationName path The segmentation name
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

GET /metastore/facts/{factName}/storages

Get all storages of the fact table in the metastore

Request Parameters
name type description
factName path The fact table name
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json StringList (JSON) StringList consisting of all the storage names
application/json StringList (JSON)
application/xml stringList (XML)

DELETE /metastore/facts/{factName}/storages

Drop all the storage tables of a fact table

Request Parameters
name type description
factName path The fact table name
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

POST /metastore/facts/{factName}/storages

Add storage to fact table

Request Parameters
name type description
factName path The fact table name
sessionid query The sessionid in which user is working
Request Body
media type data type description
application/json XStorageTableElement (JSON) The storage table description
application/json XStorageTableElement (JSON)
application/xml x_storage_table_element (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if add was successful. APIResult with state Status#FAILED, if add has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

DELETE /metastore/facts/{factName}/storages/{storage}

Drop the storage of a fact, specified by name

Request Parameters
name type description
factName path The fact table name
storage path The storage name
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

GET /metastore/facts/{factName}/storages/{storage}

Get the fact storage table

Request Parameters
name type description
factName path The fact table name
storage path The storage name
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json object (JSON) JAXB representation of XStorageTableElement
application/json object (JSON)
application/xml anyType (XML)

GET /metastore/facts/{factName}/storages/{storage}/partitions

Get all partitions of the fact table in the specified storage; can be filtered as well.

Request Parameters
name type description
factName path The fact table name
storage path The storage name
filter query The filter for partitions, string representation of the filter for ex: x < "xxx" and y > "yyy"
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json object (JSON) JAXB representation of XPartitionList containing XPartition objects
application/json object (JSON)
application/xml anyType (XML)

DELETE /metastore/facts/{factName}/storages/{storage}/partitions

Drop the partitions in the storage of a fact; can specified filter as well

Request Parameters
name type description
factName path The fact table name
storage path The storage name
filter query The filter for partitions, string representation of the filter for ex: x < "xxx" and y > "yyy"
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

POST /metastore/facts/{factName}/storages/{storage}/partition

Add a new partition for a storage of fact

Request Parameters
name type description
factName path fact table name
storage path storage name
sessionid query The sessionid in which user is working
Request Body
media type data type description
application/json XPartition (JSON) XPartition representation of partition
application/json XPartition (JSON)
application/xml x_partition (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if add was successful. APIResult with state Status#FAILED, if add has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

PUT /metastore/facts/{factName}/storages/{storage}/partition

updates an existing partition for a storage of fact

Request Parameters
name type description
factName path fact table name
storage path storage name
sessionid query The sessionid in which user is working
Request Body
media type data type description
application/json XPartition (JSON) XPartition representation of partition.
application/json XPartition (JSON)
application/xml x_partition (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if update was successful. APIResult with state Status#FAILED, if update has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

POST /metastore/facts/{factName}/storages/{storage}/partitions

Batch Add partitions for a storage of fact

Request Parameters
name type description
factName path fact table name
storage path storage name
sessionid query The sessionid in which user is working
Request Body
media type data type description
application/json XPartitionList (JSON) XPartitionList representation of partitions
application/json XPartitionList (JSON)
application/xml x_partition_list (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if add was successful. APIResult with state Status#FAILED, if add has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

PUT /metastore/facts/{factName}/storages/{storage}/partitions

Batch Update partitions for a storage of fact

Request Parameters
name type description
factName path fact table name
storage path storage name
sessionid query The sessionid in which user is working
Request Body
media type data type description
application/json XPartitionList (JSON) XPartitionList representation of partitions
application/json XPartitionList (JSON)
application/xml x_partition_list (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if update was successful. APIResult with state Status#FAILED, if update has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

DELETE /metastore/facts/{factName}/storages/{storage}/partition

Drop the partitions in the storage of a fact table, specified by exact values

Request Parameters
name type description
factName path The fact table name
storage path The storage name
sessionid query The sessionid in which user is working
values query Comma separated values
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

GET /metastore/dimtables

Get all dimension tables in the metastore

Request Parameters
name type description
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json StringList (JSON) StringList consisting of all dimension table names
application/json StringList (JSON)
application/xml stringList (XML)

POST /metastore/dimtables

Create a new dimension table

Request Parameters
name type description
sessionid query The sessionid in which user is working
Request Body
media type data type description
application/json XDimensionTable (JSON) The XDimensionTable representation of the dimension table definition
application/json XDimensionTable (JSON)
application/xml x_dimension_table (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if create was successful. APIResult with state Status#FAILED, if create has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

PUT /metastore/dimtables/{dimTableName}

Update dimension table definition

Request Parameters
name type description
dimTableName path
sessionid query The sessionid in which user is working
Request Body
media type data type description
application/json XDimensionTable (JSON) The XDimensionTable representation of the updated dim table definition
application/json XDimensionTable (JSON)
application/xml x_dimension_table (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if update was successful. APIResult with state Status#FAILED, if update has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

DELETE /metastore/dimtables/{dimTableName}

Drop the dimension table, specified by name

Request Parameters
name type description constraints
dimTableName path The dimension table name  
cascade query if true, all the storage tables of dimension table will also be dropped boolean
sessionid query The sessionid in which user is working  
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

GET /metastore/dimtables/{dimTableName}

Get the dimension table specified by name

Request Parameters
name type description
dimTableName path The cube name
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json object (JSON) JAXB representation of XDimensionTable
application/json object (JSON)
application/xml anyType (XML)

GET /metastore/dimtables/{dimTableName}/storages

Get all storages of the dimension table in the metastore

Request Parameters
name type description
dimTableName path The dimension table name
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json StringList (JSON) StringList consisting of all the storage names
application/json StringList (JSON)
application/xml stringList (XML)

POST /metastore/dimtables/{dimTableName}/storages

Add storage to dimension table

Request Parameters
name type description
dimTableName path The dimension table name
sessionid query The sessionid in which user is working
Request Body
media type data type description
application/json XStorageTableElement (JSON) The Storage table description
application/json XStorageTableElement (JSON)
application/xml x_storage_table_element (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if add was successful. APIResult with state Status#FAILED, if add has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

GET /metastore/dimtables/{dimTableName}/storages/{storage}

Get the dim storage table

Request Parameters
name type description
dimTableName path The fact table name
storage path The storage name
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json object (JSON) JAXB representation of XStorageTableElement
application/json object (JSON)
application/xml anyType (XML)

DELETE /metastore/dimtables/{dimTableName}/storages

Drop all the storage tables of a dimension table

Request Parameters
name type description
dimTableName path The dimension table name
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

DELETE /metastore/dimtables/{dimTableName}/storages/{storage}

Drop the storage of a dimension table, specified by name

Request Parameters
name type description
dimTableName path The dimension table name
storage path The storage name
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

GET /metastore/dimtables/{dimTableName}/storages/{storage}/partitions

Get all partition of the dimension table in the specified storage; can be filtered

Request Parameters
name type description
dimTableName path The dimension table name
storage path The storage name
filter query The filter for partitions, string representation of the filter for ex: x < "xxx" and y > "yyy"
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json object (JSON) JAXB representation of XPartitionList containing XPartition objects
application/json object (JSON)
application/xml anyType (XML)

DELETE /metastore/dimtables/{dimTableName}/storages/{storage}/partitions

Drop the partitions in the storage of a dimension table; can specified filter as well

Request Parameters
name type description
dimTableName path The dimension table name
storage path The storage name
filter query The filter for partitions, string representation of the filter for ex: x < 'xxx' and y > 'yyy'
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

DELETE /metastore/dimtables/{dimTableName}/storages/{storage}/partition

Drop the partitions in the storage of a dimension table, specified by exact values

Request Parameters
name type description
dimTableName path The dimension table name
storage path The storage name
sessionid query The sessionid in which user is working
values query Comma separated values
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

POST /metastore/dimtables/{dimTableName}/storages/{storage}/partition

Add a new partition for a storage of dimension

Request Parameters
name type description
dimTableName path dimension table name
storage path storage name
sessionid query The sessionid in which user is working
Request Body
media type data type description
application/json XPartition (JSON) XPartition representation of partition
application/json XPartition (JSON)
application/xml x_partition (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if add was successful. APIResult with state Status#FAILED, if add has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

PUT /metastore/dimtables/{dimTableName}/storages/{storage}/partition

Updates an existing partition for a storage of dimension

Request Parameters
name type description
dimTableName path dimension table name
storage path storage name
sessionid query The sessionid in which user is working
Request Body
media type data type description
application/json XPartition (JSON) XPartition representation of partition
application/json XPartition (JSON)
application/xml x_partition (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if update was successful. APIResult with state Status#FAILED, if update has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

POST /metastore/dimtables/{dimTableName}/storages/{storage}/partitions

Add new partitions for a storage of dimension

Request Parameters
name type description
dimTableName path dimension table name
storage path storage name
sessionid query The sessionid in which user is working
Request Body
media type data type description
application/json XPartitionList (JSON) XPartitionList representation of list of partitions
application/json XPartitionList (JSON)
application/xml x_partition_list (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if add was successful. APIResult with state Status#FAILED, if add has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

PUT /metastore/dimtables/{dimTableName}/storages/{storage}/partitions

Add new partitions for a storage of dimension

Request Parameters
name type description
dimTableName path dimension table name
storage path storage name
sessionid query The sessionid in which user is working
Request Body
media type data type description
application/json XPartitionList (JSON) XPartitionList representation of list of partitions
application/json XPartitionList (JSON)
application/xml x_partition_list (XML)
Response Body
media type data type description
application/json APIResult (JSON) APIResult with state Status#SUCCEEDED, if update was successful. APIResult with state Status#FAILED, if update has failed
application/json APIResult (JSON)
application/xml APIResult (XML)

GET /metastore/flattened/{tableName}

Get flattened list of columns reachable from a cube or a dimension

Request Parameters
name type description default constraints
tableName path name of the table    
add_chains query whether columns accessed via chains should also be returned true boolean
sessionid query session id    
Response Body
media type data type description
application/json object (JSON) list of measures, expressions or dimension attributes
application/json object (JSON)
application/xml anyType (XML)

GET /metastore/chains/{tableName}

Get all chains that belong to a table(cube or dimension) in the metastore

Request Parameters
name type description
tableName path name of the table. can be either cube or dimension
sessionid query The sessionid in which user is working
Response Body
media type data type description
application/json object (JSON) XJoinChains object
application/json object (JSON)
application/xml anyType (XML)

GET /metastore/cubes/{cubeName}/latestdate

Get the latest available date upto which data is available for the base cubes, for the time dimension.

Request Parameters
name type description
cubeName path name of the base cube
sessionid query The sessionid in which user is working
timeDimension query time dimension name
Response Body
media type data type description
application/json DateTime (JSON) DateTime object which has Date in it.
application/json DateTime (JSON)
application/xml dateTime (XML)

GET /metastore/facts/{factName}/timelines

Get the partition timelines.

Request Parameters
name type description
factName path name of the fact
sessionid query The sessionid in which user is working
storage query storage Name
timeDimension query time dimension name
updatePeriod query update period
Response Body
media type data type description
application/json StringList (JSON) List os partition timelines.
application/json StringList (JSON)
application/xml stringList (XML)