REST API

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.
 
Rufen Sie bitte folgende Seite auf:
https://app.aqua-cloud.io/aquaWebNG/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

    • Related Articles

    • Konfiguration in aqua

      Dieser Schritt ist optional, aber empfohlen. Um Informationen über Jira Elemente in aqua zu sehen, muss die Verbindung zu Jira konfiguriert werden.   Um die Integration zu konfigurieren, klicken Sie oben links in der aqua Kopfzeile auf das ...

    • Checkliste vor Start

      Bitte stellen Sie sicher, dass alle Themen der Checkliste bearbeitet wurden, bevor Sie mit der Synchronisierung beginnen. Administrativer Zugriff auf aqua und Jira wird für das initiale Setup benötigt. Lizenzen Sie erhalten eine spezielle Jira Sync ...

    • Troubleshooting

      Selbstsigniertes Zertifikat Jira kann so konfiguriert werden, dass sichere Verbindungen über HTTPS unterstützt werden. In diesem Fall werden alle HTTP-Requests von Jira auf HTTPS umgeleitet. Wenn ein selbstsigniertes Zertifikat von Jira verwendet ...

    • LDAP

      Benutzer in aqua können via LDAP authentifiziert werden. Vorbedigung: Der Benutzer wurde zuvor in aqua angelegt, das heißt, der gleiche Benutzername existiert in beiden Systemen: aqua und LDAP. Wenn Sie eine Vielzahl an Benutzern haben, können Sie ...

    • Sync konfigurieren

      Um einen neuen Sync zu erstellen, klicken Sie auf New Sync im SyncConfigurator.     Ein Fenster öffnet sich, indem Sie den Typ des Syncs auswählen müssen.     Üblicherweise haben Sie hier nur Jira Rest zur Auswahl. Um einen Jira Sync zu erstellen, ...