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

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

リクエスト

メソッド

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":"ルートグループ",
　　　　"children":[
　　　　　　{
　　　　　　　　"refid":"3",
　　　　　　　　"name":"グループA",
　　　　　　　　"children":[],
　　　　　　　　"acl":{
　　　　　　　　　　"*"　{
　　　　　　　　　　　　"list":true,
　　　　　　　　　　　　"edit":true,
　　　　　　　　　　　　"delete":true
　　　　　　　　　　}
　　　　　　　　}
　　　　　　},
　　　　　　{
　　　　　　　　"refid":"4",
　　　　　　　　"name":"グループB",
　　　　　　　　"children":[],
　　　　　　　　"acl":{
　　　　　　　　　　"*"　{
　　　　　　　　　　　　"list":true,
　　　　　　　　　　　　"edit":true,
　　　　　　　　　　　　"delete":true
　　　　　　　　　　}
　　　　　　　　}
　　　　　　}
　　　　],
　　　　"acl":{
　　　　　　"*"　{
　　　　　　　　"list":true,
　　　　　　　　"edit":true,
　　　　　　　　"delete":true
　　　　　　}
　　　　}
　　}
]}