Skip to content

実績工数一覧の取得

説明

実績工数の一覧を取得します。
指定したユーザーIDに対応するタイムシートの閲覧権限がないデータは取得できません。

必要権限

タイムシートの閲覧

URL

GET /system/users/{userId}/timeEntries

パスパラメーター

名前 型 必須か 説明
userId string ○ ユーザーID

クエリパラメーター

名前 型 必須か 説明
projectId string × プロジェクトID
processCategoryId string × 工程分類ID
processCategory string × 工程分類

工程分類の「コード」、「名前」のいずれかに完全一致する工程分類を持つ実績の検索処理を行います。
timeEntryCategoryId string × 作業分類ID
timeEntryCategory string × 作業分類

作業分類の「コード」、「名前」のいずれかに完全一致する作業分類を持つ実績の検索処理を行います。
workItemId string × ワークアイテムID
startDate Date × 検索開始日

未指定の場合は当月の初日以降のデータを取得します。
finishDate Date × 検索終了日

未指定の場合はAPI実行日までのデータを取得します。
limit int × データの最大取得件数
offset int × 何件目のデータから取得するか

省略した場合の既定値は 0 で先頭のデータから取得します。
orderby string × 並び替えに用いるフィールド

フィールド名の後の空白に続けて以下を指定することで、並び替えの順序指定ができます。
asc：昇順（既定値）
desc：降順

レスポンス

名前 型 説明
totalCount int 検索条件に該当する実績工数の総数
data ActualTimeEntry[] 取得した実績工数情報

エラーケース

  • 指定したユーザーID が存在しない

特記事項

なし

サンプル

ユーザーを指定して実績工数を取得する（期間を指定する）

リクエスト
GET /system/users/21/timeEntries?startDate=2019-01-07&finishDate=2019-01-11
レスポンス
200 OK

{
    "totalCount":48,
    "data":
    [
        {
            "projectId":"6",
            "projectName":"S機器の開発",
            "projectCode":"PRJ-002",
            "workDate":"2019-01-07T00:00:00",
            "startTime":"2019-01-07T10:30:00",
            "finishTime":"2019-01-07T12:00:00",
            "time":90,
            "memo":"",
            "workItemId":"145",
            "workItemName":"アイテム1テスト",
            "workItemNumber":"21",
            "workItemTypeId":"3",
            "userId":"21",
            "userName":"岡本 直哉",
            "timeEntryCategoryId":"4",
            "timeEntryCategory":"作業",
            "processCategoryId":"6",
            "processCategory":"外部テスト実施",
            "isLocked":false,
            "isDeleted":false,
            "id":"845",
            "createdAt":"2019-01-10T07:29:32Z",
            "createdBy":"0",
            "updatedAt":"2019-01-10T07:29:32Z",
            "updatedBy":"0"
        },
        {
            "projectId":"6",
            "projectName":"S機器の開発",
            "projectCode":"PRJ-002",
            "workDate":"2019-01-07T00:00:00",
            "startTime":"2019-01-07T17:00:00",
            "finishTime":"2019-01-07T19:00:00",
            "time":120,
            "memo":"",
            "workItemId":"145",
            "workItemName":"アイテム1テスト",
            "workItemNumber":"21",
            "workItemTypeId":"3",
            "userId":"21",
            "userName":"岡本 直哉",
            "timeEntryCategoryId":"4",
            "timeEntryCategory":"作業",
            "processCategoryId":"6",
            "processCategory":"外部テスト実施",
            "isLocked":false,
            "isDeleted":false,
            "id":"852",
            "createdAt":"2019-01-10T07:29:32Z",
            "createdBy":"0",
            "updatedAt":"2019-01-10T07:29:32Z",
            "updatedBy":"0"
        },
        .
        .
        .
    ]
}

型定義

ActualTimeEntry

名前 型 説明
id string 実績工数ID
workDate DateTime 作業日（startTimeと同じ日付の00:00:00）
time int 工数（分単位）
startTime DateTime 開始時刻
finishTime DateTime 終了時刻
memo string メモ
projectId string プロジェクトID
projectName string プロジェクト名
projectCode string プロジェクトコード
userId string ユーザーID
userName string ユーザー名
workItemId string ワークアイテムのID
workItemName string ワークアイテム名
workItemNumber string ワークアイテムのアイテム番号
workItemTypeId string ワークアイテムのアイテムタイプID
timeEntryCategoryId string 作業分類のID
timeEntryCategory string 作業分類
processCategoryId string 工程分類のID
processCategory string 工程分類
isLocked boolean 実績がロックされているかどうか
isDeleted boolean 削除されているかどうか
createdAt DateTime 作成日時
createdBy string 作成者のユーザーID
updatedAt DateTime 更新日時
updatedBy string 更新者のユーザーID