REST API for Oracle Enterprise Data Management Cloud Service

Get the result body of the job run with the given id

get

/epm/rest/v1/jobRuns/{jobRunId}/result

Request

Path Parameters

jobRunId(required): string(uuid)

Response

Supported Media Types

application/json

200 Response

Job result returned

Root Schema : JobRunResult

Type: object

Information about the execution of a particular job

Show Source

created: integer(int64)

Read Only: true
createdBy: string(uuid)

Read Only: true
description: string

Read Only: true
id: string(uuid)

Read Only: true
lastModified: integer(int64)

Read Only: true
lastModifiedBy: string(uuid)

Read Only: true
links: array links

Read Only: true
origin: string

Read Only: true

Allowed Values: [ "TRANSITION_REQUEST", "COMPARE_VIEWPOINTS", "COPY_VIEWPOINT", "DOWNLOAD_VIEWPOINT", "DOWNLOAD_VP_VALIDATION_RESULT", "EXPORT_DIMENSION", "EXPORT_MAPPING", "EXTRACT_PACKAGE", "EXTRACT_VIEWPOINT", "IMPORT_DIMENSION", "IMPORT_SAMPLE_APPLICATION", "LOAD_VIEWPOINT", "PUBLIC_COMPARE_VIEWPOINT", "REINDEX_APPLICATION", "VALIDATE_VIEWPOINT", "COPY_DIMENSION_BINDING", "CREATE_CONSOLIDATION_REQUEST", "DOWNLOAD_LICENSE_COUNT_REPORT", "DOWNLOAD_PERMISSIONS", "DOWNLOAD_POLICIES", "DOWNLOAD_PROPERTY_AUDIT", "DOWNLOAD_REQUESTS_SUMMARY", "DOWNLOAD_SYSTEM_EVENTS", "DOWNLOAD_VIEWPOINT_PROPERTIES", "DOWNLOAD_VP_QUERY_RESULT", "EXPORT_NODE_TYPE_PERMISSIONS", "EXPORT_PERMISSIONS_REPORT", "EXPORT_POLICIES_REPORT", "EXPORT_PROPERTY", "EXPORT_SUBSCRIPTIONS_REPORT", "EXPORT_TEMPLATE", "EXPORT_TRANSACTION_HISTORY", "EXPORT_VALIDATIONS_REPORT", "IMPORT_TEMPLATE", "PREVIEW_TEMPLATE", "SEARCH_NODES", "COPY_NODES", "EDIT_REQUEST_FROM_COMPARE", "EXPORT_REQUEST", "GENERATE_ATTACHMENT", "IMPORT_REQUEST", "REPAIR_REQ_VALIDATION_ERRORS", "VALIDATE_REQUEST", "SUBSCRIPTION_GENERATE_REQUEST", "RECORD_TRANSACTION_HISTORY", "REQUEST_EVAL_FULFILLMENT_STATES", "REQUEST_EVAL_FOR_INTERVAL", "PURGE_REQUEST_ACTIONS" ]
result: object JsonNode
status: string

Read Only: true

Allowed Values: [ "PENDING", "RUNNING", "ERROR", "COMPLETED" ]

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "readOnly":true
        },
        "origin":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "TRANSITION_REQUEST",
                "COMPARE_VIEWPOINTS",
                "COPY_VIEWPOINT",
                "DOWNLOAD_VIEWPOINT",
                "DOWNLOAD_VP_VALIDATION_RESULT",
                "EXPORT_DIMENSION",
                "EXPORT_MAPPING",
                "EXTRACT_PACKAGE",
                "EXTRACT_VIEWPOINT",
                "IMPORT_DIMENSION",
                "IMPORT_SAMPLE_APPLICATION",
                "LOAD_VIEWPOINT",
                "PUBLIC_COMPARE_VIEWPOINT",
                "REINDEX_APPLICATION",
                "VALIDATE_VIEWPOINT",
                "COPY_DIMENSION_BINDING",
                "CREATE_CONSOLIDATION_REQUEST",
                "DOWNLOAD_LICENSE_COUNT_REPORT",
                "DOWNLOAD_PERMISSIONS",
                "DOWNLOAD_POLICIES",
                "DOWNLOAD_PROPERTY_AUDIT",
                "DOWNLOAD_REQUESTS_SUMMARY",
                "DOWNLOAD_SYSTEM_EVENTS",
                "DOWNLOAD_VIEWPOINT_PROPERTIES",
                "DOWNLOAD_VP_QUERY_RESULT",
                "EXPORT_NODE_TYPE_PERMISSIONS",
                "EXPORT_PERMISSIONS_REPORT",
                "EXPORT_POLICIES_REPORT",
                "EXPORT_PROPERTY",
                "EXPORT_SUBSCRIPTIONS_REPORT",
                "EXPORT_TEMPLATE",
                "EXPORT_TRANSACTION_HISTORY",
                "EXPORT_VALIDATIONS_REPORT",
                "IMPORT_TEMPLATE",
                "PREVIEW_TEMPLATE",
                "SEARCH_NODES",
                "COPY_NODES",
                "EDIT_REQUEST_FROM_COMPARE",
                "EXPORT_REQUEST",
                "GENERATE_ATTACHMENT",
                "IMPORT_REQUEST",
                "REPAIR_REQ_VALIDATION_ERRORS",
                "VALIDATE_REQUEST",
                "SUBSCRIPTION_GENERATE_REQUEST",
                "RECORD_TRANSACTION_HISTORY",
                "REQUEST_EVAL_FULFILLMENT_STATES",
                "REQUEST_EVAL_FOR_INTERVAL",
                "PURGE_REQUEST_ACTIONS"
            ]
        },
        "status":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "PENDING",
                "RUNNING",
                "ERROR",
                "COMPLETED"
            ]
        },
        "result":{
            "readOnly":true,
            "$ref":"#/definitions/JsonNode"
        },
        "created":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "createdBy":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "lastModified":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "lastModifiedBy":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Information about the execution of a particular job"
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : JsonNode

