 |
A menos que un parámetro de consulta tenga un valor por defecto, como los parámetros granularity o progress, se ignora por defecto.
|
|
|
A menos que un parámetro de consulta tenga un valor por defecto, como los parámetros granularity o progress, se ignora por defecto.
|
|
Parámetro
|
Tipo
|
Descripción
|
||
|
all
|
boolean
(consulta)
|
Defina el tamaño de página en 64533 entradas. Si no se define, se devolverá una sola página de 100 sesiones junto con un vínculo nextLink a la página siguiente.
|
||
|
endTime
|
string($date-time)
(consulta)
|
Solo informa de las sesiones iniciadas a partir o antes de la fecha y hora UTC especificadas en formato RFC3339.
Ejemplo: 2022-10-11T19:30:44.005Z
|
||
|
failures
|
(consulta)
|
Permite excluir o incluir únicamente sesiones con pasos suspendidos. Este parámetro puede definirse en cualquiera de los siguientes valores:
• exclude: excluye todas las sesiones con uno o más pasos suspendidos.
• only: devuelve solo las sesiones que tienen uno o más pasos suspendidos.
|
||
|
feedback
|
array[string]
(consulta)
|
Informa de las sesiones con el estado de feedback especificado. Este parámetro puede definirse en cualquiera de los siguientes valores:
• incomplete: devuelve las sesiones que tienen al menos un paso para el que se ha omitido el feedback requerido.
• complete: devuelve las sesiones para las que se han completado todos los pasos con el feedback requerido.
• na: devuelve todas las sesiones que no tienen pasos que requieren feedback que se han abandonado o aún están en curso.
|
||
|
granularity
|
string
(consulta)
|
Especifica el nivel de granularidad de la sesión. Este parámetro puede definirse en cualquiera de los siguientes valores:
• procedure: devuelve datos de sesión sobre el procedimiento sin datos de paso.
• step: devuelve datos de sesión sobre el procedimiento con datos de paso.
Por defecto, se define en procedure.
|
||
|
latestStepState
|
cadena
(consulta)
|
Informa solo del último cambio de un paso cuando está definido como true. Por defecto, se define en true para el método POST, y en false para el método GET.
|
||
|
organizationId (obligatorio)
|
string($uuid)
(ruta)
|
El ID de su organización. Este campo es obligatorio.
|
||
|
procedureId (solo GET)
|
string
(consulta)
|
Solo informa de las sesiones con el ID de procedimiento especificado.
|
||
|
procedureIds (solo POST)
|
array[string]
(consulta)
|
Solo informa de las sesiones que pertenecen a uno de los procedimientos especificados.
|
||
|
procedureStatus
|
Debido a que este parámetro está obsoleto, recomendamos utilizar el parámetro feedback.
|
Los valores disponibles son incomplete y complete.
|
||
|
progress
|
array[string]
(consulta)
|
Informa de las sesiones con el estado de progreso especificado. Este parámetro puede definirse en cualquiera de los siguientes valores:
• completed: el trabajador de primera línea ha completado y enviado la sesión.
• abandoned: el trabajador de primera línea ha borrado la sesión.
• ongoing: el trabajador de primera línea aún no ha completado y enviado la sesión; la sesión todavía está en curso.
Por defecto, se define en completed.
|
||
|
serialNumber
|
string
(consulta)
|
Informa de los datos de sesión de los procedimientos con el número de serie especificado.
|
||
|
startTime
|
string($date-time)
(consulta)
|
Solo informa de las sesiones iniciadas a partir o después de la fecha y hora UTC especificadas en formato RFC3339.
Ejemplo: 2022-10-11T19:30:44.005Z
|
||
|
x-correlation-id
|
string($uuid)
(cabecera)
|
UUID opcional proporcionado por el usuario utilizado con fines de depuración. Si no se define uno, se genera automáticamente. Cada solicitud debe tener un x-correlation-id único.
Ejemplo: 25aa3648-7609-47cc-aa21-ce0a1ob0cb10
|
