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

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

ベース URL

ベース URL は、すべての API 要求の開始点です。これはエンドポイント URL を構築するための基盤として機能します。使用しているクラウド プラットフォームに応じて、対応するベース URL を使用します。

• Test Cloud: https://cloud.uipath.com
• Test Cloud (公共部門向け): https://govcloud.uipath.us
• Test Cloud (専有型): https://<customURL>.dedicated.uipath.com

エントリ ポイント

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

リソース パス

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

パス パラメーター

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

partitionGlobalId - 組織の ID です。

groupId - グループの ID です。

クエリ パラメーター

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

例

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

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