Documentation - aqua cloud
🇩🇪 Deutsch
🇩🇪 Deutsch
  • 💻WEB-CLIENT
    • Erste Schritte
    • Allgemein
      • Startseite
      • App-Sprache
      • Benutzerkonto
      • Passwort ändern
      • Tastenkombinationen & Barrierefreiheit
    • Kontakt zu unserem Support
  • 🧑‍🔧Verwaltung
  • Benutzerverwaltung
    • Hinzufügen und Verwalten von Benutzern
    • Rollen und Berechtigungen
    • Zuweisung von Lizenzen, Projekten und Rollen
    • Vergleich der Lizenzen
    • Lizenzstatistik
    • Statistiken
  • Projektkonfiguration
    • Konfiguration der Projektvorlage (Felder)
    • Feldregeln
    • Geteilte Wertesätze
    • Erstellen von Feldgruppen
    • Workflow-Konfiguration
    • Weitere Projekteinstellungen
    • Projektintegrationen
    • System-Log
    • E-Mail-Benachrichtigungen
      • Projekt-Standardbenachrichtigungen
      • Meine Benachrichtigungen
      • Konfiguration der Projektbenachrichtigungsvorlagen
      • Troubleshooting
  • Projekte und Ordner
    • Projekt erstellen
    • Projekte
      • Projekt exportieren
      • Projekt importieren
        • Migration von Testrail
      • Projekt archivieren
    • Ordner
      • Projektordner exportieren
      • Projektordner importieren
  • 🧩Module
  • Navigation
    • Projektbaum
    • Elementbrowser (Grid)
    • Filter und Gruppierung
    • Ansichten
    • Suche
    • Vorschau der Elementdetails
  • Elemente
    • Anforderungsmanagement
      • Anforderungen
      • Unteranforderungen
      • Anforderungsabdeckung
    • Testfallmanagement
      • Testfälle
      • Eingebettete Testfälle
      • Manuelles Testen
      • Testdaten oder Variablen-Manager
      • Verfolgung der Testumgebung mit Labels (Tags)
      • Ergebnisse der Testausführung
      • Capture: Testrekorder/ Fehlerreporter
      • Jetzt Testen: einfacher Start einer Testausführung
      • Schnelle Ausführung: Testlauf von mehreren Testfällen auf einmal
    • Management von Testszenarien
      • Testszenarien
      • Hinzufügen von Testfällen zu einem Testszenario
      • Ausführen von Testszenarios
    • Fehlermanagement
      • Fehler
      • Fehler aus einer Testausführung erstellen
      • Reviewen von gefundenen oder mit der Testdurchführung verknüpften Fehlern
      • Erstellen eines Fehler mit Capture
    • Allgemeine Funktionen in den Elementen
      • Erstellen und Bearbeiten von Elementen
      • Element in ein Zielprojekt kopieren oder innerhalb eines Projekts duplizieren
      • Übernahme von Feldwerten zwischen Elementen
      • Elementvorlage (Standardwerte)
      • Abhängigkeiten
      • Links zu einer Beschreibung hinzufügen
      • Bildschirmfotos erstellen
      • Element beobachten und andere Benutzer benachrichtigen
      • Anhänge (Dateien)
      • Verlauf der Änderungen
      • Diskussionen (Kommentare)
      • Elementdaten drucken
  • Berichte
    • Erstellen einer neuen Berichtsvorlage
    • Grundelemente des Berichts
    • Baumstruktur der Elemente
    • Eigenschaften der Elemente
    • Diagramme
    • Pivot-Tabelle
    • Funktion 'Sum'
    • Erstellen eines benutzerdefinierten Berichtsskripts
    • Parametrisierung von Berichten
    • Leere Elemente aus einem Bericht ausschließen
    • Hinzufügen eines Inhaltsverzeichnisses zu einem Bericht
  • Dashboards
    • Erstellen eines Dashbords
    • Dashboards veröffentlichen/teilen
    • Erstellen eines Diagramms
    • KPI-Warnungen
    • Drilldown zu Details aus einem Diagramm
    • Vorlage für Burndown-Chart
  • Agile
    • Backlog
    • Sprint-Board
    • Vorschau
  • 🖥️Desktop-Client
  • Wichtiger Hinweis: Abschaffung des Desktop-Clients bis April 2025
  • FAQ: Umstellung vom Desktop-Client auf den Web-Client
  • Desktop Client-Installation
  • 💿Installation für On-Premise
  • System Anforderungen
    • Server
    • Rich Client
    • Web Client
    • Agenten
  • Installation des Servers
  • Installation des Webclients
  • Desktop Client und Agenten
  • Verbindung zur MSSQL Datenbank
  • Verbindung zur Oracle Datenbank 12.2c
  • Lizenzen
  • Monitoring
  • SSL-Konfiguration
  • Einstellungen für die Content Security Policy (CSP)
  • Server-Parameter
  • Update Ihrer Installation
    • Info
    • Server stoppen
    • Update der MSSQL Datenbank
    • Update der Oracle Datenbank
    • Update des Servers
    • Update des Webclients
    • Server starten
    • Update des Desktop-Clients
    • Update der Agenten
    • Update der Hinweise
  • ❔FAQ
    • E-Mail Benachrichtigung - Web Client Links
    • E-Mail Template für neue Benutzer und Passwort zurücksetzen anpassen
    • Maximale Anhanggröße anpassen
    • 🪄KI-Kopilot
    • Transformieren Sie Ihr Test- und Projektmanagement mit KI Copilot von aqua
    • Aktivieren und Verwalten der KI Copilot Optionen
    • Einfache Erstellung von Dokumenten mit KI-Kopilot
    • KI-Kopilot: Generieren Sie eine umfassende Beschreibung für die Testfälle mit nur einem Klick
    • KI-Copilot - Testfälle aus Anforderungen oder aus dem Kontext in Sekunden erstellen
      • Erstellen von Testfällen aus einer Anforderung
      • Erstellen eines Testfalls von einer Testfallseite aus
      • Erstellen von Testfällen über die Navigationsseite
    • Generierung von Testdaten mit KI Copilot
    • Generierung von Testfall basierend auf einer Datei
    • Erstellen Sie User Stories, BDDs oder PRDs basierend auf einer Datei
    • KI-Kopilot-Chat
    • Generierung von Testfällen mit AI Copilot unter Verwendung von Unterstützte Testendesigntechniken
    • 🔗Integrationen
    • Jira-Synchronisierung: Synchronisierung von Elementen zwischen aqua- und Jira-Projekten
      • Checkliste vor dem Start
      • SyncConfigurator herunterladen
      • Erste Einrichtung der Synchronisation
      • Synchronisierung der Projekte zwischen aqua und Jira
      • Feldermapping
        • Unterstützte Jira Standardfelder
        • Kompatibilität der Felder zwischen aqua und Jira
        • Besondere Kompatibilität der Felder zwischen aqua und Jira
      • Erlaube das Mapping nur ausgewählter Werte und ignoriere andere Feldwerte für die Synchronisierung
      • Troubleshooting
      • Formatierungsunterstützung
    • Azure Devops Synchronisierung
    • Jira-Link: Erstellen und/oder Verknüpfen von Jira-Themen mit aqua-Tickets
    • aqua4Jira-Plugin: Jira-Ausgabe mit aqua-Testfällen abdecken
      • Installation des Plug-ins
        • aqua4Jira Plugin - Jetzt kompatibel mit Jira Data Center!
      • Konfiguration in Jira
      • Konfiguration in aqua
    • Confluence Integration
    • Testlink: Importer-Tool für die Migration von Testfällen nach aqua
    • SSO
      • LDAP
      • SAML-Konfiguration
        • Installation
        • Beispiel
    • 🌀Automatisierung
    • Desktop Client
      • Erstellen eines Automatisierungsagenten
      • Konfiguration der Automatisierung
      • Ranorex
      • UFT
      • JMeter
      • SoapUI
      • Datenbank
      • UnixShell
      • PowerShell
      • Jenkins Integration
      • Automatisierungsbibliothek
    • Web Client
      • Automatisierungsagent
        • Erstellung & Konfiguration
        • Agentenpools
        • Laufende Aufgabe
      • PowerShell
      • Unix Shell
      • Jenkins
      • Selenium
    • REST-API
    • Automatisierung: CI/CD-Werkzeuge und aqua REST API
      • Gitlab CI/CD: JAVA/Playwright
      • Gitlab CI/CD: TypeScript/Cypress
      • Gitlab CI/CD: TypeScript/Playwright
      • Gitlab CI/CD: TypeScript/Cypress/Cucumber
    • 🚀Produktaktualisierungen On Premise
    • Funktionsleitlinien
      • 25.30.0 - On Premise
      • 25.18.0 - On premise
      • 25.10.0- On premise
      • 24.126.0 - On premise
      • 24.108.0 - On premise
      • 24.101.0 - On premise
      • 24.93.0 - On Premise
      • 24.83.0 - On Premise
      • 24.71.0 - On Premise
      • 24.53.0 - On Premise
      • 24.8 - On Premise
      • 23.140 - On Premise
      • 23.126.0 - On Premise
      • 23.102.0 - On Premise
      • 23.70.0 - On Premise
      • 23.22.0 - On Premise
      • 22.132.0 - On Premise
      • 22.123.0 - On Premise
    • Release Notes
      • 25.31.0 und 25.33.0 - On Premise
      • 25.30.0 - On Premise
      • 25.26.0 - On Premise
      • 25.18.0 - On Premise
      • 25.10.0 - On Premise
      • 24.135.0 - On Premise
      • 24.130.0 - On Premise
      • 24.126.0 - On Premise
      • 24.114.0 - On Premise
      • 24.108.0 - On Premise
      • 24.101.0 - On Premise
      • 24.93.0 - On Premise
      • 24.83.0 - On Premise
      • 24.71.0 - On Premise
      • 24.53.0 - On Premise
      • 24.8.0 - On Premise
      • 23.140.0 - On Premise
      • 23.126.0 - On Premise
      • 23.102.0 - On Premise
      • 23.70.0 - On Premise
      • 23.22.0 - On Premise
      • 22.132.0 - On Premise
      • 22.123.0 - On Premise
    • 🚀Produktaktualisierungen für Kunden von Public und Private Clouds
    • Funktionsleitlinien
      • 25.36.0 - public und private cloud
      • 25.33.0 - Public und Private cloud
      • 25.18.0 - Public und Private cloud
      • 25.10.0 -Public and Private Cloud
      • 24.126.0 - Public and Private Cloud
      • 24.108.0 - Public and Private Cloud
      • 24.101.0 - Public and Private Cloud
      • 24.93.0 - Public and Private Cloud
      • 24.88.0 - Public und Private Clouds
      • 24.88.0 - Public und Private Clouds
      • 24.83.0 - Public und Private Clouds
      • 24.71.0 - Public und Private Clouds
      • 24.63.0 - Public und Private Clouds
      • 24.50.0 - Public und Private Clouds
      • 24.33.0 - Public und Private Clouds
      • 24.8.0 - Public und Private Clouds
      • 23.140 - Public und Private Clouds
      • 23.126.0 - Public und Private Clouds
      • 23.107.0 - Public und Private Clouds
      • 23.92 - Public und Private Clouds
      • 23.70.0 - Public und Private Clouds
      • 23.46.0 - Public und Private Clouds 1/3
      • 23.46.0 - Public und Private Clouds 2/3e
      • 23.46.0 - Public und Private Clouds 3/3
      • 23.22.0 - Public und Private Clouds
      • 22.123.0 - Public und Private Clouds
    • Release Notes
      • 25.33.0- Public und Private Clouds
      • 25.31.0- Public und Private Clouds
      • 25.30.0 - Public und Private Cloud
      • 25.24.0 - Public und Private Cloud
      • 25.18.0 - Public und Private Cloud
      • 25.10.0 - Public und Private Cloud
      • 24.135.0 - Public and Private Clouds
      • 24.130.0 - Public and Private Clouds
      • 24.126.0 - Public and Private Clouds
      • 24.114.0 - Public and Private Clouds
      • 24.108.0 - Public and Private Clouds
      • 24.101.0 - Public and Private Clouds
      • 24.93.0 - Public and Private Clouds
      • 24.88.0 - Public und Private Clouds
      • 24.83.0 - Public und Private Clouds
      • 24.71.0 - Public und Private Clouds
      • 24.63.0 - Public und Private Clouds
      • 24.50.0 - Public und Private Clouds
      • 24.33.0 - Public und Private Clouds
      • 24.8.0 - Public und Private Clouds
      • 23.140.0 - Public und Private Clouds
      • 23.126.0 - Public und Private Clouds
      • 23.107.0 - Public und Private Clouds
      • 23.92 - Public und Private Clouds
      • 23.70.0 - Public und Private Clouds
      • 23.46.0 - Public und Private Clouds
      • 23.22.0 - Public und Private Clouds
      • 22.132.0 - Public und Private Clouds
      • 22.123.0 - Public und Private Clouds
    • 📢 AQUA NEWS
      • Vorschau auf die öffentliche API von aqua
    • 📹Capture
    • Was ist Capture?
    • Installation der Chrome-Erweiterung
    • Aufnehmen im Inkognito-Modus
    • Verwenden von Capture mit Edge
    • Aufzeichnung mit Video
      • Option zum Aktivieren des Mikrofons für Sprachaufnahmen während der Bildschirmaufnahme
      • Option zum Pausieren/Fortsetzen während der Videoaufzeichnung
    • Erfassen mit Screenshot
    • Ausführung eines Tests
    • Last-Minute-Sitzungswiederholung
    • Maskierte Eingaben beim Erstellen von Captures
