Jump to

• Request
• Response
• Examples

Incremental export for a dimension

post

/epm/rest/v1/dimensions/byName/incrementalExport

Request

Body ()

Specifies the parameters to use for running the export

Root Schema : Parameters for incremental export of a dimension

Type: object

Show Source

• applicationName: string
  The name of the application the dimension to export belongs to.
• bindingNames: array bindingNames
  A list of names of bindings in this dimension to export from.
• connectionName(optional): string
  The name of the connection to export to, if exporting to a connection instead of to a direct file download.
• dimensionName: string
  The name of the dimension to export.
• fileName(optional): string
  The name to use for the exported file. A Universal application will produce a file in CSV format, while other application types produce a file in zip format.
• nodeChangeTypes: array nodeChangeTypes
  Unique Items Required: true

  A list of types of node changes to export.
• since(optional): integer(int64)
  The timestamp starting from which to export changes within the selected dimension bindings. Required if SinceLastExportOfType is not provided.
• sinceLastExportOfType(optional): string
  Allowed Values: [ "FULL", "INCREMENTAL" ]

  The type of export to find the most recent occurrence of, and export changes starting from that time. Required if Since is not provided.

{
    "type":"object",
    "required":[
        "applicationName",
        "bindingNames",
        "dimensionName",
        "nodeChangeTypes"
    ],
    "properties":{
        "applicationName":{
            "type":"string",
            "description":"The name of the application the dimension to export belongs to."
        },
        "dimensionName":{
            "type":"string",
            "description":"The name of the dimension to export."
        },
        "connectionName":{
            "type":"string",
            "description":"The name of the connection to export to, if exporting to a connection instead of to a direct file download."
        },
        "since":{
            "type":"integer",
            "format":"int64",
            "description":"The timestamp starting from which to export changes within the selected dimension bindings. Required if SinceLastExportOfType is not provided."
        },
        "sinceLastExportOfType":{
            "type":"string",
            "description":"The type of export to find the most recent occurrence of, and export changes starting from that time. Required if Since is not provided.",
            "enum":[
                "FULL",
                "INCREMENTAL"
            ]
        },
        "bindingNames":{
            "type":"array",
            "description":"A list of names of bindings in this dimension to export from.",
            "items":{
                "type":"string"
            }
        },
        "nodeChangeTypes":{
            "type":"array",
            "description":"A list of types of node changes to export.",
            "uniqueItems":true,
            "items":{
                "type":"string",
                "enum":[
                    "NEW",
                    "UPDATED"
                ]
            }
        },
        "fileName":{
            "type":"string",
            "description":"The name to use for the exported file. A Universal application will produce a file in CSV format, while other application types produce a file in zip format."
        }
    }
}

Nested Schema : bindingNames

Type: array

A list of names of bindings in this dimension to export from.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of names of bindings in this dimension to export from.",
    "items":{
        "type":"string"
    }
}

Nested Schema : nodeChangeTypes

Type: array

Unique Items Required: true

A list of types of node changes to export.

Show Source

• Array of: string
  Allowed Values: [ "NEW", "UPDATED" ]

{
    "type":"array",
    "description":"A list of types of node changes to export.",
    "uniqueItems":true,
    "items":{
        "type":"string",
        "enum":[
            "NEW",
            "UPDATED"
        ]
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Created job, export processing

400 Response

Error in body

404 Response

Not found

Back to Top

Examples

The following example shows how to Incremental export a dimension 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/incrementalExport

Example of Request Body

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

{
    "applicationName": "Financials Cloud",
    "dimensionName": "Corporate Account",
    "bindingNames": ["Corporate Account"],
    "sinceLastExportOfType": "FULL",
    "fileName": "Corporate_Account.zip",
    "nodeChangeTypes": ["NEW", "UPDATED"]
}

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