Aggiornamento allegati record

Endpoint API per aggiornare un record caricando file nei campi di tipo "Allegato".

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

PUThttps://api.gwapps.com/v1/forms/formId/records/recordId/attachments

inizio

Nota: questo endpoint è riservato esclusivamente al caricamento di allegati da registrare con i campi File Picker; solo questi campi possono essere aggiornati tramite questo endpoint.

Parametri

Parametro	Descrizione	Tipo
Parametri di percorso richiesti
formId	L'attuale formId 66b18359dc7659dc4cb98d15	stringa
recordId	Il recordId	stringa
Parametri di query opzionali
sostituisciAllegati	Se il parametro di query viene passato con valoretrue, sostituirà gli allegati esistenti nei dati del campo, altrimenti aggiungerà gli allegati ai dati del campo corrente.	booleano

inizio

Nota: per caricare i file, la richiesta HTTP deve essere di tipomultipart/form-data, in modo da poter inviare i file all'endpoint. I nomi dei campi nella richiesta sono i codici abbreviati dei campi, mentre i valori sono gli allegati da caricare.

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.	*Sono supportati solo i campi File Picker. Fare riferimento al modulo "Panoramica".

Esempio di richiesta

PUThttps://api.gwapps.com/v1/forms/66b18359dc7659dc4cb98d15/records/recordId/attachments

avvertimento

Assicurati di controllare la convalida applicata al campo File Picker nella progettazione del modulo, poiché questo endpoint convalida iltipoela dimensione dei fileconsentiti nel campo. Se i campi da caricare non corrispondono alla convalida, l'endpoint restituirà un array di errori per ogni file e il messaggio di errore relativo alla convalida non soddisfatta.

Esempio di risposta di errore

{
  "error": [
    {
      "fieldCode": "attachment1",
      "fileName": "file.zip",
      "mimeType": "application/zip",
      "message": "This file type is not supported."
    },
    {
      "fieldCode": "attachment1",
      "fileName": "file.md",
      "mimeType": "text/markdown",
      "message": "This file type is not supported."
    }
  ]
}

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.