DescribeDatabases - Spectrum_Routing_for_Big_Data - 3.0

Description

The DescribeDatabases operation returns name of all the database resources that are configured in the system and can be used in a request. This operation returns a list containing the names of all databases in the system and an array containing the datasets for each database.

HTTP GET URL Format (All Databases)

The format below is used for HTTP GET requests. If no data resource exists on the server, an empty list is returned.

http://<server>:<port>/webApp-context/services/v1/databases.json

Example (All Databases)

Request:

http://<server>:<port>/webApp-context/services/v1/databases.json

Response:

{
 "databases":
 [
  {
   "dataSets": 
   [
    "US_Central"
   ],
   "name": "US_CN"
  },
  {
   "dataSets": 
   [
    "US_NorthEast"
   ],
   "name": "US_NE"
  },
  {
   "dataSets": 
   [
    "US_Central", 
    "US_Midwest", 
    "US_NorthEast", 
    "US_Pacific", 
    "US_South"
   ],
   "name": "US"
  }
 ]
}

HTTP GET URL Format (Single Database)

The format below is used for HTTP GET requests. This request is used if to get the dataset information for a particular data resource. If no data resource with the specified name exists on the server, an exception is returned.

http://<server>:<port>/webApp-context/services/v1/<database_name>.json

Example (Single Database)

Request:

http://<server>:<port>/webApp-context/services/v1/databases/US.json

Response:

{
 "databases":
 [
  {
   "dataSets": 
   [
    "US_Central", 
    "US_Midwest", 
    "US_NorthEast", 
    "US_Pacific", 
    "US_South"
   ],
   "name": "US"
  }
 ]
}