9.6.1　タスク一覧の取得

機能

タスクの一覧を取得します。

実行権限

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

APIのバージョン

リクエスト形式

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

APIの実行ユーザーが権限を持つ，すべてのタスクを対象として一覧を取得します。クエリパラメータを指定すると，一覧を取得する対象を絞り込めます。クエリパラメータは，次の形式で指定してください。

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

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

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

指定例

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

?serviceID=2015

ステータスコード

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

ステータスコード	メッセージ	説明
200	OK	成功しました。
400	Bad Request	クエリパラメータが不正です。
401	Unauthorized	ログイン権限がありません。
412	Precondition failed	サーバが利用できません。
500	Server-side error	サーバ処理エラーが発生しました。

レスポンスのスキーマ

レスポンスボディーには，リクエストで指定したクエリパラメータの条件に合致したデータが返却されます。レスポンスボディーのスキーマを次に示します。

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

使用例

すべてのタスクを対象として，タスク一覧を取得する場合の使用例を示します。

リクエストヘッダー:

GET /Automation/v1/objects/Tasks 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 11:47:45 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO bd804a4bbfb57c37cad7fe56034d49e428b615_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" : 2026,
    "name" : "testService1_20140714044426",
    "status" : "completed",
    "startTime" : "2014-07-14T04:45:35.000-0700",
    "completionTime" : "2014-07-14T04:45:35.000-0700",
    "submitter" : "System",
    "submitTime" : "2014-07-14T04:45:34.000-0700",
    "modifyTime" : "2014-07-14T04:45:57.000-0700",
    "serviceState" : "release",
    "scheduleID" : 2025,
    "serviceGroupID" : 3,
    "serviceID" : 2015
  } ],
  "count" : 1
}

関連トピック

9.2.14　リソースのメンバー

ページの先頭へ

9.6.1 タスク一覧の取得

9.6.1　タスク一覧の取得