Parametri disponibili
L'API descritta in questa sezione (/customer-events/</customer-events/<ID org>/report>/report) recupera un elenco delle sessioni di procedura Vuforia Expert Capture ordinate dalle più recenti alle meno recenti. Per default, vengono restituite tutte le sessioni e i risultati possono essere filtrati utilizzando uno o più parametri. I risultati vengono quindi suddivisi in pagine di 100 sessioni, ognuna delle quali contiene un link alla pagina successiva.
 |
A meno che un parametro di interrogazione non abbia un valore di default, come il parametro granularity o progress, viene ignorato di default.
|
La tabella seguente fornisce informazioni su tutti i parametri disponibili che possono essere utilizzati per filtrare i risultati nell'API.
• Quando si utilizza il metodo POST, immettere i parametri nel corpo della richiesta. Ad esempio:
{ "serialNumber": "serialNo", "granularity": "step" }
• Quando si utilizza l'endpoint obsoleto GET, immettere i parametri come parametri di interrogazione URL. Ad esempio:
/report?serialNumber=serialNo&granularity=step
|
Parametro
|
Tipo
|
Descrizione
|
||
|---|---|---|---|---|
|
endTime
|
string($date-time)
(interrogazione)
|
Riporta solo le sessioni iniziate alla data e ora UTC specificate o in precedenza, in formato RFC3339.
Esempio: 2022-10-11T19:30:44.005Z
|
||
|
failures
|
(interrogazione)
|
Esclude o include esclusivamente le sessioni con passi con esito negativo. Questo parametro può essere impostato su uno dei seguenti valori:
• exclude - Esclude tutte le sessioni con uno o più passi con esito negativo.
• only - Restituisce solo le sessioni che hanno uno o più passi con esito negativo.
|
||
|
feedback
|
array[string]
(interrogazione)
|
Riporta le sessioni con lo stato di feedback specificato. Questo parametro può essere impostato su uno dei seguenti valori:
• incomplete - Restituisce le sessioni che hanno almeno un passo per il quale è stato ignorato il feedback obbligatorio.
• complete - Restituisce le sessioni per le quali sono stati completati tutti i passi con feedback obbligatorio.
• na - Restituisce tutte le sessioni senza passi che richiedono feedback o sessioni che sono state abbandonate o sono ancora in corso.
|
||
|
granularity
|
string
(interrogazione)
|
Specifica il livello di granularità della sessione. Questo parametro può essere impostato su uno dei seguenti valori:
• procedure - Restituisce i dati di sessione della procedura senza i dati del passo.
• step - Restituisce i dati di sessione della procedura inclusi i dati del passo.
Per default, il parametro è impostato su procedure.
|
||
|
latestStepState
|
string
(interrogazione)
|
Riporta solo l'ultima modifica apportata a un passo quando l'impostazione è true. Per default, il parametro è impostato su true per il metodo POST e su false per il metodo GET.
|
||
|
organizationId (obbligatorio)
|
string($uuid)
(percorso)
|
ID dell'organizzazione. Obbligatorio.
|
||
|
procedureIds (solo POST)
|
array[string]
(interrogazione)
|
Riporta solo le sessioni appartenenti a una delle procedure specificate.
|
||
|
procedureStatus
|
Poiché questo parametro è stato deprecato, si consiglia di utilizzare il parametro feedback.
|
Valori possibili includono incomplete e complete.
|
||
|
progress
|
array[string]
(interrogazione)
|
Riporta le sessioni con lo stato di avanzamento specificato. Questo parametro può essere impostato su uno dei seguenti valori:
• completed - L'operatore in prima linea ha completato e inviato la sessione.
• abandoned - L'operatore in prima linea ha eliminato la sessione.
• ongoing - L'operatore in prima linea non ha ancora completato e inviato la sessione. La sessione è ancora in corso.
Per default, il parametro è impostato su completed. Ciò significa che se si utilizza la chiamata API e non si fornisce questo parametro, la chiamata si comporta come se il valore fosse impostato su completed e pertanto, per default, restituisce solo le procedure completate.
|
||
|
serialNumber
|
string
(interrogazione)
|
Riporta i dati della sessione per le procedure con il numero di serie specificato.
|
||
|
startTime
|
string($date-time)
(interrogazione)
|
Riporta solo le sessioni iniziate alla data e ora UTC specificate o in seguito, in formato RFC3339.
Esempio: 2022-10-11T19:30:44.005Z
|
||
|
x-correlation-id
|
string($uuid)
(intestazione)
|
UUID opzionale fornito dall'utente e utilizzato a scopo di debug. Se non è impostato, viene generato automaticamente. Ogni richiesta deve avere un x-correlation-id univoco.
Esempio: 25aa3648-7609-47cc-aa21-ce0a1ob0cb10
|
