ワークアイテムAPIのフィールドについて

ワークアイテムAPIにおけるフィールドの詳細情報について紹介します。

操作可能なフィールドの一覧

ワークアイテムの取得・追加・更新のAPIでは、対象となるフィールドを fields パラメーターにより指定します。既定のフィールド（システムフィールド）とともに、カスタムフィールドも取得・追加・更新の操作で指定が可能です。指定可能なフィールドは、システムフィールドおよびプロファイルで設定されたカスタムフィールドです。

システムフィールド一覧

各システムフィールドについて、操作可能な処理と値域を以下に示します。

名前	システム名	取得	追加	更新	型	値域	既定値	備考
ID	Id	○	-	-	WorkItemId	-	-
プロジェクト	ProjectId	○	-	-	ProjectId	-	-
プロジェクト名	ProjectName	○	-	-	string	-	-	-
プロジェクトコード	ProjectCode	○	-	-	string	-	-
アイテムタイプ	ItemTypeId	○	●	-	ItemTypeId	プロジェクトで利用可能なアイテムタイプのID	-	更新時は changeItemTypeTo パラメーターを使用、itemType 指定時は未指定可
ステータス	StatusTypeId	○	○	○	StatusTypeId	ワークアイテムのアイテムタイプで利用可能なステータスタイプのID	プロファイルの初期ステータス
フォルダ	FolderId	○	-	-	WorkItemId	-	-
フォルダ名	FolderName	○	-	-	string	-	-
親アイテム	ParentId	○	-	-	WorkItemId	-	-	更新時は moveParentTo パラメーターを使用
親アイテム名	ParentName	○	-	-	string	-	-	更新時は moveParentTo パラメーターを使用
工程分類	ProcessCategoryId	○	○	○	ProcessCategoryId	ワークアイテムのアイテムタイプで利用可能な工程分類のID	0 (未設定)
作業分類	TimeEntryCategoryId	○	○	○	TimeEntryCategoryId	ワークアイテムのアイテムタイプで利用可能な作業分類のID	0 (未設定)
名前	Name	○	●	○	string	1~256文字	-
コード	Code	○	○	○	string	0~256文字	空文字
説明	Description	○	○	○	string	-	空文字
アイテム番号	ItemNumber	○	-	-	string	-	-
ツリーパス	TreePath	○	-	-	string	-	-
色	Color	○	○	○	string	#000000~#FFFFFF (空文字＝色なし)	空文字
表示順序	DisplayOrder	○	-	-	double	0.0~1.0	-
進捗率	ActualProgress	○	○	○	double	0~100 (255=N/A) ※「N/A」・・・「進捗を管理しない」ワークアイテムを示す	0
進捗率の決定方法	ProgressCalcType	○	-	-	FieldCalcType	-	-	更新時は fieldCalcTypes パラメーターで ActualProgress を指定
開始日	PlannedStartDate	○	○	○	date	1753/1/1~4712/12/31 (値のクリアには clearSchedule パラメーターを使用)	null
終了日	PlannedFinishDate	○	○	○	date	1753/1/1~4712/12/31 (値のクリアには clearSchedule パラメーターを使用)	null
マイルストーンか	IsMilestone	○	○	○	boolean	-	false
計画工数	PlannedTime	○	○	○	int	0~2147483640	0	分単位で指定
実績工数	ActualTime	○	-	-	int	-	-
実績開始日	ActualStartDate	○	-	-	date	-	-
実績終了日	ActualFinishDate	○	-	-	date	-	-
残り作業時間	RemainingTime	○	○	○	int	0~2147483640	0
計画コスト	PlannedCost	○	○	○	double	0~999,999,999,999,999	0
実績コスト	ActualCost	○	○	○	double	0~999,999,999,999,999	0
計画成果量	OutputScalePlan	○	○	○	int	0~2147483640	0
実績成果量	OutputScaleActual	○	○	○	int	0~2147483640	0
規模単位	OutputUnit	○	○	○	string	-	空文字
成果物情報	OutputInfo	○	○	○	string	-	空文字
リーダー	LeaderId	○	○	○	UserId	プロジェクトメンバーのユーザーID	0 (未設定)
期間が固定されているか	IsPlannedDateFixed	○	○	○	boolean	-	false
実績入力がロックされているか	IsTimeEntryLocked	○	○	-	boolean	-	-	更新時は setTimeEntryLocked パラメーターを使用
チェックアイテム	CheckItems	○	○	○	CheckItem	-	null
割り当て	Assignments	○	-	-	Assignment[]	-	null	追加時は assignments パラメーター、更新時は assignmentChange パラメーターを使用
子アイテムの開始日	PlannedStartDateOfChildren	○	-	-	date	-	-
子アイテムの終了日	PlannedFinishDateOfChildren	○	-	-	date	-	-
子アイテムの計画工数	PlannedTimeOfChildren	○	-	-	int	-	-
子アイテムの実績工数	ActualTimeOfChildren	○	-	-	int	-	-
子アイテムの計画コスト	PlannedCostOfChildren	○	-	-	double	-	-
子アイテムの実績コスト	ActualCostOfChildren	○	-	-	double	-	-
完了日	FinishDate	○	○	○	date	1753/1/1~4712/12/31 (空文字を指定すると値がクリアされ、null になる)	null
ツリーの深さ	TreeDepth	○	-	-	int	0~16	-
フォルダか	IsFolder	○	-	-	boolean	-	-
サブアイテムがあるか	HasSubItem	○	-	-	boolean	-	-
サブフォルダがあるか	HasSubFolder	○	-	-	boolean	-	-
稼働日数	WorkingDayCount	○	-	-	int	-	-
計画進捗率	PlannedProgress	○	-	-	double	-	-
スケジュール指標	SPI	○	-	-	double	-	-
工数指標	TPI	○	-	-	double	-	-
コスト指標	CPI	○	-	-	double	-	-
遅れ期間	SV	○	-	-	int	-	-
遅れ工数	TV	○	-	-	int	-	-
遅れコスト	CV	○	-	-	double	-	-
最終予測遅れ期間	SVAC	○	-	-	int	-	-
最終予測遅れ工数	TVAC	○	-	-	int	-	-
最終予測遅れコスト	CVAC	○	-	-	double	-	-
最終予測完了日	EstimatedFinishDate	○	-	-	date	-	-
最終予測工数	EstimatedFinalTime	○	-	-	int	-	-
最終予測コスト	EstimatedFinalCost	○	-	-	double	-	-
管理対象の計画工数	ManagedPlannedTime	○	-	-	int	-	-
管理対象の実績工数	ManagedActualTime	○	-	-	int	-	-
削除されているか	IsDeleted	○	-	-	boolean	-	-
作成日時	CreatedAt	○	-	-	date	-	-
作成者	CreatedBy	○	-	-	UserId	-	-
更新日時	UpdatedAt	○	-	-	date	-	-
更新者	UpdatedBy	○	-	-	UserId	-	-

