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

ワークアイテムの取得

説明​

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

必要権限​

プロジェクトの閲覧

URL​

GET /workitem/workItems/{workItemIds}

パスパラメーター​

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

クエリパラメーター​

名前型必須か説明
fieldsstring×取得するフィールド

大文字／小文字含めて完全一致のフィールドを取得します。
fieldCalcTypesを指定すると、フィールドの決定方法を取得します。

レスポンス​

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

エラーケース​

  • 指定したワークアイテム ID が存在しない

特記事項​

  • コスト閲覧権限がない場合、以下のフィールドは 0 で取得します。
    • 実績コスト（ActualCost）
    • 計画コスト（PlannedCost）
    • 遅れコスト（CV）
    • 最終予測遅れコスト（CVAC）
    • 最終予測コスト（EstimatedFinalCost）
    • 子アイテムの実績コスト（ActualCostOfChildren）
    • 子アイテムの計画コスト（PlannedCostOfChildren）

サンプル​

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

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

[
    {
        "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
    }
]

型定義​

WorkItem​

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

Fields​

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

FieldCalcType(列挙型)​

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