Jump to

• Request
• Response
• Examples

Extract a dimension viewpoint

post

/epm/rest/v1/dimensions/byName/extract

Request

Body ()

Specifies the parameters to use for running the extract

Root Schema : Parameters for extracting a dimension viewpoint

Type: object

Show Source

• applicationName(required): string
  The name of the application the dimension to extract belongs to.
• connection: string
  The name of the connection to extract to, if extracting to a connection instead of to a direct file download.
• dimensionName(required): string
  The name of the dimension to extract.
• extractName(required): string
  The name of the extract.
• fileName(required): string
  The target file name to extract the dimension to. 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",
        "extractName",
        "fileName"
    ],
    "properties":{
        "dimensionName":{
            "type":"string",
            "description":"The name of the dimension to extract."
        },
        "applicationName":{
            "type":"string",
            "description":"The name of the application the dimension to extract belongs to."
        },
        "connection":{
            "type":"string",
            "description":"The name of the connection to extract to, if extracting to a connection instead of to a direct file download."
        },
        "fileName":{
            "type":"string",
            "example":"dimension.csv",
            "description":"The target file name to extract the dimension to. 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."
        },
        "extractName":{
            "type":"string",
            "description":"The name of the extract."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Created job, extract processing

400 Response

Error in body

404 Response

Not found

Back to Top

Examples

The following example shows how to Extract a dimension viewpoint 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/extract

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",
    "extractName" : "extractName"
}

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