Orchestrator API specification notes, including the OpenAPI 3.0 update and the deprecation timeline for the previous Swagger 2.0 specification.
The Orchestrator default API specification is compliant with OpenAPI 3.0. The previous specification (V20, based on Swagger 2.0) is deprecated and remains available for a limited time for backward compatibility, see Deprecation timeline below for exact dates. After you migrate to the new specification, all regenerated API clients based on the new JSON definition will have to be readjusted.
If you plan on integrating our APIs with your client, you need to be aware of the possible updates and changes that may happen to the API specification, JSON schemas, or API endpoints.
The following list provides information and recommendations regarding API specification changes. If you have further questions, contact our support team.
弃用时间表
| Delivery model | 已弃用 | 已删除 |
|---|---|---|
| Automation Cloud | 2026 年 8 月 | September 2026 |
| Automation Suite | 2.2610 release | 2.2610 release |
有关 Swagger 更改的信息和建议
- Swagger JSON 文档中表示的 JSON API 描述可以随时更改。 但是，它将描述相同的基础 API，以确保向后兼容性。
- Swagger 界面和相应的 JSON 是根据当前端点生成的，并且我们始终发布最新版本。 为确保向后兼容性，我们支持相同的请求结构。
- 作为运行时生成的 API 客户端的替代方法，请使用固定时或编译时 API 客户端。 这样做可以减少依赖关系，并防止在 API 或 Swagger 定义发生更改时进行重大自动化更新。
- 标记为已弃用的项目在限定时间内可用，之后将从 Swagger 定义和 JSON API 中删除这些项目。
- 每当某些 API 在内部发生更改时，都会发布新的 Swagger API 版本。 API 版本号不会影响客户端 API 的使用。 我们不建议依赖 API 版本控制。
API 示例
现有 Orchestrator 参考文档中提供的示例描述了复杂的场景和端点。
您可以在包含最新更新的 Swagger JSON 中查看所有可用的 API。