Aggiornare un Record

​

Percorso

​

Richiesta

​

Parametri del percorso

• tableId (string): identificatore univoco della Tabella (come ottenerlo).
• recordId (string): identificatore univoco del Record da aggiornare (come ottenerlo).

​

Corpo della richiesta

• record (obbligatorio)
  • Descrizione: dati del Record da aggiornare
  • Tipo: Object
  • Esempio:
    {
      "fields": {
        "Name": "John Doe",
        "Age": 31,
        "Email": "john.doe@example.com"
      }
    }
    
  • Nota: l’oggetto fields contiene i nomi dei Campi e i relativi nuovi valori. Ogni tipo di Campo ha una struttura di valori diversa; per i dettagli, consulta Tipi di valore dei Campi dei Record.

• fieldKeyType (facoltativo)
  • Descrizione: specifica il tipo di chiave del Campo
  • Tipo: String
  • Valori possibili:
    • “name”: usa il nome del Campo come chiave
    • “id”: usa l’ID del Campo come chiave
    • “dbFieldName”: usa il dbFieldName del Campo come chiave
  • Esempio: "name" oppure "id" oppure "dbFieldName"
  • Nota: se non specificato, per impostazione predefinita viene utilizzato il nome del Campo come chiave.
  • Utilizzo:
    • Quando è impostato su “name”:
      {
        "fields": {
          "Name": "John Doe",
          "Age": 30
        }
      }
      
    • Quando è impostato su “id”:
      {
        "fields": {
          "fldABCDEFGHIJKLMN": "John Doe",
          "fldOPQRSTUVWXYZ12": 30
        }
      }
      
• typecast (facoltativo)
  • Descrizione: indica se convertire automaticamente i tipi dei valori dei Campi. Per impostazione predefinita viene applicata una convalida rigorosa, che richiede la corrispondenza tra i valori di input e il tipo di dati del Campo corrente. Se abilitato, il sistema tenterà la conversione automatica.
  • Tipo: Boolean
  • Valori possibili: true o false
  • Esempio: true
  • Nota: se impostato su true, il sistema tenterà di convertire i valori di input nel tipo di valore corretto per il Campo.
  • Esempi di utilizzo:
    • Campo di collegamento: consente di utilizzare direttamente il testo della chiave primaria per creare il collegamento
      {
        "User table": "John Smith"
      }
      
    • Campo data: consente di utilizzare stringhe di data in formato non standard
      {
        "Date": "2023-05-15"
      }
      
    • Campo utente: consente di utilizzare direttamente il nome utente
      {
        "Assigned To": "John Doe"
      }
      

• order (facoltativo)
  • Descrizione: dopo l’aggiornamento, sposta il Record in una posizione specifica all’interno di una determinata Vista.
  • Tipo: Object
  • Proprietà:
    • viewId: ID della Vista
    • anchorId: ID del Record di ancoraggio
    • position: posizione relativa al Record di ancoraggio. Valori possibili: "before" oppure "after"
  • Esempio:
    {
      "viewId": "viwABCDEFGHIJKLMN",
      "anchorId": "rec123456789ABCDE",
      "position": "after"
    }
    

​

Risposta

​

Risposta in caso di successo

• Codice di stato: 200 OK
• Corpo della risposta: restituisce i dati aggiornati del Record.

{
    "id": "rec123456789ABCDE",
    "fields": {
        "Name": "John Doe",
        "Age": 31,
        "Email": "john.doe@example.com"
    }
}

​

Risposte di errore

• Codice di stato: 400 Bad Request: formato del corpo della richiesta non valido o Campi obbligatori mancanti.
• Codice di stato: 404 Not Found: il tableId o il recordId specificato non esiste.

​

Codice di esempio

curl -X PATCH 'https://app.teable.ai/api/table/__tableId__/record/__recordId__' \
  -H 'Authorization: Bearer __token__' \
  -H 'Content-Type: application/json' \
  -d '{
    "record": {
      "fields": {
        "Name": "John Doe",
        "Age": 31
      }
    }
  }'

import { configApi, updateRecord } from '@teable/openapi';

configApi({
  endpoint: 'https://app.teable.ai',
  token,
});

const response = await updateRecord('__tableId__', '__recordId__', {
  record: {
    fields: {
      Name: 'John Doe',
      Age: 31
    }
  }
});

console.log(response.data);

const response = await fetch('https://app.teable.ai/api/table/__tableId__/record/__recordId__', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer __token__',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    record: {
      fields: {
        Name: 'John Doe',
        Age: 31
      }
    }
  })
});

console.log(await response.json());

import requests

response = requests.patch(
    'https://app.teable.ai/api/table/__tableId__/record/__recordId__',
    headers={
        'Authorization': 'Bearer __token__',
        'Content-Type': 'application/json'
    },
    json={
        'record': {
            'fields': {
                'Name': 'John Doe',
                'Age': 31
            }
        }
    }
)

print(response.json())