Skip to content

Web API の変化点

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

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を指定すると、フィールドの決定方法を取得します。