Skip to content

指定ユーザーグループ一覧の取得

説明

指定したユーザーグループの一覧を取得します。

必要権限

なし

URL

GET /system/userGroups/{userGroupId}/subgroups

パスパラメーター

名前 型 必須か 説明
userGroupId string ○ ユーザーグループID

クエリパラメーター

名前 型 必須か 説明
depth int × ツリーで取得する階層
includeDeleted boolean × 削除済みデータも取得対象とするか

true：削除されたデータを含めて取得します。
false：削除されていないデータのみを取得します。
isDeleted boolean × includeDeleted =trueのとき有効とします。

true：削除されたデータのみを取得します。
false：削除されていないデータのみを取得します。

レスポンス

名前 型 説明
ー UserGroup ユーザーグループの情報

エラーケース

  • なし

特記事項

なし

サンプル

ユーザーグループを指定し、そのユーザーグループおよび配下のユーザーグループを取得する

リクエスト
GET /system/userGroups/65/subGroups?depth=1
レスポンス
200 OK

{
    "privateProjectId":"0",
    "isProjectPrivate":false,
    "subGroups":[
        {
            "privateProjectId":"0",
            "isProjectPrivate":false,
            "subGroups":null,
            "name":"メンバー",
            "englishName":"",
            "code":"",
            "description":"",
            "treePath":"65/1150/",
            "treeDepth":1,
            "displayOrder":0.5,
            "isDeleted":false,
            "metadata":{},
            "id":"1150",
            "createdAt":"2019-01-28T11:47:04Z",
            "createdBy":"21",
            "updatedAt":"2019-02-13T03:12:03Z",
            "updatedBy":"21"
        },
        {
            "privateProjectId":"0",
            "isProjectPrivate":false,
            "subGroups":null,
            "name":"リーダー",
            "englishName":"",
            "code":"",
            "description":"",
            "treePath":"65/1158/",
            "treeDepth":1,
            "displayOrder":0.75,
            "isDeleted":false,
            "metadata":{},
            "id":"1158",
            "createdAt":"2019-02-13T03:14:49Z",
            "createdBy":"21",
            "updatedAt":"2019-02-13T03:14:49Z",
            "updatedBy":"21"
        }
    ],
    "name":"設計チーム",
    "englishName":"",
    "code":"",
    "description":"",
    "treePath":"65/",
    "treeDepth":0,
    "displayOrder":0.071428571428571425,
    "isDeleted":false,
    "metadata":{},
    "id":"65",
    "createdAt":"2019-01-10T09:13:08Z",
    "createdBy":"21",
    "updatedAt":"2019-01-10T09:13:44Z",
    "updatedBy":"21"
}

型定義

UserGroup

名前 型 説明
id string ユーザーグループID
name string ユーザーグループ名
englishName string ユーザーグループの英語名
code string ユーザーグループのコード
description string ユーザーグループの説明
treePath string ツリーパス
treeDepth int ツリーの深さ
isProjectPrivate boolean プロジェクトグループか
true：プロジェクトで作成したユーザーグループ
false：システムで作成したユーザーグループ
privateProjectId string 所属するプロジェクトID
subGroups UserGroup[] 保持しているサブグループ情報一覧
displayOrder double ユーザーグループの表示順。
UIで表示する際の表示順序を示します。
isDeleted boolean 削除されているか
createdAt DateTime 作成日時
createdBy string 作成者のユーザーID
updatedAt DateTime 更新日時
updatedBy string 更新者のユーザーID