2.7.13 応答待ち中のタスクに応答
機能
指定したIDのタスクの中で,応答待ち中になった日時が最も古いステップに応答入力します。
実行権限
Adminロール,Developロール,Modifyロール,Submitロール
APIのバージョン
v1
リクエスト形式
POST http://host:port/Automation/version/objects/Tasks/id/actions/response/invoke
リクエストボディーの構造は,次のようになっています。
{
"name" : "response",
"href" : "http://host:port/Automation/version/objects/Tasks/id/actions/response/invoke",
"method" : "POST",
"parameters" : [ {...} ]
}
リクエストのスキーマで「parameters」のメンバーとして指定できるオブジェクトを,次の表で説明します。
機能 |
リソース名称 |
数 |
説明 |
|---|---|---|---|
タスク |
ResponseInput |
1 |
応答入力 |
このオブジェクトに指定必須のプロパティについて,次に説明します。
リソース名称 |
メンバー名 |
数 |
|---|---|---|
ResponseInput |
instanceId |
1 |
labelbuttonX※ |
||
taskId |
- 注※
Xには任意の番号が入ります。
ステータスコード
リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。
ステータスコード |
メッセージ |
説明 |
|---|---|---|
200 |
OK |
成功しました。 |
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" : [ {...} ],
"result" : [ {...} ],
"resultType" : "result-type"
}
使用例
instanceID=3179のタスクに応答する場合の使用例を示します。
リクエストヘッダー:
POST /Automation/v1/objects/Tasks/3179/actions/response/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.36.0
Host: 10.196.184.182:22015
Accept: application/json
Content-Type: application/json
Content-Length: 329
Accept-Language: ja
レスポンスヘッダー:
HTTP/1.1 200 OK
Date: Fri, 31 Jul 2015 04:42:14 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 5d4cd25fd30d1b8d6b67f2d7b4cc5479a16364f_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" : "4fb38028-81d7-4573-851a-672e7524a4fc",
"created" : "2015-07-31T13:42:15.030+09:00",
"updated" : "2015-07-31T13:42:15.030+09:00",
"completed" : "2015-07-31T13:42:15.030+09:00",
"state" : "success",
"affectedResource" : [ "http://10.196.184.182:22015/Automation/v1/objects/Tasks/3179" ],
"result" : [ ]
}