2.7.1　タスク一覧の取得

機能

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

実行権限

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

APIのバージョン

リクエスト形式

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

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

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

表2‒58　API「タスク一覧の取得」で指定できるクエリパラメータの一覧
クエリパラメータ	フィルタ条件
serviceID	指定した値と等しい。
scheduleID
serviceGroupID
serviceTemplateID
tags	値をすべて含んでいるか。「,」区切りで複数指定できる。
q	次に示す検索対象のスキーマに対して，値を含んでいるか全文検索する。 name submitter description serviceName tags notes 半角スペース区切りで複数指定した場合，値をすべて含んでいるか全文検索する。大文字・小文字を区別しない。

そのほかに指定できるクエリパラメータについては，「2.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
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.36.0
Host: 10.196.184.182:22015
Accept: application/json
Accept-Language: ja

レスポンスヘッダー:

HTTP/1.1 200 OK
Date: Fri, 31 Jul 2015 02:00:18 GMT
Server Cosminexus HTTP Server is not blacklisted
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO baa98567d9a18be55be1594ea9677ab1da826a3_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

レスポンスボディー:

{
  "data" : [ {
    "instanceID" : 3042,
    "name" : "Execute Remote Command_20150731105831",
    "status" : "waiting",
    "scheduledStartTime" : "2015-07-31T11:30:00.000+09:00",
    "submitter" : "System",
    "submitTime" : "2015-07-31T11:00:06.000+09:00",
    "modifyTime" : "2015-07-31T11:00:06.000+09:00",
    "serviceState" : "release",
    "scheduleType" : "schedule",
    "description" : "",
    "serviceName" : "Execute Remote Command",
    "tags" : "Windows,Linux,Execute Script",
    "serviceGroupName" : "DefaultServiceGroup",
    "toDo" : false,
    "notes" : "",
    "serviceTemplateID" : 560,
    "scheduleID" : 3020,
    "serviceGroupID" : 3,
    "serviceID" : 2004,
    "supportedActionType" : "forciblyStop,retry"
  } ],
  "count" : 1
}

2.7.1 タスク一覧の取得

2.7.1　タスク一覧の取得