API 端点 URL 结构

在本节中，您可以通过了解 UiPath™ 端点的 URL 结构来学习构建 API 请求。

基本 URL

基本 URL 是所有 API 请求的起点。它是构建端点 URL 的基础。基本 URL 为 https://cloud.uipath.com。

入口点

api - 表示 API 平台管理资源的入口点，例如 ​/api​/Group​/

资源路径

资源路径指定要执行的确切资源或操作。它可能包含 Group、RobotAccount、Setting 等关键词，具体取决于请求的目的。

路径参数

路径参数用于将动态值传递到 API 端点。这些值有助于识别与 API 请求相关的特定资源。例如：​/Group​/{partitionGlobalId}​/{groupId}

partitionGlobalId - 组织的 ID。

groupId - 组的 ID。

查询参数

查询参数是附加到 URL 的附加参数，用于为请求的数据提供更多上下文或筛选器。这些参数前面通常带有一个 ? 符号并用 & 符号分隔。例如，您可以使用查询参数来指定筛选条件或分页说明。

示例

将所有组件放在一起，特定于组织的资源的 URL 可能如下所示： https://cloud.uipath.com/identity_/api/group/{partitionGlobalId}​/{groupId}。

特定于租户的资源的 URL 可能如下所示： https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Assets。