Tool aktualisieren

Ermöglicht das Aktualisieren der Basisinformationen, der Schnittstellendefinition und der Authentifizierungsinformationen eines Tool innerhalb einer bestimmten Organisation.

Über diese Schnittstelle können Sie die Basisinformationen, die Schnittstellendefinition und die Authentifizierungsinformationen eines Tool innerhalb einer bestimmten Organisation aktualisieren.

Anfragemethode

PUT

Anfrage-URL

https://api.${endpoint}/v1/org/tool/update

Authentifizierung der Anfrage

Basic-Authentifizierung mit DevKey / DevSecret auf Kontoebene; das aufrufende Konto muss über die Berechtigung zur Verwaltung von Tool der Organisation verfügen.

Anfrage

Beispielanfrage

curl -X PUT 'https://api.${endpoint}/v1/org/tool/update' \ -H 'Authorization: Basic ${BASIC_TOKEN}' \ -H 'Content-Type: application/json' \ -d '{ "org_id": "p-xxxx", "tool_id": "tool-xxxx", "name": "weather", "display_name": "Weather Lookup", "description": "Query current weather", "logo": "https://cdn.example.com/weather.png", "url": "https://api.example.com", "show_request": true, "api_schema": "{\"openapi\":\"3.0.0\",\"paths\":{}}", "auth_provider": "Creator", "auth_type": "Bearer", "auth_key": "token" }'

                      
                      curl -X PUT 'https://api.${endpoint}/v1/org/tool/update' \
  -H 'Authorization: Basic ${BASIC_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
    "org_id": "p-xxxx",
    "tool_id": "tool-xxxx",
    "name": "weather",
    "display_name": "Weather Lookup",
    "description": "Query current weather",
    "logo": "https://cdn.example.com/weather.png",
    "url": "https://api.example.com",
    "show_request": true,
    "api_schema": "{\"openapi\":\"3.0.0\",\"paths\":{}}",
    "auth_provider": "Creator",
    "auth_type": "Bearer",
    "auth_key": "token"
  }'

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Basic ${BASIC_TOKEN}	Basic Token als Base64-Kodierung von `DevKey:DevSecret`.
Content-Type	application/json	Format des Anfrage-Body.

Anfrageparameter (Body Parameters)

Parameter	Typ	Beschreibung	required
org_id	String	Organisations-ID.	true
tool_id	String	Tool-ID.	true
name	String	Tool-Name, maximal 20 Zeichen.	true
display_name	String	Anzeigename des Tool, maximal 50 Zeichen.	false
description	String	Tool-Beschreibung, maximal 100 Zeichen.	true
logo	String	URL des Tool-Symbols.	true
url	String	Basis-URL des Tool, muss eine öffentliche `http/https`-Adresse sein.	true
show_request	Boolean	Ob der Anfrageinhalt während des Aufrufs angezeigt wird.	true
api_schema	String	OpenAPI-JSON-Schema. Ohne Angabe wird die Schnittstellendefinition nicht aktualisiert.	false
auth_provider	String	Authentifizierungsanbieter. Ohne Angabe wird die Authentifizierungskonfiguration nicht aktualisiert.	false
auth_type	String	Authentifizierungstyp.	false
auth_key	String	Authentifizierungs-Key oder -token.	false
auth_key_name	String	Anzeigename des Authentifizierungs-Key.	false
auth_key_tip	String	Hinweis zum Authentifizierungs-Key.	false
auth_secret	String	Authentifizierungs-Secret.	false
auth_secret_name	String	Anzeigename des Authentifizierungs-Secret.	false
auth_secret_tip	String	Hinweis zum Authentifizierungs-Secret.	false

Antwort

Beispielantwort

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

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

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
affect_count	Integer	Anzahl der betroffenen Datensätze.

Fehlerantwort

Feld	Typ	Beschreibung
code	Integer	Fehlercode.
message	String	Fehlerdetails.

Statuscodes

Statuscode	Beschreibung
200	Erfolgreich
400	Ungültige Parameter
401	Nicht autorisiert
403	Unzureichende Berechtigungen
429	Zu viele Anfragen
500	Serverfehler