Jump to

• Request
• Response
• Examples

Load a viewpoint from a file

post

/epm/rest/v1/viewpoints/byName/load/file

Request

Supported Media Types

• application/json

Body ()

Specifies the parameters to use for running the load

Root Schema : LoadViewpointFromFileJson

Type: object

Show Source

• fileName: string
  Name of the file to load. File must be in the staging area.
• loadOption(optional): string
  Allowed Values: [ "ReplaceNodes", "Merge" ]

  Load option, defaults to ReplaceNodes.
• purpose: string
  The purpose or reason for running the load.
• viewName: string
  Name of the view for which viewpoint to load.
• viewpointName: string
  Name of the viewpoint to load.

{
    "type":"object",
    "required":[
        "fileName",
        "purpose",
        "viewName",
        "viewpointName"
    ],
    "properties":{
        "viewName":{
            "type":"string",
            "description":"Name of the view for which viewpoint to load."
        },
        "viewpointName":{
            "type":"string",
            "description":"Name of the viewpoint to load."
        },
        "fileName":{
            "type":"string",
            "description":"Name of the file to load. File must be in the staging area."
        },
        "purpose":{
            "type":"string",
            "description":"The purpose or reason for running the load."
        },
        "loadOption":{
            "type":"string",
            "description":"Load option, defaults to ReplaceNodes.",
            "enum":[
                "ReplaceNodes",
                "Merge"
            ]
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Created Job, load processing

400 Response

Error in body

404 Response

Not Found

415 Response

Unsupported file media type

Back to Top

Examples

The following example shows how to load data into a viewpoint submitting a post request on the REST resource using cURL. File must be in staging area.

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/byName/load/file

Example of Request Body

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

{
    "viewName": "Account Reconciliation",
    "viewpointName": "Corporate Accounts",
    "fileName": "Corporate+Accounts.csv",
    "purpose": "Replacing"
}

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/ce2ab6ac-969a-4462-8db9-a11460a51f1f"
        }
    ]
}

Back to Top