Jump to

• Request
• Response
• Examples

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(optional): string

  Application name for which to retrieve job records.

• keyword(optional): 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(optional): integer(int64)

  Maximum number of jobs to fetch.

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

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

  Default Value: 0
• orderBy(optional): string

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

  Default Value: job_ID:desc
• systemjobs(optional): boolean

  Include backup jobs in jobs records.

  Default Value: false

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Job records returned successfully.

Body ()

Root Schema : JobRecordPaginatedResultWrapper

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/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(optional): string

  Application name.

• dbName(optional): string

  Cube name.

• endTime(optional): integer(int64)

  End time of the job.

• job_ID(optional): integer(int64)

  ID number of the job.

• jobfileName(optional): string
• jobInputInfo(optional): object jobInputInfo
  Additional Properties Allowed: additionalProperties
• jobOutputInfo(optional): object jobOutputInfo
  Additional Properties Allowed: additionalProperties
• jobType(optional): string

  The type of job. Examples: dataload, dimbuild, calc, clear, importExcel, exportExcel, lcmExport, lcmImport, clearAggregation, buildAggregation, asoBufferDataLoad, asoBufferCommit, exportData, mdxScript.

• links(optional): array links
• startTime(optional): integer(int64)

  Start time of the job.

• statusCode(optional): 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(optional): 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(optional): 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.

{
    "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"
        },
        "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(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"
        }
    }
}

500 Response

Internal Server Error.

503 Response

Service Unavailable

Naming exception or server exception.

Back to Top

Examples

The following example shows how to return a filtered job list, using 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

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

{
  "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
}

Back to Top