2.7.18 Acquisition of information necessary for archiving a task
Function
Acquires the argument template necessary for archiving the specified task.
Execution permissions
Admin role, Develop role, Modify role
API version
v1
Request format
GET http://host:port/Automation/version/objects/Tasks/id/actions/archive
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. |
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" : "archive",
"href" : " http://host:port/Automation/version/objects/Tasks/id/actions/archive/invoke",
"method" : "POST",
"parameters" : []
}
Usage example
In the following example, the API function acquires information necessary for archiving the task whose instanceID is 5169.
Request header:
GET /Automation/v1/objects/Tasks/5169/actions/archive HTTP/1.1
Host: 192.168.146.132:22015
User-Agent: curl/7.36.0
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja
Response header:
HTTP/1.1 200 OK
Date: Fri, 07 Aug 2015 07:28:17 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 58791edf45552caa5592c652b533c730df4b708_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:
{
"name" : "archive",
"href" : "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5169/actions/archive/invoke",
"method" : "POST",
"parameters" : [ ]
}