REST API

aqua bietet eine REST API an. Über diese Schnittstelle können Sie dann z.B. Informationen aus Elementen oder Ausführungen abrufen, neue Elemente anlegen oder modifizieren, die Benutzerverwaltung steuern, Testausführungen erstellen und vieles mehr. Das hat den Vorteil, dass Sie über Skripte wiederkehrende Aufgaben in aqua automatisieren, schnell mit großen Datenmengen umgehen (z.B. tausende Benutzer einem Projekt zuweisen) oder auch Schnittstellen zu Ihren Drittsystemen oder Automatisierungstools erstellen können.
 
Die REST API ist im Detail dokumentiert mit Beispielen für die Requests sowie den möglichen Antworten und Inhalten.
 
Hierzu müssen Sie als aqua On Premises Kunde nur die REST API Hilfeseite aufrufen unter:
http(s)://<IhrServerNameOderIP>/aquaWebNG/Help
 
bzw. in manchen Fällen:
http(s)://<IhrServerNameOderIP>/aquaWeb/Help
 
Bitte ersetzen <IhrServerNameOderIP> durch Ihren Servernamen oder die Server IP-Adresse.
 
Als aqua SAAS Kunde rufen Sie bitte folgende Seite auf:
https://aqua-saas2.andagon.com/aquaWebNG/Help
 
Als aqua Interessent auf der Demoumgebung rufen Sie bitte folgende Seite auf:
https://aqua-demo2.andagon.com/aquaWeb/Help
 
 
 
Bitte beachten Sie auch folgendes bei der Verwendung der REST API:
  • Die Berechtigungen und die Lizenz des Benutzers, der für den Login der REST API verwendet wird, wirkt sich darauf aus, was erlaubt ist. Z.B. können Sie nicht mit einem Benutzer, der keine Rechte auf die Testfallerstellung hat über die API einen Testfall erstellen
  • Die ID von Elementen innerhalb der Requests muss ohne führende Nullen angegeben werden, also z.B. 123 und nicht TC000123 oder 000123