Effettuare la chiamata API
Dati PII e proprietari nelle chiamate API
La visibilità di tutti i dati PII e proprietari può essere controllata utilizzando le seguenti impostazioni Vuforia:
|
Impostazione
|
Informazioni
|
||
|---|---|---|---|
|
Quando questa impostazione è disattivata, è vero quanto segue:
• Le informazioni sulla procedura (titolo della procedura, commenti dell'utente) vengono rimosse
• Le informazioni sul passo (descrizione e titolo del passo, commenti dell'utente e feedback multimediale) vengono rimosse
• Le informazioni sull'utente (nome, cognome, e-mail e ruolo) vengono rimosse
Questa impostazione è disattivata per default.
Se l'impostazione è attivata, i dati di cui sopra non vengono rimossi.
|
|||
|
Quando questa impostazione è attivata, ha effetto sui dati restituiti.
Questa impostazione è disattivata per default.
|
 |
Nelle situazioni in cui queste due impostazioni sono in conflitto tra loro, prevarrà la rimozione o l'abbreviazione delle informazioni.
|
Chiamata API
È possibile effettuare chiamate API all'API /customer-events/<ID org>/report che restituirà i dati della sessione per un'organizzazione specificata. I risultati possono essere filtrati utilizzando i parametri di interrogazione. I seguenti parametri di interrogazione possono essere utili:
• feedback
• serialNumber
• failures
• progress
Per informazioni più dettagliate sui parametri di cui sopra, vedere Parametri disponibili.
 |
Per ottenere risultati ottimali, i parametri URL devono essere codificati, poiché alcuni caratteri non funzionano senza codifica. Ad esempio, se un numero di serie è 'serial$number#with|special&chars', la versione codificata sicura e consigliata da usare come parametro URL sarà 'serial%24number%23with%7Cspecial%26chars'.
|
Sono disponibili i seguenti esempi:
Risultati paginati
Le risposte dell'API sono suddivise in pagine. Anche se le dimensioni della pagina possono variare e non sono garantite, in genere una pagina include circa 100 elementi.
Quando sono disponibili più pagine, la risposta include un elemento nextPagePostBody. Questo elemento replica i parametri della richiesta iniziale e aggiunge un puntatore alla pagina successiva.
Per recuperare la pagina successiva, inviare un'altra richiesta POST allo stesso endpoint utilizzando l'elemento nextPagePostBody come corpo della richiesta. Continuare il processo fino a quando la risposta non contiene più un elemento nextPagePostBody.
Di seguito è riportato un output di esempio contenente l'elemento nextPagePostBody:
{
"items": [ ... ]
...
"nextPagePostBody": {
"granularity": "step",
"progress": [
"completed",
"abandoned",
"ongoing"
],
"startTime": "2025-04-21T22:00:00.000Z",
"endTime": "2025-10-22T21:59:59.999Z",
"latestStepState": true,
"page": 2
}
}
La chiamata POST successiva da effettuare sarebbe la seguente:
POST https://vuforia.portal.ptc.com/customer-events/<orgId>/report
{
"granularity": "step",
"progress": [
"completed",
"abandoned",
"ongoing"
],
"startTime": "2025-04-21T22:00:00.000Z",
"endTime": "2025-10-22T21:59:59.999Z",
"latestStepState": true,
"page": 2
}