工程分類一覧の取得
説明
工程分類の一覧を取得します。
必要権限
なし
URL
GET /system/processCategories
クエリパラメーター
名前 | 型 | 必須か | 説明 |
---|---|---|---|
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 | ProcessCategory[] | 取得した工程分類の情報 |
エラーケース
- なし
特記事項
なし
サンプル
有効な工程分類を一覧で取得する
リクエスト
GET /system/processCategories
レスポンス
200 OK { "totalCount":10, "data":[ { "name":"要求分析", "description":"", "code":"RD", "color":"", "displayOrder":0.0625, "groupId":"1", "isDeleted":false, "id":"5", "createdAt":"2019-01-10T07:29:22Z", "createdBy":"0", "updatedAt":"2019-01-10T08:54:23Z", "updatedBy":"21" }, { "name":"外部仕様設計", "description":"", "code":"D0", "color":"", "displayOrder":0.1875, "groupId":"1", "isDeleted":false, "id":"2", "createdAt":"2019-01-10T07:29:22Z", "createdBy":"0", "updatedAt":"2019-01-10T07:29:22Z", "updatedBy":"0" }, { "name":"基本設計", "description":"", "code":"D1", "color":"", "displayOrder":0.4375, "groupId":"1", "isDeleted":false, "id":"6", "createdAt":"2019-01-10T07:29:22Z", "createdBy":"0", "updatedAt":"2019-01-10T07:29:22Z", "updatedBy":"0" }, . . . ] }
型定義
ProcessCategory
名前 | 型 | 説明 |
---|---|---|
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 |