 |
질의 매개변수에 progress 또는 granularity 매개 변수와 같은 기본값이 없으면 기본적으로 무시됩니다.
|
|
|
질의 매개변수에 progress 또는 granularity 매개 변수와 같은 기본값이 없으면 기본적으로 무시됩니다.
|
|
매개 변수
|
유형
|
설명
|
||
|
all
|
boolean
(질의)
|
페이지 크기를 64533개 엔트리로 설정합니다. 설정하지 않으면 100개의 세션으로 구성된 단일 페이지가 다음 페이지에 대한 nextLink 링크와 함께 반환됩니다.
|
||
|
endTime
|
string($date-time)
(질의)
|
지정된 UTC 날짜/시간 또는 그 이전에 시작된 세션만 RFC3339 형식으로 보고합니다.
예: 2022-10-11T19:30:44.005Z
|
||
|
failures
|
(질의)
|
실패한 단계가 있는 세션을 제외하거나 이러한 세션만 포함합니다. 이 매개 변수는 다음 값으로 설정할 수 있습니다.
• exclude - 하나 이상의 실패한 단계가 있는 모든 세션을 제외합니다
• only - 하나 이상의 실패한 단계가 있는 세션만 반환합니다
|
||
|
feedback
|
array[string]
(질의)
|
지정한 피드백 상태의 세션을 보고합니다. 이 매개 변수는 다음 값으로 설정할 수 있습니다.
• incomplete - 필요한 피드백을 건너뛴 단계가 하나 이상 있는 세션을 반환합니다
• complete - 필요한 피드백이 포함된 모든 단계가 완료된 세션을 반환합니다
• na - 피드백이 필요한 단계가 없는 모든 세션 또는 중단되었거나 아직 진행 중인 세션을 반환합니다
|
||
|
granularity
|
string
(질의)
|
세션의 세부 수준을 지정합니다. 이 매개 변수는 다음 값으로 설정할 수 있습니다.
• procedure - 단계 데이터 없이 절차에 대한 세션 데이터를 반환합니다
• step - 단계 데이터를 포함한 절차에 대한 세션 데이터를 반환합니다
기본적으로 procedure로 설정됩니다.
|
||
|
latestStepState
|
string
(질의)
|
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)
(질의)
|
지정된 UTC 날짜/시간 또는 그 이후에 시작된 세션만 RFC3339 형식으로 보고합니다.
예: 2022-10-11T19:30:44.005Z
|
||
|
x-correlation-id
|
string($uuid)
(머리글)
|
디버깅 목적으로 사용되는 선택적 사용자 제공 UUID입니다. 설정되어 있지 않을 경우 자동으로 생성됩니다. 각 요청에는 고유한 x-correlation-id가 있어야 합니다.
예: 25aa3648-7609-47cc-aa21-ce0a1ob0cb10
|
