关于 OData 和引用

Orchestrator API 实现基于 OData 协议。 OData（开放数据协议）是 ISO/IEC 批准的 oasis 标准，它定义了一组构建和使用 RESTful API 的最佳实践。

开放数据协议 (OData) 支持创建基于 REST 的数据服务，该服务允许 Web 客户端使用简单的 HTTP 消息发布和编辑使用 URL 标识并在数据模型中定义的资源。 本规范定义了协议的核心语义和行为方面。

Orchestrator OData 元数据端点的默认格式是 JSON，元数据 URL 为https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata 。 要将默认格式更改为 XML，请将/?$format=xml附加到此 URL。

有关协议原理和定义的更多信息，建议您查看 OData 官方文档。

注意：我们力求符合 OData 标准，但无法做出保证。 虽然标准强制要求元数据端点应默认返回 XML 格式，但出于历史兼容性考虑，我们将返回 JSON。

逻辑资源和元数据

Orchestrator API 提供了自定义方法，用于查询有关在 Orchestrator 中注册的各种实体的统计信息。 每个逻辑资源都是一个 OData 实体。 所有实体（例如机器人、流程、队列）都具有属性、关系和操作。

可用操作

CRUD 操作

这些类型的操作最适用于逻辑资源。 CRUD 操作包括 GET、POST、PUT 和 DELETE 请求，但请注意，由于技术和业务原因，并非所有逻辑资源都使用所有这些动词。

请求数据

可以通过 OData 特定的参数，结合 GET 操作从特定资源请求特定信息。

它们使您能够查询、筛选、排序、选择和展开信息。 有关更多详细信息，请参阅 OData 官方文档。

自定义操作

Orchestrator API 中提供以下自定义操作和未绑定到逻辑资源的操作：

• Stats 方法 提供有关不同实体的聚合信息；
• 帐户方法 为 Orchestrator 提供身份验证方法；
• 机器人使用队列方法 来访问队列，而 QueueDefinitions 端点应通过 API 用于外部系统；
• QueueProcessingRecords 方法 提供有关队列的统计信息和聚合信息；

注意：您可以按天、小时和分钟请求数据，但仅当数据最多为 90 天时，系统才会显示数据。

• Orchestrator 可以使用机器人服务资源与机器人通信。