Automation Suite
2023.4
false
重要 :
请注意此内容已使用机器翻译进行了部分本地化。
Automation Suite API 指南
Last updated 2024年7月12日

API 端点 URL 结构

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

基本 URL

基本 URL 是所有 API 请求的起点。它是构建端点 URL 的基础。基本 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​/

资源路径

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

路径参数

路径参数用于将动态值传递到 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
  • 基本 URL
  • 服务路径
  • 入口点
  • 资源路径
  • 路径参数
  • 查询参数
  • 示例

此页面有帮助吗?

获取您需要的帮助
了解 RPA - 自动化课程
UiPath Community 论坛
Uipath Logo White
信任与安全
© 2005-2024 UiPath。保留所有权利。