Metadatenfelder löschen

Löschen Sie Metadatenfelder stapelweise anhand ihrer IDs. Vom System vordefinierte Felder können nicht gelöscht werden. Pro Anfrage können bis zu 50 Felder gelöscht werden. ids wird als durch Kommas getrennter URL-Abfrageparameter und nicht im Anfragetext übergeben.

Anfragemethode

DELETE

Endpunkt

https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/field/delete

Authentifizierung

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

Anfrage

Anfragebeispiel

curl -X DELETE 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/field/delete?ids=665f1c8a9b2e4d001a3f0001,665f1c8a9b2e4d001a3f0002' \ -H 'Authorization: Bearer ${API Key}'

                      
                      curl -X DELETE 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/field/delete?ids=665f1c8a9b2e4d001a3f0001,665f1c8a9b2e4d001a3f0002' \
-H 'Authorization: Bearer ${API Key}'

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Bearer ${API Key}	Authentifizieren Sie sich mit `Authorization: Bearer ${API Key}`. Den API Key erhalten Sie auf der API-Schlüsselseite.

Anfrageparameter

Feld	Typ	Erforderlich	Beschreibung
ids	String	Ja	Durch Kommas getrennte Feld-IDs, bis zu 50 pro Anfrage.

Antwort

Antwortbeispiel

{ "success_count": 1, "failure_count": 2, "results": [ { "id": "665f1c8a9b2e4d001a3f0001", "success": true }, { "id": "665f1c8a9b2e4d001a3f0003", "success": false, "error_message": "field not found" }, { "id": "665f1c8a9b2e4d001a3f0004", "success": false, "error_message": "predefined field cannot be deleted" } ] }

                      
                      {
    "success_count": 1,
    "failure_count": 2,
    "results": [
        {
            "id": "665f1c8a9b2e4d001a3f0001",
            "success": true
        },
        {
            "id": "665f1c8a9b2e4d001a3f0003",
            "success": false,
            "error_message": "field not found"
        },
        {
            "id": "665f1c8a9b2e4d001a3f0004",
            "success": false,
            "error_message": "predefined field cannot be deleted"
        }
    ]
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
success_count	Integer	Anzahl erfolgreich gelöschter Felder.
failure_count	Integer	Anzahl der Felder, die nicht gelöscht werden konnten.
results	Array<Object>	Löschergebnis für jede ID.
id	String	Feld-ID.
success	Boolean	Ob der Löschvorgang erfolgreich war.
error_message	String	Fehlergrund: field not found (Feld existiert nicht) / predefined field cannot be deleted (voreingestellte Felder können nicht gelöscht werden).

Fehlerantwort

Feld	Typ	Beschreibung
code	Integer	Fehlercode.
message	String	Fehlerdetails.