メインコンテンツまでスキップ

指定ワークアイテム一覧の取得

説明​

指定した ID のワークアイテムの一覧を取得します。
取得する fieldsパラメータの詳細は、次のリンクを参照ください。： 「ワークアイテムAPIのフィールドについて」

必要権限​

プロジェクトの閲覧

URL​

GET /workitem/workItems/{workItemId}/subItems

パスパラメーター​

名前型必須か説明
workItemIdstring○ワークアイテムID

クエリパラメーター​

名前型必須か説明
namestring×名前
keywordstring×キーワード

以下のフィールドに指定したキーワードを持つアイテムを取得します。
・アイテム名
・アイテムコード
・アイテム番号
・プロジェクト名
・プロジェクトコード
assignedUserIdsstring×割り当てられているユーザーID
assignedUsersstring×割り当てられているユーザー

ユーザーの「ログイン名」、「LDAPログイン名」、「メールアドレス」、「名前」のいずれかに完全一致するユーザーを割り当てに持つアイテムの検索処理を行います。
plannedStartDateFromDateTime×検索を開始する計画開始日

例：
10/1を指定した場合、10/1以降に開始したアイテムを取得する。
plannedStartDateToDateTime×検索を終了する計画開始日

例：
10/1を指定した場合、10/1までに開始したアイテムを取得する。
plannedFinishDateFromDateTime×検索を開始する計画終了日

例：
10/1を指定した場合、10/1以降に終了するアイテムを取得する。
plannedFinishDateToDateTime×検索を終了する計画終了日

例：
10/1を指定した場合、10/1までに終了するアイテムを取得する。
leaderIdsstring×リーダーID
leadersstring×リーダー

ユーザーの「ログイン名」、「LDAPログイン名」、「メールアドレス」、「名前」のいずれかに完全一致するリーダーを持つアイテムの検索処理を行います。
fieldsstring×取得対象とするフィールドをシステム名のカンマ区切りで指定します。

fieldCalcTypesを指定すると、フィールドの決定方法を取得します。
depthint×取得するアイテムの階層
(ルートフォルダを0とします)
statusTypeIdsstring×ステータスタイプID
statusTypesstring×ステータスタイプ

ステータスタイプの「名前」に完全一致するステータスタイプを持つアイテムの検索処理を行います。
itemTypeIdsstring×アイテムタイプID
itemTypesstring×アイテムタイプ

アイテムタイプの「システム名」、「名前」のいずれかに完全一致するアイテムタイプを持つアイテムの検索処理を行います。
includeDeletedboolean×削除済みデータも取得対象とするか

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

true：削除されたデータのみを取得します。
false：削除されていないデータのみを取得します。

レスポンス​

名前型説明
－WorkItem[]取得したワークアイテム

エラーケース​

  • 存在しない ワークアイテムID が指定された
  • 無効な検索日が指定された

特記事項​

  • 指定したアイテム以下をツリー構造で取得します。指定したアイテムから検索条件に一致したアイテムまでの中間アイテムを含めて取得します。
  • コスト権限がない場合は以下の情報は0で取得します。
    • 実績コスト（ActualCost）
    • 計画コスト（PlannedCost）
    • 遅れコスト（CV）
    • 最終予測遅れコスト（CVAC）
    • 最終予測コスト（EstimatedFinalCost）
    • 子アイテムの実績コスト（ActualCostOfChildren）
    • 子アイテムの計画コスト（PlannedCostOfChildren）

サンプル​

ワークアイテムのIDを指定して、そのワークアイテムと子アイテムを取得する​

GET /workitem/workItems/126/subItems?fields=Id,Name,StatusTypeId,ActualProgress,PlannedStartDate,PlannedFinishDate,PlannedTime,ActualTime
Response
200 OK

[
    {
        "fields":{
            "Id":"126",
            "StatusTypeId":"2",
            "Name":"仕様",
            "ActualProgress":25.0,
            "PlannedStartDate":"2018-11-05T00:00:00",
            "PlannedFinishDate":"2018-11-16T00:00:00",
            "PlannedTime":2400,
            "ActualTime":2130,
            "StatusTypeName":"作業中",
            "IsAclInherited":false,
            "CanEdit":true,
            "SubItems":[
                {
                    "fields":{
                        "Id":"127",
                        "StatusTypeId":"3",
                        "Name":"要求ヒアリング",
                        "ActualProgress":100.0,
                        "PlannedStartDate":"2018-11-05T00:00:00",
                        "PlannedFinishDate":"2018-11-08T00:00:00",
                        "PlannedTime":240,
                        "ActualTime":210,
                        "StatusTypeName":"完了",
                        "IsAclInherited":false,
                        "CanEdit":true
                    },
                    "aclId":"0",
                    "permission":526464
                },
                {
                    "fields":{
                        "Id":"128",
                        "StatusTypeId":"1",
                        "Name":"仕様作成",
                        "ActualProgress":0.0,
                        "PlannedStartDate":"2018-11-09T00:00:00",
                        "PlannedFinishDate":"2018-11-13T00:00:00",
                        "PlannedTime":1800,
                        "ActualTime":1290,
                        "StatusTypeName":"未着手",
                        "IsAclInherited":false,
                        "CanEdit":true
                    },
                    "aclId":"0",
                    "permission":526464
                },
                {
                    "fields":{
                        "Id":"129",
                        "StatusTypeId":"3",
                        "Name":"仕様レビュー",
                        "ActualProgress":100.0,
                        "PlannedStartDate":"2018-11-14T00:00:00",
                        "PlannedFinishDate":"2018-11-15T00:00:00",
                        "PlannedTime":360,
                        "ActualTime":540,
                        "StatusTypeName":"完了",
                        "IsAclInherited":false,
                        "CanEdit":true
                    },
                    "aclId":"0",
                    "permission":526464
                },
                {
                    "fields":{
                        "Id":"130",
                        "StatusTypeId":"3",
                        "Name":"指摘修正",
                        "ActualProgress":100.0,
                        "PlannedStartDate":"2018-11-14T00:00:00",
                        "PlannedFinishDate":"2018-11-16T00:00:00",
                        "PlannedTime":0,
                        "ActualTime":90,
                        "StatusTypeName":"完了",
                        "IsAclInherited":false,
                        "CanEdit":true
                    },
                    "aclId":"0",
                    "permission":526464
                }
            ]
        },
        "aclId":"0",
        "permission":526464
    }
]

型定義​

WorkItem​

名前型必須か説明
fieldsFields○フィールド一覧
fieldCalcTypesFieldCalcType×フィールド計算方法一覧

Fields​

名前型必須か説明
keystring○key/valueで値を保持します。
例:"XXXXX"："YYYYY"の場合、XXXXXはkeyの名称、YYYYYは値を示します。
詳細情報のリンク： 「ワークアイテムAPIのフィールドについて」

FieldCalcType(列挙型)​

デフォルト値と同じ値が設定されている場合は「null」を返します。

各フィールドのデフォルト値は、次のリンクを参照ください。： 「各フィールドに設定可能な決定方法一覧」

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