Jump to

• Request
• Response
• Examples

Validate viewpoint and write results to file

post

/epm/rest/v1/viewpoints/validate/writeToFile

Request

Supported Media Types

• application/json

Body ()

Specifies the parameters to use for validating viewpoint and writing to staging area

Root Schema : Parameters to run a Viewpoint Validating viewpoint and write to staging area

Type: object

Show Source

• fileName(required): string
  Name of the file containing the validation results. This file is written to the staging area.
• requestNumber: integer(int32)
  Request number to perform validation in the context of a request.
• viewName(required): string
  Name of the view for the viewpoint to be validated.
• viewpointName(required): string
  Name of the viewpoint to be validated.

{
    "type":"object",
    "required":[
        "fileName",
        "viewName",
        "viewpointName"
    ],
    "properties":{
        "viewName":{
            "type":"string",
            "description":"Name of the view for the viewpoint to be validated."
        },
        "viewpointName":{
            "type":"string",
            "description":"Name of the viewpoint to be validated."
        },
        "requestNumber":{
            "type":"integer",
            "format":"int32",
            "description":"Request number to perform validation in the context of a request."
        },
        "fileName":{
            "type":"string",
            "description":"Name of the file containing the validation results. This file is written to the staging area."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Created Job, load processing

400 Response

Error in body

404 Response

Not Found

Back to Top

Examples

The following example shows how to run Viewpoint Validate 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/viewpoints/validate/writeToFile

Example of Request Body

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

{
    "viewpointName": "Depts by Geography",
    "viewName": "Departments",
    "fileName": "Departments.xlsx",
    "requestNumber": "1002"
}

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