Jump to

• Request
• Response

Get Scenario-Enabled Cubes

get

/essbase/rest/v1/scenarios/databases

Gets information about all the databases registered for scenario management.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Scenario-enabled cubes returned successfully.

Body ()

Root Schema : Databases

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScenarioCubes"
            }
        },
        "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"
        }
    },
    "xml":{
        "name":"Databases"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Database

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

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

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

Nested Schema : Database

Type: object

Show Source

• application(optional): string
• createScenario(optional): boolean
• databaseAdmin(optional): boolean
• databases(optional): array databases
• easManagedApp(optional): 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.

• participateInScenario(optional): boolean

{
    "type":"object",
    "properties":{
        "application":{
            "type":"string"
        },
        "databases":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "createScenario":{
            "type":"boolean"
        },
        "participateInScenario":{
            "type":"boolean"
        },
        "databaseAdmin":{
            "type":"boolean"
        },
        "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>"
        }
    },
    "xml":{
        "name":"Database"
    }
}

Nested Schema : databases

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

400 Response

Bad Request

Failed to get scenario-enabled cubes.

500 Response

Internal Server Error.

Back to Top