GET /api/v1/stopJob.jsp

Stop a job.

Parameters:

• appId (type: string; required): id of the app in which context the job is being executed.
• jobId (type: string; required): id of the job.

Call example:

curl -i -H "Accept: application/json" -H "Content-Type: application/json" -X GET "<path_to_infolink>/api/v1/stop.jsp?apiKey=<your API key>&appId=7&jobId=<jobId returned by executeJob>"
                    

Response:

• status (type: string): the status of the call can be success or error.
• result (type: object):
  • If status is success, result.status (type: string) contains the status of the request that can be one of the following:
    • already completed - Job is already completed or stopped. Nothing to do.
    • already being stopped - Stopping is already in progress.
    • stop started - Job stopping is initiated. It may take a few moments. To confirm that the job is stopped periodically repeat the same call.
  • If status is error, result.message contains the error message.

Response example:

{
"result": 
    {
        "status": "stop started"    
    },
"status": "success"
}