 |
Verfügt ein Abfrageparameter nicht über einen Standardwert (z.B. granularity oder progress), so wird er standardmäßig ignoriert.
|
|
|
Verfügt ein Abfrageparameter nicht über einen Standardwert (z.B. granularity oder progress), so wird er standardmäßig ignoriert.
|
|
Parameter
|
Typ
|
Beschreibung
|
||
|
all
|
boolean
(Abfrage)
|
Legen Sie die Seitengröße auf 64533 Einträge fest. Ist die Seitengröße nicht festgelegt. so wird eine einzelne Seite mit 100 Sitzungen zusammen mit einem nextLink-Link zur nächsten Seite zurückgegeben.
|
||
|
endTime
|
string($date-time)
(Abfrage)
|
Meldet nur Sitzungen, die an oder vor dem/der angegebenen UTC-Datum/-Uhrzeit im RFC3339-Format gestartet wurden.
Beispiel: 2022-10-11T19:30:44.005Z
|
||
|
failures
|
(Abfrage)
|
Schließt Sitzungen mit fehlgeschlagenen Schritten aus oder schließt diese exklusiv ein. Dieser Parameter kann auf einen der folgenden Werte festgelegt werden:
• exclude – Schließt alle Sitzungen mit einem oder mehreren fehlgeschlagenen Schritten aus.
• only – Gibt nur Sitzungen mit mindestens einem fehlgeschlagenen Schritt zurück.
|
||
|
feedback
|
array[string]
(Abfrage)
|
Meldet Sitzungen mit dem angegebenen Feedback-Status. Dieser Parameter kann auf einen der folgenden Werte festgelegt werden:
• incomplete – Gibt Sitzungen mit mindestens einem Schritt, für den erforderliches Feedback übersprungen wurde, zurück.
• complete – Gibt Sitzungen, für die alle Schritte mit erforderlichem Feedback abgeschlossen wurden, zurück.
• na – Gibt alle Sitzungen zurück, die keine Schritte enthalten, die Feedback erfordern, oder Sitzungen, die entweder abgebrochen wurden oder noch ausgeführt werden.
|
||
|
granularity
|
string
(Abfrage)
|
Gibt den Granularitätsgrad für die Sitzung an. Dieser Parameter kann auf einen der folgenden Werte festgelegt werden:
• procedure – Gibt Sitzungsdaten zum Verfahren ohne Schrittdaten zurück.
• step – Gibt Sitzungsdaten zum Verfahren zurück, einschließlich Schrittdaten.
Standardmäßig ist dieser Parameter auf procedure festgelegt.
|
||
|
latestStepState
|
string
(Abfrage)
|
Meldet lediglich die letzte Änderung an einem Schritt, wenn auf true festgelegt. Standardmäßig ist dieser Parameter für die POST-Methode auf "wahr" festgelegt und für die GET-Methode auf "falsch".
|
||
|
organizationId (erforderlich)
|
string($uuid)
(Pfad)
|
Die ID für Ihre Organisation. Diese ID ist erforderlich.
|
||
|
procedureId (nur GET)
|
string
(Abfrage)
|
Meldet nur Sitzungen mit der angegebenen Verfahrens-ID.
|
||
|
procedureIds (nur POST)
|
array[string]
(Abfrage)
|
Meldet nur Sitzungen, die zu einem der angegebenen Verfahren gehören.
|
||
|
procedureStatus
|
Da dieser Parameter veraltet ist, wird empfohlen, stattdessen den Parameter feedback zu verwenden.
|
Verfügbare Werte sind u.a. incomplete und complete.
|
||
|
progress
|
array[string]
(Abfrage)
|
Meldet Sitzungen mit dem angegebenen Fortschrittsstatus. Dieser Parameter kann auf einen der folgenden Werte festgelegt werden:
• completed – Der Frontline-Worker hat die Sitzung abgeschlossen und eingereicht.
• abandoned – Der Frontline-Worker hat die Sitzung gelöscht.
• ongoing – Der Frontline-Worker hat die Sitzung noch nicht abgeschlossen und eingereicht. Die Sitzung wird noch ausgeführt.
Standardmäßig ist dieser Parameter auf completed festgelegt.
|
||
|
serialNumber
|
string
(Abfrage)
|
Meldet Sitzungsdaten für Verfahren mit der angegebenen Seriennummer.
|
||
|
startTime
|
string($date-time)
(Abfrage)
|
Meldet nur Sitzungen, die an oder nach dem/der angegebenen UTC-Datum/-Uhrzeit im RFC3339-Format gestartet wurden.
Beispiel: 2022-10-11T19:30:44.005Z
|
||
|
x-correlation-id
|
string($uuid)
(Kopfzeile)
|
Optionale, vom Benutzer angegebene UUID für Debugging-Zwecke. Ist keine UUID festgelegt, wird automatisch eine generiert. Jede Anforderung sollte eine eindeutige x-correlation-id besitzen.
Beispiel: 25aa3648-7609-47cc-aa21-ce0a1ob0cb10
|
