Deploy Form Templates

For details on Using Deploying a Form Template to a Data Collection Period.

This REST API returns the job id after starting the job.

REST Resource

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

Required Roles

Service Administrator, Power User

Request

Supported Media Types: application/json

Parameters

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

Table 20-5 Deploy Form Template

Name	Description	Type	Required	Default
`api_version`	Version of the API you are working with: v3	Path	Yes	None
`application`	The name of the application Get the application name by using the Get Applications API, for example, FCCS. See Get Applications.	Path	Yes	None
`jobName`	Name of the job that has been defined in Financial Consolidation and Close or no value for the job	String	No	None
`jobType`	Type of Job. Supported value: `DEPLOY_FORM_TEMPLATES`	String	Yes	None
`CollectionIntervalName`	The name of the collection interval to which the template should be deployed	String	Yes	None
Parameter for frequency dimension 1	Dimension and member name of interval frequency dimension, to which the template should be deployed. This optional key value parameter depends on the number of frequency dimensions in the interval. The key should be dimension name and the value should be member name.	String	No	None
Parameter for frequency dimension 2	Dimension and member name of interval frequency dimension, to which the template should be deployed. This optional key value parameter depends on the number of frequency dimensions in the interval. The key should be dimension name and the value should be member name.	String	No	None
Parameter for frequency dimension 3	Dimension and member name of interval frequency dimension, to which the template should be deployed. This optional key value parameter depends on the number of frequency dimensions in the interval. The key should be dimension name and the value should be member name.	String	No	None
Parameter for frequency dimension 4	Dimension and member name of interval frequency dimension, to which the template should be deployed. This optional key value parameter depends on the number of frequency dimensions in the interval. The key should be dimension name and the value should be member name.	String	No	None
Template	Names of the form templates to deploy. You can provide multiple parameters with the same key as "TEMPLATE" and this will be converted to a JSON array and passed as a single parameter in the JSON string. This is an optional parameter. However, if nothing is specified for the TEMPLATE key, this parameter is still present as an empty JSON Array in the JSON string, and all templates for the given interval will be deployed. Even if you give only one template name, this should still be passed as a JSON array.	JSON Array	No	None
ResetWorkflows	Either true or false. Optional parameter indicating whether all forms should be reset back to the first stage after redeploying. This parameter is also derived by the system based on changes to the template and collection, so the system-derived value can override the user specified value.	Boolean	No	false

Examples of request body

Example 1:

{
	"jobType" : "DEPLOY_FORM_TEMPLATES",
	"parameters": 
				{
					"CollectionIntervalName" : "Journal Collection Interval",
					"Year" : "2020",
					"Period" : "July",
					"Product" : "Oracle EPM",
					"Consolidation" : "Entity Input",
					"Template" : [ "Template,1","Template 2" ],
 					"ResetWorkflows" : "true"
				}
}

Example 2:

{ 
	"jobType" : "DEPLOY_FORM_TEMPLATES",
	"parameters": 
				{
					"CollectionIntervalName" : "Loan Collection Interval",
					"Year" : "2020",
					"Period" : "July",
					"Category" : "Oracle EPM",
					"Movement" : "Actual",
					"Template" : ["Template 3"]
				}
}

Example 3:

{ 
	"jobType" : "DEPLOY_FORM_TEMPLATES",
	"parameters": 
				{
					"CollectionIntervalName" : "Default",
					"Year" : "2020",
					"Period" : "July",
					"Scenario" : "Actual",
					"Template" : ["Template 5","Template 6"],
 					"ResetWorkflows" : "false",
				}
}

Example 4:

{ 
	"jobType" : "DEPLOY_FORM_TEMPLATES",
	"parameters": 
				{
					"CollectionIntervalName" : "Custom Interval",
					"Year" : "2020",
					"Period" : "July",
					"Template" : ["Template 5","Template 6","Template 7","Template 8"]
				}
}

Response

Table 20-6 Parameters

Name	Description
`jobId`	Financial Consolidation and Close job ID
`descriptiveStatus`
`details`	Any additional details
`Status`	-1 = In progress; 0 = Success; 1 = Fail
`items`	Not applicable for this job type
`links`	Detailed information about the link
`href`	Links to API call
`action`	The HTTP call type
`rel`	Possible values: self

Supported Media Types: application/json

JSON Output

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

{
   "jobId":100000000114040,
   "descriptiveStatus":",
   "detail":"In Progress",
   "status":-1,
   "items":null,
   "links":[
      {
         "rel":"self",
         "href":"https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3/applications/FCCS/fcmjobs/100000000114040",
         "action":"GET"
      }
   ]
}