はじめに

OpenAPI 3.0 の更新や以前の Swagger 2.0 仕様の非推奨化のタイムラインを含む、Orchestrator API 仕様に関するノート。

重要:

Orchestrator の既定の API 仕様は、OpenAPI 3.0 に準拠しています。以前の仕様 (Swagger 2.0 に基づく V20) は非推奨となり、後方互換性の確保のため期間限定で引き続き使用できます。正確な日付については、以下の「 非推奨化のタイムライン 」をご覧ください。新しい仕様に移行した後、新しい JSON 定義に基づいて再生成されたすべての API クライアントを再調整する必要があります。

API をクライアントと統合する予定がある場合は、API 仕様、JSON スキーマ、または API エンドポイントで発生する可能性のある更新や変更に注意する必要があります。

次のリストに、API 仕様の変更に関する情報と推奨事項を示します。さらに質問がある場合は、 サポート チームにお問い合わせください。

非推奨化のタイムライン

デリバリー モデル	非推奨	Removed
Automation Cloud	2026 年 8 月	2026 年 9 月
Automation Suite	2.2610 リリース	2.2610 リリース

Swagger の変更に関する情報と推奨事項

1. Swagger JSON ドキュメントに記載されている JSON API の説明は、随時変更される可能性があります。ただし、後方互換性を確保するために、基になる同じ API を説明します。
2. Swagger インターフェイスとそれに対応する JSON は現在のエンドポイントに基づいて生成され、常に最新バージョンが公開されます。後方互換性を確保するため、同じ要求構造がサポートされます。
3. 実行時に生成される API クライアントの代わりとして、固定 API クライアントまたはコンパイル時 API クライアントを使用します。そうすることで依存関係が減り、API または Swagger 定義が変更された場合に、オートメーションの大幅な更新を防ぐことができます。
4. 非推奨としてマークされたアイテムの利用可能な期間は限られており、その期間を過ぎると項目は Swagger 定義と JSON API から削除されます。
5. 特定の API が内部で変更されるたびに、新しい Swagger API バージョンが公開されます。API のバージョン番号は、クライアント API の使用に影響しません。API のバージョン管理を利用することはお勧めしません。

API の例

Orchestrator の既存の参照ドキュメントに記載されている例で、複雑なシナリオやエンドポイントについて説明しています。

利用可能なすべての API は、最新の更新内容が含まれる Swagger JSON で確認できます。