Jump to

• Request
• Response
• Examples

List Sessions

get

/essbase/rest/v1/sessions

Returns a list of session currently active for a user or request.

Request

Query Parameters

• application(optional): string

  Application name.

• database(optional): string

  Database name.

• userId(optional): string

  User ID for whom to return the active sessions. If not provided, all the sesions are retrieved.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Session details returned successfully.

Body ()

Root Schema : SessionAttributes

Type: object

Show Source

• application(optional): string

  Name of active application.

• connectionSource(optional): string

  Host name of the connected service.

• database(optional): string

  Name of active database.

• dbConnectTimeInSeconds(optional): string

  Number of seconds ago the database was set active.

• loginTimeInSeconds(optional): string

  Number of seconds ago the session began.

• request(optional): string

  Type of active request in progress; for example, calculation, data load, or restructure. This information can help you get details about what is occurring during lengthy sessions.

• requestState(optional): string

  The status of the active request.

• requestTimeInSeconds(optional): string

  Number of seconds the active request has been running.

• sessionId(optional): string

  Numeric session ID.

• userId(optional): string

  Logged in user name.

{
    "type":"object",
    "properties":{
        "userId":{
            "type":"string",
            "description":"<p>Logged in user name.</p>"
        },
        "sessionId":{
            "type":"string",
            "description":"<p>Numeric session ID.</p>"
        },
        "loginTimeInSeconds":{
            "type":"string",
            "description":"<p>Number of seconds ago the session began.</p>"
        },
        "application":{
            "type":"string",
            "description":"<p>Name of active application.</p>"
        },
        "database":{
            "type":"string",
            "description":"<p>Name of active database.</p>"
        },
        "dbConnectTimeInSeconds":{
            "type":"string",
            "description":"<p>Number of seconds ago the database was set active.</p>"
        },
        "request":{
            "type":"string",
            "description":"<p>Type of active request in progress; for example, calculation, data load, or restructure. This information can help you get details about what is occurring during lengthy sessions.</p>"
        },
        "requestTimeInSeconds":{
            "type":"string",
            "description":"<p>Number of seconds the active request has been running.</p>"
        },
        "connectionSource":{
            "type":"string",
            "description":"<p>Host name of the connected service.</p>"
        },
        "requestState":{
            "type":"string",
            "description":"<p>The status of the active request.</p>"
        }
    }
}

400 Response

Bad Request

Essbase or platform security exception.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to list all active user sessions on the Essbase Server.

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/sessions?links=none" -H Accept:application/json -H Content-Type:application/json -u %User%:%Password%

Example of Response Body

[ {
  "userId" : "admin",
  "sessionId" : "2790260182",
  "loginTimeInSeconds" : "200",
  "connectionSource" : "https://myserver.example.com"
}, {
  "userId" : "user1",
  "sessionId" : "4178574804",
  "loginTimeInSeconds" : "72",
  "connectionSource" : "https://myserver.example.com"
}, {
  "userId" : "power1",
  "sessionId" : "3468688851",
  "loginTimeInSeconds" : "4",
  "connectionSource" : "https://myserver.example.com"
} ]

Back to Top