Get Job Definitions

Can be used to retrieve job definitions for types of jobs that can be scheduled to run.

Using this REST API requires prerequisites, such as understanding how to use jobs. See Prerequisites. Be sure that you understand how to use jobs as described in Managing Jobs.

REST Resource

GET       /HyperionPlanning/rest/{api_version}/applications/{application}/jobdefinitions

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request.

Table 5-6 Parameters

Name Description Type Required Default
api_version Version of the API you are developing with Path Yes None
application The name of the application Path Yes None
jobIdentifier The ID of the job, such as 224 Path Yes None
q Query string Query No None
jobType Optionally, retrieve job definitions for a particular job type, such as RULES.

These jobs are supported:

     

Example URLs

https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3/applications/PS4app1/jobdefinitions

Specifying an optional jobType, RULES:

https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3/applications/PS4app1/jobdefinitions?q={"jobType":"RULES"}

Response

Supported Media Types: application/json

Parameters

The following table summarizes the parameters.

Example of Response Body

The following shows an example of the response body specifying jobType with a value of RULESET.

{
    "items": [{
        "jobType": "RULESET",
        "jobName": "Financial Statements - Forecast",
        "links": null
    }, {
        "jobType": "RULESET",
        "jobName": "Financial Statements - Plan",
        "links": null
    }, {
        "jobType": "RULESET",
        "jobName": "Revenue Forecast",
        "links": null
    }, {
        "jobType": "RULESET",
        "jobName": "Revenue Plan",
        "links": null
    }, {
        "jobType": "RULESET",
        "jobName": "RS 60 RTP vars test2",
        "links": null 
    }],
    "links": [{
        "rel": "self",
        "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3/applications/vision/jobdefinitions?q=%7BjobType:RULESET%7D",
        "action": "GET"
    }],
}