Jump to

• Request
• Response
• Examples

Export a dimension by name

post

/epm/rest/v1/dimensions/byName/export

Request

Body ()

Specifies the parameters to use for running the export

Root Schema : ExportDimensionByNameCommandJson

Type: object

Show Source

• applicationName: string
  Name of Application for which Dimension to export
• connection(optional): string
  Name of connection where the export file is written to. If not supplied, the export file is written to the staging area. Either fileName or connectionName should be passed.
• dimensionName: string
  Name of Dimension to export
• fileName: string
  The target file name to export the dimension to. File will be exported to the staging area or the specified connection. Either fileName or connectionName should be passed. If the Zip Extract option is disabled in the extract profile, use the text file name. If the Zip Extract option is enabled, use the zip file name.

  Example: dimension.csv

{
    "type":"object",
    "required":[
        "applicationName",
        "dimensionName",
        "fileName"
    ],
    "properties":{
        "fileName":{
            "type":"string",
            "example":"dimension.csv",
            "description":"The target file name to export the dimension to. File will be exported to the staging area or the specified connection. Either fileName or connectionName should be passed. If the Zip Extract option is disabled in the extract profile, use the text file name. If the Zip Extract option is enabled, use the zip file name."
        },
        "applicationName":{
            "type":"string",
            "description":"Name of Application for which Dimension to export"
        },
        "dimensionName":{
            "type":"string",
            "description":"Name of Dimension to export"
        },
        "connection":{
            "type":"string",
            "description":"Name of connection where the export file is written to. If not supplied, the export file is written to the staging area. Either fileName or connectionName should be passed."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 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 dimension by name to a file by submitting a post request on the REST resource using cURL.

cURL Command

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/dimensions/byName/export

Example of Request Body

The following shows an example of the request body in JSON format.

{
    "applicationName": "Corporate Planning",
    "dimensionName": "Account"
    "fileName": "Account.csv",
    "connection": "Production"
}

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/81ecd091-f969-4053-85ef-3718d1ad63b0"
    }
  ]
}

Back to Top