9.6.4 Acquisition of information necessary for stopping task execution
Function
Acquires information necessary for stopping execution of the specified task.
Execution permissions
Admin role, Develop role, Modify role, Submit role
API version
v1
Request format
GET http://host:port/Automation/version/objects/Tasks/id/actions/stop
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 |
Searching for or deleting a resource 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. |
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.
{ "name" : "stop", "href" : "http://host:port/Automation/version/objects/Tasks/id/actions/stop/invoke", "method" : "POST", "parameters" : null }
Usage example
In the following example, the API acquires information necessary for stopping execution of the task whose instanceID is 2026.
Request header: GET /Automation/v1/objects/Tasks/2026/actions/stop HTTP/1.1 Host:10.196.184.238:22015 Accept:application/json Accept-Language: ja Authorization: Basic c3lzdGVtOm1hbmFnZXI= User-Agent: useragent1 Response header: HTTP/1.1 200 OK Date: Mon, 14 Jul 2014 12:21:37 GMT Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate WWW-Authenticate: HSSO a542e79cb51d1228f7359e62edb254aa14b81cc_V0300 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: { "name" : "stop", "href" : "http://10.196.184.238:22015/Automation/v1/objects/Tasks/2026/actions/stop/invoke", "method" : "POST", "parameters" : [ ] }
Related topic