ワークアイテムAPIのフィールドについて
ワークアイテムAPIにおけるフィールドの詳細情報について紹介します。
操作可能なフィールドの一覧
ワークアイテムの取得・追加・更新のAPIでは、対象となるフィールドを fields パラメーターにより指定します。
既定のフィールド（システムフィールド）とともに、カスタムフィールドも取得・追加・更新の操作で指定が可能です。
指定可能なフィールドは、システムフィールドおよびプロファイルで設定されたカスタムフィールドです。
システムフィールド一覧
各システムフィールドについて、操作可能な処理と値域は以下のファイルをご参照ください。
■ダウンロードファイル
[Fieldlist.xlsx]
■ファイルイメージ
名前によるワークアイテムの追加・更新
ワークアイテムの追加・更新の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 が含まれる（ユーザーの場合：ユーザー名、プロジェクトグループの場合：ユーザーグループ名） |