Endpoint API che restituirà l'elenco dei record, con supporto per la ricerca generale e i filtri di base.
Nota: questa documentazione API ha lo scopo di fornire al lettore una panoramica delle funzionalità delle API e delle modalità di accesso alle stesse. Quando si tenta di scrivere chiamate API, si consiglia vivamente di utilizzare la documentazione API direttamente associata alla chiave API specifica che si intende chiamare. Tale documentazione include esempi con gli ID effettivi del modulo e degli elementi del modulo, esempi per ciascun campo disponibile nei moduli associati, ecc. Ciò consentirà di copiare e incollare direttamente i frammenti di codice dalla documentazione al proprio codice. Se si desidera utilizzare gli esempi presenti in questa documentazione, è necessario modificarli in base ai campi, all'ID del modulo, ecc.
Richiesta HTTP
OTTENEREL'https://api.gwapps.com/v1/forms/formId/records
Parametri
| Parametro | Descrizione | Tipo | Impostazione predefinita |
|---|---|---|---|
| Parametri di query opzionali | |||
| campi | Elenco di campi separati da virgola (vedere la sezionePanoramicaper ottenere l'elenco dei campi disponibili) | stringa | |
| risultato massimo | Numero massimo di voci restituite in una pagina di risultati. Il valore predefinito è100. L'intervallo valido è compreso tra 1 e 200. | numero | 100 |
| numero di pagina | Il numero di pagina, la risposta restituirà il flag hasNext che può essere utilizzato per verificare se ci sono altre pagine e incrementare il numero di pagine fino a quando non ci sono più pagine da restituire. | numero | 1 |
| ordina per | Un elenco di campi separati da virgole. Esempio: stage ordinare l'elenco in ordine crescente e -stage per ordinare l'elenco in ordine decrescente. | stringa | |
| q | Una stringa da cercare nei campi del record. | stringa | |
Esempio di richiesta
OTTENEREL'https://api.gwapps.com/v1/forms/66b18359dc7659dc4cb98d15/records
Risposta
La risposta restituita conterrà un array di record, dove
| Attributo | Descrizione | Tipo |
|---|---|---|
| conteggio | Utenti totali | numero |
| attuale | Numero della pagina corrente | numero |
| totalePagine | Pagine totali | numero |
| hasNext | Ha una pagina successiva | booleano |
| registrazioni | Elenco dei record | Matrice |
| record._id | L'ID del record | stringa |
| registrazioni.palcoscenico | Il palcoscenico del disco | Palcoscenico |
| record.shortCode | Dipende dal tipo di campo | Ogni valore è diverso a seconda del tipo di campo |
Esempio di risposta
{
"kind": "form#records",
"count": 5,
"current": 1,
"hasNext": false,
"totalPages": 1,
"records": [
{
"_id": "recordId",
"meta": {
"appId": "6266db8cbd86d9001a70c9ea",
"formId": "66b18359dc7659dc4cb98d15"
},
"stage": "stg0"
}
]
}
Articoli correlati sull'API
Questo articolo illustra i dettagli relativi a una specifica chiamata/endpoint API. I dettagli relativi alla struttura generale dell'API Records e alle chiamate/endpoint sono disponibili nell'articolo GW Apps Records API. Le informazioni sulla creazione delle chiavi API sono disponibili nella sezione API delle Impostazioni della piattaforma e nella sezione Sicurezza > Chiavi API di Modifica app all'interno di ciascuna applicazione.