Powered by GitBook
On this page
  • Allgemeine Informationen
  • Zugriff auf die Rest-API

Was this helpful?

  1. FAQ

REST-API

PreviousSeleniumNextAutomatisierung: CI/CD-Werkzeuge und aqua REST API

Last updated 19 days ago

Was this helpful?

Allgemeine Informationen

Wir bieten eine REST-API an. Sie können die API nutzen, um auf Informationen zu Items oder Testruns zuzugreifen, neue Items zu erstellen oder zu ändern, die Benutzerverwaltung zu managen, Testruns zu erstellen und vieles mehr.

Dies ermöglicht es Ihnen, wiederkehrende Aufgaben in aqua über Skripte zu automatisieren, große Datenmengen einfach zu handhaben (z. B. Tausende von Benutzern einem Projekt zuzuweisen) oder Schnittstellen zu Ihren Drittsystemen oder Automationstools zu erstellen.

Die REST-API ist ausführlich dokumentiert, mit Beispielen der Anfragen sowie der möglichen Antworten und Inhalte.

Als aqua OnPremises-Kunde finden Sie die Dokumentation auf der REST API-Hilfeseite unter:

http(s)://<IhrServernameOderIP>/aquaWebNG/Help

oder in einigen Fällen:

http(s)://<IhrServernameOderIP>/aquaWeb/Help

