システムロールの一覧取得

説明

システムロールの一覧を取得します。

必要権限

なし

URL

GET /system/systemRoles

クエリパラメーター

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

レスポンス

名前	型	説明
totalCount	int	検索条件に該当するシステムロールの総数
data	SystemRole[]	取得したシステムロール情報

エラーケース

なし

特記事項

なし

サンプル

有効なシステムロールを一覧で取得する

リクエスト

GET /system/systemRoles

レスポンス

200 OK

{
    "totalCount":14,
    "data":[
        {
            "name":"システム管理者",
            "description":"",
            "login":"Allow",
            "admin":"Allow",
            "createProject":"Allow",
            "editAccountSetting":"Allow",
            "editUserSecuritySetting":"Allow",
            "workItemList":"Allow",
            "multiProject":"Allow",
            "viewCost":"Allow",
            "manageProject":"Allow",
            "manageProjectScope":"All",
            "editProject":"Allow",
            "editProjectScope":"All",
            "browseProject":"Allow",
            "browseProjectScope":"All",
            "editTimeSheet":"Allow",
            "editTimeSheetScope":"All",
            "browseTimeSheet":"Allow",
            "browseTimeSheetScope":"All",
            "dashboard":"Allow",
            "dashboardScope":"All",
            "exportActualTime":"Allow",
            "exportActualTimeScope":"All",
            "pivot":"Allow",
            "pivotScope":"All",
            "workLoad":"Allow",
            "workLoadScope":"All",
            "isDeleted":false,
            "displayOrder":0.0,
            "id":"1",
            "createdAt":"2019-01-10T07:29:19Z",
            "createdBy":"0",
            "updatedAt":"2019-01-10T07:29:19Z",
            "updatedBy":"0"
        },
        {
            "name":"部長",
            "description":"",
            "login":"Allow",
            "admin":"Allow",
            "createProject":"Allow",
            "editAccountSetting":"Allow",
            "editUserSecuritySetting":"Deny",
            "workItemList":"Allow",
            "multiProject":"Allow",
            "viewCost":"Allow",
            "manageProject":"Allow",
            "manageProjectScope":"All",
            "editProject":"Allow",
            "editProjectScope":"All",
            "browseProject":"Allow",
            "browseProjectScope":"All",
            "editTimeSheet":"Allow",
            "editTimeSheetScope":"All",
            "browseTimeSheet":"Allow",
            "browseTimeSheetScope":"All",
            "dashboard":"Allow",
            "dashboardScope":"All",
            "exportActualTime":"Allow",
            "exportActualTimeScope":"All",
            "pivot":"Deny",
            "pivotScope":"Me",
            "workLoad":"Allow",
            "workLoadScope":"All",
            "isDeleted":false,
            "displayOrder":0.0,
            "id":"58",
            "createdAt":"2019-01-10T08:43:51Z",
            "createdBy":"21",
            "updatedAt":"2019-01-10T22:55:12Z",
            "updatedBy":"21"
        },
        .
        .
        .
    ]
}

型定義

SystemRole

名前	型	説明
id	string	ID
name	string	名前
description	string	説明
login	PermissionType	ログイン権限
admin	PermissionType	システム管理者権限
createProject	PermissionType	プロジェクト作成権限
editAccountSetting	PermissionType	アカウント設定の変更権限
editUserSecuritySetting	PermissionType	ユーザーのセキュリティ設定の変更権限
workItemList	PermissionType	ワークアイテムリスト権限
multiProject	PermissionType	プロジェクト横断権限
viewCost	PermissionType	コスト表示権限
manageProject	PermissionType	プロジェクト管理権限
manageProjectScope	AccessScopeType	プロジェクト管理権限範囲
editProject	PermissionType	プロジェクト編集権限
editProjectScope	AccessScopeType	プロジェクト編集権限範囲
browseProject	PermissionType	プロジェクト閲覧権限
browseProjectScope	AccessScopeType	プロジェクト閲覧権限範囲
editTimeSheet	PermissionType	タイムシート編集権限
editTimeSheetScope	AccessScopeType	タイムシート編集権限範囲
browseTimeSheet	PermissionType	タイムシート閲覧権限
browseTimeSheetScope	AccessScopeType	タイムシート閲覧権限範囲
dashboard	PermissionType	ダッシュボード権限
dashboardScope	AccessScopeType	ダッシュボード権限範囲
exportActualTime	PermissionType	実績エクスポート権限
exportActualTimeScope	AccessScopeType	実績エクスポート権限範囲
pivot	PermissionType	ピボット分析権限
pivotScope	AccessScopeType	ピボット分析権限範囲
workLoad	PermissionType	リソース負荷権限
workLoadScope	AccessScopeType	リソース負荷権限範囲
displayOrder	double	システムロールの表示順。 UIで表示する際の表示順序を示します。
isDeleted	boolean	削除されているか
createdAt	DateTime	作成日時
createdBy	string	作成者のユーザーID
updatedAt	DateTime	更新日時
updatedBy	string	更新者のユーザーID

PermissionType(列挙型)

名前	説明
None	権限未設定
Allow	許可
Deny	拒否

AccessScopeType(列挙型)

名前	説明
None	未設定
IndividualProject	個々のプロジェクトで設定
Me	自分
ManagerProject	管理者のプロジェクト
MemberProject	メンバーのプロジェクト
UnderOrganization	組織配下
All	すべて