View Job Status
get
/primeapi/restapi/action/jobStatus/{jobId}
Send a request to this endpoint to view the current status of a job with an ID value matching the value of the {jobId} path parameter. A job represents a background process within the application. Prime includes several background services, such as scheduler, leveler, risk analysis, and measures, that may initiate jobs. Completed scheduling, leveling, and measures jobs generate a job log that includes additional details about the service.
Request
Path Parameters
-
jobId: integer(int64)
The unique identifier of a scheduled job.
Response
Supported Media Types
- application/json
200 Response
successful operation
Root Schema : ApiEntityJobDetail
Type:
Show Source
object
-
jobId(optional):
integer(int64)
The unique identifier for the background service.
-
jobLog(optional):
string
Log of the job.
-
jobStatus(optional):
string
Allowed Values:
[ "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS" ]
The status of the background service. -
jobType(optional):
string
Allowed Values:
[ "SCHEDULE_SCHEDULER", "MEASURES_BY_PORTFOLIO_CALC", "SCHEDULE_MONTE_CARLO", "APPLY_ACT_UNCERTAINTY", "USER_DEFINED_REPORT" ]
The type of a job.
404 Response
The requested object does not exist, or you do not have access to it.