Endpoint API che creerà un nuovo record.
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
POSThttps://api.gwapps.com/v1/forms/formId/records
Parametri
| Parametro | Descrizione | Tipo |
|---|---|---|
| Parametri di percorso richiesti | ||
| formId | L'attuale formId 66b18359dc7659dc4cb98d15 | stringa |
Corpo della richiesta
| Parametro | Descrizione | Tipo |
|---|---|---|
| Parametri richiesti | ||
| Codice breve campo* | Ogni campo del modulo ha un codice breve univoco. È possibile trovare i codici brevi dei campi nella sezione "Panoramica" del modulo. È inoltre possibile aggiornare i codici brevi dei campi dalle proprietà dei campi nel Form Designer. | *Dipende dal tipo di campo. Fare riferimento al modulo "Panoramica". |
Esempio di richiesta
POSThttps://api.gwapps.com/v1/forms/66b18359dc7659dc4cb98d15/records
inizio
Nota: se si passa un campo che non esiste nel modulo corrente, si otterrà un Bad Request risposta di errore. Puoi dare un'occhiata alla sezione Panoramica per vedere i campi disponibili per questo modulo.
{
"text1": "John",
"number1": 10,
"currency1": {
"code": "USD",
"value": 120
}
}
Risposta
La risposta restituita conterrà le informazioni relative al record, dove
| Attributo | Descrizione | Tipo |
|---|---|---|
| _id | L'ID del record | stringa |
| palcoscenico | Il palcoscenico del disco | Palcoscenico |
| codice breve | Dipende dal tipo di campo | Ogni valore è diverso a seconda del tipo di campo |
Esempio di risposta
{
"kind": "form#record",
"_id": "recordId",
"meta": {
"appId": "6266db8cbd86d9001a70c9ea",
"formId": "66b18359dc7659dc4cb98d15"
},
"stage": {
"id": "stg0",
"status": "Draft"
},
"text1": "John",
"number1": 10,
"currency1": {
"code": "USD",
"value": 120
}
}
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.