Bitte ersetzen <IhrServernameOderIP> mit Ihrem Servernamen oder der IP-Adresse des Servers.

Als aqua-SaaS-Kunde, bitte besuchen Sie die folgende Seite:

Bitte beachten Sie auch Folgendes bei der Nutzung der REST

  • Die Berechtigungen und Lizenzen des Benutzers, der sich in die REST-API einloggt, beeinflussen, was erlaubt ist. Beispielsweise kann man keinen Testfall mit der API erstellen, wenn der Benutzer keine Berechtigung zum Erstellen von Testfällen hat.

  • Die ID der Elemente innerhalb der Anfragen muss ohne führende Nullen angegeben werden, z.B. 123 und nicht TC000123 oder 000123

Zugriff auf die Rest-API

Bitte folgen Sie den Anweisungen im Abschnitt 'Autorisierungen' unserer REST-API-Dokumentation, um Zugang zu erhalten.​

Wenn Sie JavaScript, Python oder PowerShell verwenden, um mit der REST-API zu kommunizieren, können Sie uns unter support@aqua-cloud.io für zusätzliche Unterstützung kontaktieren.

Um die Stabilität zu verbessern und Ihre Automatisierungs-Workflows zukunftssicher zu gestalten, führen wir in einigen Monaten eine neue öffentliche API ein. Diese neue API wird mit der aktuellen internen koexistieren, ist jedoch für höhere Stabilität ausgelegt und wird zukünftig unsere empfohlene Schnittstelle für externe Integrationen sein, da sich die interne API ohne Vorankündigung ändern kann.

