---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-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: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 6 Minuten Lesedauer

Verwaltet Tests, die in einem Cloud Runner für automatisiertes Test-Framework (ATF) ausgeführt werden sollen.
Die Cloud Runner-Testlauf API erfordert [ATF Test Generator and Cloud Runner](https://www.servicenow.com/docs/access?context=atf-tg-cr-intro&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US)Plugin (sn_atf_tg). Die mit dieser API verfügbaren Methoden werden in ausgeführt Jetzt Namespace und kann über API-Namen 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 einen ATF-Test oder eine Test-Suite im Cloud Runner-Browser.
* Überprüfen Sie den Fortschritt des Testauftrags.
* Brechen Sie den Testauftrag ab.
{#cloudrunner-testrunner-api__cloudrnr-TestRunnerAPI-scoped_ul_vwb_wvn_31c}

Die Cloud Runner-Testlauf API kann zusammen mit verwendet werden [REST-API für Cloud Runner-Testgenerierung](https://servicenow-prod.fluidtopics.net/f2BtiILLFT4ojMNM6P7QOA#cloudrunner-testgeneration-api "Verwaltet die Testauftragsgenerierung, die in einem Cloud Runner für automatisiertes Test-Framework (ATF) ausgeführt werden soll.")Und [Cloud Runner-Testanwender-REST-API](https://servicenow-prod.fluidtopics.net/MUeoyh3rK8hyQFqsqByx1A#cloudrunner-testuser-api "Verwaltet Testanwenderaufträge, die in einem Cloud Runner für automatisiertes Test-Framework (ATF) ausgeführt werden sollen."). Sie können beispielsweise einen Test generieren (Cloud Runner-Testgenerierungs-API), dann den Fortschritt des Tests in der Browser-Orchestration-Warteschlange (Cloud Runner-TESTGENERIERUNGS-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 TestRunnerApi: Bereichsbezogen, global](https://servicenow-prod.fluidtopics.net/nNJhCpN~0DF6sDSBxM_qXg#cloudrnr-TestRunnerAPI-scoped "Verwaltet Tests, die in einem Cloud Runner für automatisiertes Test-Framework (ATF) ausgeführt werden sollen. Diese API ist Teil der CloudRunnerApi-Skripteinbindung.").

## Cloud Runner-Testlauf -- GET /now/sn_atf_tg/Test_Runner_Progress {#ariaid-title2}

Stellt den Status jedes ausgeführten Tests für einen angegebenen BOQ-Datensatz (BrowserOrchestration Queue) bereit.

### URL-Format

Standard-URL: ABRUFEN /api/now/sn_atf_tg/Test_Runner_Progress

### Unterstützte Anforderungsparameter

{#cr-TestRunnerAPI-GET-test-run-progress__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 1. Pfad-Parameter]

{#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. Datentyp: Zeichenfolge Tabelle: BOQ \[sn_atf_tg_sn_boq\] |
[Tabelle : 2. Abfrageparameter]

{#cr-TestRunnerAPI-GET-test-run-progress__entry__10}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 3. Anforderungstext-Parameter (XML oder JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. 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/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#cr-TestRunnerAPI-GET-test-run-progress__entry__14}{#cr-TestRunnerAPI-GET-test-run-progress__accept-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json |
[Tabelle : 4. Anforderungskopfzeilen.]

{#cr-TestRunnerAPI-GET-test-run-progress__entry__18}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 5. Antwort-Header]

### 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](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#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 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 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. Stellen Sie sicher, dass der Anwender über die Administratorrolle verfügt. |
[Tabelle : 6. Statuscodes]

{#cr-TestRunnerAPI-GET-test-run-progress__table_vdy_gwz_31c}

### Antworttext-Parameter (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" } } |
| 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 sich im Status „wird ausgeführt" befindet. 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. {#cr-TestRunnerAPI-GET-test-run-progress__ul_hph_y5h_41c} Datentyp: Zeichenfolge |
[ ]

### Curl-Anforderung

Die folgende Anforderung ruft den Fortschritt des Test Runner-Auftrags des BOQ-Datensatzes ab.

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

Die Antwort gibt an, dass der 100 %-Test abgeschlossen ist.

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

Das folgende Beispiel gibt eine Fehlermeldung 400 zurück, 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"
      }
    }

Das folgende Beispiel gibt eine Fehlermeldung 400 zurück, 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-Testlauf: VERÖFFENTLICHEN SIE /now/sn_atf_tg/Cancel_Test_Runner {#ariaid-title3}

Legt den Status des Test Runner-Auftrags auf „Abgeschlossen" fest und bricht die Stammtracker aller generierten Tests ab, die ausgeführt werden.

### URL-Format

Standard-URL: ABRUFEN /Now/sn_atf_tg/Cancel_Test_Runner

### Unterstützte Anforderungsparameter

{#cr-TestRunnerAPI-POST-cancel-test-runner__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 7. Pfad-Parameter]

{#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. Datentyp: Zeichenfolge Tabelle: BOQ \[sn_atf_tg_sn_boq\] |
[Tabelle : 9. Anforderungstext-Parameter (XML oder JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. 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/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch 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}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder 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}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 11. Antwort-Header]

### 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](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#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 kann nicht gefunden werden -- ungültige SYS-ID. Stellen Sie sicher, 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. Stellen Sie sicher, dass der Anwender über die Administratorrolle verfügt. |
[Tabelle : 12. Statuscodes]

### Antworttext-Parameter (JSON oder XML)

{#cr-TestRunnerAPI-POST-cancel-test-runner__entry__32}

| Name | Beschreibung |
|-|-|
| Ergebnis | Objekt, das die Ergebnisse der Anforderung enthält. "result": { "message": String } {#cr-TestRunnerAPI-POST-cancel-test-runner__codeblock_hhp_4k2_p1c} Datentyp: Objekt |
| Ergebnis.Nachricht | Nachricht, die angibt, ob der Testabbruch erfolgreich war. Datentyp: Zeichenfolge |
[ ]

### Curl-Anforderung

Das folgende Beispiel zeigt, wie eine Testausführungsanforderung zum Abbrechen gemäß 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\":\"<sys_id of BOQ record>\"}" \ 
    --user "username:password"

Die Antwortnachricht, die angibt, dass der Test Runner erfolgreich abgebrochen wurde.

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

## Cloud Runner-Testlauf: VERÖFFENTLICHEN SIE /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 Test-Suite ein, der 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. Pfad-Parameter]

{#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. Anforderungstext-Parameter (XML oder JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. 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/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch 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}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json |
[Tabelle : 16. Anforderungskopfzeilen.]

{#cr-TestRunnerAPI-POST-test-runner__table_gcx_1fj_41c} {#cr-TestRunnerAPI-POST-test-runner__entry__20}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 17. Antwort-Header]

### 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](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#cr-TestRunnerAPI-POST-test-runner__entry__24}

| Statuscode | Beschreibung |
|-|-|
| 200 | Ein Test Runner-BOQ-Auftrag wurde erfolgreich eingefügt. |
| 400 | Fehler beim Starten des Test Runner-Auftrags. Gibt eine der folgenden Nachrichten zurück: * Test- oder Test-Suite mit SYS-ID-\<testId\> nicht gefunden -- 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 ist und der Datensatz vorhanden ist. * Keine Test-ID übergeben: Es wurde keine Test-ID bestanden. 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. Stellen Sie sicher, dass der Anwender über die Administratorrolle verfügt. |
[Tabelle : 18. Statuscodes]

### Antworttext-Parameter (JSON oder XML)

{#cr-TestRunnerAPI-POST-test-runner__entry__32}

| Name | Beschreibung |
|-|-|
| Ergebnis | Objekt, das die Ergebnisse der Anforderung enthält. Datentyp: Objekt { "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} |
| Ergebnis.snboqId | SYS_ID des BOQ-Datensatzes, der beim Start des Test Runners eingefügt wird. Datentyp: Zeichenfolge Tabelle: BOQ \[sn_atf_tg_sn_boq\] |
| Ergebnis.Nachricht | Fehlermeldung, die angibt, warum der Test Runner nicht gestartet werden kann. Datentyp: Zeichenfolge |
[ ]

### Curl-Anforderung

Die folgende Anforderung fügt einen Test Runner-Auftrag in die Tabelle „BOQ \[sn_atf_tg_sn_boq\]" ein.

    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\":\"<sys_id of ATF test or test suite>\"}" \ 
    --user "username:password"

Der Antworttext gibt die sys_ID des Test Runner-Auftrags zurück, der erfolgreich eingefügt wurde.

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

{#cr-TestRunnerAPI-POST-test-runner__codeblock_bhq_np3_41c}

