Cloud Runner-Test-Anwender-REST-API

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 9 Minuten Lesedauer

    • Verwaltet Testanwenderaufträge, die in einem Cloud Runner für Automated Test Framework (ATF) ausgeführt werden sollen.

    Die Cloud Runner-Testanwender API erfordert ATF Test Generator and Cloud Runner Plugin (sn_atf_tg). Die mit dieser API verfügbaren Methoden werden in ausgeführt Jetzt Namespace und kann mit API-Name aufgerufen werden, Ein-Klick-Regressionstests für ATF , Im REST API Explorer. Für den Zugriff auf diese API ist die Administratorrolle erforderlich.

    Sie können diese API für die folgenden Aufgaben verwenden:
    • Starten Sie den Anwendertestauftrag.
    • Legen Sie den Cloud-Anwender fest.
    • Überprüfen Sie, ob der angegebene Anwender gültig ist.
    • Überprüfen Sie den Fortschritt des Anwendertestauftrags.
    • Brechen Sie den Testauftrag ab.

    Die Cloud Runner Test Runner API kann zusammen mit verwendet werden Cloud Runner-Testgenerierungs-REST-API Und Cloud Runner-Test-Anwender-REST-API. Sie können beispielsweise einen Test generieren (Cloud Runner Test Generation API), dann den Fortschritt des Tests in der Browser-Orchestration-Warteschlange (Cloud Runner TEST Generation API) abrufen und die Anzahl der bestandenen oder fehlgeschlagenen Tests überprüfen.

    Informationen zum Anzeigen der Server-API-Referenzdokumentation dieser API finden Sie unter Cloud Runner TestUserApi: Bereichsbezogen, Global.

    Cloud Runner-Testanwender – GET /now/sn_atf_tg/Test_user_Progress

    Stellt den Status des Testanwenderauftrags für einen angegebenen BOQ-Datensatz (Browser Orchestration Queue) bereit.

    URL-Format

    Standard-URL: GET /api/now/sn_atf_tg/Test_user_Progress

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    SnboqId Erforderlich. SYS_ID des BOQ-Datensatzes des Testanwenderauftrags, dessen Fortschritt abgerufen werden soll.

    Datentyp: Zeichenfolge

    Tabelle: BOQ [sn_atf_tg_sn_boq]
    Tabelle : 3. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 4. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 5. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Der Fortschritt des Testanwenderauftrags wurde erfolgreich abgerufen.
    400 Fehler beim Abrufen des BOQ-Datensatzstatus. Gibt eine der folgenden Nachrichten zurück:
    • Keine BOQ-ID übergeben: Es wurde keine BOQ-ID angegeben. Fügen Sie dem Anforderungstext die BOQ-ID hinzu.
    • BOQ-Datensatz kann nicht gefunden werden – ungültige SYS-ID. Stellen Sie sicher, dass die sys_ID des BOQ-Datensatzes gültig ist und der Datensatz vorhanden ist.
    403 Fehler beim Gewähren des Anwenderzugriffs auf den Endpunkt. Stellen Sie sicher, dass der Anwender über die Administratorrolle verfügt.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt mit den Fortschrittsergebnissen des Test Runner-Auftrags oder einer Meldung, die erklärt, warum die Anforderung fehlgeschlagen ist.
    "result": { 
    "progress": 100, 
    "state": "completed" 
  }

    Oder:

    "result": { 
    "message": "String"
}

    Datentyp: Objekt
    Ergebnis.Nachricht Fehlermeldung, die angibt, warum der Test Runner-Fortschritt nicht abgerufen werden kann. Der Nachrichtenparameter wird in einer erfolgreichen Antwort nicht zurückgegeben.

    Datentyp: Zeichenfolge
    result.progress Prozentsatz, der angibt, wie kurz vor dem Abschluss eines Tests steht, während er ausgeführt wird.

    Datentyp: Zahl
    Ergebnis.Status Aktueller Status des BOQ-Datensatzes.

    Mögliche Werte:

    • Angeforderte Browser: Eine Anforderung wurde an die Cloud-Infrastruktur gesendet, um Browser für die Testgenerierung oder Testausführung zu starten.
    • Abgeschlossen: Die Testaufgabe ist abgeschlossen.
    • Status „fehlgeschlagen“: Die Testaufgabe ist fehlgeschlagen.
    • Ausstehend: Die angeforderte Testaktivität wurde erstellt und wartet auf die Ausführung.
    • Verarbeitung: Die Instanz scannt nach Datensätzen, um sicherzustellen, dass die Ausführungstracker für Cloud Runner markiert sind, bevor die Anforderung an die Cloud-Infrastruktur gesendet wird.
    • Wird ausgeführt: Die Cloud-Infrastrukturbrowser suchen ausstehende Tests und führen sie aus.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Anforderungsbeispiel zeigt, wie der Fortschritt eines Testanwenderauftrags überprüft wird.

    curl "https://instance.service-now.com/api/now/sn_atf_tg/test_user_progress?snboqId=<sys_id of SNBOQ record>" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user "username:password"

    Antworttext:

    { 
  "result": { 
    "progress": 100, 
    "state": "completed" 
  } 
}

    Cloud Runner-Testanwender – GET /now/sn_atf_tg/is_valid_Cloud_user

    Überprüft, ob ein angegebener Anwender ein gültiger Cloud-Anwender ist.

    Diese Methode überprüft, ob der Anwender die folgenden Kriterien erfüllt:
    • Vorhanden,
    • Ist aktiv,
    • Ist nicht gesperrt,
    • Erfordert eine Passwortzurücksetzung,
    • Ist ein Administrator,
    • Ist schreibgeschützt,
    • Ist nur Webservices

    URL-Format

    Standard-URL: GET /api/now/sn_atf_tg/is_valid_Cloud_user

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    username Erforderlich. Anwendername des sys_user, um zu überprüfen, ob der Anwender die folgenden Baseline-Kriterien erfüllt.
    • Vorhanden,
    • Ist aktiv,
    • Ist nicht gesperrt,
    • Erfordert eine Passwortzurücksetzung,
    • Ist ein Administrator,
    • Ist schreibgeschützt,
    • Ist nur Webservices

    Wenn eine dieser Bedingungen fehlschlägt, gibt die API einen falschen booleschen Wert mit einer Meldung zurück, welche Kriterien fehlgeschlagen sind.

    Datentyp: Zeichenfolge
    Tabelle : 9. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 10. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 11. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Gibt „wahr“ oder „falsch“ zurück, wenn der Anwender gültig ist und die Cloud-Anwenderkriterien erfüllt.
    403 Fehler beim Gewähren des Anwenderzugriffs auf den Endpunkt. Stellen Sie sicher, dass der Anwender über die Administratorrolle verfügt.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das die Ergebnisse der Anforderung enthält.
    
  "result": { 
    "validUser": Boolean 
  }

    Datentyp: Objekt
    Ergebnis.validierter Anwender Kennzeichnung, die angibt, ob der Anwender die Cloud-Anwenderkriterien erfüllt. Bei „wahr“ erfüllt der Anwender die Kriterien.

    Datentyp: Boolesch

    cURL-Anforderung

    Die folgende Anforderung überprüft, ob der angegebene sys_user die Kriterien für die Verwendung der Cloud-Funktionalität erfüllt.

    curl "http://instance.service-now.com/api/now/sn_atf_tg/is_valid_cloud_user?username=<username of sys_user to check>" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user "username:password"

    Antworttext:

    { 
  "result": { 
    "validUser": <Boolean value indicating whether user is valid cloud user> 
  } 
}

    Cloud Runner-Testanwender – POST /now/sn_atf_tg/Test_user

    Fügt einen Testanwenderauftrag in die BOQ-Tabelle [sn_atf_tg_sn_boq] für einen bestimmten Anwendernamen ein, der dann im Cloud Runner ausgeführt wird.

    URL-Format

    Standard-URL: POST /api/now/sn_atf_tg/Test_user

    Unterstützte Anforderungsparameter

    Tabelle : 13. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 15. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    username Erforderlich. Anwendername des sys_user zum Testen der End-to-End-Infrastruktur des Cloud Runners.

    Datentyp: Zeichenfolge

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 16. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 17. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 18. Statuscodes
    Statuscode Beschreibung
    200 Ein Testanwender-BOQ-Auftrag wurde erfolgreich eingefügt.
    400 Fehler beim Starten des Testanwenderauftrags.

    Wenn ein leerer Anwendername angegeben wird oder ein Anwender in der Tabelle „sys_user“ nicht gefunden werden kann, löst der Server einen Fehler aus.
    403 Fehler beim Gewähren des Anwenderzugriffs auf den Endpunkt. Stellen Sie sicher, dass der Anwender über die Administratorrolle verfügt.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das die Ergebnisse der Anforderung enthält.
    
  "result": { 
    "snboqId": String
  }

    Oder:

    "result": { 
    "message": "String"
}

    Datentyp: Objekt
    Ergebnis.Nachricht Fehlermeldung, die angibt, warum dem Anwendernamen keine Testfähigkeiten zugewiesen werden können. Der Nachrichtenparameter wird in einer erfolgreichen Antwort nicht zurückgegeben.

    Datentyp: Zeichenfolge
    Ergebnis.snboqId SYS_ID des BOQ-Datensatzes, der eingefügt wird, wenn der Testanwenderauftrag erfolgreich gestartet wird.

    Datentyp: Zeichenfolge

    Tabelle: BOQ [sn_atf_tg_sn_boq]

    cURL-Anforderung

    Das folgende Anforderungsbeispiel zeigt, wie ein Testanwenderauftrag für einen bestimmten Anwendernamen in die Tabelle „BOQ“ [sn_atf_tg_sn_boq] eingefügt wird.

    curl "http://instance.service-now.com/api/now/sn_atf_tg/test_user" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{\"username\":\"<username of sys_user to test cloud infrastructure>\"}" \ 
--user "username:password"

    Die Antwort gibt eine sys_ID des BOQ-Datensatzes zurück, der beim Start des Testanwenderauftrags eingefügt wird.

    { 
  "result": { 
    "snboqId": "<sys_id of newly inserted BOQ record>" 
  } 
}

    Das folgende Beispiel gibt eine Fehlermeldung 400 zurück, wenn kein Anwendername oder ein ungültiger Anwendername übergeben wird.

    curl "https://instance.service-now.com/api/now/sn_atf_tg/test_user" \
--request POST \
--header "Accept:application/json" \
--user "username:password"

    Antwort:

    {
  "result": {
    "message": "Unable to set cloud user as cloud user not valid"
  }
}

    Cloud Runner-Testanwender – POST /now/sn_atf_tg/Cancel_Test_user

    Legt den Status des Testanwenderauftrags in der Tabelle „Browser Orchestration Queue“ (BOQ) [sn_atf_tg_sn_boq] auf „Abgeschlossen“ fest.

    URL-Format

    Standard-URL: POST /api/now/sn_atf_tg/Cancel_Test_user

    Unterstützte Anforderungsparameter

    Tabelle : 19. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 21. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    SnboqId Erforderlich. SYS_ID des BOQ-Datensatzes, der dem Testanwenderauftrag zugeordnet ist, abzubrechen.

    Datentyp: Zeichenfolge

    Tabelle: SNBOQ [sn_atf_tg_sn_boq]

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 22. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 23. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 24. Statuscodes
    Statuscode Beschreibung
    200 Der BOQ-Auftrag wurde erfolgreich abgebrochen.
    400 Fehler beim Abbrechen des Auftrags. Gibt eine der folgenden Nachrichten zurück:
    • Keine BOQ-ID übergeben: Es wurde keine BOQ-ID angegeben. Fügen Sie dem Anforderungstext die BOQ-ID hinzu.
    • BOQ-Datensatz kann nicht gefunden werden – ungültige SYS-ID. Stellen Sie sicher, dass die sys_ID des BOQ-Datensatzes gültig ist und der Datensatz vorhanden ist.
    403 Fehler beim Gewähren des Anwenderzugriffs auf den Endpunkt. Stellen Sie sicher, dass der Anwender über die Administratorrolle verfügt.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das die Ergebnisse der Anforderung enthält.
    
  "result": { 
    "message": String
  }

    Datentyp: Objekt
    Ergebnis.Nachricht Nachricht, die angibt, ob der Abbruch des Testanwenders erfolgreich war.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Die folgende Anforderung zeigt, wie ein Testanwenderauftrag in der Tabelle „Browser Orchestration-Warteschlange“ [sn_atf_tg_sn_boq] abgebrochen wird.

    curl "https://instance.service-now.com/api/now/sn_atf_tg/cancel_test_user" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{\"snboqId\":\"<sys_id of BOQ record>\"}" \ 
--user "username:password"

    Erfolgreicher Antworttext:

    { 
  "result": { 
    "message": "success" 
  } 
}

    Cloud Runner-Testanwender – POST /now/sn_atf_tg/select_Cloud_user

    Startet einen End-to-End-Test-Anwenderauftrag im Cloud Runner. Wenn sich der Anwender mit der Administratorrolle anmelden kann, wird für zukünftige Testläufe und Testgenerierungen standardmäßig die Eigenschaft „Cloud-Anwender“ auf diesen Anwender festgelegt.

    URL-Format

    Standard-URL: POST /api/now/sn_atf_tg/select_Cloud_user

    Unterstützte Anforderungsparameter

    Tabelle : 25. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 26. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 27. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    username Erforderlich. Anwendername des sys_user, der den Cloud-Anwender für zukünftige Test Runner- und Testgenerierungsaufträge testen und festlegen soll.

    Datentyp: Zeichenfolge

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 28. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 29. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 30. Statuscodes
    Statuscode Beschreibung
    200 Die End-to-End-Cloud Runner-Infrastruktur wurde erfolgreich getestet und der Cloud-Anwender für zukünftige Testausführungs- und Testgenerierungsaufträge festgelegt.
    400 Fehler beim Testen der vollständigen End-to-End-Cloud Runner-Infrastruktur und beim Festlegen des Cloud-Anwenders. Stellen Sie sicher, dass der Anwendername nicht leer ist oder dass der Anwender in der Tabelle „sys_user“ für einen bestimmten Anwendernamen vorhanden ist.
    403 Fehler beim Gewähren des Anwenderzugriffs auf den Endpunkt. Stellen Sie sicher, dass der Anwender über die Administratorrolle verfügt.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das die Ergebnisse der Anforderung enthält.
    
  "result": { 
    "message": "String"
  }

    Datentyp: Objekt
    Ergebnis.Nachricht Nachricht, die angibt, ob der Anwender erfolgreich für zukünftige Testläufe und Testgenerierungen in der Cloud Runner-Infrastruktur ausgewählt wurde.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Sie die Auswahl eines bestimmten Anwenders für zukünftige Testläufe und Testgenerierungen in der Cloud Runner-Infrastruktur anfordern.

    curl "https://instance.service-now.com/api/now/sn_atf_tg/select_cloud_user" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{\"username\":\"<username of sys_user to set as cloud user>\"}" \ 
--user "username:password"

    Der Antworttext gibt eine Erfolgsmeldung zurück, die angibt, dass der Cloud-Anwender erfolgreich für Testläufe und Generierungen ausgewählt wurde.

    { 
  "result": { 
    "message": "success" 
  } 
}