作業分類一覧の取得

説明

作業分類の一覧を取得します。

必要権限

なし

URL

GET /system/timeEntryCategories

クエリパラメーター

名前	型	必須か	説明
name	string	×	名前
code	string	×	コード
keyword	string	×	キーワード 以下のフィールドに指定したキーワードを持つ作業分類を取得します。 ・名前 ・コード
limit	int	×	データの最大取得件数
offset	int	×	何件目のデータから取得するか 省略した場合の既定値は 0 で先頭のデータから取得します。
orderby	string	×	並び替えに用いるフィールド フィールド名の後の空白に続けて以下を指定することで、並び替えの順序指定ができます。 asc：昇順（既定値） desc：降順
includeDeleted	boolean	×	削除済みデータも取得対象とするか true：削除されたデータを含めて取得します。 false：削除されていないデータのみを取得します。
isDeleted	boolean	×	includeDeleted =trueのとき有効とします。 true：削除されたデータのみを取得します。 false：削除されていないデータのみを取得します。

レスポンス

名前	型	説明
totalCount	int	検索条件に該当する作業分類の総数
data	TimeEntryCategory[]	取得した作業分類の情報

エラーケース

• なし

特記事項

なし

サンプル

有効な作業分類を一覧で取得する

リクエスト

GET /system/timeentrycategories

レスポンス

200 OK

{
    "totalCount":6,
    "data":[
        {
            "name":"作業",
            "code":"W",
            "color":"",
            "description":"",
            "displayOrder":0.125,
            "groupId":"1",
            "isDeleted":false,
            "id":"1",
            "createdAt":"2019-01-10T07:29:22Z",
            "createdBy":"0",
            "updatedAt":"2019-01-10T07:29:22Z",
            "updatedBy":"0"
        },
        {
            "name":"レビュー",
            "code":"R",
            "color":"",
            "description":"",
            "displayOrder":0.25,
            "groupId":"1",
            "isDeleted":false,
            "id":"2",
            "createdAt":"2019-01-10T07:29:22Z",
            "createdBy":"0",
            "updatedAt":"2019-01-10T07:29:22Z",
            "updatedBy":"0"
        },
        {
            "name":"手戻り",
            "code":"F",
            "color":"",
            "description":"",
            "displayOrder":0.21875,
            "groupId":"1",
            "isDeleted":false,
            "id":"3",
            "createdAt":"2019-01-10T07:29:22Z",
            "createdBy":"0",
            "updatedAt":"2019-01-10T08:53:19Z",
            "updatedBy":"21"
        },
        .
        .
        .
    ]
}

型定義

TimeEntryCategory

名前	型	説明
id	string	ID
name	string	名前
description	string	説明
code	string	コード
color	Color	色
groupId	string	グループID
displayOrder	double	作業分類の表示順。 UIで表示する際の表示順序を示します。
isDeleted	boolean	削除されているか
createdAt	DateTime	作成日時
createdBy	string	作成者のユーザーID
updatedAt	DateTime	更新日時
updatedBy	string	更新者のユーザーID