API 端点 URL 结构

In this section, you can learn to construct API requests by understanding the URL structure of UiPath® endpoints.

基本 URL

基本 URL 是所有 API 请求的起点。它是构建端点 URL 的基础。对于 Automation Suite，基本 URL 为 https://{yourDomain}。

服务路径

服务路径用于标识您想要与之交互的特定服务。

对于在组织级别运行的 API，服务路径通常紧跟在基本 URL 之后。这些 API 提供适用于整个组织的功能，无论该组织内的特定租户如何。

/identity_ - 用于与与创建、更新或删除帐户以及管理组织设置相关的功能进行交互。

/audit_ - 用于与组织中与审核日志相关的功能进行交互。

/lrm - 用于与和组织中的租户和服务的许可证分配相关的功能进行交互。

/la - 用于跟踪许可证使用情况（Robot Unit、已配置的租户和服务等）

处理特定于组织内特定租户的 API 时，URL 应包含其他参数，以便在服务路径前同时指定组织和租户。例如：

/{orgName}/{tenantName}/orchestrator_ - 用于与特定租户和组织中的 Orchestrator 资源进行交互。

/{orgName}/{tenantName}/dataservice_ - 用于与特定租户和组织中的 Data Service 资源进行交互。

有关租户 API 资源的详细信息，请参阅特定的产品文档。

入口点

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

资源路径

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

路径参数

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

partitionGlobalId - 组织的 ID。

groupId - 组 ID。

查询参数

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

示例

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

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