Référence API REST d’Administration du site

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

Améliorations de la documentation

La documentation API REST d’Administration du site comprend les améliorations suivantes :

  • Utiliser le format de description des API Swagger, qui rend la documentation plus lisible.

  • Inclure les API REST d’Administration du site pour SaaS.

Accéder à la documentation de l’API REST de SA

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

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

  1. À partir de la page ALM qcbin (http://<ALM server>:<port number>/qcbin/), cliquer sur le lien Outils.

  2. Au bas de la page des outils ALM, cliquez sur le lien Documentation ALM REST API.

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

Retour en haut

Étiquettes de l’API REST de SA

Les étiquettes suivantes sont ajoutées aux API REST de l’Administration du site :

Étiquette Description
SaaS uniquement

Cette étiquette est ajoutée pour les API REST qui sont disponibles pour ALM SaaS uniquement. Vous ne pouvez pas les utiliser pour les environnements sur site.

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

Cette étiquette est ajoutée pour les API REST qui nécessitent des autorisations d’administrateur de site pour ALM SaaS. Les administrateurs des clients ne peuvent pas utiliser ces API.

Remarque : Chaque API REST disponible pour les installations sur site nécessite des autorisations d’administrateur du site. Cependant, toutes ces API n’incluent pas cette étiquette, à moins qu’elles ne soient également disponibles pour les administrateurs du site SaaS.

Retour en haut

Autorisations

Pour les installations sur site, toutes les API REST SA nécessitent les autorisations de l’administrateur du site.

Pour ALM SaaS, la possibilité pour un utilisateur d’utiliser une API et ce qu’elle renvoie dépendent des autorisations du rôle de l’utilisateur. Par exemple, la même API peut renvoyer des données différentes pour un administrateur du site et un administrateur de client. Pour vous assurer que vous disposez des autorisations requises, nous vous recommandons d’appeler les API SaaS (à l’exception des API réservées aux administrateurs du site) avec le rôle d’administrateur client.

Retour en haut