Skip to content

フィールドタイプ一覧の取得

説明

フィールドタイプの一覧を取得します。

必要権限

なし

URL

GET /system/fieldTypes

クエリパラメーター

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

以下のフィールドに指定したキーワードを持つフィールドタイプが取得されます。
・名前
・システム名
・コード
isSystemField 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 FieldType[] 取得したフィールドタイプ情報

エラーケース

  • なし

特記事項

なし

サンプル

システムで定義されているカスタムフィールドを一覧で取得する

リクエスト
GET /system/fieldTypes
レスポンス
200 OK

{
    "totalCount":88,
    "data":[
        {
            "name":"アクティビティ1",
            "systemName":"Activity1",
            "code":"",
            "dataType":"DTSingleLineText",
            "isSystemField":false,
            "description":"",
            "displayOrder":0.142857142857143,
            "isDeleted":false,
            "group":"カスタム",
            "category":"WorkItem",
            "isVisible":true,
            "isCustomizable":true,
            "isQueryable":true,
            "allowedFieldCalcTypes":["UserInput"],
            "fieldCode":"1001",
            "id":"81",
            "createdAt":"2019-01-10T07:29:19Z",
            "createdBy":"0",
            "updatedAt":"2019-01-15T10:08:40Z",
            "updatedBy":"21"
        },
        {
            "name":"アクティビティ2",
            "systemName":"Activity2",
            "code":"",
            "dataType":"DTSingleLineText",
            "isSystemField":false,
            "description":"",
            "displayOrder":0.285714285714286,
            "isDeleted":false,
            "group":"カスタム",
            "category":"WorkItem",
            "isVisible":true,
            "isCustomizable":true,
            "isQueryable":true,
            "allowedFieldCalcTypes":["UserInput"],
            "fieldCode":"1002",
            "id":"82",
            "createdAt":"2019-01-10T07:29:19Z",
            "createdBy":"0",
            "updatedAt":"2019-01-15T10:08:55Z",
            "updatedBy":"21"
        },
        .
        .
        .
    ]
}

型定義

FieldType

名前 型 説明
id string フィールドタイプID
name string 名前
systemName string システム名
code string コード
description string 説明
group string グループ
dataType DataType データ型
allowedFieldCalcTypes FieldCalcType[] 設定可能なフィールドの決定方法
isSystemField boolean true：システムフィールド
false：カスタムフィールド
displayOrder double フィールドの表示順。
UIで表示する際の表示順序を示します。
isDeleted boolean 削除されているか
createdAt DateTime 作成日時
createdBy string 作成者のユーザーID
updatedAt DateTime 更新日時
updatedBy string 更新者のユーザーID

DataType(列挙型)

名前 説明
DTSingleLineText 単一行テキスト
DTMultiLineText 複数行テキスト
DTInt 整数
DTDouble 実数
DTDate 日付
DTBool 論理値
DTColor カラー
DTCost コスト
DTProgress 進捗率
DTTimeValue 工数
DTDocumentSize 成果量
DTUser ユーザー
DTProject プロジェクト
DTItem アイテム
DTStatusType ステータスタイプ
DTItemType アイテムタイプ
DTProcessCategory 工程分類
DTTimeEntryCategory 作業分類
DTObject オブジェクト

FieldCalcType(列挙型)

名前 説明
None 無効値
UserInput ユーザー入力
Sum 合計
Average 平均
Max 最大
Min 最小
And 論理積
Or 論理和
Count 個数
ProgressNA 進捗管理なし
ProgressOutputScale 規模進捗
ProgressWeightedAverage 加重平均
ProgressRemainingTime 進捗率(残作業時間)
Auto 自動計算
Expression 計算式