Skip to content

アイテムタイプ一覧の取得

説明

アイテムタイプの一覧を取得します。

必要権限

なし

URL

GET /system/itemTypes

クエリパラメーター

名前 必須か 説明
name string × 名前
systemName string × システム名
code string × コード
keyword string × キーワード

以下のフィールドに指定したキーワードを持つアイテムタイプが取得されます。
・名前
・システム名
・コード
isSystemItemType boolean × true:システムのアイテムタイプのみを取得対象とします。
false:カスタムのアイテムタイプのみを取得対象とします。
指定なし:このフィルタを適用しません。
includeDeleted boolean × 削除済みデータも取得対象とするか

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

true:削除されたデータのみを取得します。
false:削除されていないデータのみを取得します。
limit int × データの最大取得件数
offset int × 何件目のデータから取得するか

省略した場合の既定値は 0 で先頭のデータから取得します。
orderby string × 並び替えに用いるフィールド

フィールド名の後の空白に続けて以下を指定することで、並び替えの順序指定ができます。
asc:昇順(既定値)
desc:降順

レスポンス

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

エラーケース

  • なし

特記事項

なし

サンプル

ユーザーが利用できるカスタムのアイテムタイプを一覧で取得する

リクエスト
GET /system/itemTypes?isSystemItemType=false
レスポンス
200 OK

{
    "totalCount":2,
    "data":[
        {
            "name":"タスク",
            "systemName":"Task",
            "baseType":"Task",
            "itemTypeCategory":"WorkItem",
            "isFolder":false,
            "isContentType":false,
            "canInputTimeEntry":true,
            "color":"",
            "iconName":"clipboard",
            "displayOrder":0.5,
            "code":"",
            "description":"",
            "isDeleted":false,
            "isSystemItemType":false,
            "id":"3",
            "createdAt":"2019-01-10T07:29:19Z",
            "createdBy":"0",
            "updatedAt":"2019-01-10T07:29:19Z",
            "updatedBy":"0"
        },
        {
            "name":"パッケージ",
            "systemName":"Package",
            "baseType":"Task",
            "itemTypeCategory":"WorkItem",
            "isFolder":true,
            "isContentType":false,
            "canInputTimeEntry":false,
            "color":"",
            "iconName":"folder",
            "displayOrder":0.666666666666667,
            "code":"",
            "description":"",
            "isDeleted":false,
            "isSystemItemType":false,
            "id":"4",
            "createdAt":"2019-01-10T07:29:19Z",
            "createdBy":"0",
            "updatedAt":"2019-01-10T07:29:19Z",
            "updatedBy":"0"
        }
    ]
}

型定義

ItemType

名前 説明
id string アイテムタイプID
name string 名前
systemName string システム名
code string コード
description string 説明
color Color アイテムタイプの色
iconName string アイコン名

isSystemItemType boolean システムのアイテムタイプか
isFolder boolean このアイテムタイプがフォルダか
canInputTimeEntry boolean 実績入力できるか
displayOrder double アイテムタイプの表示順。
UIで表示する際の表示順序を示します。
isDeleted boolean 削除されているか
createdAt DateTime 作成日時
createdBy string 作成者のユーザーID
updatedAt DateTime 更新日時
updatedBy string 更新者のユーザーID