Skip to content

ワークアイテムの取得

説明

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

必要権限

プロジェクトの閲覧

URL

GET /workitem/workItems/{workItemIds}

パスパラメーター

名前 必須か 説明
workItemIds string ワークアイテムID

クエリパラメーター

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

大文字/小文字含めて完全一致のフィールドを取得します。

レスポンス

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

エラーケース

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

特記事項

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

サンプル

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

リクエスト
GET /workitem/workItems/128?fields=Id,name,statusTypeId,actualProgress,plannedStartDate,plannedFinishDate,PlannedTime,ActualTime
レスポンス
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

名前 必須か 説明
fields Fields フィールド一覧
fieldCalcTypes FieldCalcType × フィールド計算方法一覧

Fields

名前 必須か 説明
key string
key/valueで値を保持します。
Ex:"XXXXX":"YYYYY"
XXXXXはkeyの名称
YYYYYは値

FieldCalcType(列挙型)

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