REST API Reference

Back Next

Getting the job operation status

Use this resource to get the current run status of a

database ingestion and replication

job or

application ingestion and replication

job in a Customer Managed runtime environment.

To get the job operation status, use the following API call:

GET https://<agent-host>:9443/rm/dbmi/api/v1/job/<job-id>/status
RM-USER-TOKEN: <rm-token>

To start a job with curl, use the following command:

curl -ik -X GET https://<agent-host>:9443/rm/dbmi/api/v1/job/<job-id>/status \
   -H "RM-USER-TOKEN: <rm-token>"

The following table describes the URL parameter:

Field	Type	Required	Description
job-id	Number	Yes	ID of the job.

Returns the job ID and status if the request is successful. Returns an error if errors occur.

A successful request returns the following response:

{"jobStatus":"RUNNING","operation":"STOP","operationState":"DONE"}

The following table describes the attributes:

Field	Type	Description
jobStatus	String	Current status of the job. Valid values are: DEPLOYED AWAITING_AUTO_RESTART RUNNING WARNING FAILED STOPPED ABORTED COMPLETED
Operation	String	Latest operation requested for the job. Valid values are: STOP ABORT The value is null if you haven't requested a stop or abort operation for the job.
operationState	String	State of the latest operation. Options are: REQUESTED. The operation was received but isn't yet applied to the job. DONE. The operation was applied. The value is null if the operation field is null.

The following examples show how the response changes when you stop a running job, and the response after you abort a job:

Scenario	Response
Running job with no operation requested.	{"jobStatus":"RUNNING","operation":null,"operationState":null}
Stop requested but not yet applied	{"jobStatus":"RUNNING","operation":"STOP","operationState":"REQUESTED"}
Stop applied and the job still running	{"jobStatus":"RUNNING","operation":"STOP","operationState":"DONE"}
Job stopped	jobStatus":"STOPPED","operation":"STOP","operationState":"DONE"}
Job aborted	{"jobStatus":"ABORTED","operation":"ABORT","operationState":"DONE"}