2.7.19 Archiving a task

Function

Archives the specified task.

Execution permissions

Admin role, Develop role, Modify role

API version

Request format

POST http://host:port/Automation/version/objects/Tasks/id/actions/archive/invoke

The following shows the structure of the request body.

{
  "name" : "archive",
  "href" : "http://host:port/Automation/version/objects/Tasks/id/actions/archive/invoke",
  "method" : "POST",
  "parameters" : [ ]
}

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.
400	Bad Request	The argument is invalid.
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 Completed, Failed, or Canceled.
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" : [ {...} ],
  "resultType" : "result-type"
}

Usage example

In the following example, the API function archives the task whose instanceID is 5209.

Request header:

POST /Automation/v1/objects/Tasks/5209/actions/archive/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: 171
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

Response header:

HTTP/1.1 200 OK
Date: Fri, 07 Aug 2015 08:15:46 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO aec4a069aea32fe6d59c8325bfae96af27dde14_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" : "0fea3bf2-9747-4d29-a4bf-faaddf22076d",
  "created" : "2015-08-07T17:15:46.474+09:00",
  "updated" : "2015-08-07T17:15:46.474+09:00",
  "completed" : "2015-08-07T17:15:46.474+09:00",
  "state" : "success",
  "affectedResource" : [ "http://192.168.146.132:22015/Automation/v1/objects/TaskHistories/5237" ],
  "result" : [ ]
}

To Page Top