9.7.4　プロパティ値一覧の取得

機能

次に示す値の一覧を取得します。

サービス共有プロパティ
特定のサービスに関連するプロパティ
特定のスケジュールに関連するプロパティ
特定のタスクに関連するプロパティ

実行権限

Adminロール，Developロール，Modifyロール，Submitロール

APIのバージョン

リクエスト形式

GET http://host:port/Automation/version/objects/PropertyValues

APIの実行ユーザーが権限を持つ，すべてのサービス，スケジュール，タスクを対象としてプロパティ値の一覧を取得します。クエリパラメータを指定すると，一覧を取得する対象を絞り込めます。クエリパラメータは，次の形式で指定してください。

?クエリパラメータ=値[&クエリパラメータ=値...]

表9‒51　API「プロパティ値一覧の取得」で設定できるクエリパラメータ
クエリパラメータ	フィルター条件
serviceID	指定した値と等しい
scheduleID	指定した値と等しい
taskID	指定した値と等しい

そのほかに指定できるクエリパラメータについては，「9.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
Accept-Language: ja
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: useragent1

レスポンスヘッダー:

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" : 18,
    "type" : "boolean",
    "keyName" : "com.hitachi.software.dna.sys.mail.notify",
    "value" : "false",
  }, {
    "instanceID" : 11,
    "type" : "string",
    "keyName" : "com.hitachi.software.dna.sys.mail.smtp.server",
    "value" : "",
  }, {
    "instanceID" : 20,
    "type" : "integer",
    "keyName" : "com.hitachi.software.dna.sys.mail.smtp.port",
    "value" : "25",
  }, {
    "instanceID" : 5,
    "type" : "string",
    "keyName" : "com.hitachi.software.dna.sys.mail.smtp.userid",
    "value" : "",
  }, {
    "instanceID" : 13,
    "type" : "password",
    "keyName" : "com.hitachi.software.dna.sys.mail.smtp.password",
  }, {
    "instanceID" : 17,
    "type" : "string",
    "keyName" : "com.hitachi.software.dna.sys.mail.from",
    "value" : "",
  }, {
    "instanceID" : 12,
    "type" : "string",
    "keyName" : "com.hitachi.software.dna.sys.mail.to",
    "value" : "",
  }, {
    "instanceID" : 7,
    "type" : "string",
    "keyName" : "com.hitachi.software.dna.sys.mail.cc",
    "value" : "",
  }, {
    "instanceID" : 6,
    "type" : "string",
    "keyName" : "com.hitachi.software.dna.sys.mail.bcc",
    "value" : "",
  } ],
  "count" : 9
}

関連トピック

9.2.14　リソースのメンバー

ページの先頭へ

9.7.4 プロパティ値一覧の取得

9.7.4　プロパティ値一覧の取得