Note

「取得」列： ○のフィールドが指定可能です。

Note

「追加」「更新」列： ●は必須、○は任意の指定フィールドであることを意味します。

名前によるワークアイテムの追加・更新

ワークアイテムの追加・更新のAPIでは、ID型のフィールドに対して、IDに加え名前でも値を指定可能です。名前で値を指定する場合、基本的にフィールド名はシステム名の末尾から Idを除去した名前で指定します。 IDと名前の両方が指定された場合は、IDの指定を優先します。以下に詳細を示します。

対象API

POST /workitem/workItems
POST /workitem/workItems/{workItemId}/subItems
PUT /workitem/workItems/{workItemIds}

対象パラメータ

名前	追加	更新	対象フィールド
ItemType	○	-	システム名、名前
StatusType	○	○	システム名、名前
Leader	○	○	ログイン名、LDAPログイン名、メールアドレス、名前
ProcessCategory	○	○	コード、名前
TimeEntryCategory	○	○	コード、名前
User	○	○	（ユーザー）ログイン名、LDAPログイン名、メールアドレス、名前、（ユーザーグループ）コード、名前

エラーケース

ステータスコード	エラーコード	エラーメッセージ
400	EntityNotFound	指定された{パラメーター名}は存在しません。

ワークアイテムの取得によりレスポンスに含まれるフィールド

ワークアイテムの取得のAPIでは、取得対象に指定したフィールドをレスポンスに含めて返します。特定のフィールドを取得する場合に、関連するフィールドもレスポンスに含まれます。その関連フィールドについて以下に示します。

対象API

GET /workitem/workItems/{workItemIds}
GET /workitem/workItems/{workItemId}/subItems

レスポンスに含まれるフィールド

名前	型	説明	条件
ItemTypeName	string	アイテムタイプ名	レスポンスに ItemTypeId が含まれる
StatusTypeName	string	ステータスタイプ名	レスポンスに StatusTypeId が含まれる
LeaderName	string	リーダー名	レスポンスに LeaderId が含まれる
Assignments.Name	string	パーティー名	レスポンスに Assignments が含まれる（ユーザーの場合：ユーザー名、プロジェクトグループの場合：ユーザーグループ名）