変更履歴
TimeTracker NX が公開するWeb APIについて、バージョン毎の変化点を示します。
Version 7.1
既存APIの変更
以下のAPIを変更しました。
変更箇所は型定義の追加などであり、すでに公開しているパラメータなどの使い方は変わりません。
| No. | API | 変更内容 |
|---|---|---|
| 1 | GET /project/projects | - パラメータ追加 - レスポンスのフィールド追加 |
| 2 | GET /project/projects/{projectIds} POST /workitem/workItems/{workItemId}/subItems/duplicate | - レスポンスのフィールド追加 |
| 3 | POST /project/projects PUT /project/projects/{projectIds} | - パラメータ追加 |
| 4 | POST /project/projects/{projectId}/acl PUT /project/projects/{projectId}/acl/{aclId} | - 制約のあるバージョンの情報を更新 |
Version 7
APIキーを使った認証を追加
詳細は以下を参照ください。
「APIキーの認証」
既存APIの変更
以下のAPIを更新しました。
Version 6.0
対象の API を以下に示します。
新規追加
以下のAPIを新規で追加しました。
| No | API | リンク |
|---|---|---|
| 1 | GET /api/system/users/me | ■ |
| 2 | GET /system/users/{userIds}/notifications | ■ |
| 3 | GET /system/organizations/{organizationId}/allassignedusers | ■ |
| 4 | GET /system/organizations/{organizationId}/users | ■ |
| 5 | GET /system/profiles/{profileIds} | ■ |
| 6 | GET /system/profiles/latest | ■ |
| 7 | GET /project/projects/{projectId}/profile | ■ |
| 8 | DELETE /project/projects/{projectId}/acl/{aclId} (2023/9/29改訂) | ■ |
| 9 | GET /project/projects/{projectId}/acl (2023/10/16改訂) | ■ |
| 10 | POST /project/projects/{projectId}/acl (2023/10/16改訂) | ■ |
既存APIの変更
以下のAPIを変更しました。
変更箇所は型定義の追加などであり、すでに公開しているパラメータなどの使い方は変わりません。
| No | API | 変更内容 |
|---|---|---|
| 1 | GET /system/users/{userId}/preference | ・レスポンスの型を定義 ・breakTimes の多重度を修正 |
| 2 | PUT /project/projects/{projectIds} | ・レスポンスの型を定義 |
| 3 | GET /system/profiles | ・Profile の profileCategoryId と profileCategoryName を公開に変更 |
| 4 | PUT /project/projects/{projectId}/acl/{aclId} | ・レスポンスの型を定義 ・ProjectAceAddの制約を追加(2023/9/29改訂) |
Version 5.5
対象の API を以下に示します
| No | API | 機能 |
|---|---|---|
| 1 | GET /system/users/{userIds}/preference | 設定情報の取得 |
出力フィールドの追加
- APIのレスポンスに「firstVisibleTimeStartTime」と「showNameWithMemo」を追加。
Version 5
対象の API を以下に示します
| No | API | 機能 |
|---|---|---|
| 1 | GET /workitem/workItems/timeEntries/export | 実績工数のエクスポート |
出力フィールドの追加
- 出力フィールド「Leve1」~「Leve15」を追加しました。
- 詳細へのリンク: 「エクスポート時の出力項目について」
- 使い方のリンク: 「サンプル - ユーザーと出力するフィールドを指定し、実績工数を実績単位で集計しCSV形式で出力する」
Version 4.5
対象の API を以下に示します
| No | API | 機能 |
|---|---|---|
| 1 | GET /project/projects | プロジェクト一覧の取得 |
クエリパラメータ追加
取得対象を絞り込むパラメータを追加しました。
| 名前 | 型 | 説明 |
|---|---|---|
| managerOrganizationIds | string | マネージャの組織Id カンマ区切りで複数のIdを指定できます。 |
| itemIds | string | アイテムId カンマ区切りで複数のIdを指定できます。 |
Version 4.3
対象の API を以下に示します
| No | API | 機能 |
|---|---|---|
| 1 | GET /project/projects | プロジェクト一覧の取得 |
| 2 | GET /project/projects/{projectIds} | プロジェクトの取得 |
| 3 | GET /system/profiles | プロファイル一覧の取得 |
| 4 | GET /workitem/workItems/{workItemId}/subItems | 指定ワークアイテム一覧の取得 |
取得フィールドの追加
以下のAPIにおいて、取得可能なフィールドが追加されました。
-
プロジェクト一覧の取得
GET /project/projects名前 型 説明 baseProfileId string 継承元プロファイルID baseProfileName string 継承元プロファイル名 baseProfileVersionName string 継承元プロファイルのバージョン名 -
プロジェクトの取得
GET /project/projects/{projectIds}名前 型 説明 baseProfileId string 継承元プロファイルID baseProfileName string 継承元プロファイル名 baseProfileVersionName string 継承元プロファイルのバージョン名 -
プロファイル一覧の取得
GET /system/profiles名前 型 説明 revision int 改訂番号 revisedContent string 改訂内容 lastBaseAppliedAt DateTime 継承元プロファイルの最終反映日時
パラメータの説明を追加
以下のAPIのクエリパラメーターに説明を追加しました。
-
指定ワークアイテム一覧の取得
GET /workitem/workItems/{workItemId}/subItems名前 型 説明(赤字箇所が追加分) fields string 取得対象とするフィールドをシステム名のカンマ区切りで指定します。
プロジェクトで利用可能なアイテムタイプが持つ、 フィールドタイプのシステム名をカンマ区切りで指定します。
SV を指定すると、PlannedStartDate、PlanendFinishDate、ActualProgress、HasSubItem も取得フィールドに追加します。
fieldCalcTypesを指定すると、フィールドの決定方法を取得します。