Référence API REST Administration du site

Vous pouvez utiliser l’API REST Administration du site pour accéder aux données ALM et les utiliser dans Administration du site. La référence API REST Administration du site fournit une référence en ligne complète pour l’API de base REST Administration du site.

Accéder à la documentation de l’API REST Administration du site

La documentation sur l’API REST Administration du site est intégrée au produit.

Pour accéder à la documentation sur l’API REST Administration du site :

  1. Ouvrez le lien suivant : http://<serveur>:<numéro du port>/qcbin/api-doc/sa/v2/.

    Sur la page ALM qcbin (http://<serveur ALM>:<numéro du port>/qcbin/), vous pouvez également cliquer sur le lien Outils. Au bas de la page Outils, cliquez sur le lien Guide de ALM Site Administration REST API.

  2. Dans le menu latéral, développez la section concernée.

Cette documentation inclut toutes les API REST dont l’URL commence par qcbin/v2/sa/api.

Retour en haut

API SaaS uniquement

Les API dotées de la balise SaaS uniquement sont disponibles uniquement pour l’édition SaaS. Vous ne pouvez pas les utiliser pour les environnements sur site.

Pour les installations sur site, toutes les API sans cette étiquette sont disponibles.

Retour en haut

Autorisations

La section Autorisations de chaque API indique les autorisations requises pour appeler l’API.

Nous vous recommandons de lire la section Autorisations avant d’appeler une API.

Retour en haut