Hier ist, was kommt

  • 🧾Vorläufige Dokumentation steht Ihnen zur Verfügung, damit Sie alle verfügbaren Endpunkte überprüfen und mit Ihrer aktuellen Nutzung vergleichen können. Bitte laden Sie die Datei unten herunter.

  • 🔐 Die Autorisierung ändert sich. Zukünftig müssen Sie bei jeder Anfrage den Authorization-Header mit dem Bearer-Token verwenden. Weitere Details folgen bald in der vollständigen Dokumentation .

  • 🧪 Testumgebung. Wir bereiten eine spezielle Testumgebung für die neue API vor. Sie können Ihre Implementierung validieren, bevor sie live geht. Wir benachrichtigen Sie, sobald es fertig ist.

Was kommt als Nächstes?

Um sicherzustellen, dass alles reibungslos funktioniert, möchten wir Sie bitten, die Dokumentation zu prüfen und uns Ihre Fragen oder Ihr Feedback bis zum 23. Juni 2025 mitzuteilen. So haben wir genug Zeit, um vor der offiziellen Freigabe alle erforderlichen Anpassungen vorzunehmen.

Laden Sie die API Dokumentation herunter:

Für private Cloud- oder On Prem Benutzer:

Please review the documentation and provide us the feedback too. But you’ll have full control over when to upgrade to the version that includes the new API, so you can adapt at your own pace.

❔
Logoaqua REST API Help
479KB
aqua-public-swagger.json