9.6.12　ステップの一覧取得

機能

指定したタスクに含まれるステップのうち，［タスク詳細］ダイアログボックスに表示されるステップの一覧を取得します。

実行権限

Adminロール，Developロール，Modifyロール，Submitロール

APIのバージョン

リクエスト形式

GET http://host:port/Automation/version/objects/FlowSteps

クエリパラメータとしてtaskIDを必ず指定してください。

taskIDを指定することで対象のタスクを絞り込みます。そのタスクに含まれるステップのうち，［タスク詳細］ダイアログボックスに表示されるステップの一覧を取得できます。クエリパラメータの指定がない場合，または複数のクエリパラメータを指定した場合はエラーになります。クエリパラメータは，次の形式で指定してください。

?クエリパラメータ=値[&クエリパラメータ=値...]

表9‒48　API「ステップの一覧取得」に指定できるクエリパラメータの一覧
クエリパラメータ	フィルタ条件
taskID	指定した値と等しい

そのほかに指定できるクエリパラメータについては，「9.2.9　クエリパラメータ」を参照してください。

指定例

クエリパラメータとしてtaskIDに512を指定する例を次に示します。

?taskID=512

ステータスコード

リクエストに対するレスポンスとして返却されるステータスコードを，次の表に示します。

ステータスコード	メッセージ	説明
200	Created	成功しました。
400	Bad Request	引数が不正です。
401	Unauthorized	ログイン権限がありません。
404	Not found	権限が不正です。または，リソースがありません。
412	Precondition failed	サーバが起動していません。
500	Server-side error	サーバ処理エラーが発生しました。

レスポンスのスキーマ

リクエストに対するレスポンスボディーの構造を次に示します。

{
  "data" : [ {"ステップ機能のリソース（FlowSteps）のメンバー" : 値 ... }, ... ],
  "count" : クエリパラメータの条件に合致したデータの個数（0〜n）
}

使用例

タスクID「2052」のタスクが実行するステップの一覧を取得する場合の使用例を示します。

リクエストヘッダー:

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

レスポンスヘッダー:

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


レスポンスボディー:
{
  "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
}

ページの先頭へ

9.6.12 ステップの一覧取得

9.6.12　ステップの一覧取得