統合での API バージョンを指定

Last update: Mon Feb 05 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

作成対象：

すべての Adobe Workfront URI は、URI の「attask/api」部分の後にある特定のバージョンの API を参照する必要があります。次の例では、バージョン 15.0 を呼び出します。

attask/api/v15.0/<objectName>/<objectId>

すべての統合が現在サポートされている Workfront API を呼び出すことを確認してください。

Workfront API のリリースおよび廃止スケジュール

API の新しいバージョンは、通常年に 2 回、定期的にリリースされています。各バージョンは、リリース日から 3 年間サポートされます。また、使用可能であるがサポートされていない、廃止予定の状態のバージョンには、1 年が追加されます。

Workfront API のリリース頻度および廃止スケジュールに関して詳しくは、API のバージョン管理とサポートのスケジュールを参照してください。

IMPORTANT

API のデフォルトバージョンは、最新バージョンに設定されています。バージョンが指定されていない API 呼び出しでは、デフォルトバージョンが使用されます。Workfront が API の新しいバージョンをリリースするたびに、デフォルトのバージョンが最新バージョンにアップデートされます。したがって、新しいバージョンの Workfront API がリリースされた後は、すべてのデフォルトバージョンを使用する API 呼び出しをチェックして、機能が引き続きサポートされていることを確認する必要があります。
組織が現在デフォルト API を使用している場合、Workfront 管理者に、デフォルト API に関する詳細な手順を含む、お知らせセンターのメッセージが届いています。

API の最新バージョンについては、API のバージョン管理とサポートのスケジュールを参照してください。

Workfront API に送信された HTTP リクエストの URI を確認することで、使用している API のバージョンを確認することができます。次の例は、API のバージョン 15 を指定する Workfront リクエスト URI を示しています。

https://<domainname>.my.workfront.com/attask/api/v15.0/proj/4c7c08b20000002de5ca1ebc19edf2d5

URI でバージョンが指定されていない場合、次の例に示すように、API のデフォルトバージョンが使用されています。

https://<domainname>.my.workfront.com/attask/api/proj/4c7c08b20000002de5ca1ebc19edf2d5

IMPORTANT

URI で API のバージョンを指定しない統合は、自動的に API のデフォルトバージョンにルーティングされます。

Workfront 統合を作成または維持する際に、API バージョンや変更される可能性のある（API キーなどの）他のプロパティを動的にアップデートするメソッドを含める必要があります。

統合をより効率的にアップデートするために、統合値を録画する際には、以下の提案を考慮する必要があります。

このことを念頭に置いて Workfront 統合を設計すると、これらの値が必然的に変更される場合に、大規模な開発作業の必要性が軽減されます。

recommendation-more-help

5f00cc6b-2202-40d6-bcd0-3ee0c2316b43