REST API for Oracle Essbase

Get Job List

get

/essbase/rest/v1/jobs

Returns job list for the given query parameters, including job status, type, and input and output information. If no query parameter is specified, returns a list of all the jobs.

Request

Query Parameters

fullAppName: string

Application name for which to retrieve job records.
fullDatabaseName: string

Database name for which to retrieve job records.
keyword: string

Filter the job records using a keyword that may be part of the job ID, application name, database name, job file name (script), or user name. If this parameter and fullAppName are both specified, fullAppName takes precedence.
limit: integer(int64)

Maximum number of jobs to fetch.

Default Value: 50
offset: integer(int64)

Number of jobs to omit from the start of the result set.

Default Value: 0
orderBy: string

Order By specification. By default, jobs records are returned by job IDs in descending order.

Default Value: job_ID:desc
systemjobs: boolean

Include backup jobs in jobs records.

Default Value: false

Response

Supported Media Types

application/json
application/xml

200 Response

Job records returned successfully.

Root Schema : JobRecordPaginatedResultWrapper

Type: object

Show Source

count: integer(int64)
hasMore: boolean
items: array items
limit: integer(int64)
offset: integer(int64)
properties: object properties

Additional Properties Allowed: additionalProperties
totalResults: integer(int64)

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

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

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

string

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

Nested Schema : JobRecordBean

Type: object

Show Source

appName: string

Application name.
dbName: string

Cube name.
endTime: integer(int64)

End time of the job.
job_ID: integer(int64)

ID number of the job.
jobfileName: string

The script file used for the job.
jobInputInfo: object jobInputInfo

Additional Properties Allowed: additionalProperties
jobOutputInfo: object jobOutputInfo

Additional Properties Allowed: additionalProperties
jobType: string

The type of job. Examples: dataload, dimbuild, calc, clear, importExcel, exportExcel, lcmExport, lcmImport, clearAggregation, buildAggregation, asoBufferDataLoad, asoBufferCommit, exportData, mdxScript.
links: array links
startTime: integer(int64)

Start time of the job.
statusCode: integer(int32)

Job status code indicating progress. Each code has a corresponding statusMessage.

statusCode statusMessage
100 IN_PROGRESS
200 COMPLETED
300 COMPLETED_WITH_WARNINGS
400 FAILED
statusMessage: string

Job status message string indicating progress. Each string has a corresponding statusCode.

statusCode statusMessage
100 IN_PROGRESS
200 COMPLETED
300 COMPLETED_WITH_WARNINGS
400 FAILED
userName: string

User who ran the job. Users have access to job listings based on their assigned user role. For example, if you have the Service Administrator role, you can see all jobs; if you have the User role, you can see only the jobs you ran.

statusCode	statusMessage
100	IN_PROGRESS
200	COMPLETED
300	COMPLETED_WITH_WARNINGS
400	FAILED

statusCode	statusMessage
100	IN_PROGRESS
200	COMPLETED
300	COMPLETED_WITH_WARNINGS
400	FAILED

