9.6.12 Acquisition of a list of steps
Function
Acquires a list of steps displayed in the Task Details dialog box among the steps included in the specified task.
Execution permissions
Admin role, Develop role, Modify role, Submit role
API version
v1
Request format
GET http://host:port/Automation/version/objects/FlowSteps
Make sure that you specify taskID as a query parameter.
By specifying taskID, you can filter the target task. Among the steps included in the task, you can acquire a list of steps displayed in the Task Details dialog box. If no query parameter is specified, or if multiple query parameters are specified, an error occurs. Specify a query parameter in the following format:
?query-parameter=value[&query-parameter=value...]
Query parameter |
Filter condition |
---|---|
taskID |
Equal to the specified value |
For details about other query parameters that can be specified, see 9.2.9 Query parameter.
- Example
-
The following example specifies 512 for taskID as a query parameter.
?taskID=512
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 |
Created |
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. |
412 |
Precondition failed |
The server is not running. |
500 |
Server-side error |
A server processing error occurred. |
Response schema
The following shows the structure of the response body for a request.
{ "data" : [ {"member-of-the-resources-for-step-functionality(FlowSteps)" : value ... }, ... ], "count" : number-of-data-items-that-match-the-conditions-specified-by-query-parameters(0-to-n) }
Usage example
In the following example, the API acquires a list of steps to be executed by the task whose task ID is 2052.
Request header: GET /Automation/v1/objects/FlowSteps?taskID=2052 HTTP/1.1 Host:10.196.184.238:22015 Accept:application/json Accept-Language: ja Authorization: Basic c3lzdGVtOm1hbmFnZXI= User-Agent: useragent1 Response header: HTTP/1.1 200 OK Date: Mon, 14 Jul 2014 12:51:18 GMT Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate WWW-Authenticate: HSSO 91b080f3e0409735fa1583e8e4d6409daa4433f8_V0300 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" : [ { "instanceID" : "remoteHostCommandExe_2052", "name" : "remoteHostCommandExe", "startTime" : "2014-07-14 04:57:10", "endTime" : "2014-07-14 04:57:34", "jobStatus" : "normal", "comment" : "Executes a command on the remote execution target server and displays the results.", "stepStatus" : "complete" } ], "count" : 1 }