2.7.4 Deletion of a task

Function

Deletes the specified task. If the specified task is not a debug task, this API function acquires the URL for archiving the task.

Execution permissions

Admin role, Develop role, Modify role

API version

Request format

DELETE http://host:port/Automation/version/objects/Tasks/id

Status code

The following table describes the various status codes that can be returned as the response to a request.

Status code	Message	Description
204	No Content	Processing has been successfully completed. Or, the task to be deleted did not exist.
303	See Other	The URL for deleting the task was successfully returned as a response. Use the URL shown in the Location response header to archive the task.
401	Unauthorized	The user does not have login permission.
403	Forbidden	The user does not have permission to delete tasks.
412	Precondition failed	The server is not available.
500	Server-side error	A server processing error occurred.

Usage example

In the following example, the API function deletes the task whose instanceID is 5169.

Request header:

DELETE /Automation/v1/objects/Tasks/5169 HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: 192.168.146.132:22015
Accept: application/json
User-Agent:useragent1
Accept-Language: ja

Response header:

HTTP/1.1 303 See Other
Date: Fri, 07 Aug 2015 07:38:26 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 10a7b94b76e0747b63ee8e0828c186a5d95f699_Vlo8Y30JBWoKHUYTEXAMXx5iHgQ=_V0810
Access-Control-Allow-Origin: *
Location: http://192.168.146.132:22015/Automation/v1/objects/Tasks/5169/actions/archive
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, HEAD, OPTIONS
Access-Control-Allow-Credentials: true
Cache-Control: no-cache
Transfer-Encoding: chunked
Content-Type: text/html;charset=utf-8

Response body:

<html><head><title>303 See Other</title></head><body><h1>303 See Other</h1></body></html>