API リファレンス

Swagger ファイルにアクセスする

The Orchestrator API Swagger definition can be accessed as follows, depending on your deployment type:

• オンプレミス - オンプレミスの Orchestrator URL に /swagger/index.html を追加します。(例: https://myOrchestrator.com/swagger/index.html)。
• Automation Cloud - 組織名とテナント名、および orchestrator_/swagger/index.html をクラウドのベース URL に追加します。たとえば、https://cloud.uipath.com/{organization_name}/{tenant_name}/orchestrator_/swagger/index.html です。
  {organization_name} および {tenant_name} は、Automation Cloud アカウントの [API アクセス] ページで確認できます。
• Automation Suite - 組織名とテナント名、および orchestrator_/swagger/index.html を、https://AutomationSuiteURL/{organization_name}/{tenant_name}/orchestrator_/swagger/index.html の構文に従って Automation Suite のベース URL に追加します。たとえば、Orchestrator の Automation Suite デプロイ用の Swagger にアクセスするには、リンク https://myasuite.westeurope.cloudapp.azure.com/docs/DefaultTenant/orchestrator_/swagger/index.html を使用できます。
  注:

  Please note that if you are using Automation Cloud, all requests to Orchestrator endpoints should include /{organization_name}/{tenant_name}/.

  If you are using Automation Suite, all requests to Orchestrator endpoints should include /{organization_name}/{tenant_name}/.

The API you see in Swagger is directly dependant on the Orchestrator instance you use. To easily make requests directly in the Swagger documentation, just log in to Orchestrator in another tab. This feature is available starting with the 2017.1 version.

The guide herein is built to support the Swagger documentation, by providing examples for the more trickier Orchestrator endpoints.

Orchestrator API - Postman コレクション

Orchestrator のインスタンスを操作するための PowerShell ライブラリについては、こちらをご覧ください。Postman を使用したい場合は、こちらに利用可能なコレクションがいくつかあります。コレクションは [Run in Postman] ボタンをクリックしてインポートできます。

注: v2018.1.3 より、Swagger で Windows 認証を使用して要求を実行できます。以前は、実行できるのは GET 要求のみで、POST/PUT/DELETE 操作はサポートされていませんでした。