2.7.9 Forced stoppage of a task
Function
Forcibly stops the specified task.
Execution permissions
Admin role, Develop role, Modify role, Submit role
API version
v1
Request format
POST http://host:port/Automation/version/objects/Tasks/id/actions/forceStop/invoke
Status code
The following table describes the various status codes that can be returned as the response to a request.
Status code |
Message |
Description |
---|---|---|
200 |
OK |
Processing has been successfully completed. |
401 |
Unauthorized |
The user does not have login permission. |
404 |
Not found |
The permission is invalid, or the resource does not exist. |
409 |
Conflict |
The status of the task is not In progress, Waiting for response, or Abnormality detected. |
412 |
Precondition failed |
The server is not available. |
500 |
Server-side error |
A server processing error occurred. |
Response schema
The following shows the structure of the response body for a request.
{ "instanceId" : "instance-id", "created" : "created-date-and-time", "updated" : "updated-date-and-time", "completed" : "completed-date-and-time", "state" : "state", "affectedResources" : [ {...} ], "result" : [ ] }
Usage example
In the following example, the API function forcibly stops the task whose instanceID is 5381.
Request header: POST /Automation/v1/objects/Tasks/5381/actions/forceStop/invoke HTTP/1.1 Host: 192.168.146.132:22015 User-Agent: curl/7.36.0 Accept: application/json Content-Type: application/json Content-Length: 175 Authorization: Basic c3lzdGVtOm1hbmFnZXI= { "name" : "forceStop", "href" : "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5338/actions/forceStop/invoke", "method" : "POST", "parameters" : [ ] } Accept-Language: ja Response header: HTTP/1.1 200 OK Date: Fri, 07 Aug 2015 10:00:39 GMT Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate WWW-Authenticate: HSSO a2e8ab6f7a9c35323fb7d9331735a9419235ebad_Vlo8Y30JBWoKHUYTEXAMXx5iHgQ=_V0810 Access-Control-Allow-Origin: * Access-Control-Allow-Methods: GET, POST, DELETE, PUT, HEAD, OPTIONS Access-Control-Allow-Credentials: true Cache-Control: no-cache Transfer-Encoding: chunked Content-Type: application/json Response body: { "instanceID" : "68451399-53c2-4f6b-bbdd-be025a61ed02", "created" : "2015-08-07T19:00:40.025+09:00", "updated" : "2015-08-07T19:00:40.025+09:00", "completed" : "2015-08-07T19:00:40.025+09:00", "state" : "success", "affectedResource" : [ "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5381" ], "result" : [ ] }