Type: object

Nested Schema : Link

Type: object

Show Source

href: string
method: string
rel: string
templated: boolean

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "templated":{
            "type":"boolean"
        },
        "method":{
            "type":"string"
        }
    }
}

404 Response

Job result not found

Examples

The following example shows how to retrieve the results of a job run by submitting a get request on the REST resource using cURL.

cURL Command

curl --user epm_cloud_user -X GET \
  https://servername.fa.us2.oraclecloud.com/epm/rest/v1/jobRuns/c9f63edd-d2c8-4712-a1a0-43fc3a410f97/result

Example of Response Body

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

{
    "id": "c9f63edd-d2c8-4712-a1a0-43fc3a410f97",
    "description": "Importing file 'RequestFileTest.xlsx' into request Automated Request (e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4) in view Corporate Planning (EPBCS)",
    "origin": "IMPORT_REQUEST",
    "status": "COMPLETED",
    "result": {
        "fileName": "RequestFileTest.xlsx",
        "sheets": [
            {
                "viewpointName": "Account",
                "viewpointDescription": "Account dimension for EPBCS",
                "sheetName": "Account",
                "invalidForLoad": false,
                "rowCount": 5,
                "columnCount": 5,
                "columns": [
                    {
                        "label": "Name",
                        "status": "OK",
                        "validationMessage": ""
                    },
                    {
                        "label": "Parent",
                        "status": "OK",
                        "validationMessage": ""
                    },
                    {
                        "label": "Description",
                        "status": "OK",
                        "validationMessage": ""
                    },
                    {
                        "label": "Node Type",
                        "status": "OK",
                        "validationMessage": ""
                    },
                    {
                        "label": "Parent Node Type",
                        "status": "OK"
                    }
                ],
                "rows": [
                    [
                        {
                            "value": "Acct1",
                            "status": "OK",
                            "validationMessage": ""
                        },
                        {
                            "value": "A_All_Corp_Acct_V1",
                            "status": "OK",
                            "validationMessage": ""
                        },
                        {
                            "value": "",
                            "status": "OK",
                            "validationMessage": ""
                        },
                        {
                            "value": "Account",
                            "status": "OK",
                            "validationMessage": ""
                        },
                        {
                            "value": "Account",
                            "status": "OK"
                        }
                    ],
                    [
                        {
                            "value": "Acct2",
                            "status": "OK",
                            "validationMessage": ""
                        },
                        {
                            "value": "A_All_Corp_Acct_V1",
                            "status": "OK",
                            "validationMessage": ""
                        },
                        {
                            "value": "Acct2 Desc",
                            "status": "OK",
                            "validationMessage": ""
                        },
                        {
                            "value": "Account",
                            "status": "OK",
                            "validationMessage": ""
                        },
                        {
                            "value": "Account",
                            "status": "OK"
                        }
                    ],
                    [
                        {
                            "value": "Acct3",
                            "status": "OK",
                            "validationMessage": ""
                        },
                        {
                            "value": "A_All_Corp_Acct_V1",
                            "status": "OK",
                            "validationMessage": ""
                        },
                        {
                            "value": "Acct3 Desc",
                            "status": "OK",
                            "validationMessage": ""
                        },
                        {
                            "value": "Account",
                            "status": "OK",
                            "validationMessage": ""
                        },
                        {
                            "value": "Account",
                            "status": "OK"
                        }
                    ],
                    [
                        {
                            "value": "Acct4",
                            "status": "OK",
                            "validationMessage": ""
                        },
                        {
                            "value": "A_All_Corp_Acct_V1",
                            "status": "OK",
                            "validationMessage": ""
                        },
                        {
                            "value": "Acct4 Desc",
                            "status": "OK",
                            "validationMessage": ""
                        },
                        {
                            "value": "Account",
                            "status": "OK",
                            "validationMessage": ""
                        },
                        {
                            "value": "Account",
                            "status": "OK"
                        }
                    ],
                    [
                        {
                            "value": "Acct5",
                            "status": "OK",
                            "validationMessage": ""
                        },
                        {
                            "value": "A_All_Corp_Acct_V1",
                            "status": "OK",
                            "validationMessage": ""
                        },
                        {
                            "value": "Acct5 Desc",
                            "status": "OK",
                            "validationMessage": ""
                        },
                        {
                            "value": "Account",
                            "status": "OK",
                            "validationMessage": ""
                        },
                        {
                            "value": "Account",
                            "status": "OK"
                        }
                    ]
                ]
            }
        ],
        "links": [
            {
                "rel": "request",
                "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4"
            },
            {
                "rel": "validate",
                "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/validations"
            },
            {
                "rel": "attachment",
                "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/attachments/b70919e7-5c07-466f-9989-6063fc59bf3e"
            }
        ]
    },
    "created": "2018-04-02T20:08:30.786Z",
    "createdBy": "dd3dd761-1a0e-4aea-9256-b2252145d9a6",
    "lastModified": "2018-04-02T20:08:31.407Z",
    "lastModifiedBy": "dd3dd761-1a0e-4aea-9256-b2252145d9a6",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/jobRuns/c9f63edd-d2c8-4712-a1a0-43fc3a410f97/result"
        },
        {
            "rel": "jobRun",
            "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/jobRuns/c9f63edd-d2c8-4712-a1a0-43fc3a410f97"
        }
    ]
}