最新プロファイルの一覧取得
説明
最新のプロファイルの一覧を取得します。
最新のプロファイルとは
プロファイル番号毎で有効なプロファイルのうち、リビジョン(revision)の値が最も大きいプロファイルを指します。
必要権限
なし
URL
GET /system/profiles/latest
パスパラメーター
なし
クエリパラメーター
名前 | 型 | 必須か | 説明 |
---|---|---|---|
profileNumber | int | × | プロファイル番号 |
profileCategoryId | ProfileCategoryId | × | プロファイルカテゴリID |
isPublished | boolean | × | 公開/非公開で取得対象を決める ・true:公開プロファイル のみ ・false:非公開プロファイルのみ ・指定なし:全てのプロファイル |
isProjectPrivate | boolean | × | プロジェクトプロファイルにより取得対象を決める ・true:プロジェクトプロファイルのみ ・false:システムプロファイルのみ ・指定なし:全てのプロファイルを取得 |
keyword | string | × | キーワード 以下のフィールドに指定したキーワードを持つプロファイルを取得します。 ・名前 ・コード |
システムプロファイル/プロジェクトプロファイル の違い
- システムプロファイル:システム管理画面で定義したプロファイル
- プロジェクトプロファイル:プロジェクトが持つプロファイル
レスポンス
名前 | 型 | 説明 |
---|---|---|
totalCount | int | 検索条件に該当するプロファイルの総数 |
data | Profile[] | 取得したプロファイル |
エラーケース
なし
サンプル
公開されたプロファイルの一覧を最新のリビジョンで取得する
GET /system/profiles/latest?isPublished=true
Response
200 OK
{
"totalCount":5,
"data":[
{
"name":"デフォルトのプロファイル",
"versionName":"",
"code":"",
"description":"",
"profileNumber":"1",
"revision":3,
"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":4,
"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
プロファイル型の定義は、次のリンクを参照ください。: 「Profile」