グループ情報取得

グループ情報を取得します。検索条件を指定した場合は、完全一致で検索が行われます。

(1) 必要な権限

GetGroupInformation APIを使用するには以下の権限が必要です。

  • システム管理の参照権限

 

管理対象種別による違いは以下のとおりです。

システム全体

任意のグループの情報を取得可能

グループ単位

管理対象グループの情報、およびAPIを使用するユーザ自身が所属するグループの情報のみ取得可能

= 備考 =

権限がなくても、APIを使用するユーザ自身が所属するグループの情報は取得できます。

(2) リクエストURL

http(s)://Domain:xxxx/コンテキスト名/GetGroupInformation

(3) リクエストインタフェース

表1.5 グループ情報取得のリクエストインタフェースの項目

項目名

説明

文字

省略

省略値

group_id

グループID(検索条件)

検索するグループIDを32バイト以内で指定します。

半角

ブランク

group_name

所属(検索条件)

検索する所属を128バイト以内で指定します。

混在

ブランク

(4) レスポンスインタフェース

表1.6 グループ情報取得のレスポンスインタフェースの項目

項目名

説明

備考

info_group

グループ情報

グループ情報が単一またはグループIDの昇順で複数返却されます。

「グループ情報(info_group)」参照