Delete Session By ID
delete
/essbase/rest/v1/sessions/{sessionId}
Deletes a particular session or kills a particular request using the session id.
Request
Path Parameters
-
sessionId: integer(int64)
sessionId of the session to be disconnected or request killed.
Query Parameters
-
disconnect(optional): boolean
Disconnection value. Default is false, meaning kill the request. If true, disconnect the user session.
Default Value:false
Response
Supported Media Types
- application/json
- application/xml
200 Response
OK
Session or request terminated successfully.
400 Response
Bad Request
- Essbase or platform security exception.
- If the sessionId is incorrect,
Error: No session with specified login id. - Cannot disconnect user. Essbase Error(1051041): Insufficient privilege for this operation
500 Response
Internal Server Error.
Examples
The following example shows how to terminate a user session 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 DELETE "https://myserver.example.com:9001/essbase/rest/v1/sessions/4178574804?links=none" -H Accept:application/json -H Content-Type:application/json -u %User%:%Password%