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

プロファイル一覧の取得

説明​

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

必要権限​

なし

URL​

GET /system/profiles

クエリパラメーター​

名前型必須か説明
namestring×プロファイル名
codestring×プロファイルのコード
keywordstring×キーワード

以下のフィールドに指定したキーワードを持つプロファイルを取得します。
・名前
・コード
isProjectPrivateboolean×プロジェクトプロファイルのみ取得するか
規定値はNullで指定なしです。

true：プロジェクトプロファイルのみを取得します。
false：システムプロファイルのみを取得します。
指定なし：全てのプロファイルを取得します。
privateProjectIdstring×所属するプロジェクトのID
profileCategoryIdstring×プロファイルカテゴリID
isPublishedboolean×公開されたプロファイルのみを取得するか

true：公開されたプロファイルのみを取得します。
false：非公開のプロファイルのみを取得します。
指定なし：全てのプロファイルを取得します。
includeDeletedboolean×削除済みデータも取得対象とするか

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

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

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

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

レスポンス​

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

エラーケース​

  • なし

特記事項​

なし

サンプル​

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

GET /system/profiles?isPublished=true
Response
200 OK

{
    "totalCount":5,
    "data":[
        {
            "name":"デフォルトのプロファイル",
            "versionName":"",
            "code":"",
            "description":"",
            "profileNumber":"1",
            "revision":1,
            "revisedContent":"",
            "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,
            "revisedContent":"",
            "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​

名前型説明
idstringプロファイルID
namestringプロファイル名
versionNamestringバージョン名
codestringプロファイルのコード
descriptionstringプロファイルの説明
baseProfileIdstring継承元プロファイルID
baseProfileNamestring継承元プロファイル名
profileCategoryIdstringプロファイルカテゴリID
profileCategoryNamestringプロファイルカテゴリ名
revisionint改訂番号
revisedContentstring改訂内容
isProjectPrivatebooleanプロジェクトプロファイルか
privateProjectIdstring所属するプロジェクトのID(プロジェクトプロファイルのみ有効)
isPublishedboolean公開状態

true：公開
false：非公開
timeEntryCategoryRequiredInTimeEntryboolean実績入力時に作業分類の設定を必要とするか。
trueの場合、タイムシートで作業分類の設定が必要になります。
processCategoryRequiredInTimeEntryboolean実績入力時に工程分類の設定を必要とするか。
trueの場合、タイムシートで工程分類の設定が必要になります。
lastBaseAppliedAtDateTime継承元プロファイルの最終反映日時
itemTypeUsesItemTypeUse利用アイテムタイプ
isDeletedboolean削除されているか
createdAtDateTime作成日時
createdBystring作成者のユーザーID
updatedAtDateTime更新日時
updatedBystring更新者のユーザーID
に最終更新