Metadatenfelder bearbeiten

Bearbeiten Sie Metadatenfelder stapelweise. Nur display_label, description und ai_search_filter können geändert werden. Es werden ausschließlich die übergebenen Werte aktualisiert; alle anderen bleiben unverändert. Pro Anfrage können bis zu 50 Felder bearbeitet werden.

Batch-Regeln:
Es können maximal 50 gleichzeitig bearbeitet werden, und der gesamte Stapel wird nicht verarbeitet, wenn er 50 überschreitet.
Wenn eine id in der Anfrage mehrfach vorkommt, wird nur der erste Eintrag verarbeitet; alle weiteren Duplikate schlagen fehl.

Anfragemethode

PUT

Endpunkt

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

Authentifizierung

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

Anfrage

Anfragebeispiel

curl -X PUT 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/field/update' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "fields": [ { "id": "665f1c8a9b2e4d001a3f0001", "display_label": "Dokumentkategorie", "description": "Geschäftskategorie des Dokuments", "ai_search_filter": false } ] }'

                      
                      curl -X PUT 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/field/update' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
    "fields": [
        {
            "id": "665f1c8a9b2e4d001a3f0001",
            "display_label": "Dokumentkategorie",
            "description": "Geschäftskategorie des Dokuments",
            "ai_search_filter": false
        }
    ]
}'

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.
Content-Type	application/json	Datentyp, eingestellt auf `application/json`.

Anfrageparameter

Feld	Typ	Erforderlich	Beschreibung
fields	Array<Object>	Ja	Eine Liste der zu bearbeitenden Felder, bis zu 50 gleichzeitig.
id	String	Ja	ID des Metadatenfelds, mit der das Feld identifiziert wird.
display_label	String	Nein	Neuer Anzeigename mit maximal 64 Zeichen. Wird nur geändert, wenn ein Wert übergeben wird.
description	String	Nein	Neue Feldbeschreibung mit maximal 50 Zeichen. Wird nur geändert, wenn ein Wert übergeben wird.
ai_search_filter	Boolean	Nein	Neue Einstellung für den AI Search-Filter. Wird nur geändert, wenn ein Wert übergeben wird.

Antwort

Antwortbeispiel

{ "success_count": 1, "failure_count": 2, "results": [ { "id": "665f1c8a9b2e4d001a3f0001", "success": true }, { "id": "665f1c8a9b2e4d001a3f0002", "success": false, "error_message": "display_label already exists" }, { "id": "665f1c8a9b2e4d001a3f0001", "success": false, "error_message": "duplicate id in request" } ] }

                      
                      {
    "success_count": 1,
    "failure_count": 2,
    "results": [
        {
            "id": "665f1c8a9b2e4d001a3f0001",
            "success": true
        },
        {
            "id": "665f1c8a9b2e4d001a3f0002",
            "success": false,
            "error_message": "display_label already exists"
        },
        {
            "id": "665f1c8a9b2e4d001a3f0001",
            "success": false,
            "error_message": "duplicate id in request"
        }
    ]
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
success_count	Integer	Anzahl erfolgreich bearbeiteter Felder.
failure_count	Integer	Die Anzahl der Felder, die nicht bearbeitet werden konnten.
results	Array<Object>	Feldweise Ergebnisse, zurückgegeben in der Reihenfolge der Anfrage.
id	String	Feld-ID.
success	Boolean	Ob die Bearbeitung erfolgreich war.
error_message	String	Grund für den Fehler: display_label already exists (der Anzeigename steht im Konflikt mit einem vorhandenen) / duplicate id in request (id wird in der Anfrage wiederholt) / field not found (das Feld existiert nicht).

Fehlerantwort

Feld	Typ	Beschreibung
code	Integer	Fehlercode.
message	String	Fehlerdetails.