Jump to

• Request
• Response
• Examples

Export a dimension mapping by name

post

/epm/rest/v1/dimensions/byName/exportMappings

Request

Body ()

Specifies the parameters to use for running the export

Root Schema : ExportDimensionMappingByNameCommandJson

Type: object

Show Source

• applicationName(required): string
  Name of Application for which Dimension mapping to export
• connection: string
  Name of connection where the export file is written to. If not supplied, the export file is written to the staging area.
• dimensionName(required): string
  Name of Dimension to export
• fileName(required): string
  The target file name to export the dimension mapping to. File will be exported to the staging area or the specified connection.

  Example: mappings.csv
• mappingLocation(required): string
  Name of the mapping location to export

{
    "type":"object",
    "required":[
        "applicationName",
        "dimensionName",
        "fileName",
        "mappingLocation"
    ],
    "properties":{
        "fileName":{
            "type":"string",
            "example":"mappings.csv",
            "description":"The target file name to export the dimension mapping to. File will be exported to the staging area or the specified connection."
        },
        "mappingLocation":{
            "type":"string",
            "description":"Name of the mapping location to export"
        },
        "dimensionName":{
            "type":"string",
            "description":"Name of Dimension to export"
        },
        "applicationName":{
            "type":"string",
            "description":"Name of Application for which Dimension mapping 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."
        }
    }
}

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 mapping by name to a CSV 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/exportMappings

Example of Request Body

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

{
    "applicationName": "Financials Cloud",
    "dimensionName": "Corporate Account"
    "fileName": "Corporate_Account.csv",
    "mappingLocation": "Mapping1",
    "connection": "Financials Connection"
}

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