 |
如果查詢參數沒有預設值 (例如 granularity 或 progress 參數)，則會依預設進行略過。
|
|
|
如果查詢參數沒有預設值 (例如 granularity 或 progress 參數)，則會依預設進行略過。
|
|
參數
|
類型
|
描述
|
||
|
all
|
boolean
(查詢)
|
將頁面大小設定為 64533 個筆項目。如未設定，單頁將傳回 100 筆工作階段，並加上前往下一頁的連結 (nextLink)。
|
||
|
endTime
|
string($date-time)
(查詢)
|
以 RFC3339 格式僅回報指定 UTC 日期時間當下或之前啟動的工作階段。
範例：2022-10-11T19:30:44.005Z
|
||
|
failures
|
(查詢)
|
排除或專門包括具有失敗步驟的工作階段。此參數可設定為下列任何值：
• exclude - 排除所有具有一或多個失敗步驟的工作階段。
• only - 僅傳回具有一或多個失敗步驟的工作階段。
|
||
|
feedback
|
array[string]
(查詢)
|
回報具有指定意見反應狀態的工作階段。此參數可設定為下列任何值：
• incomplete - 傳回至少有一個步驟略過必要意見反應的工作階段。
• complete - 傳回已完成必要意見反應之步驟的所有工作階段。
• na - 傳回不含必要意見反應之步驟，或已放棄或仍在處理中的所有工作階段。
|
||
|
granularity
|
string
(查詢)
|
指定工作階段的精細度層級。此參數可設定為下列任何值：
• procedure - 傳回不含步驟資料的程序相關工作階段資料。
• step - 傳回含步驟資料的程序相關工作階段資料。
依預設，已設定為 procedure。
|
||
|
latestStepState
|
字串
(查詢)
|
設定為 true 時，僅報告步驟的最新變更。POST 方法的此項設定預設為「true」，而GET 方法則為「false」。
|
||
|
organizationId (必要)
|
string($uuid)
(路徑)
|
貴組織的組織 ID。此為必填內容。
|
||
|
procedureId (僅限 GET)
|
string
(查詢)
|
僅回報具有指定程序 ID 的工作階段。
|
||
|
procedureIds (僅限 POST)
|
array[string]
(查詢)
|
僅報告屬於其中一個指定程序的工作階段。
|
||
|
procedureStatus
|
此參數已遭取代，我們建議改用 feedback 參數。
|
您可以使用的值包括 incomplete 與 complete。
|
||
|
progress
|
array[string]
(查詢)
|
回報具有指定進度狀態的工作階段。此參數可設定為下列任何值：
• completed - 前線員工已完成及已提交工作階段。
• abandoned - 前線員工已刪除工作階段。
• ongoing - 前線員工尚未完成並提交工作階段；工作階段仍在進行中。
依預設，已設定為 completed。
|
||
|
serialNumber
|
string
(查詢)
|
回報具有指定序號的程序相關工作階段資料。
|
||
|
startTime
|
string($date-time)
(查詢)
|
以 RFC3339 格式僅回報指定 UTC 日期時間當下或之後啟動的工作階段。
範例：2022-10-11T19:30:44.005Z
|
||
|
x-correlation-id
|
string($uuid)
(標題)
|
用於偵錯的非強制型使用者提供 UUID。如果未設定，系統會自動產生一組。每個請求都應具備一組具唯一性的 x-correlation-id。
範例：25aa3648-7609-47cc-aa21-ce0a1ob0cb10
|
