デフォルトの API バージョン管理を使用する統合の更新

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

URI で API のバージョンを指定しない統合は、自動的にデフォルトバージョンにルーティングされます。API 呼び出しで特定のバージョンの API を使用する場合は、そのバージョンを Workfront API リクエストで指定する必要があります。

API リクエストでのバージョンの指定については、統合での API バージョンの指定を参照してください。

デフォルト API を使用する場合の考慮事項

Workfront デフォルト API を使用する際は、次の点に留意してください。

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

サポートされている API バージョンへの統合の更新

Workfront API リクエストでバージョンが指定されていない場合は、デフォルトバージョンが使用されます。API リクエストには、サポートされている API バージョン（できればサポートされている最新の API）を指定することをお勧めします。

例えば、次の Workfront API リクエストでは API バージョンが指定されていません。

https://davidwhite.my.workfront.com/attask/api/project/metadata

このリクエストが実行されると、Workfront インスタンスからのデータを指定する JSON エンコードされたテキストで応答を受け取ります。この URI では API バージョンが指定されていないので、呼び出し先はデフォルト API になります。

デフォルト API リクエストをバージョン指定された API リクエストに変えるには、サポートされている API バージョンを呼び出すだけです。例えば、次の URI はバージョン 15 のリクエストになります。

https://davidwhite.my.workfront.com/attask/api/v15.0/project/metadata

Workfront API リクエストを更新する際には、アドビの API のあらゆるサポート対象バージョンを指定できます。特定の API の参照について詳しくは、統合での API バージョンの指定を参照してください。

最長のサポート期間を確保するには、最新バージョンを呼び出してください。サポートされている API のリストについては、API のバージョン管理とサポートスケジュールを参照してください。

API のデフォルトバージョンの履歴

「デフォルト API」（または単にデフォルト）の本来の目的は、それを Workfront API の最新バージョンにマッピングすることでした。これにより、基本的な統合でデフォルトを呼び出しているお客様が、API リクエストを更新する必要がなくなります。

2011年に、Workfront は API のバージョン 3.0 をリリースしました。デフォルトバージョンは自動的にバージョン 3.0 に移行されましたが、お客様による多くの統合が、更新せずにバージョン 3.0 を利用するには複雑すぎたので、機能しなくなりました。その結果、Workfront はこの変更をロールバックし、デフォルトバージョンをバージョン 2 のままにしました。

2011年以降、Workfront は API の機能を大幅に増やしました。このため、API の古いバージョンは廃止されました。2017年に、デフォルトを更新するのではなく、デフォルトバージョンの概念を完全に削除しました。これは、アドビの API の安定バージョンを使用することと、統合を最大 3 年のサイクルで保守することをお客様に促すためでした。

Workfront は今、デフォルト API バージョンを元に戻しています。デフォルト API は Workfront API の最新バージョンに設定され、新しいバージョンがリリースされるたびに最新バージョンに更新されます。