2.9.5 プロパティ値一覧の取得
機能
次に示す値の一覧を取得します。
サービス共有プロパティ
特定のサービスに関連するプロパティ
特定のスケジュールに関連するプロパティ
特定のタスクに関連するプロパティ
実行権限
Adminロール,Developロール,Modifyロール,Submitロール
APIのバージョン
v1
リクエスト形式
GET http://host:port/Automation/version/objects/PropertyValues
APIの実行ユーザーが権限を持つ,すべてのサービス,スケジュール,タスクを対象としてプロパティ値の一覧を取得します。クエリパラメータを指定すると,一覧を取得する対象を絞り込めます。クエリパラメータは,次の形式で指定してください。
?クエリパラメータ=値[&クエリパラメータ=値...]
クエリパラメータ |
フィルタ条件 |
---|---|
serviceID |
指定した値と等しい |
scheduleID |
|
taskID |
そのほかに指定できるクエリパラメータについては,「2.2.9 クエリパラメータ」を参照してください。
- 指定例
クエリパラメータとして,serviceIDに16731を,taskIDに512を指定する例を次に示します。
?serviceID=16731&taskID=512
サービス,スケジュールまたはタスク用にプロパティ値を取得したい場合,serviceID,scheduleID,またはtaskIDのそれぞれに対応するクエリパラメータを指定する必要があります。クエリパラメータが指定されていない場合は,サービス共有プロパティだけがレスポンスとして返されます。
ステータスコード
リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。
ステータスコード |
メッセージ |
説明 |
---|---|---|
200 |
OK |
成功しました。 |
401 |
Unauthorized |
ログイン権限がありません。 |
412 |
Precondition failed |
サーバが利用できません。 |
500 |
Server-side error |
サーバ処理エラーが発生しました。 |
レスポンスのスキーマ
レスポンスボディーには,リクエストで指定したクエリパラメータの条件に合致したデータが返却されます。レスポンスボディーのスキーマを次に示します。
{ "data" : [ {"プロパティ値機能のリソース(PropertyValues)のメンバー" : 値 ... }, ... ], "count" : クエリパラメータの条件に合致したデータの個数(0~n) }
使用例
すべてのサービス,スケジュール,タスクを対象として,プロパティ値一覧を取得する場合の使用例を示します。
リクエストヘッダー: GET /Automation/v1/objects/PropertyValues 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:40:06 GMT Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate WWW-Authenticate: HSSO 56ca4c95167e4ce4aeb51fa73a85b2923d65e28e_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" : [ { "instanceID" : 25, "type" : "boolean", "keyName" : "com.hitachi.software.dna.sys.mail.notify", "value" : "false", "readOnly" : false, "hidden" : false }, { "instanceID" : 24, "type" : "string", "keyName" : "com.hitachi.software.dna.sys.mail.smtp.server", "value" : "", "readOnly" : false, "hidden" : false }, { "instanceID" : 18, "type" : "integer", "keyName" : "com.hitachi.software.dna.sys.mail.smtp.port", "value" : "25", "readOnly" : false, "hidden" : false }, { "instanceID" : 5, "type" : "string", "keyName" : "com.hitachi.software.dna.sys.mail.smtp.userid", "value" : "", "readOnly" : false, "hidden" : false }, { "instanceID" : 14, "type" : "password", "keyName" : "com.hitachi.software.dna.sys.mail.smtp.password", "readOnly" : false, "hidden" : false }, { "instanceID" : 9, "type" : "string", "keyName" : "com.hitachi.software.dna.sys.mail.from", "value" : "", "readOnly" : false, "hidden" : false }, { "instanceID" : 20, "type" : "string", "keyName" : "com.hitachi.software.dna.sys.mail.to", "value" : "", "readOnly" : false, "hidden" : false }, { "instanceID" : 28, "type" : "string", "keyName" : "com.hitachi.software.dna.sys.mail.cc", "value" : "", "readOnly" : false, "hidden" : false }, { "instanceID" : 21, "type" : "string", "keyName" : "com.hitachi.software.dna.sys.mail.bcc", "value" : "", "readOnly" : false, "hidden" : false } ], "count" : 9 }