Action d'API personnalisée

Adresser une requête HTTP authentifiée à l'API SCIM et REST Lucidchart.

Options

Champ Définition Type Obligatoire

Type de requête

Voici les méthodes de requête HTTP prises en charge, ou verbes HTTP, dans un appel API personnalisé (voir Méthodes de requête HTTP).

  • GET : Récupère des données d'un serveur web en fonction des paramètres. Cette méthode demande une représentation de la ressource spécifiée. Si une requête réussit, un message de réponse 200 (OK) est retourné avec le contenu demandé.

  • POST : Envoie des données à un serveur web en fonction des paramètres, par exemple, charger un fichier. Plusieurs requêtes POST peuvent aboutir à un résultat différent d'un seul POST. Soyez prudent pour éviter d'envoyer plusieurs requêtes POST par inadvertance. Si une requête réussit, un message de réponse 200 (OK) est retourné.

  • PUT : Envoie des données à stocker à un emplacement spécifique sur un serveur web en fonction des paramètres, comme charger un fichier. Contrairement aux requêtes POST, les requêtes PUT sont idempotentes. Pour les requêtes réussies, le résultat d'une seule requête PUT est le même que plusieurs requêtes PUT identiques. Si une requête réussit, un message de réponse 200 (OK), 201 (Created) ou 204 (No Content) est retourné.

  • PATCH : Applique des modifications partielles à une ressource sur un serveur web en fonction des paramètres. PATCH n'est pas idempotente. Plusieurs requêtes PATCH pourraient avoir des conséquences non souhaitées. Si un PATCH réussit, un message de réponse 200 (OK) ou 204 (No Content) est retourné.

  • DELETE : Supprime la ressource spécifiée si elle existe du serveur web en fonction des paramètres. Si une requête DELETE aboutit, un message de réponse200 (OK) est renvoyé.

Liste déroulante TRUE

Type API

Utilisez Type d'API pour différencier les deux API prises en charge. Cela garantit qu'un type d'API approprié est sélectionné, et que la requête correcte et les URL relatives sont appliquées.

  • SCIM API

  • REST API

Liste déroulante FALSE

Entrée

Champ Définition Type Obligatoire

Requête

URL liée

L'adresse URL du serveur Web que vous essayez d'appeler. Spécifiez l'URL relative comme /{insert_remaining_URL}.

Vous pouvez spécifier des paramètres de requête dans l'URL relative à l'aide de ?, ou spécifier les paramètres de requête sous forme de paire clé/valeur dans l'entrée Requête.

 Texte TRUE

En-têtes

Spécifiez tous les en-têtes requis en plus de authorization ou content-type, puisque le connecteur gère déjà ces en-têtes.

 Objet FALSE

Requête

Spécifiez tous les paramètres de requête supplémentaires qui doivent être inclus sous forme de paires clé/valeur.

Par exemple, {"name":"something-urgent"}.

 Objet FALSE

Corps

Spécifiez un corps de requête au format JSON.

Cette entrée n'est disponible que pour les requêtes POST, PUT et PATCH.

 Objet FALSE

Sortie

Champ Définition Type

Réponse

Code de statut

Résultat de l'opération. Le connecteur retourne un code de statut HTTP qui indique si l'action effectuée par la carte a réussi ou échoué. Par exemple :

  • Un code de statut 201 Created indique un succès où une nouvelle ressource a été créée.
  • Une erreur 403 Forbidden indique que la requête HTTP n'a pas été traitée parce que les permissions nécessaires étaient manquantes.

Pour une liste complète des codes de statut possibles, voir Codes de statut HTTP.

 Nombre

En-têtes

Contexte détaillé du code de statut, sans lien avec le corps de la sortie. Les en-têtes de réponse dépendent de l'option de requête HTTP sélectionnée. Tous les en-têtes ne sont pas des en-têtes de réponse. Ceci est semblable à {"Content-type":"application/json"}.

 Objet

Corps

Données retournées par votre requête HTTP sélectionnée.

Par exemple, les données d'une requête GET.

 Objet