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(required): string
  Name of Application for which Dimension 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 to. File will be exported to the staging area or the specified connection.

  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."
        },
        "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."
        }
    }
}

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

Example of Job Run Result Body

The following shows an example of the response body for the Job Run Results in JSON format.

{
    "id": "0105ee75-3f15-4efd-b725-a1769001fbfa",
    "description": "Exporting dimension Account (cdefe5d3-0f9b-4b11-8c2d-91af7f1b3ec5) to connection Production (d35589c5-e69d-48e9-9354-0485d69c06a5)",
    "origin": "EXPORT_DIMENSION",
    "status": "COMPLETED",
    "result": {
        "success": false,
        "dimensionName": "Account",
        "failedViewpoints": [],
        "links": [],
        "startTime": "2023-05-04T07:59:35.317Z",
        "endTime": "2023-05-04T07:59:38.429Z",
        "connectionName": "Production",
        "recordCount": 0,
        "runByUser": "epm_default_cloud_admin",
        "tasks": [
            {
                "syncId": "4cae87ac-735f-4c00-acd0-b23e01a80d44",
                "taskName": "Transfer file to Financials Cloud",
                "taskKey": "export.fincloud.export.transfer.file.task.name",
                "status": "ERROR",
                "startTime": "2023-05-04T07:59:38.029Z",
                "endTime": "2023-05-04T07:59:38.433Z",
                "duration": "00:00:00.404",
                "messages": [
                    "Transfer file to Financials Cloud failed because of the following reason: Unknown host 'https://fuscdrmsmc76-fa-ext.us.oracle.com/'.  Check and modify the connection details and ensure the connected system is online"
                ]
            }
        ],
        "messages": "Exported 418 records for viewpoint 'Account Vision Chile'.\nExported 418 records for viewpoint 'Account Vision Chile | Account Vision Chile Base'.\nExported 418 records for viewpoint 'Account Vision Chile | Account Vision Chile Current'.\n"
    },
    "created": "2023-05-04T07:59:35.331Z",
    "createdBy": "8bc5dbf7-fcd4-462e-a1c7-e72d0b92fbfb",
    "lastModified": "2023-05-04T07:59:38.497Z",
    "lastModifiedBy": "8bc5dbf7-fcd4-462e-a1c7-e72d0b92fbfb",
    "links": [
        {
            "rel": "self",
            "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/jobRuns/81ecd091-f969-4053-85ef-3718d1ad63b0/result"
        },
        {
            "rel": "jobRun",
            "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/jobRuns/81ecd091-f969-4053-85ef-3718d1ad63b0"
        }
    ]
}

Back to Top