Datensatz aktualisieren

​

Pfad

​

Anfrage

​

Pfadparameter

• tableId (string): Die eindeutige Kennung der Tabelle (so erhalten Sie sie).
• recordId (string): Die eindeutige Kennung des zu aktualisierenden Datensatzes (so erhalten Sie sie).

​

Anfragekörper

• record (erforderlich)
  • Beschreibung: Die zu aktualisierenden Datensatzdaten
  • Typ: Object
  • Beispiel:
    {
      "fields": {
        "Name": "John Doe",
        "Age": 31,
        "Email": "john.doe@example.com"
      }
    }
    
  • Hinweis: Das fields-Objekt enthält Feldnamen und die entsprechenden neuen Werte. Jeder Feldtyp hat eine andere Wertstruktur; Details finden Sie unter Werttypen für Datensatzfelder.

• fieldKeyType (optional)
  • Beschreibung: Legt den Typ des Feldschlüssels fest
  • Typ: String
  • Mögliche Werte:
    • “name”: Feldname als Schlüssel verwenden
    • “id”: Feld-ID als Schlüssel verwenden
    • “dbFieldName”: dbFieldName des Feldes als Schlüssel verwenden
  • Beispiel: "name" oder "id" oder "dbFieldName"
  • Hinweis: Wenn nicht angegeben, wird standardmäßig der Feldname als Schlüssel verwendet.
  • Verwendung:
    • Bei Einstellung auf “name”:
      {
        "fields": {
          "Name": "John Doe",
          "Age": 30
        }
      }
      
    • Bei Einstellung auf “id”:
      {
        "fields": {
          "fldABCDEFGHIJKLMN": "John Doe",
          "fldOPQRSTUVWXYZ12": 30
        }
      }
      
• typecast (optional)
  • Beschreibung: Gibt an, ob Feldwerttypen automatisch konvertiert werden sollen. Standardmäßig wird eine strikte Validierung erzwungen, bei der Eingabewerte dem Datentyp des aktuellen Felds entsprechen müssen. Wenn aktiviert, versucht das System eine automatische Konvertierung.
  • Typ: Boolean
  • Mögliche Werte: true oder false
  • Beispiel: true
  • Hinweis: Wenn auf true gesetzt, versucht das System, Eingabewerte in den korrekten Feldwerttyp zu konvertieren.
  • Anwendungsbeispiele:
    • Verknüpfungsfeld: Für die Verknüpfung kann direkt der Primärschlüsseltext verwendet werden
      {
        "User table": "John Smith"
      }
      
    • Datumsfeld: Datumszeichenfolgen in nicht standardisiertem Format können verwendet werden
      {
        "Date": "2023-05-15"
      }
      
    • Benutzerfeld: Der Benutzername kann direkt verwendet werden
      {
        "Assigned To": "John Doe"
      }
      

• order (optional)
  • Beschreibung: Verschieben Sie den Datensatz nach der Aktualisierung an eine angegebene Position in einer angegebenen Ansicht.
  • Typ: Object
  • Eigenschaften:
    • viewId: Ansichts-ID
    • anchorId: Anker-Datensatz-ID
    • position: Position relativ zum Anker-Datensatz. Mögliche Werte: "before" oder "after"
  • Beispiel:
    {
      "viewId": "viwABCDEFGHIJKLMN",
      "anchorId": "rec123456789ABCDE",
      "position": "after"
    }
    

​

Antwort

​

Erfolgsantwort

• Statuscode: 200 OK
• Antwortkörper: Gibt die aktualisierten Datensatzdaten zurück.

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

​

Fehlerantworten

• Statuscode: 400 Bad Request: Fehler im Format des Anfragekörpers oder erforderliche Felder fehlen.
• Statuscode: 404 Not Found: Die angegebene tableId oder recordId existiert nicht.

​

Beispielcode

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())