Jump to

• Request
• Response
• Examples

Get the job run with the given id

get

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

Request

Path Parameters

• jobRunId(required): string(uuid)

Back to Top

Response

Supported Media Types

• application/json

200 Response

Job returned. Loop until the job completes to retrieve the job results.

Body ()

Root Schema : JobRun

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
• error: string
  Read Only: true
• id: string(uuid)
  Read Only: true
• jobProgress: integer(int32)
• jobSize: integer(int32)
• 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", "VALIDATE_VIEWPOINT_WRITE_TO_FILE", "COPY_DIMENSION_BINDING", "CREATE_CONSOLIDATION_REQUEST", "DOWNLOAD_LICENSE_COUNT_REPORT", "DOWNLOAD_PERMISSIONS", "DOWNLOAD_POLICIES", "DOWNLOAD_PROPERTY_AUDIT", "DOWNLOAD_REQUESTS_SUMMARY", "DOWNLOAD_WF_CLOSED_REQUESTS", "DOWNLOAD_RM_OPEN_REQUESTS", "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", "RECORD_ANALYTICS", "REQUEST_EVAL_FULFILLMENT_STATES", "REQUEST_EVAL_FOR_INTERVAL", "PURGE_REQUEST_ACTIONS", "MATCH_REQUEST_ITEMS", "APPLY_MATCH_RESULTS", "DEDUPLICATE_NODES", "APPLY_DEDUPLICATE_RESULTS" ]
• 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",
                "VALIDATE_VIEWPOINT_WRITE_TO_FILE",
                "COPY_DIMENSION_BINDING",
                "CREATE_CONSOLIDATION_REQUEST",
                "DOWNLOAD_LICENSE_COUNT_REPORT",
                "DOWNLOAD_PERMISSIONS",
                "DOWNLOAD_POLICIES",
                "DOWNLOAD_PROPERTY_AUDIT",
                "DOWNLOAD_REQUESTS_SUMMARY",
                "DOWNLOAD_WF_CLOSED_REQUESTS",
                "DOWNLOAD_RM_OPEN_REQUESTS",
                "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",
                "RECORD_ANALYTICS",
                "REQUEST_EVAL_FULFILLMENT_STATES",
                "REQUEST_EVAL_FOR_INTERVAL",
                "PURGE_REQUEST_ACTIONS",
                "MATCH_REQUEST_ITEMS",
                "APPLY_MATCH_RESULTS",
                "DEDUPLICATE_NODES",
                "APPLY_DEDUPLICATE_RESULTS"
            ]
        },
        "status":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "PENDING",
                "RUNNING",
                "ERROR",
                "COMPLETED"
            ]
        },
        "error":{
            "type":"string",
            "readOnly":true
        },
        "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"
            }
        },
        "jobSize":{
            "type":"integer",
            "format":"int32"
        },
        "jobProgress":{
            "type":"integer",
            "format":"int32"
        }
    },
    "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 : 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 not found

Back to Top

Examples

The following example shows how to retrieve 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/5a8ca1a9-ab3d-49fd-8f94-a66a895c9609

Example of Response Body

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

{
  "id": "5a8ca1a9-ab3d-49fd-8f94-a66a895c9609",
  "description": "Exporting dimension Account (9ae152c1-9d03-46b8-9206-744680c84c43) to csv.",
  "origin": "EXPORT_DIMENSION",
  "status": "COMPLETED",
  "created": "2018-03-30T21:41:18.222Z",
  "createdBy": "dd3dd761-1a0e-4aea-9256-b2252145d9a6",
  "lastModified": "2018-03-30T21:41:18.728Z",
  "lastModifiedBy": "dd3dd761-1a0e-4aea-9256-b2252145d9a6",
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/jobRuns/5a8ca1a9-ab3d-49fd-8f94-a66a895c9609"
    },
    {
      "rel": "results",
      "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/files/temp/5a8ca1a9-ab3d-49fd-8f94-a66a895c9609?fileName=dimension.csv"
    }
  ]
}

Back to Top