2.7.13 Response to a task that is in the status Waiting for Response
Function
Among the steps of the task that has the specified ID, performs a response input for the step that was least recently placed in the status Waiting for Response.
Execution permissions
Admin role, Develop role, Modify role, Submit role
API version
v1
Request format
POST http://host:port/Automation/version/objects/Tasks/id/actions/response/invoke
The following shows the structure of the request body.
{ "name" : "enter Response", "href" : "http://host:port/Automation/version/objects/Tasks/id/actions/response/invoke", "method" : "POST", "parameters" : [ {...} ] }
The following table describes the object that can be specified as parameters (member) in the schema of a request.
Function |
Resource name |
Number |
Description |
---|---|---|---|
Task |
ResponseInput |
1 |
Response input |
The following table describes the properties that must be specified for this object.
Resource name |
Member name |
Number |
---|---|---|
ResponseInput |
instanceId |
1 |
labelbuttonX# |
||
taskId |
- #
X is replaced with a number.
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 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.
{ "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 responds to the task whose instanceID is 3179.
Request header: POST /Automation/v1/objects/Tasks/3179/actions/response/invoke HTTP/1.1 Authorization: Basic c3lzdGVtOm1hbmFnZXI= User-Agent: curl/7.36.0 Host: 10.196.184.182:22015 Accept: application/json Content-Type: application/json Content-Length: 329 Response header: HTTP/1.1 200 OK Date: Fri, 31 Jul 2015 04:42:14 GMT Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate WWW-Authenticate: HSSO 5d4cd25fd30d1b8d6b67f2d7b4cc5479a16364f_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: { "instanceID" : "4fb38028-81d7-4573-851a-672e7524a4fc", "created" : "2015-07-31T13:42:15.030+09:00", "updated" : "2015-07-31T13:42:15.030+09:00", "completed" : "2015-07-31T13:42:15.030+09:00", "state" : "success", "affectedResource" : [ "http://10.196.184.182:22015/Automation/v1/objects/Tasks/3179" ], "result" : [ ] }