Jump to

• Request
• Response
• Examples

Export a template file

post

/epm/rest/v1/templates/export

Request

Supported Media Types

• application/json

Body ()

Specifies the parameters to use for running the export, applications or dimensions are needed to export

Root Schema : ExportTemplateCommandJson

Type: object

Show Source

• applications: array applications
  Unique Items Required: true

  Names of the applications for which to export a template.
• dimensions: array dimensions
  Unique Items Required: true

  Names of the applications and dimensions for which to export a template. Each application and dimension combination must be separated by the | delimiter. Example: applicationName|dimensionName
• fileName(required): string
  Name of the template file exported to the staging area. Example: application.json

{
    "type":"object",
    "required":[
        "fileName"
    ],
    "properties":{
        "applications":{
            "type":"array",
            "description":"Names of the applications for which to export a template.",
            "uniqueItems":true,
            "items":{
                "type":"string"
            }
        },
        "dimensions":{
            "type":"array",
            "description":"Names of the applications and dimensions for which to export a template. Each application and dimension combination must be separated by the | delimiter.  Example:  applicationName|dimensionName",
            "uniqueItems":true,
            "items":{
                "type":"string"
            }
        },
        "fileName":{
            "type":"string",
            "description":"Name of the template file exported to the staging area. Example: application.json"
        }
    }
}

Nested Schema : applications

Type: array

Unique Items Required: true

Names of the applications for which to export a template.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Names of the applications for which to export a template.",
    "uniqueItems":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : dimensions

Type: array

Unique Items Required: true

Names of the applications and dimensions for which to export a template. Each application and dimension combination must be separated by the | delimiter. Example: applicationName|dimensionName

Show Source

• Array of: string

{
    "type":"array",
    "description":"Names of the applications and dimensions for which to export a template. Each application and dimension combination must be separated by the | delimiter.  Example:  applicationName|dimensionName",
    "uniqueItems":true,
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Created job, export processing

400 Response

Error in body

404 Response

Not found

Back to Top

Examples

The following example shows how to export 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/export

Example of Request Body

The following show examples of the request body in JSON format.

{
    "applications": ["Corporate GL"],
    "fileName": "Corporate GL.json",
}

{
    "dimensions": ["Corporate GL|Account"],
    "fileName": "Corporate Accounts.json",
}

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