Action d'API personnalisée

Adressez une requête HTTP personnalisée et authentifiée à l'API DataGrail.

Options

Champ Définition Type Obligatoire

Type de requête

Il s'agit de l'une des méthodes de requête HTTP prises en charge, ou de verbes HTTP, dans un appel d'API personnalisé (consultez 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 aboutit, un message de réponse 200 (OK) est renvoyé avec le contenu demandé.
  • POST : envoie des données à un serveur Web en fonction des paramètres (par exemple, le chargement d'un fichier). Plusieurs requêtes POST peuvent produire un résultat différent de celui d'une seule requête POST. Il faut être prudent pour éviter d'envoyer plusieurs requêtes POST par inadvertance. Si une requête aboutit, un message de réponse 200 (OK) est renvoyé.
Liste déroulante TRUE

Entrée

Champ Définition Type Obligatoire

URL liée

L'adresse (URL) du serveur Web que vous essayez d'appeler. Spécifiez l'URL liée comme suit : /{version}/{insert_remaining_URL}.

Vous pouvez spécifier les paramètres de la requête dans l'URL liée en utilisant « ? » ou spécifier les paramètres de la requête comme une paire de clés de l'objet dans l'entrée de requête.

Par exemple, pour le point de terminaison DataGrail : https://api.datagrail.io/v1/privacy_requests l'URL relative est : /privacy_requests.

 Texte TRUE

Requête

Indiquez tout paramètre de requête supplémentaire qui doit être inclus dans le format de l'objet (paires clé-valeur).

 Objet FALSE

En-têtes

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

 Objet FALSE

Corps

Spécifiez un corps de requête au format JSON. Disponible uniquement pour les requêtes POST.

 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