はじめに

重要:

UiPath では、Orchestrator Swagger のバージョンを Swagger 3.0 にアップグレードする予定です (現在、Orchestrator API は Swagger 3.0 を使用して定義されています)。

既存の API クライアントとの後方互換性についての心配は不要です。API の互換性は確実に維持されます。

UiPath では、以前のクライアントを使用することをお勧めします。要求の構造には後方互換性があるため、JSON の変更によってクライアントが変更されることはありません。

Swagger 3.0 への更新後、新しい JSON 定義に基づいて再生成されたすべての API クライアントでは、再調整が必要になります。

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

Swagger の変更に関する情報と推奨事項は以下のとおりです。さらに質問がある場合は、サポート チームまでお問い合わせください。

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