はじめに

Orchestrator API specification notes, including the OpenAPI 3.0 update and the deprecation timeline for the previous Swagger 2.0 specification.

重要:

The Orchestrator default API specification is compliant with OpenAPI 3.0. The previous specification (V20, based on Swagger 2.0) is deprecated and remains available for a limited time for backward compatibility, see Deprecation timeline below for exact dates. After you migrate to the new specification, all regenerated API clients based on the new JSON definition will have to be readjusted.

If you plan on integrating our APIs with your client, you need to be aware of the possible updates and changes that may happen to the API specification, JSON schemas, or API endpoints.

The following list provides information and recommendations regarding API specification changes. If you have further questions, contact our support team.

非推奨化のタイムライン

Delivery model	非推奨	Removed
Automation Cloud	2026 年 8 月	September 2026
Automation Suite	2.2610 release	2.2610 release

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 で確認できます。