orchestrator
2023.4
false
- 入门指南
- 关于 OData 和引用
- 枚举类型
- 正在验证身份
- 每个端点的权限
- 构建 API 请求
- 响应代码
- 运行状况检查端点
- 身份验证
- 身份验证方法
- 外部应用程序 (OAuth)
- ROPC（不推荐）
- Swagger 定义
- 读取我
- 在 Swagger 中授权 API 调用
- 管理逻辑资源
- Orchestrator API
- 警示请求
- 资产请求
- 日历请求
- 环境请求
- 文件夹请求
- 一般任务请求
- 作业请求
- 库请求
- 许可证请求
- 包请求
- 权限请求
- 个人工作区请求
- 流程请求
- 队列项目请求
- Queue retention policy requests
- 机器人请求
- 角色请求
- 计划请求
- 设置请求
- 储存桶要求
- 任务请求
- 任务目录请求
- 任务表单请求
- 租户请求
- 事务请求
- 用户请求
- Webhook 请求
- 平台管理 API
- 入门指南
- 关于本指南
- 可用资源：
- API 端点 URL 结构
- 枚举列表
- 作用域和权限
- 关于作用域和权限
- 平台管理作用域和权限
- 平台管理 API
- 审核日志
- 获取审核日志
- 下载审核日志
- 组
- 获取所有组
- 获取指定组
- 删除指定组
- 创建新的本地组
- 更新组
- 机器人帐户
- 获取所有机器人帐户
- 删除机器人帐户
- 获取特定机器人帐户
- 删除特定机器人帐户
- 创建新的机器人帐户
- 更新机器人帐户
- 用户
- 更新用户
- 删除特定用户
- 删除用户
- 设置
- 获取设置
- 更新设置
- 消息模板
- 获取消息模板
- 更新消息模板
- 按名称获取消息模板
重要 :
请注意，此内容已使用机器翻译进行了部分本地化。
新发布内容的本地化可能需要 1-2 周的时间才能完成。
Orchestrator API 指南
上次更新日期 2025年2月13日
要访问 Orchestrator API Swagger，请将
/swagger/index.html 附加到 Orchestrator URL。例如 https://{yourDomain}/swagger/index.html。
您在 Swagger 中看到的 API 直接取决于您使用的 Orchestrator 实例。要轻松地直接在 Swagger 中发出请求，请在另一个选项卡中登录 Orchestrator。
要通过 Swagger 用户界面为 Orchestrator 服务授权 API 调用，请执行以下步骤：
-
在 Orchestrator API 页面的右上角找到“授权”按钮。如果锁是打开的，则表示您未经授权。
-
单击 “授权”。 系统将显示“ 可用权限 ” 窗口。
注意： 我们目前支持一种称为 OAuth2 的授权方案。 - 系统会预先选择所有作用域，以便您可以在 Orchestrator API 中试验所有端点。 如果要限制对某些 API 的访问，请清除它们。
- 单击 “授权”。 系统将显示一个新窗口，确认您已获得授权。
- 完成后，单击 “关闭” 或 X 以关闭“ 可用的授权 ” 窗口。 “ 授权 ”按钮显示关闭的锁，表示您已获得授权。
当访问令牌过期时，您会收到
401: You are not authenticated! 响应。 您的请求仍存在不记名授权标头，但访问令牌已过期。 发生这种情况时，您需要使过期的令牌失效并生成新的访问令牌：