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

変更履歴


TimeTracker NX が公開するWeb APIについて、バージョン毎の変化点を示します。

Version 7.1

既存APIの変更

以下のAPIを変更しました。

変更箇所は型定義の追加などであり、すでに公開しているパラメータなどの使い方は変わりません。
No.API変更内容
1GET /project/projects- パラメータ追加
- レスポンスのフィールド追加
2GET /project/projects/{projectIds}
POST /workitem/workItems/{workItemId}/subItems/duplicate
- レスポンスのフィールド追加
3POST /project/projects
PUT /project/projects/{projectIds}
- パラメータ追加
4POST /project/projects/{projectId}/acl
PUT /project/projects/{projectId}/acl/{aclId}
- 制約のあるバージョンの情報を更新

Version 7

APIキーを使った認証を追加

詳細は以下を参照ください。
APIキーの認証

既存APIの変更

以下のAPIを更新しました。

NoAPI変更内容
1PUT /project/projects/{projectId}/acl/{aclId}
POST /system/users/{userId}/timeEntries
PUT /system/users/{userId}/timeEntries/{timeEntryIds}
DELETE /system/users/{userId}/timeEntries/{timeEntryIds}
エラーケース追加
2GET /project/projects
GET /project/projects/{projectIds}
レスポンスのフィールド追加
3POST /project/projects
PUT /project/projects/{projectIds}
パラメータ追加
4GET /workitem/workItems/timeEntries/export取得するユーザー組織の説明を追加
5POST /auth/token連続実行時に同じトークンを返す

Version 6.0

対象の API を以下に示します。

新規追加

以下のAPIを新規で追加しました。

NoAPIリンク
1GET /api/system/users/me
2GET /system/users/{userIds}/notifications
3GET /system/organizations/{organizationId}/allassignedusers
4GET /system/organizations/{organizationId}/users
5GET /system/profiles/{profileIds}
6GET /system/profiles/latest
7GET /project/projects/{projectId}/profile
8DELETE /project/projects/{projectId}/acl/{aclId} (2023/9/29改訂)
9GET /project/projects/{projectId}/acl (2023/10/16改訂)
10POST /project/projects/{projectId}/acl (2023/10/16改訂)

既存APIの変更

以下のAPIを変更しました。

変更箇所は型定義の追加などであり、すでに公開しているパラメータなどの使い方は変わりません。
NoAPI変更内容
1GET /system/users/{userId}/preference・レスポンスの型を定義
・breakTimes の多重度を修正
2PUT /project/projects/{projectIds}・レスポンスの型を定義
3GET /system/profiles・Profile の profileCategoryId と
 profileCategoryName を公開に変更
4PUT /project/projects/{projectId}/acl/{aclId}・レスポンスの型を定義
・ProjectAceAddの制約を追加(2023/9/29改訂)

Version 5.5

対象の API を以下に示します

NoAPI機能
1GET /system/users/{userIds}/preference設定情報の取得

出力フィールドの追加

  • APIのレスポンスに「firstVisibleTimeStartTime」と「showNameWithMemo」を追加。

Version 5

対象の API を以下に示します

NoAPI機能
1GET /workitem/workItems/timeEntries/export実績工数のエクスポート

出力フィールドの追加

Version 4.5

対象の API を以下に示します

NoAPI機能
1GET /project/projectsプロジェクト一覧の取得

クエリパラメータ追加

取得対象を絞り込むパラメータを追加しました。

名前説明
managerOrganizationIdsstringマネージャの組織Id
カンマ区切りで複数のIdを指定できます。
itemIdsstringアイテムId
カンマ区切りで複数のIdを指定できます。

Version 4.3

対象の API を以下に示します

NoAPI機能
1GET /project/projectsプロジェクト一覧の取得
2GET /project/projects/{projectIds}プロジェクトの取得
3GET /system/profilesプロファイル一覧の取得
4GET /workitem/workItems/{workItemId}/subItems指定ワークアイテム一覧の取得

取得フィールドの追加

以下のAPIにおいて、取得可能なフィールドが追加されました。

  • プロジェクト一覧の取得
    GET /project/projects

    名前説明
    baseProfileIdstring継承元プロファイルID
    baseProfileNamestring継承元プロファイル名
    baseProfileVersionNamestring継承元プロファイルのバージョン名
  • プロジェクトの取得
    GET /project/projects/{projectIds}

    名前説明
    baseProfileIdstring継承元プロファイルID
    baseProfileNamestring継承元プロファイル名
    baseProfileVersionNamestring継承元プロファイルのバージョン名
  • プロファイル一覧の取得
    GET /system/profiles

    名前説明
    revisionint改訂番号
    revisedContentstring改訂内容
    lastBaseAppliedAtDateTime継承元プロファイルの最終反映日時

パラメータの説明を追加

以下のAPIのクエリパラメーターに説明を追加しました。

  • 指定ワークアイテム一覧の取得
    GET /workitem/workItems/{workItemId}/subItems

    名前説明(赤字箇所が追加分)
    fieldsstring取得対象とするフィールドをシステム名のカンマ区切りで指定します。

    プロジェクトで利用可能なアイテムタイプが持つ、 フィールドタイプのシステム名をカンマ区切りで指定します。
    SV を指定すると、PlannedStartDate、PlanendFinishDate、ActualProgress、HasSubItem も取得フィールドに追加します。

    fieldCalcTypesを指定すると、フィールドの決定方法を取得します。