orchestrator
latest
false
Orchestrator API 指南
重要 :
新发布内容的本地化可能需要 1-2 周的时间才能完成。
如何在 Orchestrator API 中查看逻辑资源的请求和响应架构。
关于响应和请求架构
要查看响应和请求架构，请单击您感兴趣的资源旁边的“展开操作”按钮。
图 1. 响应和请求架构
在“响应类”部分，您可以查看资源的整个模型，以及如何填充参数的说明，或您请求的信息示例。
“参数”部分包含选定资源支持的所有可用参数，以及简短说明。此外，所有受支持的参数都可以填充信息，以便您在阅读文档时试用 Orchestrator API。
列表操作
要查看特定资源的所有可用操作，请单击您感兴趣的资源旁边的“列出操作”按钮。
图 2. 可用操作
使用响应模型构建请求参数
任何资源的响应模型都可以帮助您了解其结构以及如何在未来的请求中使用它。 它具有以下结构：
- 主实体或 Dto（数据传输对象）及其属性。 对于每个属性，系统将显示以下信息：
- 接受的值类型，写在括号中；
- 必需或可选 - 标记可选参数；
- 有关参数和最大可接受值的说明。
- 二级实体 - 仅在主实体包含资源作为参数时显示；请注意，可以有多个二级实体，具体取决于主要资源。
资源级别的总数取决于主要实体。 例如，RobotDto 具有三个级别，而 EnvironmentsDto 具有两个级别。
图 3. 资源级别
精确 API
您可以使用“常规”选项卡的“API 设置”部分中的“严格 API租户”设置减轻 API 请求带来的潜在负载。启用后，以下字段将变为不可筛选和/或不可排序：
| 实体 | 字段 | Non-filterable | Non-sortable |
|---|---|---|---|
| 队列项目 | OutputData | 是 | 是 |
AnalyticsData | 是 | 是 | |
ReviewerUserId | 不适用 | 是 | |
Key | 是 | 是 | |
Reference | 不适用 | 是 | |
DueDate | 是 | 是 | |
RiskSlaDate | 是 | 是 | |
DeferDate | 是 | 是 | |
StartProcessing | 是 | 不适用 | |
EndProcessing | 是 | 不适用 | |
SecondsInPreviousAttempts | 是 | 是 | |
AncestorId | 是 | 是 | |
RetryNumber | 是 | 是 | |
SpecificData | 是 | 是 | |
CreationTime | 是 | 是 | |
Progress | 是 | 是 | |
RowVersion | 是 | 是 | |
OrganizationUnitId | 是 | 是 | |
OrganizationUnitFullyQualifiedName | 是 | 是 |
根据我们观察到的使用模式，将来会扩展上面的列表。