Import a template file
post
/epm/rest/v1/templates/import
Request
Supported Media Types
- application/json
Specifies the parameters to use for running the import.
Root Schema : ImportTemplateCommandJson
Type:
Show Source
object
-
fileName(required):
string
Name of the template file in the staging area to import.
-
importOptions:
object ImportTemplateOptionsJson
Options to use when importing the template file.
Nested Schema : ImportTemplateOptionsJson
Type:
object
Options to use when importing the template file.
Show Source
-
filterArchivedObjects:
boolean
Determines whether to exclude archived objects during template import if the objects do not already exist. Default behavior is to include archived objects.
-
permissions:
string
Allowed Values:
[ "MERGE", "REPLACE" ]
Determines how differences in permissions are applied to target objects during template import. During Merge, new permissions are added from the template and existing permissions are retained in the target environment. During Replace, new permissions are added and existing permissions in the target environment are replaced with those from the source template. Default behavior is to merge. -
policyGroups:
string
Allowed Values:
[ "MERGE", "REPLACE" ]
Determines how differences in policy groups are applied to target objects during template import. During Merge, new policy groups are added from the template and existing policy groups are retained in the target environment. During Replace, new policy groups are added and existing policy groups in the target environment are replaced with those from the source template. Default behavior is to merge.
Response
Supported Media Types
- application/json
202 Response
Created job, import processing
400 Response
Error in body
404 Response
Not found
Examples
The following example shows how to import a template submitting a post request on the REST resource using cURL.
curl --user epm_cloud_user -X POST -H 'Content-Type: application/json' -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/epm/rest/v1/templates/import
Example of Request Body
The following shows an example of the request body in JSON format.
{ "fileName": "Corporate Accounts.json", "importOptions": { "policyGroups": "REPLACE", "permissions": "REPLACE", "filterArchivedObjects": "false" } }
Example of Response Body
The following shows an example of the response body in JSON format.
{ "links": [ { "rel": "results", "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/jobRuns/ce2ab6ac-969a-4462-8db9-a11460a51f1f" } ] }