Jump to

• Request
• Response
• Examples

Get Job Statistics

get

/essbase/rest/v1/jobs/statistics/{userId}

Returns the job statistics for the currently logged in user, including number of jobs that are successful, number of jobs containing errors, number of jobs containing warnings, and the number of jobs running.

Request

Path Parameters

• userId: string
  User Id of the logged in user

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Job statistics returned successfully.

Body ()

Root Schema : JobStatisticsBean

Type: object

Show Source

• errCt(optional): integer(int64)
• runningCt(optional): integer(int64)
• succesCt(optional): integer(int64)
• warningCt(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "errCt":{
            "type":"integer",
            "format":"int64"
        },
        "succesCt":{
            "type":"integer",
            "format":"int64"
        },
        "warningCt":{
            "type":"integer",
            "format":"int64"
        },
        "runningCt":{
            "type":"integer",
            "format":"int64"
        }
    }
}

500 Response

Internal Server Error.

503 Response

Naming Exception or Server Exception.

Back to Top

Examples

The following example shows how to return jobs statistics for a user.

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/jobs/statistics/power1" -H "accept: application/json" -u %User%:%Password%

Example of Response Body

{
  "errCt": 6,
  "succesCt": 12,
  "warningCt": 2,
  "runningCt": 1
}

Back to Top