2.8.1　履歴一覧の取得

機能

履歴の一覧を取得します。

実行権限

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

APIのバージョン

リクエスト形式

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

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

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

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

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

ステータスコード

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

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

レスポンスのスキーマ

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

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

使用例

すべての履歴を対象として一覧を取得する場合の使用例を示します。

リクエストヘッダー:

GET /Automation/v1/objects/TaskHistories 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 06:22:25 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 24f87c98d12f4f434cf398edcbe582939cee4d6_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" : 4006,
    "name" : "Execute Remote Command_20150731105831",
    "submitter" : "System",
    "serviceName" : "Execute Remote Command",
    "tags" : "Windows,Linux,Execute Script",
    "scheduleType" : "schedule",
    "scheduledStartTime" : "2015-07-31T11:30:00.000+09:00",
    "startTime" : "2015-07-31T11:30:00.000+09:00",
    "completionTime" : "2015-07-31T11:30:33.000+09:00",
    "archiveTime" : "2015-07-31T15:22:21.000+09:00",
    "taskID" : 3042,
    "submitTime" : "2015-07-31T11:00:06.000+09:00",
    "status" : "completed",
    "description" : "",
    "serviceState" : "release",
    "toDo" : true,
    "notes" : "Notes Test",
    "serviceGroupName" : "DefaultServiceGroup",
    "serviceGroupID" : 3
  } ],
  "count" : 1
}

2.8.1 履歴一覧の取得

2.8.1　履歴一覧の取得