9.6.2 タスクの情報取得
機能
指定したタスクに関する情報を取得します。
実行権限
Adminロール,Developロール,Modifyロール,Submitロール
APIのバージョン
v1
リクエスト形式
GET http://host:port/Automation/version/objects/Tasks/id
ステータスコード
リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。
ステータスコード |
メッセージ |
説明 |
---|---|---|
200 |
OK |
成功しました。 |
401 |
Unauthorized |
ログイン権限がありません。 |
404 |
Not found |
権限が不正です。または,リソースがありません。 |
412 |
Precondition failed |
サーバが利用できません。 |
500 |
Server-side error |
サーバ処理エラーが発生しました。 |
レスポンスのスキーマ
リクエストに対するレスポンスボディーの構造を次に示します。
{ "instanceID" : instance-id, "name" : "task-name", "status" : "task-status", "startTime" : "start-date-and-time", "completionTime" : "completion-time", "submitter" : "submit-user-name", "submitTime" : "created-date-and-time", "modifyTime" : "updated-date-and-time", "serviceState" : "service-state", "scheduleID" : schedule-id, "serviceGroupID" : service-group-id "serviceID" : service-id }
使用例
instanceID=2026のタスクに関する情報を取得する場合の使用例を示します。
リクエストヘッダー: GET /Automation/v1/objects/Tasks/2026 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:58:17 GMT Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate WWW-Authenticate: HSSO 4c41b543aa586cdc7eda448abadac3ff6268be_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 レスポンスボディー: { "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 }