2.9.10　プロパティグループ一覧の取得

機能

サービスが保持するプロパティが所属しているプロパティグループの一覧を取得します。

実行権限

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

APIのバージョン

v1

リクエスト形式

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

APIを実行するときは，クエリパラメータを必ず指定して，一覧を取得する対象を絞り込んでください。クエリパラメータは複数指定できません。クエリパラメータは，次の形式で指定してください。

?クエリパラメータ=値

そのほかに指定できるクエリパラメータについては，「2.2.9　クエリパラメータ」を参照してください。

ステータスコード

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

レスポンスのスキーマ

レスポンスボディーには，リクエストで指定したクエリパラメータの条件に合致したデータが返却されます。レスポンスボディーのスキーマを次に示します。

{
  "data" : [ {"プロパティグループ機能のリソース（PropertyGroups）のメンバー" : 値 ... }, ... ],
  "count" : クエリパラメータの条件に合致したデータの個数（0～n）
}

使用例

serviceID=3134のサービスが保持するプロパティが所属している，プロパティグループ一覧を取得する場合の使用例を示します。

リクエストヘッダー:

GET /Automation/v1/objects/PropertyGroups?serviceID=3134 HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.36.0
Host: 10.196.184.182:22015
Accept: application/json
Accept-Language: ja

レスポンスヘッダー:

HTTP/1.1 200 OK
Date: Mon, 03 Aug 2015 04:06:07 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO b3e9a4ed913c5b5bc941f48bfb1333ced0f1fff6_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

レスポンスボディー:

{
  "data" : [ {
    "keyName" : "reserved.defaultGroup",
    "displayName" : "reserved.defaultGroup",
    "description" : "",
    "ordinal" : 0,
    "validationScript" : "",
    "display" : "config,submit,taskDetail"
  } ],
  "count" : 1
}