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

プロジェクトカテゴリ一覧の取得

説明​

プロジェクトカテゴリの一覧を取得します。

必要権限​

なし

URL​

GET /system/projectCategories

クエリパラメーター​

名前型必須か説明
namestring×プロジェクトカテゴリ名
codestring×プロジェクトカテゴリのコード
systemNamestring×プロジェクトカテゴリのシステム名
keywordstring×キーワード

以下のフィールドに指定したキーワードを持つプロジェクトカテゴリを取得します。
・名前
・コード
・システム名
allowGroupingboolean×グループ化可能か。
falseの場合はプロジェクト一覧などのプロジェクトカテゴリを表示する画面にて、該当のプロジェクトカテゴリを非表示とします。
orderbystring×並び替えに用いるフィールド

フィールド名の後の空白に続けて以下を指定することで、並び替えの順序指定ができます。
asc：昇順（既定値）
desc：降順
includeDeletedboolean×削除済みデータも取得対象とするか

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

true：削除されたデータのみを取得します。
false：削除されていないデータのみを取得します。

レスポンス​

名前型説明
ーProjectCategory[]条件に一致するプロジェクトカテゴリ

エラーケース​

特記事項​

なし

サンプル​

有効なプロジェクトカテゴリを一覧で取得する​

GET /system/projectCategories
Response
200 OK

[
    {
        "name":"顧客",
        "systemName":"ProjectCategory1",
        "code":"",
        "description":"",
        "allowedValues":"A社,B社,C社",
        "allowGrouping":true,
        "displayOrder":0.5,
        "isDeleted":false,
        "id":"1",
        "createdAt":"2019-01-30T02:51:42Z",
        "createdBy":"21",
        "updatedAt":"2019-01-30T02:51:42Z",
        "updatedBy":"21"
    },
    {
        "name":"業務分野",
        "systemName":"ProjectCategory2",
        "code":"",
        "description":"",
        "allowedValues":"開発,管理,営業,総務",
        "allowGrouping":true,
        "displayOrder":0.75,
        "isDeleted":false,
        "id":"2",
        "createdAt":"2019-01-30T02:52:11Z",
        "createdBy":"21",
        "updatedAt":"2019-01-30T02:52:11Z",
        "updatedBy":"21"
    },
    .
    .
    .
]

型定義​

ProjectCategory​

名前型説明
idstring
namestring名前
codestringコード
descriptionstring説明
systemNamestringシステム名
allowedValuesstring設定許可値
allowGroupingdoubleグループ化可能か。
falseの場合はプロジェクト一覧などのプロジェクトカテゴリを表示する画面にて、該当のプロジェクトカテゴリを非表示とします。
displayOrderdoubleプロジェクトカテゴリの表示順序。
UIで表示する際の表示順序を示します。
isDeletedboolean削除されているか
createdAtDateTime作成日時
createdBystring作成者のユーザーID
updatedAtDateTime更新日時
updatedBystring更新者のユーザーID
に最終更新