Execute a Job

Use this resource to execute several jobs simultaneously by providing the job name and type. The job is expected to be defined in Planning with all the required parameters saved with the job definition. For some job types, the parameters can be either provided or overwritten at runtime.

Supported job types

This topic describes general information for executing a job. Details for each job type are described in separate topics for individual jobs.

REST Resource

POST /HyperionPlanning/rest/{api_version}/applications/{application}/jobs

Request

Supported Media Types: application/json

Parameters

This table summarizes the request parameters that are generic to all jobs. The following tables describe parameters specific to individual jobs.

Note that all parameter names and values are case sensitive.

Table 5-8 Parameters

Name Description Type Required Default
api_version Version of the API you are developing with Path Yes None
application Name of the application for which the job will be executed Path Yes None

Example URL and Payload

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

{"jobType":"jobType","jobName":"jobName","parameters":{"parameter1":"value","parameter2":"value2"}}

Response

Supported Media Types: application/json

Parameters

This table summarizes the response parameters that are generic to all jobs. The following topics describe parameters specific to individual jobs:

Table 5-9 Parameters

Name Description
status Status of the job: -1 = in progress; 0 = success; 1 = error; 2 = cancel pending; 3 = cancelled; 4 = invalid parameter; Integer.MAX_VALUE = unknown
details Details about the job status, such as “Metadata import was successful” for metadata import
jobID The ID of the job, such as 145
jobName The name of the job, such as Refresh Database
descriptiveStatus The status of the job, such as Completed or Error