Jump to

• Request
• Response
• Examples

Export a dimension to a configured connection

post

/epm/rest/v1/dimensions/{dimensionId}/export/connection

Request

Path Parameters

• dimensionId: string(uuid)

Body ()

Root Schema : Parameters for exporting a dimension

Type: object

Show Source

• connectionId(optional): string(uuid)
  The id of the connection to export the dimension (for export to connection only).
• fileName: string
  The target file name to export the dimension to.

  Example: dimension.csv

{
    "type":"object",
    "required":[
        "fileName"
    ],
    "properties":{
        "fileName":{
            "type":"string",
            "example":"dimension.csv",
            "description":"The target file name to export the dimension to."
        },
        "connectionId":{
            "type":"string",
            "format":"uuid",
            "description":"The id of the connection to export the dimension (for export to connection only)."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted, export processing

400 Response

Error in body

404 Response

Dimension not found

415 Response

Unsupported file media type

500 Response

Invalid file stream

Back to Top

Examples

The following example shows how to export a dimension to a connection 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/cdc22d88-8b47-4521-8f16-5edcc31e3f77/export/connection

Example of Request Body

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

{
    "connectionId": "445e92f5-e232-4100-b709-a875c06cf294",
    "fileName": "dimension.zip"
}

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