2.6.2 スケジュールの情報取得
機能
指定したスケジュールに関する情報を取得します。
実行権限
Adminロール,Developロール,Modifyロール,Submitロール
APIのバージョン
v1
リクエスト形式
GET http://host:port/Automation/version/objects/Schedules/id
ステータスコード
リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。
ステータスコード |
メッセージ |
説明 |
---|---|---|
200 |
OK |
成功しました。 |
401 |
Unauthorized |
ログイン権限がありません。 |
404 |
Not found |
権限が不正です。または,リソースがありません。 |
412 |
Precondition failed |
サーバが利用できません。 |
500 |
Server-side error |
サーバ処理エラーが発生しました。 |
レスポンスのスキーマ
リクエストに対するレスポンスボディーの構造を次に示します。
{ "instanceID" : instance-id, "name" : "registered-service-name", "submitter" : "submit-user-name", "status" : "status-of-schedule", "scheduleType" : "type-of-schedule", "createTime" : "created-date-and-time", "modifyTime" : "updated-date-and-time", "description" : "description-text", "scheduledStartTime" : "scheduled-start-time", "recurrenceInterval" : "interval-type", "recurrenceDayOfWeek" : "interval-of-weekly-job", "recurrenceDayOfMonth" : "interval-of-monthly-job", "recurrenceLastDayOfMonth" : {true|false}, "recurrenceStartDate" : "recurrence-start-date", "recurrenceTime" : "exec-time-of-day", "serviceState" : "service-state", "serviceID" : service-id }
使用例
instanceID=2060のスケジュールに関する情報を取得する場合の使用例を示します。
リクエストヘッダー: GET /Automation/v1/objects/Schedules/2060 HTTP/1.1 Host: 10.196.184.238:22015 Accept: application/json Authorization: Basic c3lzdGVtOm1hbmFnZXI= User-Agent: useragent1 Accept-Language: ja レスポンスヘッダー: HTTP/1.1 200 OK Date: Mon, 14 Jul 2014 12:26:19 GMT Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate WWW-Authenticate: HSSO 55fb30b1218f2ceec1b52d59d1b77b267895821_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 レスポンスボディー: { "instanceID" : 2060, "name" : "testService1_20140714044426_Resubmit", "submitter" : "System", "scheduleType" : "immediate", "createTime" : "2014-07-14T05:19:39.000-0700", "modifyTime" : "2014-07-14T05:19:39.000-0700", "description" : "", "serviceState" : "release", "serviceID" : 2015 }