2.7.20 Acquisition of a list of steps

Function

Among the steps included in the specified task, acquires a list of steps displayed in the Task Details window. This API function is for a JP1/AO instance whose version is earlier than V11.

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 window. 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...] 

For details about other query parameters that can be specified, see 2.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.

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 5381.

Request header:

GET /Automation/v1/objects/FlowSteps?taskID=5381 HTTP/1.1
Host: 10.196.184.238:22015
User-Agent: curl/7.36.0
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

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 f1bd56cdd5e340caa0d6f2419205ba81b3317ef_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" : [ {
    "instanceID" : "remoteHostCommandExe_2052",
    "name" : "remoteHostCommandExe",
    "startTime" : "2014-07-14 04:57:10",
    "completionTime" : "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
}