ステータスタイプ一覧の取得

説明

ステータスタイプの一覧を取得します。

必要権限

なし

URL

GET /system/statusTypes

クエリパラメーター

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

レスポンス

名前	型	説明
totalCount	int	検索条件に該当するステータスタイプの総数
data	StatusType[]	取得したステータスタイプ情報

エラーケース

• なし

特記事項

なし

サンプル

システムで定義されている有効なステータスを一覧で取得する

リクエスト

GET /system/statusTypes

レスポンス

200 OK

{
    "totalCount":3,
    "data":[
        {
            "name":"未着手",
            "color":"#BDBDBD",
            "description":"",
            "displayOrder":0.166666666666667,
            "groupId":"1",
            "isDeleted":false,
            "code":"",
            "id":"1",
            "createdAt":"2019-01-10T07:29:19Z",
            "createdBy":"0",
            "updatedAt":"2019-01-10T07:29:19Z",
            "updatedBy":"0"
        },
        {
            "name":"作業中",
            "color":"#303F9F",
            "description":"",
            "displayOrder":0.333333333333333,
            "groupId":"2",
            "isDeleted":false,
            "code":"",
            "id":"2",
            "createdAt":"2019-01-10T07:29:19Z",
            "createdBy":"0",
            "updatedAt":"2019-01-10T07:29:19Z",
            "updatedBy":"0"
        },
        {
            "name":"完了",
            "color":"#00FF00",
            "description":"",
            "displayOrder":0.5,
            "groupId":"3",
            "isDeleted":false,
            "code":"",
            "id":"3",
            "createdAt":"2019-01-10T07:29:19Z",
            "createdBy":"0",
            "updatedAt":"2019-01-07T00:02:13Z",
            "updatedBy":"21"
        }
    ]
}

型定義

StatusType

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