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

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

ベース URL

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

エントリ ポイント

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

リソース パス

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

パス パラメーター

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

partitionGlobalId - 組織の ID です。

groupId - グループの ID です。

クエリ パラメーター

Query parameters are additional parameters attached to the URL to provide more context or filters for the requested data. These are often preceded by a ? symbol and separated by & symbols. For instance, you might use query parameters to specify filtering criteria or pagination instructions.

例

Putting all components together, a URL for a organization-specific resource might look like this, https://{yourDomain}/identity/api/group/{partitionGlobalId}​/{groupId}.

A URL for tenant-specific resource can look like this: https://{yourDomain}/odata/Assets.