Jump to

• Request
• Response
• Examples

List Databases

get

/essbase/rest/v1/applications/{applicationName}/databases

Returns list of databases. Providing the connection name for which to list databases is optional. If a connection name is provided, connections created at the specified application is used to fetch the database list.

Request

Path Parameters

• applicationName(required): string

  Application name.

Query Parameters

• applicationNameForConnection: string

  Application name from which to list databases.

• connectionName: string

  Connection name.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Database list returned successfully.

Body ()

Root Schema : CubeList

Type: object

Show Source

• count: integer(int64)
• hasMore: boolean
• items: array items
• limit: integer(int64)
• offset: integer(int64)
• properties: object properties
  Additional Properties Allowed: additionalProperties
• totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Cube"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Cube

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Cube"
    }
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : Cube

Type: object

Show Source

• application: string
• applicationRole: string
• creationTime: integer(int64)
• description: string
• easManagedApp: boolean

  If true, the application is managed in Essbase Administration Services (EAS) Lite instead of the Essbase web interface. EAS Lite is available as a limited-option alternative available only for Essbase 21c independent deployment.

• inspectDBAllowed: boolean
• links: array links
• modifiedBy: string
• modifiedTime: integer(int64)
• name: string
• owner: string
• startStopDBAllowed: boolean
• startTime: integer(int64)
• status: string
• type: string
  Allowed Values: [ "ASO", "BSO", "CURRENCY" ]

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "application":{
            "type":"string"
        },
        "owner":{
            "type":"string"
        },
        "creationTime":{
            "type":"integer",
            "format":"int64"
        },
        "modifiedBy":{
            "type":"string"
        },
        "modifiedTime":{
            "type":"integer",
            "format":"int64"
        },
        "status":{
            "type":"string"
        },
        "startTime":{
            "type":"integer",
            "format":"int64"
        },
        "description":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "ASO",
                "BSO",
                "CURRENCY"
            ]
        },
        "applicationRole":{
            "type":"string"
        },
        "easManagedApp":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, the application is managed in Essbase Administration Services (EAS) Lite instead of the Essbase web interface. EAS Lite is available as a limited-option alternative available only for Essbase 21c independent deployment.</p>"
        },
        "startStopDBAllowed":{
            "type":"boolean"
        },
        "inspectDBAllowed":{
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• method: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

Failed to get databases.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to get a list of Essbase databases.

This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat.

Script with cURL Command

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases?links=none" -H "Accept:application/json" -H "Content-Type:application/json" -u %User%:%Password%

Example of Response Body

{
  "items" : [ {
    "name" : "Basic",
    "application" : "Sample",
    "owner" : "admin",
    "creationTime" : 1663198643123,
    "status" : "started",
    "startTime" : 1663814542677,
    "type" : "BSO",
    "description" : "",
    "modifiedBy" : "admin",
    "modifiedTime" : 1663814710916,
    "applicationRole" : "app_manager",
    "startStopDBAllowed" : true,
    "inspectDBAllowed" : true,
    "dbVariablesSetting" : {
      "showVariables" : true,
      "updateVariables" : true
    }
  } ]
}

Back to Top