ワークアイテムの追加
プロジェクトのID({projectId}
)と追加対象の親のワークアイテムのID({workitemId}
)が既知とすると、以下のようになります。
プロジェクトのプロファイルを取得
プロジェクトのプロファイルを取得します。includes
パラメータに ItemTypes
,FieldTypes
,StatusTypes
を指定します。
GET /api/project/projects/{projectId}/profile?includes=ItemTypes,FieldTypes,StatusTypes
アイテムタイプ一覧の取得
取得したプロファイルの ItemTypes
フィールドからプロジェクトで利用可能なアイテムタイプの一覧が取得できます。
その中から使用するアイテムタイプのIDを取得します(SystemName
が Task
なもの、など)
ワークアイテムの追加
リクエストボディの fields パラメータに、以下のようにキー・バリューのオブジェクト(ディクショナリ)を指定して、
ワークアイテムの追加のAPIを実行します。
POST /api/workitem/workitems/{workitemId}/subitems
Request Body
{
"fields": {
"Name": "タスク",
"ItemTypeId": "3"
}
}
備考
- 最低限、
Name
とItemTypeId
は指定する必要があります。 - キーはフィールドのシステム名です。プロジェクトのプロファイルの ItemTypes[].Fields フィールドから、
対象のアイテムタイプで利用可能なフィールドのIDが取得できます。 - フィールドのシステム名はプロジェクトのプロファイルの FieldTypes フィールドから取得できます。
- fieldsのパラメータ名は「ワークアイテムAPIのフィールドについて」を参照ください。