Deploy Task Manager Templates

This API executes the job based on the job type (TM_DEPLOY_TEMPLATE) provided as a JSON parameter. This is an asynchronous API and responds with a callback API to get the job status.

Parameters

The following table summarizes the client request:

Table 19-2 TM_DEPLOY_TEMPLATES Parameters

Name	Description	Type	Required	Default
`jobType`	Type of the Job, value for this Job is TM_DEPLOY_TEMPLATE	String	Yes	None
`templateName`	The name of the task manager template to be deployed	String	Yes	None
`scheduleName`	The name of the new schedule that will be created from the template	String	Yes	None
`year`	The member of the Year dimension where the template will be deployed	String	Yes	None
`period`	The member of the Period dimension where the template will be deployed	String	Yes	None
`dayZeroDate`	The Day Zero date used in creating the Schedule in a valid format	String	Yes	None
`dateFormat`	The date format for the Day Zero Date	String	No	YYY-MM-DD
`orgUnit`	The Organization Unit name	String	No	None

REST Resource

POST/HyperionPlanning/rest/cmapi/{api_version}/jobs

Required Roles

Service Administrator

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request parameters specific to this job.

Table 19-3 Parameters

Name	Description	Type	Required	Default
`api_version`	It is a path parameter. Version of the API you are developing with for example, v1	String	Yes	None

Examples of Request Body

Example for Job Type: TM_DEPLOY_TEMPLATE

Example 1:

{

    "jobType":"TM_DEPLOY_TEMPLATE",

    "parameters":{

        "templateName":"Template1",

        "scheduleName": "scheduleA",

        "year":"2021",

        "period":"Jan",

        "dayZeroDate":"2021-01-01"

    }

}

Example 2:

{

    "jobType":"TM_DEPLOY_TEMPLATE",

    "parameters":{

        "templateName":"Template1",

        "scheduleName": "scheduleA",

        "year":"2021",

        "period":"Jan",

        "dayZeroDate":"2021-01-01",

         "orgUnit":"JPAC"

    }

}

Response

Supported Media Types: application/json

Table 19-4 Parameters

Name	Description
`jobId`	Job ID
`descriptiveStatus`	Any additional details
`details`	Message to the end user. In case of errors, details are published.
`status`	-1 – In Progress; 0 – Success; 1 – Fail
`items`	Not applicable for this job type
`links`	Detailed information about the link
`rel`	Possible values: self
`href`	Links to API call
`action`	The HTTP call type

JSON Output

The following is an example of the response body in JSON format.

{

    "links": [

        {

            "rel": "self",

            "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/cmapi/v1/jobs",

            "action": "POST"

        },

        {

            "rel": "Job Status",

            "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/cmapi/v1/jobs/14008",

            "action": "GET"

        }

    ],

    "details": "In Process",

    "status": -1,

    "type": "TM",

    "link": {},

    "error": null,

    "items": []

}