 |
除非查询参数具有默认值，例如 granularity 或 progress，否则默认情况下会将其忽略。
|
|
|
除非查询参数具有默认值，例如 granularity 或 progress，否则默认情况下会将其忽略。
|
|
参数
|
类型
|
说明
|
||
|
all
|
boolean
(query)
|
将页面大小设置为 64533 个条目。如果未设置，则将返回包含 100 个会话的单个页面，以及指向下一页的 nextLink 链接。
|
||
|
endTime
|
string($date-time)
(query)
|
仅报告在指定 UTC 日期时间（RFC3339 格式）及之前开始的会话。
示例：2022-10-11T19:30:44.005Z
|
||
|
failures
|
(query)
|
排除或仅包括具有失败步骤的会话。此参数可设置为以下任意值：
• exclude - 排除有一个或多个失败步骤的所有会话
• only - 仅返回有一个或多个失败步骤的会话
|
||
|
feedback
|
array[string]
(query)
|
报告具有指定反馈状况的会话。此参数可设置为以下任意值：
• incomplete - 返回至少一个需要反馈的步骤被跳过的会话
• complete - 返回需要反馈的所有步骤均已完成的会话
• na - 返回无步骤需要反馈的所有会话，或者所有已放弃或仍在进行的会话
|
||
|
granularity
|
string
(query)
|
指定会话的细化程度。此参数可设置为以下任意值：
• procedure - 返回不含步骤数据的过程会话数据
• step - 返回包含步骤数据的过程会话数据
默认情况下，此参数设置为 procedure。
|
||
|
latestStepState
|
string
(query)
|
设置为 true 时，仅报告步骤的最新变更。默认情况下，对于 POST 方法设置为 true，对于 GET 方法设置为 false。
|
||
|
organizationId（必需）
|
string($uuid)
(path)
|
组织的 ID。此参数是必需的。
|
||
|
procedureId（仅限 GET)
|
string
(query)
|
仅报告具有指定过程 ID 的会话。
|
||
|
procedureIds（仅限 POST)
|
array[string]
(query)
|
仅报告属于指定过程之一的会话。
|
||
|
procedureStatus
|
由于此参数已弃用，因此建议改用 feedback 参数。
|
可用值包括 incomplete 和 complete。
|
||
|
progress
|
array[string]
(query)
|
报告具有指定进度状况的会话。此参数可设置为以下任意值：
• completed - 一线工作人员已完成并提交会话
• abandoned - 一线工作人员已删除会话
• ongoing - 一线工作人员尚未完成并提交会话；会话仍在进行
默认情况下，此参数设置为 completed。
|
||
|
serialNumber
|
string
(query)
|
报告具有指定序列号的过程的会话数据。
|
||
|
startTime
|
string($date-time)
(query)
|
仅报告在指定 UTC 日期时间（RFC3339 格式）及之后开始的会话。
示例：2022-10-11T19:30:44.005Z
|
||
|
x-correlation-id
|
string($uuid)
(header)
|
（可选）由用户提供的 UUID，用于调试目的。如果未设置，则会自动生成。每个请求应具有唯一的 x-correlation-id。
示例：25aa3648-7609-47cc-aa21-ce0a1ob0cb10
|
