メインコンテンツまでスキップ

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

説明​

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

必要権限​

なし

URL​

GET /system/userGroups

クエリパラメーター​

名前型必須か説明
namestring×名前
englishNamestring×英語名
codestring×コード
keywordstring×キーワード

以下のフィールドに指定したキーワードを持つユーザーグループが取得されます。
・名前
・英語名
・コード
depthint×取得する階層の深さ
includeDeletedboolean×削除済みデータも取得対象とするか

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

true：削除されたデータのみを取得します。
false：削除されていないデータのみを取得します。
limitint×データの最大取得件数
offsetint×何件目のデータから取得するか

省略した場合の既定値は 0 で先頭のデータから取得します。
orderbystring×並び替えに用いるフィールド

フィールド名の後の空白に続けて以下を指定することで、並び替えの順序指定ができます。
asc：昇順（既定値）
desc：降順

レスポンス​

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

エラーケース​

  • なし

特記事項​

なし

サンプル​

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

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​

名前型説明
idstringユーザーグループID
namestringユーザーグループ名
englishNamestringユーザーグループの英語名
codestringユーザーグループのコード
descriptionstringユーザーグループの説明
treePathstringツリーパス
treeDepthintツリーの深さ
isProjectPrivatebooleanプロジェクトグループか
true：プロジェクトで作成したユーザーグループ
false：システムで作成したユーザーグループ
privateProjectIdstring所属するプロジェクトID
subGroupsUserGroup[]保持しているサブグループ情報一覧
displayOrderdoubleユーザーグループの表示順。
UIで表示する際の表示順序を示します。
isDeletedboolean削除されているか
createdAtDateTime作成日時
createdBystring作成者のユーザーID
updatedAtDateTime更新日時
updatedBystring更新者のユーザーID
に最終更新