Jump to

• Request
• Response
• Examples

Import a dimension by name

post

/epm/rest/v1/dimensions/byName/import

Request

Supported Media Types

• application/json

Body ()

Specifies the parameters to use for running the import

Root Schema : ImportDimensionByNameCommandJson

Type: object

Show Source

• applicationName(required): string
  Name of Application for which Dimension to import.
• connection: string
  Name of connection where the import file is read from. If not supplied, the import file is read from the staging area.
• dimensionName(required): string
  Name of Dimension to import
• fileName(required): string
  Name of the file to import. File should be in the staging area or the specified connection.
• importOption: string
  Allowed Values: [ "ResetDimension", "ReplaceNodes", "Merge" ]

  Option for Reset/Replace/Merge on Import. Default value is Replace.

{
    "type":"object",
    "required":[
        "applicationName",
        "dimensionName",
        "fileName"
    ],
    "properties":{
        "fileName":{
            "type":"string",
            "description":"Name of the file to import. File should be in the staging area or the specified connection."
        },
        "importOption":{
            "type":"string",
            "description":"Option for Reset/Replace/Merge on Import. Default value is Replace.",
            "enum":[
                "ResetDimension",
                "ReplaceNodes",
                "Merge"
            ]
        },
        "dimensionName":{
            "type":"string",
            "description":"Name of Dimension to import"
        },
        "applicationName":{
            "type":"string",
            "description":"Name of Application for which Dimension to import."
        },
        "connection":{
            "type":"string",
            "description":"Name of connection where the import file is read from. If not supplied, the import file is read from the staging area."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Created job, import processing

400 Response

Error in body

404 Response

Not found

409 Response

Virus check failed. Please retry with a clean file.

Back to Top

Examples

The following example shows how to Import a dimension by name from a specified file 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/import

Example of Request Body

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

{
    "applicationName": "Corporate Planning",
    "dimensionName": "Account",
    "fileName": "Account.csv",
    "connection": "Production"
}

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

Back to Top