Jump to

• Request
• Response
• Examples

Export transaction history to a file

post

/epm/rest/v1/transactionHistory/byName/export

Request

Body ()

Specifies the parameters to use for running the export. NOTE: Either fromDate or lastDays should be passed.

Root Schema : Parameters for exporting transaction history records

Type: object

Show Source

• actions: string
  List of action names separated by comma for which transaction history is to be exported.
• applicationName: string
  Application name for which transaction history is to be exported.
• dimensionName: string
  Dimension name for which transaction history is to be exported.
• downloadOption: string
  Allowed Values: [ "TRANSACTION_HIST_ONLY", "TRANSACTION_HIST_AND_WORKFLOW" ]

  Specifies the content to be included in the exported file. Default value is TRANSACTION_HIST_ONLY.
• fileName: string
  The target file name with .xlsx extension to export the transaction history to.

  Example: transaction_history.xlsx
• fromDate: string
  Epoch date in seconds after which transaction history is to be exported. Either fromDate or lastDays should be passed. The period cannot exceed 90 days.
• hierarchySetName: string
  Hierarchy set name for which transaction history is to be exported.
• includeRelatedRequests: string
  Allowed Values: [ "true", "false" ]

  Specifies whether requests in the same lineage as that of the request number should be included in the export. Should be used only when request number is provided. Default value is false.
• lastDays: string
  Number of days for which transaction history is to be exported. Maximum value of 90. Either fromDate or lastDays should be passed.
• nodeName: string
  Node name for which transaction history is to be exported.
• nodeTypeName: string
  Node type name for which transaction history is to be exported.
• requestNumber: string
  Request Number for which transaction history is to be exported.
• toDate: string
  Epoch date in seconds before which transaction history is to be exported. toDate has to be after the fromDate. The period cannot exceed 90 days.
• users: string
  List of usernames separated by comma for which transaction history is to be exported.
• viewName: string
  View name for which transaction history is to be exported.
• viewpointName: string
  Viewpoint name for which transaction history is to be exported.

{
    "type":"object",
    "properties":{
        "applicationName":{
            "type":"string",
            "description":"Application name for which transaction history is to be exported."
        },
        "dimensionName":{
            "type":"string",
            "description":"Dimension name for which transaction history is to be exported."
        },
        "nodeTypeName":{
            "type":"string",
            "description":"Node type name for which transaction history is to be exported."
        },
        "hierarchySetName":{
            "type":"string",
            "description":"Hierarchy set name for which transaction history is to be exported."
        },
        "viewName":{
            "type":"string",
            "description":"View name for which transaction history is to be exported."
        },
        "viewpointName":{
            "type":"string",
            "description":"Viewpoint name for which transaction history is to be exported."
        },
        "users":{
            "type":"string",
            "description":"List of usernames separated by comma for which transaction history is to be exported."
        },
        "nodeName":{
            "type":"string",
            "description":"Node name for which transaction history is to be exported."
        },
        "actions":{
            "type":"string",
            "description":"List of action names separated by comma for which transaction history is to be exported."
        },
        "requestNumber":{
            "type":"string",
            "description":"Request Number for which transaction history is to be exported."
        },
        "fromDate":{
            "type":"string",
            "description":"Epoch date in seconds after which transaction history is to be exported. Either fromDate or lastDays should be passed. The period cannot exceed 90 days."
        },
        "toDate":{
            "type":"string",
            "description":"Epoch date in seconds before which transaction history is to be exported. toDate has to be after the fromDate. The period cannot exceed 90 days."
        },
        "lastDays":{
            "type":"string",
            "description":"Number of days for which transaction history is to be exported. Maximum value of 90. Either fromDate or lastDays should be passed."
        },
        "fileName":{
            "type":"string",
            "example":"transaction_history.xlsx",
            "description":"The target file name with .xlsx extension to export the transaction history to."
        },
        "downloadOption":{
            "type":"string",
            "description":"Specifies the content to be included in the exported file. Default value is TRANSACTION_HIST_ONLY.",
            "enum":[
                "TRANSACTION_HIST_ONLY",
                "TRANSACTION_HIST_AND_WORKFLOW"
            ]
        },
        "includeRelatedRequests":{
            "type":"string",
            "description":"Specifies whether requests in the same lineage as that of the request number should be included in the export. Should be used only when request number is provided. Default value is false.",
            "enum":[
                "true",
                "false"
            ]
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted, download processing

400 Response

Error in body

404 Response

Not found

Back to Top

Examples

The following example shows how to Export Transaction History to a 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/transactionHistory/byName/export

Example of Request Body

The following shows an example of the request body in JSON format. To include workflow history, include the downloadOption parameter like the example below.

{
    "fromDate": "1609518964",
    "toDate" : "1612810620",
    "applicationName": "Financials Cloud",
    "dimensionName": "Corporate Account",
    "fileName": "Transactions.xlsx",
    "downloadOption": "TRANSACTION_HIST_AND_WORKFLOW"
}

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