API エンドポイント URL の構造

このセクションでは、UiPath® エンドポイントの URL 構造を理解して、API 要求の構築方法を学びます。

ベース URL

ベース URL は、すべての API 要求の開始点です。これはエンドポイント URL を構築するための基盤として機能します。ベース URL は https://{お使いのドメイン} です。

サービス パス

サービス パスによって、対話する特定のサービスが識別されます。

組織レベルで動作する API の場合、サービス パスは通常、ベース URL の直後に入ります。これらの API は、組織内の特定のテナントに関係なく、組織全体に適用できる機能を提供します。

/identity_ - アカウントの作成、更新、削除、および組織設定の管理に関連する機能を操作します。

/audit_ - 組織内の監査ログに関連する機能を操作します。

/lrm - 組織内のテナントおよびサービスへのライセンス割り当てに関連する機能を操作します。

/la - ライセンス (ロボット ユニット、プロビジョニングされたテナントとサービスなど) の使用状況を追跡します。

組織内の特定のテナントに専用の API を扱う場合、URL には、サービス パスの前に組織とテナントの両方を指定する追加のパラメーターを含める必要があります。以下に例を示します。

/{orgName}/{tenantName}/orchestrator_ - 特定のテナントおよび組織の Orchestrator リソースを操作するために使用します。

/{orgName}/{tenantName}/dataservice_ - 特定のテナントおよび組織の Data Service のリソースを操作するために使用します。

テナント API リソースについて詳しくは、特定の製品ドキュメントをご覧ください。

エントリ ポイント

api - エントリ ポイントを API プラットフォーム管理リソースに知らせます (例: /api/Group/)

リソース パス

リソース パスは、実行するリソースや操作を正確に指定します。要求の目的に応じて、Grouo、RobotAccount、Settingなどのキーワードを含めます。

パス パラメーター

パス パラメーターは、動的な値を API エンドポイントに渡すために使用されます。これらの値は、API 要求に関連する特定のリソースを識別するのに役立ちます。例: /Group/{partitionGlobalId}/{groupId}

partitionGlobalId - 組織の ID です。

groupId - グループの ID です。

クエリ パラメーター

クエリ パラメーターとは、要求されたデータにコンテキストやフィルターを提供するために、URL にアタッチされる追加のパラメーターです。多くの場合、? 記号で始まり、& 記号で区切られます。クエリ パラメーターを使用すると、たとえばフィルター条件やページネーションの指示を指定できます。

例

すべてのコンポーネントを集約すると、組織固有のリソースの URL は次のようになります。https://{yourDomain}/{organizationName}/identity_/api/group/{partitionGlobalId}/{groupId}

テナント固有のリソースの URL は次のようになります。https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Assets