Tabellendaten löschen

Mit dieser API können Sie gezielt Datensätze aus Agent-Datenbanktabellen stapelweise löschen. Pro Anfrage können maximal 1.000 Datensätze entfernt werden.

Anfragemethode

POST

Anfrage-URL

https://api-${endpoint}/v2/database/delete/record

Authentifizierung

Informationen zur Authentifizierung finden Sie im Abschnitt Authentifizierung in der API-Übersicht.

Anfrage

Beispielanfrage

curl -X POST 'https://api-${endpoint}/v2/database/delete/record' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "table_id": "673af861ed69656ac0895b07", "delete_data":[ { "record_id":"123456" }, { "filter": { "id": "789" } } ] }'

                      
                      curl -X POST 'https://api-${endpoint}/v2/database/delete/record' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
      "table_id": "673af861ed69656ac0895b07",
      "delete_data":[
        {
          "record_id":"123456"
        },
        {  
          "filter": {
            "id": "789"
          }
        }
      ]
    }'

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Bearer ${API Key}	Verwenden Sie `Authorization: Bearer ${API Key}` zur Authentifizierung. Ihren API Key erhalten Sie auf der Seite API-Schlüssel.
Content-Type	application/json	Datentyp, muss application/json sein.

Anfrage-Body

Feld	Typ	Erforderlich	Beschreibung
table_id	string	Ja	Die ID der Tabelle.
delete_data	array	Ja	Array der zu löschenden Datensätze.
record_id	string	Nein	Entweder record_id oder Filterbedingung angeben. record_id wird empfohlen.
filter	map	Nein	Individuelle Filterbedingungen (es müssen eigene eindeutige Primärschlüsselfelder genutzt werden).

Hinweis: Sie müssen entweder record_id oder eine Filterbedingung angeben, wobei record_id bevorzugt wird. Wenn beides vorhanden ist, hat record_id Vorrang.

Antwort

Beispielantwort

{ "code": 0, "message": "OK" }

                      
                      {
    "code": 0,
    "message": "OK"
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
code	int	Antwortcode zur Kennzeichnung des Nachrichtentyps.
message	string	Beschreibung der Antwortnachricht.

Fehlerantwort

Feld	Typ	Beschreibung
code	int	Fehlercode.
message	string	Detaillierte Fehlermeldung.

Fehlercodes

Code	Nachricht
40000	Ungültige Parameter
50000	Interner Systemfehler
403106	Tabelle nicht gefunden
403131	Keine Berechtigung für Zugriff auf die Tabelle