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

---

説明

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

必要権限

なし

URL

GET /system/userGroups

クエリパラメーター

名前	型	必須か	説明
name	string	×	名前
englishName	string	×	英語名
code	string	×	コード
keyword	string	×	キーワード 以下のフィールドに指定したキーワードを持つユーザーグループが取得されます。 ・名前 ・英語名 ・コード
depth	int	×	取得する階層の深さ
includeDeleted	boolean	×	削除済みデータも取得対象とするか true：削除されたデータを含めて取得します。 false：削除されていないデータのみを取得します。
isDeleted	boolean	×	includeDeleted =trueのとき有効とします。 true：削除されたデータのみを取得します。 false：削除されていないデータのみを取得します。
limit	int	×	データの最大取得件数
offset	int	×	何件目のデータから取得するか 省略した場合の既定値は 0 で先頭のデータから取得します。
orderby	string	×	並び替えに用いるフィールド フィールド名の後の空白に続けて以下を指定することで、並び替えの順序指定ができます。 asc：昇順（既定値） desc：降順

レスポンス

名前	型	説明
totalCount	int	検索条件に該当するユーザーグループの総数
data	UserGroup[]	取得したユーザーグループ一覧情報

エラーケース

• なし

特記事項

なし

サンプル

有効なユーザーグループを一覧で取得する

GET /system/userGroups

Response

200 OK

{
    "totalCount":7,
    "data":[
        {
            "privateProjectId":"6",
            "isProjectPrivate":true,
            "subGroups":null,
            "name":"設計チーム",
            "englishName":"",
            "code":"",
            "description":"",
            "treePath":"48/",
            "treeDepth":0,
            "displayOrder":0.2857142857142857,
            "isDeleted":false,
            "id":"48",
            "createdAt":"2019-01-10T08:38:16Z",
            "createdBy":"21",
            "updatedAt":"2019-01-10T08:38:16Z",
            "updatedBy":"21"
        },
        {
            "privateProjectId":"6",
            "isProjectPrivate":true,
            "subGroups":null,
            "name":"実装チーム",
            "englishName":"",
            "code":"",
            "description":"",
            "treePath":"49/",
            "treeDepth":0,
            "displayOrder":0.42857142857142855,
            "isDeleted":false,
            "id":"49",
            "createdAt":"2019-01-10T08:38:16Z",
            "createdBy":"21",
            "updatedAt":"2019-01-10T08:38:16Z",
            "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