2.7.5 タスク操作一覧の取得
機能
指定したタスクに対して実行できる操作の一覧を取得します。
実行権限
Adminロール,Developロール,Modifyロール,Submitロール
APIのバージョン
v1
リクエスト形式
GET http://host:port/Automation/version/objects/Tasks/id/actions
ステータスコード
リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。
ステータスコード |
メッセージ |
説明 |
|---|---|---|
200 |
OK |
成功しました。 |
401 |
Unauthorized |
ログイン権限がありません。 |
404 |
Not found |
権限がありません。または,リソースがありません。 |
412 |
Precondition failed |
サーバが利用できません。 |
500 |
Server-side error |
サーバ処理エラーが発生しました。 |
レスポンスのスキーマ
リクエストに対するレスポンスボディーの構造を次に示します。
{
"data" : [ {
"name" : "update",
"href" : "http://host:port/Automation/version/objects/Tasks/id",
"method" : "PUT",
"parameters" : [ ]
}, {
"name" : "delete",
"href" : "http://host:port/Automation/version/objects/Tasks/id",
"method" : "DELETE",
"parameters" : [ ]
}, {
"name" : "stop",
"href" : "http://host:port/Automation/version/objects/Tasks/id/actions/stop/invoke",
"method" : "POST",
"parameters" : [ ]
}, {
"name" : "forceStop",
"href" : "http://host:port/Automation/version/objects/Tasks/id/actions/forceStop/invoke",
"method" : "POST",
"parameters" : [ ]
}, {
"name" : "resubmit",
"href" : "http://host:port/Automation/version/objects/Tasks/id/actions/resubmit/invoke",
"method" : "POST",
"parameters" : [ ]
}, {
"name" : "archive",
"href" : "http://host:port/Automation/version/objects/Tasks/id/actions/archive/invoke",
"method" : "POST",
"parameters" : [ ]
}, {
"name" : "response",
"href" : "http://host:port/Automation/version/objects/Tasks/id/actions/response/invoke",
"method" : "POST",
"parameters" : [ ]
}, {
"name" : "rerunStart",
"href" : "http://host:port/Automation/version/objects/Tasks/id/actions/rerunStart/invoke",
"method" : "POST",
"parameters" : [ ]
}, {
"name" : "rerunStepStart",
"href" : "http://host:port/Automation/version/objects/Tasks/id/actions/rerunStepStart/invoke",
"method" : "POST",
"parameters" : [ ]
} ],
"count" : 9
}
使用例
instanceID=5169のタスクに対して実行できる操作の一覧を,取得する場合の使用例を示します。
リクエストヘッダー:
GET /Automation/v1/objects/Tasks/5169/actions HTTP/1.1
Host: 192.168.146.132:22015
User-Agent: curl/7.36.0
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja
レスポンスヘッダー:
HTTP/1.1 200 OK
Date: Fri, 07 Aug 2015 07:32:08 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 10fad7e4bd5eb0e56b4740f5efc08e6dc750d972_Vlo8Y30JBWoKHUYTEXAMXx5iHgQ=_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" : [ {
"name" : "update",
"href" : "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5169",
"method" : "PUT",
"parameters" : [ ]
}, {
"name" : "delete",
"href" : "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5169",
"method" : "DELETE",
"parameters" : [ ]
}, {
"name" : "stop",
"href" : "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5169/actions/stop/invoke",
"method" : "POST",
"parameters" : [ ]
}, {
"name" : "forceStop",
"href" : "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5169/actions/forceStop/invoke",
"method" : "POST",
"parameters" : [ ]
}, {
"name" : "resubmit",
"href" : "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5169/actions/resubmit/invoke",
"method" : "POST",
"parameters" : [ ]
}, {
"name" : "archive",
"href" : "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5169/actions/archive/invoke",
"method" : "POST",
"parameters" : [ ]
}, {
"name" : "response",
"href" : "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5169/actions/response/invoke",
"method" : "POST",
"parameters" : [ ]
}, {
"name" : "rerunStart",
"href" : "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5169/actions/rerunStart/invoke",
"method" : "POST",
"parameters" : [ ]
}, {
"name" : "rerunStepStart",
"href" : "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5169/actions/rerunStepStart/invoke",
"method" : "POST",
"parameters" : [ ]
} ],
"count" : 9
}