2.7.12 Acquisition of information necessary for responding to a task that is in the status Waiting for Response

Function

Acquires information necessary for responding to a task that is in the status Waiting for Response. Among the steps of the task that has the specified ID, information about the step that was least recently placed in the status Waiting for Response is acquired.

Execution permissions

Admin role, Develop role, Modify role, Submit role

API version

Request format

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

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	A query parameter 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 Waiting for response.
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" : "response",
  "href" : " http://host:port/Automation/version/objects/Tasks/id/actions/response/invoke",
  "method" : "POST",
  "parameters" : [ {...} ]
}

Usage example

In the following example, the API function acquires information necessary for responding to the task whose instanceID is 3179.

Request header:

GET /Automation/v1/objects/Tasks/3179/actions/response HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.36.0
Host: 10.196.184.182:22015
Accept: application/json
Accept-Language: ja

Response header:

HTTP/1.1 200 OK
Date: Fri, 31 Jul 2015 04:36:56 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 13691d353edd835f6f83942ec70f4ae1411a3f_Vlo8Y30JdDBUB3ljJSVPaRtjBSA=_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" : "response",
  "href" : "http://10.196.184.182:22015/Automation/v1/objects/Tasks/3179/actions/response/invoke",
  "method" : "POST",
  "parameters" : [ {
    "instanceID" : 3239,
    "dialogText" : "",
    "labelButton0" : "OK",
    "screenURL" : "services/default/index.jsp",
    "taskID" : 3179
  } ]
}

To Page Top