Hitachi

JP1 Version 12 JP1/Automatic Operation コマンド・API リファレンス 


2.7.19 タスクのアーカイブ

機能

指定したタスクをアーカイブします。

実行権限

Adminロール,Developロール,Modifyロール

APIのバージョン

v1

リクエスト形式

POST http://host:port/Automation/version/objects/Tasks/id/actions/archive/invoke

リクエストボディーの構造は,次のようになっています。

{
  "name" : "archive",
  "href" : "http://host:port/Automation/version/objects/Tasks/id/actions/archive/invoke",
  "method" : "POST",
  "parameters" : [ ]
}

ステータスコード

リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。

ステータスコード

メッセージ

説明

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=5209のタスクをアーカイブする場合の使用例を示します。

リクエストヘッダー:

POST /Automation/v1/objects/Tasks/5209/actions/archive/invoke HTTP/1.1
Host: 192.168.146.132:22015
User-Agent: curl/7.36.0
Accept: application/json
Content-Type: application/json
Content-Length: 171
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

レスポンスヘッダー:

HTTP/1.1 200 OK
Date: Fri, 07 Aug 2015 08:15:46 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO aec4a069aea32fe6d59c8325bfae96af27dde14_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

レスポンスボディー:

{
  "instanceID" : "0fea3bf2-9747-4d29-a4bf-faaddf22076d",
  "created" : "2015-08-07T17:15:46.474+09:00",
  "updated" : "2015-08-07T17:15:46.474+09:00",
  "completed" : "2015-08-07T17:15:46.474+09:00",
  "state" : "success",
  "affectedResource" : [ "http://192.168.146.132:22015/Automation/v1/objects/TaskHistories/5237" ],
  "result" : [ ]
}