{
    "type":"object",
    "properties":{
        "job_ID":{
            "type":"integer",
            "format":"int64",
            "description":"<p>ID number of the job.</p>"
        },
        "appName":{
            "type":"string",
            "description":"<p>Application name.</p>"
        },
        "dbName":{
            "type":"string",
            "description":"<p>Cube name.</p>"
        },
        "jobType":{
            "type":"string",
            "description":"<p>The type of job. Examples: <code>dataload</code>, <code>dimbuild</code>, <code>calc</code>, <code>clear</code>, <code>importExcel</code>, <code>exportExcel</code>, <code>lcmExport</code>, <code>lcmImport</code>,  <code>clearAggregation</code>, <code>buildAggregation</code>, <code>asoBufferDataLoad</code>, <code>asoBufferCommit</code>, <code>exportData</code>, <code>mdxScript</code>.</p>"
        },
        "jobfileName":{
            "type":"string",
            "description":"<p>The script file used for the job.</p>"
        },
        "userName":{
            "type":"string",
            "description":"<p>User who ran the job. Users have access to job listings based on their assigned user role. For example, if you have the Service Administrator role, you can see all jobs; if you have the User role, you can see only the jobs you ran.</p>"
        },
        "startTime":{
            "type":"integer",
            "format":"int64",
            "description":"<p>Start time of the job.</p>"
        },
        "endTime":{
            "type":"integer",
            "format":"int64",
            "description":"<p>End time of the job.</p>"
        },
        "statusCode":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Job status code indicating progress. Each code has a corresponding <i>statusMessage</i>.</p><br><table><tr><th>statusCode</th><th>statusMessage</th></tr><tr><td>100</td><td>IN_PROGRESS</td></tr><tr><td>200</td><td>COMPLETED</td></tr><tr><td>300</td>    <td>COMPLETED_WITH_WARNINGS</td></tr><tr><td>400</td><td>FAILED</td></tr></table>"
        },
        "statusMessage":{
            "type":"string",
            "description":"<p>Job status message string indicating progress. Each string has a corresponding <i>statusCode</i>.</p><br><table><tr><th>statusCode</th><th>statusMessage</th></tr><tr><td>100</td><td>IN_PROGRESS</td></tr><tr><td>200</td><td>COMPLETED</td></tr><tr><td>300</td>    <td>COMPLETED_WITH_WARNINGS</td></tr><tr><td>400</td><td>FAILED</td></tr></table>"
        },
        "jobInputInfo":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "jobOutputInfo":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : jobInputInfo

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

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

Nested Schema : jobOutputInfo

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

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

Nested Schema : links

Type: array

Show Source

Array of: object Link

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

Nested Schema : additionalProperties

Type: object

Nested Schema : additionalProperties

Type: object

Nested Schema : Link

Type: object

Show Source

href: string
method: string
rel: string
type: string

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

500 Response

Internal Server Error.

503 Response

Service Unavailable

Naming exception or server exception.

Examples

The following example shows how to return a filtered Essbase jobs list.

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

The following example gets up to 10 jobs that use the keyword ASO_Sample.xlsx.

curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/jobs?keyword=ASO_Sample.xlsx&offset=0&limit=10&systemjobs=false" -H "accept: application/json" -u %User%:%Password%

Example of Response Body

Two jobs were returned that involved ASO_Sample.xlsx.

{
  "items": [
    {
      "job_ID": 3,
      "appName": "ASOSamp",
      "dbName": "Basic",
      "jobType": "Import Excel",
      "jobfileName": "ASO_Sample.xlsx",
      "userName": "power1",
      "startTime": 1574812065000,
      "endTime": 1574812135000,
      "statusCode": 200,
      "statusMessage": "Completed",
      "links": [
        {
          "rel": "canonical",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/jobs/3",
          "method": "GET"
        },
        {
          "rel": "post",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/jobs/3",
          "method": "POST"
        }
      ]
    },
    {
      "job_ID": 2,
      "appName": "ASOSamp",
      "dbName": "Basic",
      "jobType": "Import Excel",
      "jobfileName": "ASO_Sample.xlsx",
      "userName": "power1",
      "startTime": 1574810127000,
      "endTime": 1574810180000,
      "statusCode": 200,
      "statusMessage": "Completed",
      "links": [
        {
          "rel": "canonical",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/jobs/2",
          "method": "GET"
        },
        {
          "rel": "post",
          "href": "https://myserver.example.com:9001/essbase/rest/v1/jobs/2",
          "method": "POST"
        }
      ]
    }
  ],
  "offset": 0,
  "limit": 10,
  "count": 2,
  "totalResults": 2,
  "hasMore": false
}

Script with cURL Command

The following example gets all jobs for the Ratings cube in the application named Facility.

call properties.bat
curl -X GET "https://192.0.2.1:443/essbase/rest/v1/jobs?fullAppName=Facility&fullDatabaseName=Rating&links=none" -H "accept: application/json" -u %User%:%Password%

Example of Response Body

Three jobs were returned.

{
  "items" : [ {
    "job_ID" : 128,
    "appName" : "Facility",
    "dbName" : "Rating",
    "jobType" : "Export Data",
    "jobfileName" : null,
    "userName" : "power1",
    "startTime" : 1712778858000,
    "endTime" : 1712778858000,
    "statusCode" : 200,
    "statusMessage" : "Completed"
  }, {
    "job_ID" : 127,
    "appName" : "Facility",
    "dbName" : "Rating",
    "jobType" : "Data Load",
    "jobfileName" : "[\"\"]",
    "userName" : "power1",
    "startTime" : 1712697441000,
    "endTime" : 1712697441000,
    "statusCode" : 200,
    "statusMessage" : "Completed"
  }, {
    "job_ID" : 126,
    "appName" : "Facility",
    "dbName" : "Rating",
    "jobType" : "Clear Data",
    "jobfileName" : null,
    "userName" : "power1",
    "startTime" : 1712697424000,
    "endTime" : 1712697424000,
    "statusCode" : 200,
    "statusMessage" : "Completed"
  } ],
  "offset" : 0,
  "limit" : 50,
  "count" : 3,
  "totalResults" : 3,
  "hasMore" : false
}