2.7.5 Acquisition of a list of task operations

Function

Acquires a list of operations that can be executed for the specified task.

Execution permissions

Admin role, Develop role, Modify role, Submit role

API version

Request format

GET http://host:port/Automation/version/objects/Tasks/id/actions

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.

{
  "data" : [ {
    "name" : "update",
    "href" : "http://host:port/Automation/version/objects/Tasks/id",
    "method" : "PUT",
    "parameters" : [ ]
  }, {
    "name" : "delete",
    "href" : "http://host:port/Automation/version/objects/Tasks/id",
    "method" : "DELETE",
    "parameters" : [ ]
  }, {
    "name" : "stop",
    "href" : "http://host:port/Automation/version/objects/Tasks/id/actions/stop/invoke",
    "method" : "POST",
    "parameters" : [ ]
  }, {
    "name" : "forceStop",
    "href" : "http://host:port/Automation/version/objects/Tasks/id/actions/forceStop/invoke",
    "method" : "POST",
    "parameters" : [ ]
  }, {
    "name" : "resubmit",
    "href" : "http://host:port/Automation/version/objects/Tasks/id/actions/resubmit/invoke",
    "method" : "POST",
    "parameters" : [ ]
  }, {
    "name" : "archive",
    "href" : "http://host:port/Automation/version/objects/Tasks/id/actions/archive/invoke",
    "method" : "POST",
    "parameters" : [ ]
  }, {
    "name" : "response",
    "href" : "http://host:port/Automation/version/objects/Tasks/id/actions/response/invoke",
    "method" : "POST",
    "parameters" : [ ]
  }, {
    "name" : "rerunStart",
    "href" : "http://host:port/Automation/version/objects/Tasks/id/actions/rerunStart/invoke",
    "method" : "POST",
    "parameters" : [ ]
  }, {
    "name" : "rerunStepStart",
    "href" : "http://host:port/Automation/version/objects/Tasks/id/actions/rerunStepStart/invoke",
    "method" : "POST",
    "parameters" : [ ]
  } ],
  "count" : 9
}

Usage example

In the following example, the API acquires a list of operations that can be executed for the task whose instanceID is 5169.

Request header:

GET /Automation/v1/objects/Tasks/5169/actions 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:32:08 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 10fad7e4bd5eb0e56b4740f5efc08e6dc750d972_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:

{
  "data" : [ {
    "name" : "update",
    "href" : "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5169",
    "method" : "PUT",
    "parameters" : [ ]
  }, {
    "name" : "delete",
    "href" : "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5169",
    "method" : "DELETE",
    "parameters" : [ ]
  }, {
    "name" : "stop",
    "href" : "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5169/actions/stop/invoke",
    "method" : "POST",
    "parameters" : [ ]
  }, {
    "name" : "forceStop",
    "href" : "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5169/actions/forceStop/invoke",
    "method" : "POST",
    "parameters" : [ ]
  }, {
    "name" : "resubmit",
    "href" : "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5169/actions/resubmit/invoke",
    "method" : "POST",
    "parameters" : [ ]
  }, {
    "name" : "archive",
    "href" : "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5169/actions/archive/invoke",
    "method" : "POST",
    "parameters" : [ ]
  }, {
    "name" : "response",
    "href" : "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5169/actions/response/invoke",
    "method" : "POST",
    "parameters" : [ ]
  }, {
    "name" : "rerunStart",
    "href" : "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5169/actions/rerunStart/invoke",
    "method" : "POST",
    "parameters" : [ ]
  }, {
    "name" : "rerunStepStart",
    "href" : "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5169/actions/rerunStepStart/invoke",
    "method" : "POST",
    "parameters" : [ ]
  } ],
  "count" : 9
}

To Page Top