MetastoreResource
metastore resource api
This provides api for all things metastore.The following resources are applicable:
- /metastore
- /metastore/cubes
- /metastore/cubes/{cubeName}
- /metastore/cubes/{cubeName}/facts
- /metastore/cubes/{cubeName}/latestdate
- /metastore/databases
- /metastore/databases/{dbName}
- /metastore/databases/current
- /metastore/dimensions
- /metastore/dimensions/{dimName}
- /metastore/dimtables
- /metastore/dimtables/{dimTableName}
- /metastore/dimtables/{dimTableName}/storages
- /metastore/dimtables/{dimTableName}/storages/{storage}
- /metastore/dimtables/{dimTableName}/storages/{storage}/partition
- /metastore/dimtables/{dimTableName}/storages/{storage}/partitions
- /metastore/facts
- /metastore/facts/{factName}
- /metastore/facts/{factName}/storages
- /metastore/facts/{factName}/storages/{storage}
- /metastore/facts/{factName}/storages/{storage}/partition
- /metastore/facts/{factName}/storages/{storage}/partitions
- /metastore/flattened/{tableName}
- /metastore/nativetables
- /metastore/nativetables/{tableName}
- /metastore/storages
- /metastore/storages/{storage}
- /metastore/storages/{storageName}
/metastore
Mount Point: /metastore
GET
API to know if metastore service is up and running
Response Body
| element: | (custom) |
| media types: | text/plain |
Simple text saying it up
/metastore/cubes
Mount Point: /metastore/cubes
The following operations are supported on this resource:
GET
Get all cubes in the metastores, of the specified type
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| type | The type of cubes. Accepted values are 'all' or 'base' or 'derived' or 'queryable' | query | all |
Response Body
| element: | stringList |
| media types: | application/xml application/json |
StringList consisting of all cubes names
DELETE
Delete all cubes
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query |
Response Body
| element: | result |
| media types: | application/xml application/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.
POST
Create a new cube
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query |
Request Body
| element: | cube |
| media types: | */* application/xml |
The XCube representation of the cube definition
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if create was successful. APIResult with state Status#FAILED, if create has failed
/metastore/cubes/{cubeName}
Mount Point: /metastore/cubes/{cubeName}
The following operations are supported on this resource:
PUT
Update cube definition
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| cubeName | The cube name | path |
Request Body
| element: | cube |
| media types: | */* application/xml |
The XCube representation of the updated cube definition
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if update was successful. APIResult with state Status#FAILED, if udpate has failed
GET
Get the cube specified by name
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| cubeName | The cube name | path |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
JAXB representation of XCube
DELETE
Drop the cube, specified by name
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| cubeName | The cube name | path |
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
/metastore/cubes/{cubeName}/facts
Mount Point: /metastore/cubes/{cubeName}/facts
GET
Get all facts that belong to a cube in the metastore
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| cubeName | name of the base cube or derived cube | path |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
List of XFactTable objects
/metastore/cubes/{cubeName}/latestdate
Mount Point: /metastore/cubes/{cubeName}/latestdate
GET
Get the latest available date upto which data is available for the base cubes, for the time dimension.
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| cubeName | name of the base cube | path | |
| timeDimension | time dimension name | query |
Response Body
| element: | dateTime |
| media types: | application/xml application/json |
DateTime object which has Date in it.
/metastore/databases
Mount Point: /metastore/databases
GET
Get all databases in the metastore
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query |
Response Body
| element: | stringList |
| media types: | application/xml application/json |
StringList consisting of all database names.
POST
Create a new database
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| ignoreIfExisting | If true, create will be ignored if db already exists, otherwise it fails. | query | true |
Request Body
| element: | dbName |
| media types: | */* application/xml |
The db name
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if create was successful. APIResult with state Status#FAILED, if create has failed
/metastore/databases/{dbName}
Mount Point: /metastore/databases/{dbName}
DELETE
Delete the db specified by name. Deleting underlying tables is optional. If db does not exist, delete is ignored.
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| dbName | The db name | path | |
| cascade | if true, all the tables inside the db will also be dropped. | query |
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if delete was successful. APIResult with state Status#FAILED, if delete has failed
/metastore/databases/current
Mount Point: /metastore/databases/current
GET
Get the current database
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
The current db name
PUT
Set the current db
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query |
Request Body
| element: | dbName |
| media types: | application/xml application/json |
The db name
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if set was successful. APIResult with state Status#FAILED, if set has failed
/metastore/dimensions
Mount Point: /metastore/dimensions
The following operations are supported on this resource:
GET
Get all dimensions in the metastore
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query |
Response Body
| element: | stringList |
| media types: | application/xml application/json |
StringList consisting of all the dimension names
POST
Create new dimension
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query |
Request Body
| element: | dimension |
| media types: | */* application/xml |
The XDimension representation of dimension
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if create was successful. APIResult with state Status#FAILED, if create has failed
DELETE
Delete all dimensions in metastore
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query |
Response Body
| element: | result |
| media types: | application/xml application/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.
/metastore/dimensions/{dimName}
Mount Point: /metastore/dimensions/{dimName}
The following operations are supported on this resource:
PUT
Update dimension definition
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| dimName | The dimension name | path |
Request Body
| element: | dimension |
| media types: | */* application/xml |
The XDimension representation of the updated dimension definition
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if update was successful. APIResult with state Status#FAILED, if update has failed
GET
Get the dimension specified by name
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| dimName | The dimension name | path |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
JAXB representation of XDimension
DELETE
Drop the dimension, specified by name
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| dimName | The dimension name | path |
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
/metastore/dimtables
Mount Point: /metastore/dimtables
GET
Get all dimension tables in the metastore
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query |
Response Body
| element: | stringList |
| media types: | application/xml application/json |
StringList consisting of all dimension table names
POST
Create a new dimension table
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | formdata | |
| dimensionTable | The XDimensionTable representation of the dimension table definition | formdata |
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if create was successful. APIResult with state Status#FAILED, if create has failed
/metastore/dimtables/{dimTableName}
Mount Point: /metastore/dimtables/{dimTableName}
The following operations are supported on this resource:
PUT
Update dimension table definition
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| dimTableName | (no documentation provided) | path |
Request Body
| element: | dimensionTable |
| media types: | */* application/xml |
The XDimensionTable representation of the updated dim table definition
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if update was successful. APIResult with state Status#FAILED, if udpate has failed
DELETE
Drop the dimension table, specified by name
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| dimTableName | The dimension table name | path | |
| cascade | if true, all the storage tables of dimension table will also be dropped | query |
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
GET
Get the dimension table specified by name
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| dimTableName | The cube name | path |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
JAXB representation of XDimensionTable
/metastore/dimtables/{dimTableName}/storages
Mount Point: /metastore/dimtables/{dimTableName}/storages
The following operations are supported on this resource:
GET
Get all storages of the dimension table in the metastore
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| dimTableName | The dimension table name | path |
Response Body
| element: | stringList |
| media types: | application/xml application/json |
StringList consisting of all the storage names
POST
Add storage to dimension table
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| dimTableName | The dimension table name | path |
Request Body
| element: | storageTbl |
| media types: | */* application/xml |
The Storage table description
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if add was successful. APIResult with state Status#FAILED, if add has failed
DELETE
Drop all the storage tables of a dimension table
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| dimTableName | The dimension table name | path |
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
/metastore/dimtables/{dimTableName}/storages/{storage}
Mount Point: /metastore/dimtables/{dimTableName}/storages/{storage}
GET
Get the dim storage table
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| dimTableName | The fact table name | path | |
| storage | The storage name | path |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
JAXB representation of XStorageTableElement
DELETE
Drop the storage of a dimension table, specified by name
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| dimTableName | The dimension table name | path | |
| storage | The storage name | path |
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
/metastore/dimtables/{dimTableName}/storages/{storage}/partition
Mount Point: /metastore/dimtables/{dimTableName}/storages/{storage}/partition
DELETE
Drop the partitions in the storage of a dimension table, specified by exact values
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| dimTableName | The dimension table name | path | |
| storage | The storage name | path | |
| values | Comma separated values | query |
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
POST
Add a new partition for a storage of dimension
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| dimTableName | dimension table name | path | |
| storage | storage name | path |
Request Body
| element: | partition |
| media types: | */* application/xml |
XPartition representation of partition
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if add was successful. APIResult with state Status#FAILED, if add has failed
/metastore/dimtables/{dimTableName}/storages/{storage}/partitions
Mount Point: /metastore/dimtables/{dimTableName}/storages/{storage}/partitions
The following operations are supported on this resource:
GET
Get all partition of the dimension table in the specified storage; can be filtered
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| dimTableName | The dimension table name | path | |
| storage | The storage name | path | |
| filter | The filter for partitions, string representation of the filter for ex: x < "xxx" and y > "yyy" | query |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
JAXB representation of XPartitionList containing XPartition objects
DELETE
Drop the partitions in the storage of a dimension table; can specified filter as well
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| dimTableName | The dimension table name | path | |
| storage | The storage name | path | |
| filter | The filter for partitions, string representation of the filter for ex: x < 'xxx' and y > 'yyy' | query |
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
POST
Add new partitions for a storage of dimension
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| dimTableName | dimension table name | path | |
| storage | storage name | path |
Request Body
| element: | partitions |
| media types: | */* application/xml |
XPartitionList representation of list of partitions
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if add was successful. APIResult with state Status#FAILED, if add has failed
/metastore/facts
Mount Point: /metastore/facts
The following operations are supported on this resource:
GET
Get all fact tables in the metastore in the current database
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query |
Response Body
| element: | stringList |
| media types: | application/xml application/json |
StringList consisting of all fact table names
DELETE
Delete all fact tables
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| cascade | if set to true, all the underlying tables will be dropped, if set to false, only the fact table will be dropped | query | false |
Response Body
| element: | result |
| media types: | application/xml application/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.
POST
Create a new fact tabble
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | formdata | |
| fact | The XFactTable representation of the fact table definition | formdata |
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if create was successful. APIResult with state Status#FAILED, if create has failed
/metastore/facts/{factName}
Mount Point: /metastore/facts/{factName}
The following operations are supported on this resource:
GET
Get the fact table specified by name
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| factName | The fact table name | path |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
JAXB representation of XFactTable
PUT
Update fact table definition
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| factName | name of the fact table | path |
Request Body
| element: | fact |
| media types: | */* application/xml |
The XFactTable representation of the updated fact table definition
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if update was successful. APIResult with state Status#FAILED, if udpate has failed
DELETE
Drop the fact table, specified by name
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| factName | The fact table name | path | |
| cascade | If true, all the storage tables of the fact will also be dropped | query | false |
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
/metastore/facts/{factName}/storages
Mount Point: /metastore/facts/{factName}/storages
The following operations are supported on this resource:
GET
Get all storages of the fact table in the metastore
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| factName | The fact table name | path |
Response Body
| element: | stringList |
| media types: | application/xml application/json |
StringList consisting of all the storage names
DELETE
Drop all the storage tables of a fact table
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| factName | The fact table name | path |
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
POST
Add storage to fact table
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| factName | The fact table name | path |
Request Body
| element: | storageTable |
| media types: | */* application/xml |
The storage table description
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if add was successful. APIResult with state Status#FAILED, if add has failed
/metastore/facts/{factName}/storages/{storage}
Mount Point: /metastore/facts/{factName}/storages/{storage}
DELETE
Drop the storage of a fact, specified by name
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| factName | The fact table name | path | |
| storage | The storage name | path |
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
GET
Get the fact storage table
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| factName | The fact table name | path | |
| storage | The storage name | path |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
JAXB representation of XStorageTableElement
/metastore/facts/{factName}/storages/{storage}/partition
Mount Point: /metastore/facts/{factName}/storages/{storage}/partition
POST
Add a new partition for a storage of fact
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| factName | fact table name | path | |
| storage | storage name | path |
Request Body
| element: | partition |
| media types: | */* application/xml |
XPartition representation of partition
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if add was successful. APIResult with state Status#FAILED, if add has failed
DELETE
Drop the partitions in the storage of a fact table, specified by exact values
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| factName | The fact table name | path | |
| storage | The storage name | path | |
| values | Comma separated values | query |
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
/metastore/facts/{factName}/storages/{storage}/partitions
Mount Point: /metastore/facts/{factName}/storages/{storage}/partitions
The following operations are supported on this resource:
GET
Get all partitions of the fact table in the specified storage; can be filtered as well.
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| factName | The fact table name | path | |
| storage | The storage name | path | |
| filter | The filter for partitions, string representation of the filter for ex: x < "xxx" and y > "yyy" | query |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
JAXB representation of XPartitionList containing XPartition objects
DELETE
Drop the partitions in the storage of a fact; can specified filter as well
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| factName | The fact table name | path | |
| storage | The storage name | path | |
| filter | The filter for partitions, string representation of the filter for ex: x < "xxx" and y > "yyy" | query |
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
POST
Batch Add partitions for a storage of fact
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| factName | fact table name | path | |
| storage | storage name | path |
Request Body
| element: | partitions |
| media types: | */* application/xml |
XPartitionList representation of partitions
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if add was successful. APIResult with state Status#FAILED, if add has failed
/metastore/flattened/{tableName}
Mount Point: /metastore/flattened/{tableName}
GET
Get flattened list of columns reachable from a cube or a dimension
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | session id | query | |
| tableName | name of the table | path |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
list of measures, expressions or dimension attributes
/metastore/nativetables
Mount Point: /metastore/nativetables
GET
Get all native tables.
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| dbOption | 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. | query | |
| dbName | The db name. If not empty, the tables in the db will be returned | query |
Response Body
| element: | stringList |
| media types: | application/xml application/json |
StringList consisting of all table names.
/metastore/nativetables/{tableName}
Mount Point: /metastore/nativetables/{tableName}
GET
Get the native table passed in name
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| tableName | The native table name | path |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
JAXB representation of XNativeTable
/metastore/storages
Mount Point: /metastore/storages
The following operations are supported on this resource:
GET
Get all storages in the metastore
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query |
Response Body
| element: | stringList |
| media types: | application/xml application/json |
StringList consisting of all the storage names
POST
Create new storage
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query |
Request Body
| element: | storage |
| media types: | */* application/xml |
The XStorage representation of storage
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if create was successful. APIResult with state Status#FAILED, if create has failed
DELETE
Delete all storages in metastore
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query |
Response Body
| element: | result |
| media types: | application/xml application/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.
/metastore/storages/{storage}
Mount Point: /metastore/storages/{storage}
GET
Get the storage specified by name
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| storage | The storage name | path |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
JAXB representation of XStorage
DELETE
Drop the storage, specified by name
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| storage | The storage name | path |
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if drop was successful. APIResult with state Status#FAILED, if drop has failed
/metastore/storages/{storageName}
Mount Point: /metastore/storages/{storageName}
PUT
Update storage definition
Parameters
| name | description | type | default |
|---|---|---|---|
| sessionid | The sessionid in which user is working | query | |
| storageName | The storage name | path |
Request Body
| element: | storage |
| media types: | */* application/xml |
The XStorage representation of the updated storage definition
Response Body
| element: | result |
| media types: | application/xml application/json |
APIResult with state Status#SUCCEEDED, if update was successful. APIResult with state Status#FAILED, if update has failed