Jump to

• Request
• Response
• Examples

Import a template file

post

/epm/rest/v1/templates/import

Request

Supported Media Types

• application/json

Body ()

Specifies the parameters to use for running the import.

Root Schema : ImportTemplateCommandJson

Type: object

Show Source

• fileName: string
  Name of the template file in the staging area to import.
• importOptions(optional): object ImportTemplateOptionsJson
  Options to use when importing the template file.

{
    "type":"object",
    "required":[
        "fileName"
    ],
    "properties":{
        "fileName":{
            "type":"string",
            "description":"Name of the template file in the staging area to import."
        },
        "importOptions":{
            "description":"Options to use when importing the template file.",
            "$ref":"#/definitions/ImportTemplateOptionsJson"
        }
    }
}

Nested Schema : ImportTemplateOptionsJson

Type: object

Options to use when importing the template file.

Show Source

• filterArchivedObjects(optional): 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(optional): 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(optional): 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.

{
    "type":"object",
    "properties":{
        "policyGroups":{
            "type":"string",
            "description":"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.",
            "enum":[
                "MERGE",
                "REPLACE"
            ]
        },
        "permissions":{
            "type":"string",
            "description":"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.",
            "enum":[
                "MERGE",
                "REPLACE"
            ]
        },
        "filterArchivedObjects":{
            "type":"boolean",
            "description":"Determines whether to exclude archived objects during template import if the objects do not already exist. Default behavior is to include archived objects."
        }
    },
    "description":"Options to use when importing the template file."
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Created job, import processing

400 Response

Error in body

404 Response

Not found

Back to Top

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"
        }
    ]
}

Back to Top