- 入门指南
- 身份验证
- Swagger 定义
- Orchestrator API
- 平台管理 API
概述 OData 协议及其如何支持 Orchestrator API 实施
Orchestrator API 实现基于 OData 协议。OData（开放数据协议）是 ISO/IEC 批准的 OASIS 标准，它定义了一组构建和使用 RESTful API 的最佳实践。
开放数据协议 (OData) 支持创建基于 REST 的数据服务，该服务允许 Web 客户端使用简单的 HTTP 消息发布和编辑使用 URL 标识并在数据模型中定义的资源。 本规范定义了协议的核心语义和行为方面。
Orchestrator OData 元数据端点的默认格式是 JSON，元数据 URL 为 https://{yourDomain}/odata。要将默认格式更改为 XML，请将 /?$format=xml 附加到此 URL。
有关协议原理和定义的更多信息，建议您查看 OData官方文档。
We aim at compliance with the OData standard, but cannot guarantee it.
While the standard mandates that the metadata endpoint should return XML format by default, we return JSON for historical compatibility.
逻辑资源和元数据
Orchestrator API 提供了自定义方法，用于查询有关在 Orchestrator 中注册的各种实体的统计信息。 每个逻辑资源都是一个 OData 实体。 所有实体（例如机器人、流程、队列）都具有属性、关系和操作。
图 1. Orchestrator 实体框架数据模型
可用操作
CRUD 操作
这些类型的操作最适用于逻辑资源。 CRUD 操作包括 GET、POST、PUT 和 DELETE 请求，但请注意，由于技术和业务原因，并非所有逻辑资源都使用所有这些动词。
请求数据
可以通过 OData 特定的参数，结合 GET 操作从特定资源请求特定信息。
您可借此查询、筛选、排序、选择和展开信息。更多详细信息，请参阅官方 OData 文档。
自定义操作
Orchestrator API 中提供以下自定义操作和未绑定到逻辑资源的操作：
- 统计方法提供不同实体的聚合信息；
- 帐户方法为 Orchestrator 提供身份验证方法；
- 队列方法由机器人用于访问队列，而
QueueDefinitions端点应通过 API 用于外部系统； - QueueProcessingRecords 方法提供队列的统计信息和聚合信息；
- RobotsService 资源可以由 Orchestrator 用于与机器人通信。
图 2. 自定义 Orchestrator API 方法