2.6.5 スケジュールのキャンセル
機能
指定したスケジュールをキャンセルします。
実行権限
Adminロール,Developロール,Modifyロール,Submitロール
APIのバージョン
v1
リクエスト形式
POST http://host:port/Automation/version/objects/Schedules/id/actions/cancel/invoke
リクエストボディーの構造は,次のようになっています。
{ "name" : "cancel", "href" : "http://host:port/Automation/version/objects/Schedules/id/actions/cancel/invoke", "method" : "POST", "parameters" : null }
ステータスコード
リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。
ステータスコード |
メッセージ |
説明 |
---|---|---|
200 |
Created |
成功しました。 |
400 |
Bad Request |
引数が不正です。 |
401 |
Unauthorized |
ログイン権限がありません。 |
404 |
Not found |
権限が不正です。または,リソースがありません。 |
409 |
Conflict |
タスクの状態が待機中または保留中ではありません。 |
412 |
Precondition failed |
サーバが利用できません。 |
500 |
Server-side error |
サーバ処理エラーが発生しました。 |
レスポンスのスキーマ
リクエストに対するレスポンスボディーの構造は,次のようになっています。
{ "instanceId" : "instance-id", "created" : "created-date-and-time", "updated" : "updated-date-and-time", "completed" : "completed-date-and-time", "state" : "state", "affectedResources" : [ {...} ] }
「affectedResources」のメンバーとして出力されるオブジェクトを,次の表で説明します。
出力 |
リソース名称 |
数 |
説明 |
---|---|---|---|
影響を受けたスケジュールへのリンク |
String |
1 |
影響を受けたスケジュール機能のリソース(Schedules)へのリンク |
使用例
instanceID=2193のスケジュールをキャンセルする場合の使用例を示します。
リクエストヘッダー: POST /Automation/v1/objects/Schedules/2193/actions/cancel/invoke HTTP/1.1 Host: 10.196.184.238:22015 Accept: application/json Content-Type: application/json Content-Length: 172 Authorization: Basic c3lzdGVtOm1hbmFnZXI= User-Agent: useragent1 Accept-Language: ja レスポンスヘッダー: HTTP/1.1 200 OK Date: Mon, 14 Jul 2014 12:35:22 GMT Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate WWW-Authenticate: HSSO f214b39fba479af17375f1ad0e052124041ea60_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" : "7a2924f8-1d5b-4f94-aef0-babccb2eb525", "created" : "2014-07-14T05:35:23.113-0700", "updated" : "2014-07-14T05:35:23.113-0700", "completed" : "2014-07-14T05:35:23.113-0700", "state" : "success", "affectedResource" : [ "http://10.196.184.238:22015/Automation/v1/objects/Schedules/2193" ] }