Skip to content

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

説明

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

必要権限

なし

URL

GET /system/projectCategories

クエリパラメーター

名前 型 必須か 説明
name string × プロジェクトカテゴリ名
code string × プロジェクトカテゴリのコード
systemName string × プロジェクトカテゴリのシステム名
keyword string × キーワード

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

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

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

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

レスポンス

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

エラーケース

特記事項

なし

サンプル

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

リクエスト
GET /system/projectCategories
レスポンス
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

名前 型 説明
id string
name string 名前
code string コード
description string 説明
systemName string システム名
allowedValues string 設定許可値
allowGrouping double グループ化可能か。
falseの場合はプロジェクト一覧などのプロジェクトカテゴリを表示する画面にて、該当のプロジェクトカテゴリを非表示とします。
displayOrder double プロジェクトカテゴリの表示順序。
UIで表示する際の表示順序を示します。
isDeleted boolean 削除されているか
createdAt DateTime 作成日時
createdBy string 作成者のユーザーID
updatedAt DateTime 更新日時
updatedBy string 更新者のユーザーID