OData と参照について

Orchestrator API の実装は、OData プロトコルに基づいています。OData (Open Data Protocol) は、ISO/IEC 認定を受けた OASIS 標準です。RESTful API の構築と利用に関するさまざまなベスト プラクティスを定義しています。

Open Data Protocol (OData) では、REST ベースのデータ サービスを作成できます。これらのサービスでは、URL で特定され、データ モデルで定義されたリソースを Web クライアントがシンプルな HTTP メッセージを使用してパブリッシュしたり、編集したりすることができます。この仕様は、プロトコルのコア セマンティックと動作に関する部分を定義するものです。

Orchestrator OData メタデータ エンドポイントの既定の形式は JSON で、メタデータ URL は https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odataです。既定の形式を XML に変更するには、この URL に /?$format=xml を追加します。

プロトコルの原則と定義について詳しくは、OData の公式ドキュメントを確認することをお勧めします。

注: UiPath は OData 標準への準拠を目指していますが、保証はいたしかねます。標準では、メタデータ エンドポイントが既定で XML 形式を返すことが義務付けられていますが、UiPath では履歴の相互運用性のために JSON を返します。

論理リソースとメタデータ

The Orchestrator API provides custom methods for querying stats about various entities registered in Orchestrator. Each logical resource is an OData entity. All entities (such as Robot, Process, Queue) have properties, relationships, and operations.

使用可能な操作

CRUD 操作

この種類の操作は、ほとんどの論理リソースで使用可能です。CRUD 操作には、GET、POST、PUT、DELETE のリクエストがあります。ただし、技術的および業務上の理由により、全論理リソースでこれらすべての動詞が使用されるわけではありません。

データを要求する

GET 操作と組み合わせて OData 固有のパラメーターを使用することで、特定の情報を特定のリソースに要求できます。

情報のクエリ、フィルター処理、並べ替え、選択、展開が可能です。詳細については、OData の公式ドキュメントをご覧ください。

Custom Actions

The following custom actions and actions which are not tied to a logical resource are available in the Orchestrator API:

• Stats メソッドは、さまざまなエンティティに関する集計情報を提供します。
• Account メソッドは、Orchestrator に認証方法を提供します。
• Queues メソッドは、ロボットがキューにアクセスするために使用しますが、外部システムでは代わりに QueueDefinitions エンドポイントを API 経由で使用する必要があります。
• QueueProcessingRecords メソッドは、キューに関する統計情報と集計情報を提供します。

注: 日、時間、分単位でデータを要求できますが、最大 90 日前までのデータのみが表示されます。

• RobotsService リソースは、Orchestrator がロボットと通信するために使用できます。