REST API Reference

Back Next

Aborting a job

Use this resource to stop a running job and its child jobs in a Customer Managed runtime environment.

In the URL, use tasks instead of job. The request body is required and must include the job number to abort.

PUT Request

To abort a job, use the following API call:

PUT https://<agent-host>:9443/rm/mftsaas/api/v1/offline/tasks/<taskId>/abort
RM-USER-TOKEN: <rm-token>
Content-Type: application/json

Use the following attributes in the request body:

{
   "jobNumber": 1728712345678
}

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

curl -k -X PUT \
   https://<agent-host>:9443/rm/mftsaas/api/v1/offline/tasks/<taskId>/abort \
   -H "RM-USER-TOKEN: <rm-token>" \
   -H "Content-Type: application/json" \
   -d '{"jobNumber":1728712345678}'

The following table describes the attributes:

Field	Type	Required	Description
taskId	String	Yes	URL parameter. FRS ID of the task.
jobNumber	Long	Yes	Job number that the run resource returns.
userName	String	No	Not used when a token is present. The token user is recorded as the user who stopped the job.

Put response

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

If the job stops, the request returns the following response:

{
   "agentId": "0a1B2c3D4e5F6g7H8i9J0k",
   "status": "ABORTED",
   "failMessage": null,
   "jobNumber": 1728712345678,
   "jobFilePath": null
}

If the job is no longer running, the request returns the following response:

{
   "agentId": "0a1B2c3D4e5F6g7H8i9J0k",
   "status": "FAILED",
   "failMessage": "Task must have finished.",
   "jobNumber": 1728712345678,
   "jobFilePath": null
}

A FAILED result means the job had already finished. Call the job status resource to see the final outcome.

The following table describes the attributes:

Field	Type	Description
agentId	String	ID of the agent.
status	String	The status of the job. Options are: FAILED. The job was no longer running when you tried to stop it. ABORTED. The job stopped.
failMessage	String	Reason when the status is FAILED.
jobNumber	Number	Job number.

The following table describes the errors:

HTTP status	Response	Description
400	{"error":"taskId is required"}	The path has no task ID.
400	{"error":"Request body is required"}	The request has no body.

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Aborting a job

Aborting a job

PUT Request

Put response