Jump to

• Request
• Response
• Examples

Import a dimension via a connection

post

/epm/rest/v1/dimensions/{dimensionId}/import/connection

Request

Path Parameters

• dimensionId(required): string(uuid)

Body ()

Root Schema : ImportDimensionFromConnectionCommandJson

Type: object

Show Source

• connectionId(required): string(uuid)
  the id of the configured connection to import from
• fileName(required): string
  the name of the file to import from at the given connection
• importOption: string
  Allowed Values: [ "ResetDimension", "ReplaceNodes", "Merge" ]

  Option for Reset/Replace/Merge on Import. Default value is Replace.
• resetDimension: boolean
  Set to true to reset the dimension prior to import. If importOption is provided, then resetDimension is ignored. Default value is false.

{
    "type":"object",
    "required":[
        "connectionId",
        "fileName"
    ],
    "properties":{
        "fileName":{
            "type":"string",
            "description":"the name of the file to import from at the given connection"
        },
        "connectionId":{
            "type":"string",
            "format":"uuid",
            "description":"the id of the configured connection to import from"
        },
        "importOption":{
            "type":"string",
            "description":"Option for Reset/Replace/Merge on Import. Default value is Replace.",
            "enum":[
                "ResetDimension",
                "ReplaceNodes",
                "Merge"
            ]
        },
        "resetDimension":{
            "type":"boolean",
            "description":"Set to true to reset the dimension prior to import. If importOption is provided, then resetDimension is ignored. Default value is false."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted, import processing

400 Response

Error in body

404 Response

Dimension not found

415 Response

Unsupported file media type

Back to Top

Examples

The following example shows how to import a dimension from a connection 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/9ae152c1-9d03-46b8-9206-744680c84c43/import/connection

Example of Request Body

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

{
    "fileName": "sampleImportFile.zip",
    "connectionId": "445e92f5-e232-4100-b709-a875c06cf294",
    "resetDimension": true,
    "importOption": "ResetDimension"
}

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/a5069c59-a9f7-4f72-8c21-9e9e72fbcdfe"
    }
  ]
}

Back to Top