Verify Interfaces de programmation d'applications (API)

Modifier en ligne

Verify Les interfaces de programmation d'applications (API) sont accessibles et peuvent être utilisées pour le développement d'applications en interne.

Support Pour plus d'informations, consultez la documentation de l'API dans le IBM® Verify Centre de documentation.

Formation IBM Regardez une Verify vidéo sur les API dans la formation « IBM ».

Méthodes HTTP

Chaque ressource d'API est identifiée par un URI (Uniform Resource Identifier) désigné et est accessible à l'aide des méthodes HTTP standard suivantes. Les méthodes HTTP indiquent l'action prévue sur un objet.
Tableau 1. HTTP méthodes
méthode HTTP Descriptif
GET Extrait une ressource ou une relation à l'URL spécifiée.
  • Une requête au niveau de la ressource URL (<resource-noun>) permet de récupérer toutes les instances, sous réserve des contraintes de recherche et de pagination (voir la section « Recherche »).
  • Une requête au niveau de l'identifiant de ressource (<resource-noun>/<resource-id>) renvoie une ressource spécifique.
  • Une requête au niveau du nom de la relation (<relationship>) permet de récupérer toutes les instances de cette relation, sous réserve des contraintes de recherche et de pagination.
  • Le code de statut de la réponse par défaut est 200.
  • La pagination du résultat peut être personnalisée en ajoutant un paramètre de requête, comme "count" avec une valeur maximale de 1 000.
  • Une requête au niveau de l'identifiant de relation (<relationship>/<relationship-id>) renvoie une instance de relation spécifique.
POST Crée une ressource ou une relation à l'URL spécifiée.
  • Une requête au niveau de la ressource URL (<resource-noun>) crée la ressource.
  • Une requête au niveau de l'identifiant de relation (<relationship>) permet de créer la nouvelle relation.
  • Peut être utilisé pour la création de charge en bloc.
PUT Met à jour une ressource ou une relation à l'URL spécifiée
  • Une requête au niveau de la ressource URL (<resource-noun>) met à jour la ressource.
  • Une requête au niveau de l'identifiant de relation (<relationship>) met à jour la nouvelle relation. Toutes les relations ne peuvent pas être modifiées, dans certains cas cela peut être considéré comme une mauvaise demande.
  • Une demande de modification d'informations en lecture seule (telles que l'identificateur de ressource ou de relation) est considérée comme une demande incorrecte.
PATCH

Utilisé pour les mises à jour partielles d'une ressource.

  • Une requête au niveau de l' URL,<resource-noun> qui met à jour uniquement les modifications apportées aux propriétés spécifiées dans la requête concernant la ressource indiquée.
  • Le type de contenu pour PATCH est application/json-patch+json.
  • Si une opération de suppression est spécifiée avec l'identificateur principal (ID unique ou propriété mappée à une clé primaire), l'objet entier est supprimé.
DELETE Supprime une ressource ou une relation à l'URL spécifiée.
Remarque : pour supprimer des données en masse, utilisez PATCH.