--- sourceDocument: Xanadu-API-Referenz sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/xanadu/api-reference Release : - xanadu ft:locale : - de-DE ft:publication_title : - Xanadu-API-Referenz ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # Cloud Runner Test Runner REST API # Cloud Runner Test Runner REST API {#ariaid-title1} * Freigeben Version: Xanadu * * Aktualisiert 1. August 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 6 Minuten Lesedauer Verwaltet Tests, die in einem Cloud Runner für Automated Test Framework (ATF) ausgeführt werden sollen. Die Cloud Runner Test Runner API erfordert das Plugin [ATF Test Generator and Cloud Runner](https://www.servicenow.com/docs/access?context=atf-tg-cr-intro&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US) (sn_atf_tg). Die mit dieser API verfügbaren Methoden werden im Now -Namespace ausgeführt und können mit dem API-Namen, Ein-Klick-Regressionstests für ATF, im REST-API-Explorer aufgerufen werden. Für den Zugriff auf diese API ist die Administratorrolle erforderlich. Sie können diese API für die folgenden Aufgaben verwenden: * Starten Sie einen ATF-Test oder eine ATF-Test-Suite im Cloud Runner-Browser. * Überprüft den Fortschritt des Testauftrags. * Brechen Sie den Testauftrag ab. {#cloudrunner-testrunner-api__cloudrnr-TestRunnerAPI-scoped_ul_vwb_wvn_31c} Die Cloud Runner Test Runner API kann zusammen mit [REST API für Cloud Runner-Testgenerierung](https://servicenow-prod.fluidtopics.net/cDiiuDDI9hWNzKmv7Gufzw#cloudrunner-testgeneration-api "Verwaltet die Testauftragsgenerierung, die in einem Cloud Runner für Automated Test Framework (ATF) ausgeführt werden soll.") und [REST API für Cloud Runner-Testanwender](https://servicenow-prod.fluidtopics.net/pBMj2YlrLniExXfO0cX6pA#cloudrunner-testuser-api "Verwaltet Testanwenderaufträge, die in einem Cloud Runner für Automated Test Framework (ATF) ausgeführt werden sollen.")verwendet werden. Sie können beispielsweise einen Test generieren (Cloud Runner-Testgenerierungs-API), dann den Fortschritt des Tests in der Browser-Orchestrationswarteschlange abrufen (Cloud Runner-TEST-Generierungs-API) und die Anzahl der Tests überprüfen, die bestanden oder fehlgeschlagen sind. Informationen zum Anzeigen der Server-API-Referenzdokumentation dieser API finden Sie unter [Cloud Runner TestRunnerApi -- Bereichsbezogen, Global](https://servicenow-prod.fluidtopics.net/1NP46AtE~kQ9Cyr3dKTIPQ#cloudrnr-TestRunnerAPI-scoped "Verwaltet Tests, die in einem Cloud Runner für Automated Test Framework (ATF) ausgeführt werden sollen. Diese API ist Teil der CloudRunnerApi-Skripteinbindung."). ## Cloud Runner-Test Runner -- GET /now/sn_atf_tg/test_runner_progress {#ariaid-title2} Stellt den Status jedes Tests bereit, der für einen angegebenen BOQ-Datensatz (Browser Orchestration Queue) ausgeführt wurde. ### URL-Format Standard-URL: GET /api/now/sn_atf_tg/test_runner_progress ### Unterstützte Anforderungsparameter {#cr-TestRunnerAPI-GET-test-run-progress__entry__2} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 1. Pfadparameter] {#cr-TestRunnerAPI-GET-test-run-progress__entry__6} | Name | Beschreibung | |-|-| | snboqId | Erforderlich. Die sys_id des BOQ-Datensatzes des Test-Runner-Auftrags, dessen Fortschritt abgerufen werden soll. Befindet sich in der BOQ-Tabelle \[sn_atf_tg_sn_boq\]. Datentyp: Zeichenfolge | [Tabelle : 2. Abfrageparameter] {#cr-TestRunnerAPI-GET-test-run-progress__entry__10} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 3. Anforderungstextparameter (XML oder JSON)] ### 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#cr-TestRunnerAPI-GET-test-run-progress__entry__14}{#cr-TestRunnerAPI-GET-test-run-progress__accept-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json | [Tabelle : 4. Anforderungskopfzeilen] {#cr-TestRunnerAPI-GET-test-run-progress__entry__18} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 5. Antwortkopfzeilen] ### 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 [HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#cr-TestRunnerAPI-GET-test-run-progress__table_vdy_gwz_31c__entry__2} | Statuscode | Beschreibung | |-|-| | 200 | Der Fortschritt des BOQ-Auftrags wurde erfolgreich abgerufen. | | 400 | Fehler beim Abrufen des Status des BOQ-Datensatzes. 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 konnte nicht gefunden werden -- Ungültige Sys-ID. Vergewissern Sie sich, dass die sys_id des BOQ-Datensatzes gültig und der Datensatz vorhanden ist. {#cr-TestRunnerAPI-GET-test-run-progress__ul_d5p_btk_p1c} | | 403 | Fehler beim Gewähren des Anwenderzugriffs auf den Endpunkt. Vergewissern Sie sich, dass der Benutzer über die Administratorrolle verfügt. | [Tabelle : 6. Statuscodes] {#cr-TestRunnerAPI-GET-test-run-progress__table_vdy_gwz_31c} ### Parameter des Antworttexts (JSON oder XML) {#cr-TestRunnerAPI-GET-test-run-progress__entry__30} | Name | Beschreibung | |-|-| | Ergebnis | Objekt, das die Fortschrittsergebnisse des Test-Runner-Auftrags oder eine Nachricht enthält, die erklärt, warum die Anforderung fehlgeschlagen ist. Datentyp: Objekt "result": { "progress": 100, "state": "completed" } Oder: { "result": { "message": "String" } } | | result.message | Fehlermeldung, in der beschrieben wird, warum der Test Runner-Fortschritt nicht abgerufen werden kann. Der Nachrichtenparameter wird in einer erfolgreichen Antwort nicht zurückgegeben. Datentyp: Zeichenfolge | | result.progress | Ein Prozentsatz, der angibt, wie kurz der Abschluss eines Tests ist, während er ausgeführt wird. Datentyp: Zahl | | result.state | Der aktuelle Status des BOQ-Datensatzes. Mögliche Werte: * Ausstehend: Die angeforderte Testaktivität wurde erstellt und wartet auf die Ausführung. * Wird verarbeitet -- Die Instanz scannt Datensätze, um sicherzustellen, dass die Ausführungstracker für Cloud Runner markiert sind, bevor die Anforderung an die Cloud-Infrastruktur gesendet wird. * Browser angefordert: An die Cloud-Infrastruktur wurde eine Anforderung zum Starten von Browsern für die Testgenerierung oder den Testlauf gesendet. * Wird ausgeführt -- Cloud-Infrastrukturbrowser suchen ausstehende Tests und führen sie aus. * Abgeschlossen: Die Testaufgabe ist abgeschlossen. * Status „Fehlgeschlagen" -- Die Testaufgabe ist fehlgeschlagen. {#cr-TestRunnerAPI-GET-test-run-progress__ul_hph_y5h_41c} Datentyp: Zeichenfolge | [ ] ### cURL-Anforderung Die folgende Anforderung ruft den Test Runner-Auftragsfortschritt des BOQ-Datensatzes ab. curl "http://instance.service-now.com/api/now/sn_atf_tg/test_runner_progress?snboqId=" \ --request GET \ --header "Accept:application/json" \ --user "username:password" Die Antwort gibt an, dass der Test zu 100 % abgeschlossen ist. { "result": { "progress": 100, "state": "completed" } } Im folgenden Beispiel wird eine Fehlermeldung 400 zurückgegeben, wenn keine BOQ-ID übergeben wird. curl "http://instance.service-now.com/api/now/sn_atf_tg/test_runner_progress" \ --request GET \ --header "Accept:application/json" \ --user "username:password" Antwort: { "result": { "message": "No SNBOQ ID passed in, add snboqId to request body" } } Im folgenden Beispiel wird eine Fehlermeldung 400 zurückgegeben, wenn eine ungültige BOQ-ID übergeben wird. curl "http://instance.service-now.com/api/now/sn_atf_tg/test_runner_progress?snboqId=invalid_sys_id" \ --request GET \ --header "Accept:application/json" \ --user "username:password" Antwort: { "result": { "message": "Invalid SNBOQ sys_id passed in" } } ## Cloud Runner Test Runner -- POST /now/sn_atf_tg/cancel_test_runner {#ariaid-title3} Legt den Test Runner-Auftrag auf den Status „Abgeschlossen" fest und bricht die Stammtracker aller generierten Tests ab, die ausgeführt werden. ### URL-Format Standard-URL: GET /now/sn_atf_tg/cancel_test_runner ### Unterstützte Anforderungsparameter {#cr-TestRunnerAPI-POST-cancel-test-runner__entry__2} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 7. Pfadparameter] {#cr-TestRunnerAPI-POST-cancel-test-runner__entry__6} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 8. Abfrageparameter] {#cr-TestRunnerAPI-POST-cancel-test-runner__entry__10} | Name | Beschreibung | |-|-| | snboqId | Sys_id des BOQ-Datensatzes (Browser Orchestration Queue) (sn_atf_tg_sn_boq), der dem abzubrechenden Test-Runner-Auftrag zugeordnet ist. Befindet sich in der BOQ-Tabelle \[sn_atf_tg_sn_boq\]. | [Tabelle : 9. Anforderungstextparameter (XML oder JSON)] ### 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#cr-TestRunnerAPI-POST-cancel-test-runner__table_ism_z2j_41c__entry__2}{#cr-TestRunnerAPI-POST-cancel-test-runner__accept-RESTAPI}{#cr-TestRunnerAPI-POST-cancel-test-runner__content_type-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json | | Content-Type | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json | [Tabelle : 10. Anforderungskopfzeilen] {#cr-TestRunnerAPI-POST-cancel-test-runner__table_ism_z2j_41c} {#cr-TestRunnerAPI-POST-cancel-test-runner__entry__20} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 11. Antwortkopfzeilen] ### 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 [HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#cr-TestRunnerAPI-POST-cancel-test-runner__entry__24}{#cr-TestRunnerAPI-POST-cancel-test-runner__entry-200-status-code} | Statuscode | Beschreibung | |-|-| | 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. | | 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 konnte nicht gefunden werden -- Ungültige Sys-ID. Vergewissern Sie sich, dass die sys_id des BOQ-Datensatzes gültig und der Datensatz vorhanden ist. {#cr-TestRunnerAPI-POST-cancel-test-runner__ul_fzp_ztk_p1c} | | 403 | Fehler beim Gewähren des Anwenderzugriffs auf den Endpunkt. Vergewissern Sie sich, dass der Benutzer über die Administratorrolle verfügt. | [Tabelle : 12. Statuscodes] ### Parameter des Antworttexts (JSON oder XML) {#cr-TestRunnerAPI-POST-cancel-test-runner__entry__32} | Name | Beschreibung | |-|-| | Ergebnis | Objekt mit den Ergebnissen der Anforderung. "result": { "message": String } {#cr-TestRunnerAPI-POST-cancel-test-runner__codeblock_hhp_4k2_p1c} Datentyp: Objekt | | result.message | Meldung, die beschreibt, ob der Testabbruch erfolgreich war. Datentyp: Zeichenfolge | [ ] ### cURL-Anforderung Das folgende Beispiel zeigt, wie eine Anforderung zum Abbrechen des Test Runners entsprechend der sys_id des BOQ-Datensatzes erstellt wird. curl "https://instance.service-now.com/api/now/sn_atf_tg/cancel_test_runner" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{\"snboqId\":\"\"}" \ --user "username:password" Die Antwortnachricht, die angibt, dass der Test Runner erfolgreich abgebrochen wurde. { "result": { "message": "success" } } ## Cloud Runner Test Runner -- POST /now/sn_atf_tg/test_runner {#ariaid-title4} Fügt einen Test Runner-Auftrag in die BOQ-Tabelle \[sn_atf_tg_sn_boq\] für den angegebenen Test oder die angegebene Test-Suite ein, die dann auf dem Cloud Runner ausgeführt wird. ### URL-Format Standard-URL: POST api/now/sn_atf_tg/test_runner ### Unterstützte Anforderungsparameter {#cr-TestRunnerAPI-POST-test-runner__entry__2} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 13. Pfadparameter] {#cr-TestRunnerAPI-POST-test-runner__entry__6} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 14. Abfrageparameter] {#cr-TestRunnerAPI-POST-test-runner__entry__10} | Name | Beschreibung | |-|-| | testId | Sys_id des Tests \[sys_atf_test\] oder der Test-Suite \[sys_atf_test_suite\], der auf dem Cloud Runner ausgeführt werden soll. | [Tabelle : 15. Anforderungstextparameter (XML oder JSON)] ### 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#cr-TestRunnerAPI-POST-test-runner__table_gcx_1fj_41c__entry__2}{#cr-TestRunnerAPI-POST-test-runner__accept-RESTAPI}{#cr-TestRunnerAPI-POST-test-runner__content_type-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json | | Content-Type | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json | [Tabelle : 16. Anforderungskopfzeilen] {#cr-TestRunnerAPI-POST-test-runner__table_gcx_1fj_41c} {#cr-TestRunnerAPI-POST-test-runner__entry__20} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 17. Antwortkopfzeilen] ### 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 [HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#cr-TestRunnerAPI-POST-test-runner__entry__24} | Statuscode | Beschreibung | |-|-| | 200 | Es wurde erfolgreich ein Test-Runner-BOQ-Auftrag eingefügt. | | 400 | Fehler beim Starten des Test-Runner-Auftrags. Gibt eine der folgenden Nachrichten zurück: * Test oder Test-Suite mit Sys-ID konnte nicht gefunden werden\ -- Ungültige Test-ID. Stellen Sie sicher, dass die sys_id des Test- (sys_atf_test) oder Test-Suite-Datensatzes (sys_atf_test_suite) gültig und der Datensatz vorhanden ist. * Keine Test-ID übergeben: Es wurde keine Test-ID übergeben. Fügen Sie dem Anforderungstext die Test-ID hinzu. {#cr-TestRunnerAPI-POST-test-runner__ul_uht_ttk_p1c} | | 403 | Fehler beim Gewähren des Anwenderzugriffs auf den Endpunkt. Vergewissern Sie sich, dass der Benutzer über die Administratorrolle verfügt. | [Tabelle : 18. Statuscodes] ### Parameter des Antworttexts (JSON oder XML) {#cr-TestRunnerAPI-POST-test-runner__entry__32} | Name | Beschreibung | |-|-| | Ergebnis | Objekt mit den Ergebnissen der Anforderung. { "result": { "snboqId": "String" } } {#cr-TestRunnerAPI-POST-test-runner__codeblock_n5d_sxk_p1c} Oder: "result": { "message": "String" } {#cr-TestRunnerAPI-POST-test-runner__codeblock_hhp_4k2_p1c} Datentyp: Objekt | | result.snboqId | Sys_id des BOQ-Datensatzes, der beim Start des Test Runners eingefügt wird. Befindet sich in der BOQ-Tabelle \[sn_atf_tg_sn_boq\]. | | result.message | Fehlermeldung, die beschreibt, warum der Test Runner nicht gestartet werden kann. | [ ] ### cURL-Anforderung Mit der folgenden Anforderung wird ein Test Runner-Auftrag in die Tabelle „BOQ" \[sn_atf_tg_sn_boq\] eingefügt. curl "https://instance.service-now.com/api/now/sn_atf_tg/test_runner" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{\"testId\":\"\"}" \ --user "username:password" Der Antworttext gibt die sys_id des Test-Runner-Auftrags zurück, der erfolgreich eingefügt wurde. { "result": { "snboqId": "" } } {#cr-TestRunnerAPI-POST-test-runner__codeblock_bhq_np3_41c}