Jump to

• Request
• Response
• Examples

Run an extract package

post

/epm/rest/v1/applications/extractPackage

Request

Body ()

Specifies the parameters to use for running the extract package

Root Schema : ExtractPackageByNameCommandJson

Type: object

Show Source

• applicationName(required): string
  The name of the application the extract package belongs to.
• connectionName: string
  The name of the connection to extract to. If not provided, file will be extracted to the staging area.
• extractPackageName(required): string
  The name of the extract package.
• fileName(required): string
  The target file name to extract to. The file name must include the .zip extension

  Example: extractPackage.zip

{
    "type":"object",
    "required":[
        "applicationName",
        "extractPackageName",
        "fileName"
    ],
    "properties":{
        "applicationName":{
            "type":"string",
            "description":"The name of the application the extract package belongs to."
        },
        "extractPackageName":{
            "type":"string",
            "description":"The name of the extract package."
        },
        "fileName":{
            "type":"string",
            "example":"extractPackage.zip",
            "description":"The target file name to extract to. The file name must include the .zip extension"
        },
        "connectionName":{
            "type":"string",
            "description":"The name of the connection to extract to. If not provided, file will be extracted to the staging area."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted, extract package processing

400 Response

Error in body

403 Response

Insufficient Permission

Back to Top

Examples

The following example shows how to run an application extract package 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/applications/extractPackage

Example of Request Body

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

{
    "applicationName":"Account Reconciliation",
    "extractPackageName": "AccountExtractPackage",
    "fileName": "packageExtract.zip"
}

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": "78c4bcf6-da0f-40bd-9f71-54c029511528",
        "description": "Running extract package 'AccountExtractPackage' (4fa85884-5238-4a64-a578-3d2c4285fdb9).",
        "origin": "EXTRACT_PACKAGE",
        "status": "COMPLETED",
        "result": {
            "success": true,
            "links": [
                {
                    "rel": "results",
                    "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/files/staging/packageExtract.zip"
                },
                {
                    "rel": "delete",
                    "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/files/staging/packageExtract.zip"
                }
            ],
            "extractFileName": "packageExtract.zip",
            "startTime": "2023-11-08T20:27:19.977Z",
            "endTime": "2023-11-08T20:27:19.977Z",
            "connectionName": "",
            "runByUser": "dcosby",
            "rowsExtracted": 1414,
            "messages": "Extract Package ran successfully."
        },
        "created": "2023-11-08T20:27:19.946Z",
        "createdBy": "45b96c8a-7e8a-4e24-8279-9f2b88118e29",
        "lastModified": "2023-11-08T20:27:28.914Z",
        "lastModifiedBy": "45b96c8a-7e8a-4e24-8279-9f2b88118e29",
        "links": [
            {
                "rel": "self",
                "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/jobRuns/81ecd091-f969-4053-85ef-3718d1ad63b0/result"
            },
            {
                "rel": "jobRun",
                "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/jobRuns/81ecd091-f969-4053-85ef-3718d1ad63b0"
            }
        ]
    }

Back to Top