Mettre à jour un Tool

Permet de mettre à jour les informations de base, la définition d'interface et les informations d'authentification d'un Tool au sein de l'organisation spécifiée.

Cette interface permet de mettre à jour les informations de base, la définition d'interface et les informations d'authentification d'un Tool au sein de l'organisation spécifiée.

Méthode de requête

PUT

URL de la requête

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

Authentification de la requête

Utilise l'authentification Basic avec la DevKey / le DevSecret de niveau compte et requiert que le compte appelant dispose de l'autorisation de gestion des Tools de l'organisation.

Requête

Exemple de requête

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"
  }'

Ce bloc de code dans la fenêtre flottante

En-têtes de la requête

Champ	Type	Description
Authorization	Basic ${BASIC_TOKEN}	Utilisez le Basic Token obtenu en encodant `DevKey:DevSecret` en Base64.
Content-Type	application/json	Format du corps de la requête.

Paramètres de la requête (Body Parameters)

Champ	Type	Description	required
org_id	String	ID de l'organisation.	true
tool_id	String	ID du Tool.	true
name	String	Nom du Tool, 20 caractères maximum.	true
display_name	String	Nom d'affichage du Tool, 50 caractères maximum.	false
description	String	Description du Tool, 100 caractères maximum.	true
logo	String	URL de l'icône du Tool.	true
url	String	URL de base du Tool, doit être une adresse publique `http/https`.	true
show_request	Boolean	Indique s'il faut afficher le contenu de la requête pendant l'appel.	true
api_schema	String	OpenAPI JSON Schema. La définition d'interface n'est pas mise à jour s'il n'est pas fourni.	false
auth_provider	String	Fournisseur d'authentification. La configuration d'authentification n'est pas mise à jour s'il n'est pas fourni.	false
auth_type	String	Type d'authentification.	false
auth_key	String	key ou token d'authentification.	false
auth_key_name	String	Nom d'affichage de la key d'authentification.	false
auth_key_tip	String	Info-bulle de la key d'authentification.	false
auth_secret	String	secret d'authentification.	false
auth_secret_name	String	Nom d'affichage du secret d'authentification.	false
auth_secret_tip	String	Info-bulle du secret d'authentification.	false

Réponse

Exemple de réponse

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

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

Ce bloc de code dans la fenêtre flottante

Réponse en cas de succès

Champ	Type	Description
affect_count	Integer	Nombre d'enregistrements affectés.

Réponse en cas d'échec

Champ	Type	Description
code	Integer	Code d'erreur.
message	String	Détails de l'erreur.

Codes d'état

Code d'état	Description
200	Succès
400	Erreur de paramètre
401	Non autorisé
403	Autorisation insuffisante
429	Requêtes trop fréquentes
500	Erreur du serveur