9.5.4 スケジュールのキャンセルに必要な情報の取得
機能
指定したスケジュールをキャンセルするために必要な情報を取得します。
実行権限
Adminロール,Developロール,Modifyロール,Submitロール
APIのバージョン
v1
リクエスト形式
GET http://host:port/Automation/version/objects/Schedules/id/actions/cancel
ステータスコード
リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。
ステータスコード |
メッセージ |
説明 |
---|---|---|
200 |
OK |
成功しました。 |
401 |
Unauthorized |
ログイン権限がありません。 |
404 |
Not found |
権限が不正です。または,リソースがありません。 |
412 |
Precondition failed |
サーバが利用できません。 |
500 |
Server-side error |
サーバ処理エラーが発生しました。 |
レスポンスのスキーマ
リクエストに対するレスポンスボディーの構造を次に示します。
{ "name" : "cancel", "href" : "http://host:port/Automation/version/objects/Schedules/id/actions/cancel/invoke", "method" : "POST", "parameters" : [ {...} ] }
使用例
instanceID=2193のスケジュールをキャンセルするために必要になる情報を,取得する場合の使用例を示します。
リクエストヘッダー: GET /Automation/v1/objects/Schedules/2193/actions/cancel 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 12:34:39 GMT Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate WWW-Authenticate: HSSO d0f2fa4f5046c92521664920b9d84e652bcb6dee_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 レスポンスボディー: { "name" : "cancel", "href" : "http://10.196.184.238:22015/Automation/v1/objects/Schedules/2193/actions/cancel/invoke", "method" : "POST", "parameters" : [ ] }
関連トピック