Jump to

• Request
• Response
• Examples

List Applications

get

/essbase/rest/v1/applications

Returns the list of Essbase applications. Connection name and application name for connection are optional parameters.

If you provide only a connection name with no application name, this API fetches all applications using that named connection.

If you provide a connection name and application name, this API fetches the specified applications using the specified connection.

Use the fields parameter to return only required fields.

Limitation: If the application status is required in response, the limit must be less than or equal to 100.

Request

Query Parameters

• applicationNameForConnection(optional): string

  Application name for connection.

• connectionName(optional): string

  Connection name.

• fields(optional): string

  Comma-separated list of fields to be returned in response fields. If omitted, all fields are returned.

• filter(optional): string
  Default Value: *
• limit(optional): integer(int32)

  Maximum number of applications to return. Default is 50.

  Default Value: 50
• offset(optional): integer(int32)

  Number of applications to omit from the start of the result set. Default value is 0.

  Default Value: 0

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Application list returned successfully.

Body ()

Root Schema : ApplicationList

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/Application"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Application

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

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

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

Nested Schema : Application

Type: object

Show Source

• connectedUsersCount(optional): integer(int32)

  The number of users currently connected to the application.

• creationTime(optional): integer(int64)
• description(optional): string
• easManagedApp(optional): boolean

  If true, the application is managed in Essbase Administration Services (EAS) Lite instead of the Essbase web interface. Before you can connect to an application in EAS Lite, you must set it as an EAS managed application. The Essbase web interface is the modern administration interface that supports all current platform features, but EAS Lite is available as a limited-option alternative available only for Essbase 21c independent deployment.

• inspectAppAllowed(optional): boolean
• links(optional): array links
• modifiedBy(optional): string
• modifiedTime(optional): integer(int64)
• name(optional): string
• owner(optional): string
• role(optional): string
• startStopAppAllowed(optional): boolean

  true if users who have at least read permission can start the application.

• startTime(optional): integer(int64)
• status(optional): string
• type(optional): string
  Allowed Values: [ "ASO", "BSO", "CURRENCY" ]

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "owner":{
            "type":"string"
        },
        "creationTime":{
            "type":"integer",
            "format":"int64"
        },
        "modifiedBy":{
            "type":"string"
        },
        "modifiedTime":{
            "type":"integer",
            "format":"int64"
        },
        "status":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "ASO",
                "BSO",
                "CURRENCY"
            ]
        },
        "startTime":{
            "type":"integer",
            "format":"int64"
        },
        "connectedUsersCount":{
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of users currently connected to the application.</p>"
        },
        "role":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "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. Before you can connect to an application in EAS Lite, you must set it as an EAS managed application. The Essbase web interface is the modern administration interface that supports all current platform features, but EAS Lite is available as a limited-option alternative available only for Essbase 21c independent deployment.</p>"
        },
        "startStopAppAllowed":{
            "type":"boolean",
            "description":"<p><b>true</b> if users who have at least read permission can start the application.</p>"
        },
        "inspectAppAllowed":{
            "type":"boolean"
        }
    }
}

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(optional): string
• method(optional): string
• rel(optional): string
• type(optional): string

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

400 Response

Bad Request

Failed to get applications.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to retrieve a list of Essbase applications.

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?filter=*&offset=0&limit=50&links=none" -H "accept: application/json" -u %User%:%Password%

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
  "items": [
    {
      "name": "ASOSamp",
      "owner": "admin",
      "creationTime": 1572892960265,
      "status": "stopped",
      "type": "ASO",
      "connectedUsersCount": 0,
      "description": "",
      "modifiedBy": "admin",
      "modifiedTime": 1572892960000,
      "role": "app_manager",
      "startStopAppAllowed": "true",
      "inspectAppAllowed": "true",
      "appVariablesSetting": {
         "showVariables": true,
         "updateVariables": true
       }
    },
    {
      "name": "Sample",
      "owner": "admin",
      "creationTime": 1571317262832,
      "status": "stopped",
      "type": "BSO",
      "connectedUsersCount": 0,
      "description": "",
      "modifiedBy": "admin",
      "modifiedTime": 1571317262000,
      "role": "app_manager",
      "startStopAppAllowed": "true",
      "inspectAppAllowed": "true",
      "appVariablesSetting": {
         "showVariables": true,
         "updateVariables": true
       }
    },
    {
      "name": "Sample_Dynamic",
      "owner": "admin",
      "creationTime": 1571317308132,
      "status": "stopped",
      "type": "BSO",
      "connectedUsersCount": 0,
      "description": "",
      "modifiedBy": "admin",
      "modifiedTime": 1571317308000,
      "role": "app_manager",
      "startStopAppAllowed": "true",
      "inspectAppAllowed": "true",
      "appVariablesSetting": {
         "showVariables": true,
         "updateVariables": true
       }
    }
  ],
  "offset": 0,
  "limit": 50,
  "count":  3,
  "totalResults":  3,
  "hasMore": false
}

Back to Top