Check Job Status Using Oracle WebCenter Content

When the extract job is scheduled using the extractSchedules API, the job status can be tracked through the ESS job framework.

Fetch the ESS job request ID using the Location header URL returned at creation of the schedule to query the job status.

Fetch ESS Job Request ID

Endpoint

Attribute Value
URL /api/boss/data/objects/ora/scmCore/dataExtract/v1/$en/extractSchedules/{{dataExtractScheduleId}}
HTTP Method GET

Response

Example Response

{
    "id": "300100641281811",
    "name": "ExtractMostLabels-Incremental",
    "scheduleId": "14701",
    "$id": "300100641281811",
    "$context": {
        "links": {
            "$self": {
                "href": "https://example.com:443/api/boss/data/objects/ora/scmCore/dataExtract/v1/$en/extractSchedules/300100641281811"
            }
        }
    }
}

scheduleId is the jobRequestID used to fetch the job status.

Fetch Job Status

To track the job status through the ESS Scheduler API, use the jobRequestId.

Endpoint

Attribute Value
URL
/ess/rest/scheduler/v1/requests/{{jobRequestId}}
HTTP Method GET

Response

Example Responses

Wait

{
    "requestId": 94553,
    "state": "WAIT",
    "stateDescription": "Wait"
}

Succeeded

{
    "requestId": 94553,
    "state": "SUCCEEDED",
    "stateDescription": "Succeeded"
}

Error

{
    "requestId": 94553,
    "state": "ERROR",
    "stateDescription": "Error"
}

Job Status and Request Values

A job request is considered successfully completed when:
  • state: SUCCEEDED
  • stateDescription: Succeeded

A job request is considered failed when:

  • state: ERROR