Ottieni record

Endpoint API che restituirà il record richiesto in base all'ID.

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/recordId

Parametri

ParametroDescrizioneTipo
Parametri di percorso richiesti
formIdL'attuale formId 66b18359dc7659dc4cb98d15stringa
recordIdIl recordIdstringa
Parametri di query opzionali
campiElenco di campi separati da virgola (vedere la sezionePanoramicaper ottenere l'elenco dei campi disponibili)stringa
includeAllegatiRestituisce gli allegati con un link per il download quando i dati del record contengono campi allegati. Il link URL per ciascun allegato ha unascadenza di 10 minuti.booleano

Esempio di richiesta

OTTENETEL'https://api.gwapps.com/v1/forms/66b18359dc7659dc4cb98d15/records/recordId

Risposta

La risposta restituita conterrà le informazioni relative al record, dove

AttributoDescrizioneTipo
_idL'ID del recordstringa
palcoscenicoIl palcoscenico del discoPalcoscenico
codice breveDipende dal tipo di campoOgni valore è diverso a seconda del tipo di campo

Esempio di risposta

{
  "kind": "form#record",
  "_id": "recordId",
  "meta": {
    "appId": "6266db8cbd86d9001a70c9ea",
    "formId": "66b18359dc7659dc4cb98d15"
  },
  "stage": "stg0",
  "text1": "Example Text"
}

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.

Aggiornato il 27 agosto 2024
Questo articolo è stato utile?

Articoli correlati