グループマップ取得 (REST APIリファレンス)

グループマップを取得します。

リクエスト

メソッド

GET

URL

https:////groups//rest_api=1.0/

の指定は任意です。を指定した場合は、対応するグループとその下層に属するサブグループを出力します。

ヘッダー

パラメータ名
Content-Type application/json

すべてのリソースで共通のリクエストヘッダーは、こちらをご参照ください。

コンテント

リクエスト例

curl -v -X GET
       -H "CONTENT-TYPE: application/json" 
       -H "X-ECHO-APP-ID: fd15eacfaf2388fac2980fef163c6116" 
       -H "X-ECHO-APP-KEY: 0cdf8bc765d7d9604e83becf93137d42" 
       "https://hogehoge.echopf.com/members/groups/rest_api=1.0/"

レスポンス

HTTPステータス

ステータスコード内容
200 取得成功

ヘッダー

パラメータ名
Content-Type application/json

コンテント

グループマップが出力されます。

フィールド名説明
groups 配列 グループマップ(各要素はグループマップオブジェクト

グループマップオブジェクト

ツリー構造をとるグループマップは、次に示すように再帰的に表現されます。

フィールド名説明





















refid 文字列 グループID

name 文字列 グループ名
acl ACLオブジェクト アクセスコントロール (ACL)
children 配列 サブグループマップ(各要素はグループマップオブジェクト)

レスポンス例

{
  "groups":[
    {
      "refid":"1",
      "name":"\u30eb\u30fc\u30c8\u30b0\u30eb\u30fc\u30d7",
      "children":[
        {
          "refid":"3",
          "name":"\u30b0\u30eb\u30fc\u30d7A",
          "children":[
            
          ],
          "acl":{
            "*":{
              "list":true,
              "edit":true,
              "delete":true
            }
          }
        },
        {
          "refid":"4",
          "name":"\u30b0\u30eb\u30fc\u30d7B",
          "children":[
            
          ],
          "acl":{
            "*":{
              "list":true,
              "edit":true,
              "delete":true
            }
          }
        }
      ],
      "acl":{
        "*":{
          "list":true,
          "edit":true,
          "delete":true
        }
      }
    }
  ]
}