Hitachi

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


2.9.3 プロパティ定義に対する操作一覧の取得

機能

指定したプロパティ定義に対して実行できる操作の一覧を取得します。

実行権限

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

APIのバージョン

v1

リクエスト形式

GET http://host:port/Automation/version/objects/PropertyDefinitions/id/actions

ステータスコード

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

ステータスコード

メッセージ

説明

200

OK

成功しました。

401

Unauthorized

ログイン権限がありません。

404

Not found

権限が不正です。または,リソースがありません。

412

Precondition failed

リクエストがほかのリクエストと競合しています。または,リクエストが現在のオブジェクトの状態と不一致です。

500

Server-side error

サーバ処理エラーが発生しました。

レスポンスのスキーマ

リクエストに対するレスポンスボディーの構造を次に示します。

{
  "data" : [ {"プロパティ定義機能のリソース(PropertyDefinitions)のメンバー" :  ... }, ... ],
  "count" : クエリパラメータの条件に合致したデータの個数(0~n)
}

使用例

instanceID=158のプロパティ定義に対して実行できる操作の一覧を取得する場合の使用例を示します。

リクエストヘッダー:

GET /Automation/v1/objects/PropertyDefinitions/158/actions HTTP/1.1
Host: 10.196.184.238:22015
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: useragent1
Accept-Language: ja

レスポンスヘッダー:

HTTP/1.1 200 OK
Date: Mon, 14 Jul 2014 12:38:20 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 78d4d9d37740a76bfe7212277228eb2db759bb10_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

レスポンスボディー:

{
  "data" : [ ],
  "count" : 0
}