Jump to

• Request
• Response
• Examples

Load a dimension viewpoint

post

/epm/rest/v1/dimensions/byName/load

Request

Body ()

Specifies the parameters to use for loading the viewpoint

Root Schema : LoadDimensionViewpointJson

Type: object

Show Source

• applicationName(required): string
  Name of the application.
• dimensionName(required): string
  Name of the dimension.
• fileName(required): string
  Name of the file to load. File must be in the staging area.
• loadName(required): string
  Name of the defined load profile for the dimension.
• loadOption: string
  Allowed Values: [ "ReplaceNodes", "Merge" ]

  Load option, defaults to ReplaceNodes.
• purpose: string
  Purpose for loading the viewpoint.

{
    "type":"object",
    "required":[
        "applicationName",
        "dimensionName",
        "fileName",
        "loadName"
    ],
    "properties":{
        "applicationName":{
            "type":"string",
            "description":"Name of the application."
        },
        "dimensionName":{
            "type":"string",
            "description":"Name of the dimension."
        },
        "loadName":{
            "type":"string",
            "description":"Name of the defined load profile for the dimension."
        },
        "fileName":{
            "type":"string",
            "description":"Name of the file to load. File must be in the staging area."
        },
        "loadOption":{
            "type":"string",
            "description":"Load option, defaults to ReplaceNodes.",
            "enum":[
                "ReplaceNodes",
                "Merge"
            ]
        },
        "purpose":{
            "type":"string",
            "description":"Purpose for loading the viewpoint."
        }
    }
}

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 load a dimension by name with a file that is uploaded 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/load

Example of Request Body

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

{
    "applicationName": "Departments",
    "dimensionName": "Departments",
    "loadName": "DeptByGeoLoad",
    "loadOption": "Merge",
    "purpose": "DeptByGeoLoad",
    "fileName": "Depts+by+Geography.xlsx"
}

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"
    }
  ]
}

Example of Job Run Result Body

The following shows an example of the response body for the Job Run Results in JSON format.

    {
        "id": "18b3a48c-fc7a-4062-b3da-8a64911659c2",
        "description": "Loading file with option Merge load mode into viewpoint 'Depts by Geography' (26b268ce-672f-4982-b1a9-4adf92597232) in application 'Departments' (64a99b9c-a13e-4509-9513-2d086da4ff00)",
        "origin": "LOAD_VIEWPOINT",
        "status": "COMPLETED",
        "result": {
            "success": true,
            "sourceFileName": "Depts+by+Geography.xlsx",
            "startTime": "2024-09-17T16:35:03.754Z",
            "endTime": "2024-09-17T16:35:08.685Z",
            "recordCount": 491,
            "runByUser": "dcosby",
            "requestNumber": 1001,
            "links": [
                {
                    "rel": "request",
                    "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/18b3a48c-fc7a-4062-b3da-8a64911659c2"
                },
                {
                    "rel": "validationResults",
                    "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/18b3a48c-fc7a-4062-b3da-8a64911659c2/items?expand=item.validations"
                }
            ],
            "messages": "491 records loaded.\nMerge load processed 491 records and generated request 'Load Request 1001' with 2 request items.\n"
        },
        "created": "2024-09-17T16:35:03.747Z",
        "createdBy": "45b96c8a-7e8a-4e24-8279-9f2b88118e29",
        "lastModified": "2024-09-17T16:35:09.956Z",
        "lastModifiedBy": "45b96c8a-7e8a-4e24-8279-9f2b88118e29",
        "links": [
            {
                "rel": "self",
                "href": "http://servername.fa.us2.oraclecloud.com/rest/v1/jobRuns/18b3a48c-fc7a-4062-b3da-8a64911659c2/result"
            },
            {
                "rel": "jobRun",
                "href": "http://servername.fa.us2.oraclecloud.com/rest/v1/jobRuns/18b3a48c-fc7a-4062-b3da-8a64911659c2"
            }
        ]
    }

Back to Top