 |
Par défaut, les paramètres de requête sont ignorés, sauf s'ils possèdent une valeur par défaut, tels que les paramètres granularity ou progress.
|
|
|
Par défaut, les paramètres de requête sont ignorés, sauf s'ils possèdent une valeur par défaut, tels que les paramètres granularity ou progress.
|
|
Paramètre
|
Type
|
Description
|
||
|
all
|
boolean
(requête)
|
Définissez le format de page sur 64533 entrées. Si ce paramètre n'est pas défini, une seule page de 100 sessions sera renvoyée avec un lien nextLink vers la page suivante.
|
||
|
endTime
|
string($date-time)
(requête)
|
Signale uniquement les sessions démarrées avant ou à la date/heure UTC spécifiée au format RFC3339.
Exemple : 2022-10-11T19:30:44.005Z
|
||
|
failures
|
(requête)
|
Exclut ou inclut uniquement les sessions dont certaines étapes ont échoué. Ce paramètre peut être défini sur l'une des valeurs suivantes :
• exclude : exclut toutes les sessions comportant une ou plusieurs étapes ayant échoué.
• only : renvoie uniquement les sessions comportant une ou plusieurs étapes ayant échoué.
|
||
|
feedback
|
array[string]
(requête)
|
Signale les sessions présentant le statut de retour d'information spécifié. Ce paramètre peut être défini sur l'une des valeurs suivantes :
• incomplete : renvoie les sessions comportant au moins une étape pour laquelle un retour d'information requis a été ignoré.
• complete : renvoie les sessions pour lesquelles toutes les étapes avec retour d'information requis ont été complétées.
• na : renvoie toutes les sessions ne comportant aucune étape nécessitant un retour d'information ou qui ont été abandonnées ou sont toujours en cours.
|
||
|
granularity
|
string
(requête)
|
Spécifie le niveau de granularité de la session. Ce paramètre peut être défini sur l'une des valeurs suivantes :
• procedure : renvoie les données de session relatives à la procédure sans données d'étape.
• step : renvoie les données de session relatives à la procédure, y compris les données d'étape.
Par défaut, cette valeur est définie sur procedure.
|
||
|
latestStepState
|
chaîne
(requête)
|
Signale uniquement la dernière modification apportée à une étape lorsqu'elle est définie sur true. Par défaut, cette valeur est définie sur vrai pour la méthode POST et sur faux pour la méthode GET.
|
||
|
organizationId (obligatoire)
|
string($uuid)
(chemin)
|
ID de votre organisation. Il est obligatoire.
|
||
|
procedureId (GET uniquement)
|
string
(requête)
|
Ne signale que les sessions présentant l'ID de procédure spécifié.
|
||
|
procedureIds (POST uniquement)
|
array[string]
(requête)
|
Ne signale que les sessions appartenant à l'une des procédures spécifiées.
|
||
|
procedureStatus
|
Etant donné que ce paramètre est obsolète, nous vous recommandons d'utiliser le paramètre feedback à la place.
|
Les valeurs disponibles incluent incomplete et complete.
|
||
|
progress
|
array[string]
(requête)
|
Signale les sessions présentant le statut d'avancement spécifié. Ce paramètre peut être défini sur l'une des valeurs suivantes :
• completed : l'opérateur de première ligne a terminé et soumis la session.
• abandoned : l'opérateur de première ligne a supprimé la session.
• ongoing : l'opérateur de première ligne n'a pas encore terminé et pas encore soumis la session ; la session est toujours en cours.
Par défaut, cette valeur est définie sur completed.
|
||
|
serialNumber
|
string
(requête)
|
Signale les données de session pour les procédures portant le numéro de série spécifié.
|
||
|
startTime
|
string($date-time)
(requête)
|
Signale uniquement les sessions démarrées à partir de la date/heure UTC spécifiée au format RFC3339.
Exemple : 2022-10-11T19:30:44.005Z
|
||
|
x-correlation-id
|
string($uuid)
(en-tête)
|
UUID facultatifs fournis par l'utilisateur aux fins de débogage. Si aucun n'est défini, il est généré automatiquement. Chaque requête doit avoir un x-correlation-id unique.
Exemple : 25aa3648-7609-47cc-aa21-ce0a1ob0cb10
|
