プロファイルの一覧取得

説明

プロファイルの一覧を取得します。

必要権限

なし

URL

GET /system/profiles

クエリパラメーター

名前	型	必須か	説明
name	string	×	プロファイル名
code	string	×	プロファイルのコード
keyword	string	×	キーワード以下のフィールドに指定したキーワードを持つプロファイルを取得します。・名前・コード
isProjectPrivate	boolean	×	プロジェクトプロファイルのみ取得するか true：プロジェクトプロファイルのみを取得します。 false：システムプロファイルのみを取得します。指定なし：全てのプロファイルを取得します。
privateProjectId	string	×	所属するプロジェクトのID
profileCategoryId	string	×	プロファイルカテゴリID
isPublished	boolean	×	公開されたプロファイルのみを取得するか true：公開されたプロファイルのみを取得します。 false：非公開のプロファイルのみを取得します。指定なし：全てのプロファイルを取得します。
includeDeleted	boolean	×	削除済みデータも取得対象とするか true：削除されたデータを含めて取得します。 false：削除されていないデータのみを取得します。
isDeleted	boolean	×	includeDeleted =trueのとき有効とします。 true：削除されたデータのみを取得します。 false：削除されていないデータのみを取得します。
limit	int	×	データの最大取得件数
offset	int	×	何件目のデータから取得するか省略した場合の既定値は 0 で先頭のデータから取得します。
orderby	string	×	並び替えに用いるフィールドフィールド名の後の空白に続けて以下を指定することで、並び替えの順序指定ができます。 asc：昇順（既定値） desc：降順

レスポンス

名前	型	説明
totalCount	int	検索条件に該当するプロファイルの総数
data	Profile[]	取得したプロファイル

エラーケース

なし

特記事項

なし

サンプル

公開されているプロファイルを一覧で取得する

リクエスト

GET /system/profiles?isPublished=true

レスポンス

200 OK

{
    "totalCount":5,
    "data":[
        {
            "name":"デフォルトのプロファイル",
            "versionName":"",
            "code":"",
            "description":"",
            "profileNumber":"1",
            "revision":1,
            "baseProfileId":"0",
            "baseProfileNumber":"0",
            "baseProfileName":null,
            "isProjectPrivate":false,
            "privateProjectId":"0",
            "isPublished":true,
            "profileCategoryId":"1",
            "profileCategoryName":"デフォルトのカテゴリ",
            "isDeleted":false,
            "timeEntryCategoryRequiredInTimeEntry":false,
            "processCategoryRequiredInTimeEntry":false,
            "lastBaseAppliedAt":null,
            "id":"1",
            "createdAt":"2019-01-10T07:29:19Z",
            "createdBy":"0",
            "updatedAt":"2019-01-10T07:29:19Z",
            "updatedBy":"0"
        },
        {
            "name":"事業部共通のプロファイル",
            "versionName":"",
            "code":"",
            "description":"事業部のプロジェクトが作成時に利用するプロファイル",
            "profileNumber":"26",
            "revision":1,
            "baseProfileId":"0",
            "baseProfileNumber":"0",
            "baseProfileName":null,
            "isProjectPrivate":false,
            "privateProjectId":"0",
            "isPublished":true,
            "profileCategoryId":"0",
            "profileCategoryName":null,
            "isDeleted":false,
            "timeEntryCategoryRequiredInTimeEntry":false,
            "processCategoryRequiredInTimeEntry":false,
            "lastBaseAppliedAt":null,
            "id":"26",
            "createdAt":"2019-01-15T10:53:32Z",
            "createdBy":"15",
            "updatedAt":"2019-01-15T11:03:31Z",
            "updatedBy":"15"
        },
        .
        .
        .
    ]
}

型定義

Profile

名前	型	説明
id	string	プロファイルID
name	string	プロファイル名
versionName	string	バージョン名
code	string	プロファイルのコード
description	string	プロファイルの説明
baseProfileId	string	継承元プロファイルID
baseProfileName	string	継承元プロファイル名
isProjectPrivate	boolean	プロジェクトプロファイルか
privateProjectId	string	所属するプロジェクトのID(プロジェクトプロファイルのみ有効)
isPublished	boolean	公開状態 true：公開 false：非公開
timeEntryCategoryRequiredInTimeEntry	boolean	実績入力時に作業分類の設定を必要とするか。 trueの場合、タイムシートで作業分類の設定が必要になります。
processCategoryRequiredInTimeEntry	boolean	実績入力時に工程分類の設定を必要とするか。 trueの場合、タイムシートで工程分類の設定が必要になります。
isDeleted	boolean	削除されているか
createdAt	DateTime	作成日時
createdBy	string	作成者のユーザーID
updatedAt	DateTime	更新日時
updatedBy	string	更新者のユーザーID