Jump to

• Request
• Response
• Examples

Compare viewpoints and write results to file

post

/epm/rest/v1/views/compare/writeToFile

Request

Supported Media Types

• application/json

Body ()

Root Schema : Parameters to run a Compare Profile and export results to a file.

Type: object

Show Source

• compareProfileName(required): string
  Name of the compare profile to be run
• fileName(required): string
  Name of the file containing the compare results. This file is written to the staging area.
• requestNumber: integer(int32)
  Optional Request Number used to run the Compare Profile in the context of a request.
• viewName(required): string
  Name of the view for the compare profile

{
    "type":"object",
    "required":[
        "compareProfileName",
        "fileName",
        "viewName"
    ],
    "properties":{
        "viewName":{
            "type":"string",
            "description":"Name of the view for the compare profile"
        },
        "compareProfileName":{
            "type":"string",
            "description":"Name of the compare profile to be run"
        },
        "fileName":{
            "type":"string",
            "description":"Name of the file containing the compare results. This file is written to the staging area."
        },
        "requestNumber":{
            "type":"integer",
            "format":"int32",
            "description":"Optional Request Number used to run the Compare Profile in the context of a request."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Accepted, compare processing

400 Response

Error in body

403 Response

Insufficient Permission

404 Response

Object not found

Back to Top

Examples

The following example shows how to run a Compare Profile and export the results 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/views/compare/writeToFile

Example of Request Body

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

{
    "viewName": "Account Maintenance",
    "compareProfileName": "Compare Profile",
    "fileName": "CompareDifferences.xlsx"
}

Example of Response Body

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

{
  "links": [
    {
      "rel": "results",
      "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/jobRuns/acdaea6f-1ba6-4efd-bb35-4b51c3e11708"
    }
  ]
}

Back to Top