---
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 TestRunnerApi: Bereichsbezogen, global

# Cloud Runner TestRunnerApi: Bereichsbezogen, global {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 Minuten Lesedauer

Verwaltet Tests, die in einem Cloud Runner für automatisiertes Test-Framework (ATF) ausgeführt werden sollen.
Diese API ist Teil der CloudRunnerApi-Skripteinbindung.  
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.
{#cloudrnr-TestRunnerAPI-scoped__cloudrnr-TestRunnerAPI-scoped_ul_vwb_wvn_31c}

Im globalen Bereich wird diese API innerhalb des Namespace „sn_atf_tg" ausgeführt. Sie müssen haben [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)(sn_atf_tg) Plugin aktiviert, um diese API zu verwenden.  
Siehe auch:

* [Cloud Runner-TestgenerationApi: Bereichsbezogen, global](https://servicenow-prod.fluidtopics.net/gOV3~zQ7Sv9dIz6fUpRihw#cloudrnr-TestGenerationAPI-scoped "Verwaltet die Testauftragsgenerierung, die in einem Cloud Runner für automatisiertes Test-Framework (ATF) ausgeführt werden soll. Diese API ist Teil der CloudRunnerApi-Skripteinbindung.")
* [Cloud Runner-TestanwenderApi -- Umfang, Global](https://servicenow-prod.fluidtopics.net/B3pJaXlVC2jVCRG6bYdCxg#cloudrnr-TestUserAPI-scoped "Verwaltet Testanwenderaufträge, die in einem Cloud Runner für automatisiertes Test-Framework (ATF) ausgeführt werden sollen. Diese API ist Teil der CloudRunnerApi-Skripteinbindung.")
* [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.")
{#cloudrnr-TestRunnerAPI-scoped__ul_gd4_zsn_31c}

## TestRunnerApi -- cancelJob (Zeichenfolge snboqId) {#ariaid-title2}

Legt den Status des Test Runner-Auftrags auf „Abgeschlossen" fest und bricht die Stammtracker aller generierten Tests ab, die ausgeführt werden.
{#cr-TestRunnerAPI-cancelJob_S__table_epx_lv4_g1c__entry__3}{#cr-TestRunnerAPI-cancelJob_S__cr-snboqId-ph-desc}

| Name | Typ | Beschreibung |
|-|-|-|
| SnboqId | Zeichenfolge | Erforderlich. Die sys_ID des BOQ-Datensatzes in der Tabelle „Browserorchestration-Warteschlange \[sn_atf_tg_sn_boq\]". |
[Tabelle : 1. Parameter]

{#cr-TestRunnerAPI-cancelJob_S__table_epx_lv4_g1c} {#cr-TestRunnerAPI-cancelJob_S__table_fpx_lv4_g1c__entry__2}

| Typ | Beschreibung |
|-|-|
| Null | Null, wenn erfolgreich, andernfalls Fehlermeldung. |
[Tabelle : 2. Rückgaben]

{#cr-TestRunnerAPI-cancelJob_S__table_fpx_lv4_g1c}  
Das folgende Beispiel zeigt, wie ein Testlauf eines ATF-Tests gestartet, der Fortschritt angezeigt und der Testlauf gestoppt wird. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestRunnerAPI.startJob({
    	"testId": "<sys_id>"
    });

    gs.info(JSON.stringify(CloudRunnerAPI.TestRunnerAPI.progress({"snboqId": snboqId})));

    CloudRunnerAPI.TestRunnerAPI.cancelJob({"snboqId": snboqId});

Ausgabe:

    {progress: 64, state: running}

## TestRunnerApi -- Fortschritt (Zeichenfolge snboqId) {#ariaid-title3}

Stellt den Status jedes ausgeführten Tests für einen angegebenen BOQ-Datensatz (BrowserOrchestration Queue) bereit.
{#cr-TestRunnerAPI-progress_S__table_epx_lv4_g1c__entry__3}{#cr-TestRunnerAPI-progress_S__cr-snboqId-ph-desc}

| Name | Typ | Beschreibung |
|-|-|-|
| SnboqId | Zeichenfolge | Erforderlich. Die sys_ID des BOQ-Datensatzes in der Tabelle „Browserorchestration-Warteschlange \[sn_atf_tg_sn_boq\]". |
[Tabelle : 3. Parameter]

{#cr-TestRunnerAPI-progress_S__table_epx_lv4_g1c} {#cr-TestRunnerAPI-progress_S__table_fpx_lv4_g1c__entry__2}{#cr-TestRunnerAPI-progress_S__cr-prog-state-ph-desc}

| Typ | Beschreibung |
|-|-|
| Objekt | JSON-Objekt, das den Testfortschritt anzeigt. { "progress": Number, "state": "String" } |
| Object.progress | Gibt den Prozentsatz des abgeschlossenen Testfortschritts an. Typ: Zahl |
| Objekt.Status | Status des BOQ-Datensatzes. Mögliche Werte: * Ausstehend: Die angeforderte Testaktivität wurde erstellt und wartet auf die Ausführung.{#cr-TestRunnerAPI-progress_S__cr-prog-state-li-pending} {#cr-TestRunnerAPI-progress_S__cr-prog-state-li-pending} * 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. * Browser angefordert: Eine Anforderung wurde an die Cloud-Infrastruktur gesendet, um Browser für die Testgenerierung oder Testausführung zu starten.{#cr-TestRunnerAPI-progress_S__cr-prog-state-li-brsreq} {#cr-TestRunnerAPI-progress_S__cr-prog-state-li-brsreq} * Wird ausgeführt: Cloud-Infrastrukturbrowser suchen ausstehende Tests und führen sie aus. * Abgeschlossen: Die Testaufgabe ist abgeschlossen.{#cr-TestRunnerAPI-progress_S__cr-prog-state-li-complete} {#cr-TestRunnerAPI-progress_S__cr-prog-state-li-complete} * Status „Fehlgeschlagen": Die Testaufgabe ist fehlgeschlagen.{#cr-TestRunnerAPI-progress_S__cr-prog-state-li-failed} {#cr-TestRunnerAPI-progress_S__cr-prog-state-li-failed} {#cr-TestRunnerAPI-progress_S__ul_rvl_vsg_l1c} Typ: Zeichenfolge |
| Fehler | Wenn nicht erfolgreich, mögliche Fehlermeldungen: * Keine BOQ-ID übergeben -- das angegebene JSON-Objekt hat keinen BOQ-ID-Eintrag. Stellen Sie sicher, dass das JSON-Objekt strukturiert ist `{SnboqId: „<sys_id>"} `. * Ungültige sys_ID der BOQ übergeben -- die angegebene ID muss für einen BOQ-Datensatz in der Tabelle „Browserorchestration-Warteschlange \[sn_atf_tg_sn_boq\]" sein. {#cr-TestRunnerAPI-progress_S__ul_wqr_slb_j1c} |
[Tabelle : 4. Rückgaben]

{#cr-TestRunnerAPI-progress_S__table_fpx_lv4_g1c}  
Das folgende Beispiel zeigt, wie ein Testlauf eines ATF-Tests gestartet, der Fortschritt angezeigt und der Testlauf gestoppt wird. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestRunnerAPI.startJob({
    	"testId": "<sys_id>"
    });

    gs.info(JSON.stringify(CloudRunnerAPI.TestRunnerAPI.progress({"snboqId": snboqId})));

    CloudRunnerAPI.TestRunnerAPI.cancelJob({"snboqId": snboqId});

Ausgabe:

    {progress: 64, state: running}

## TestRunnerApi -- startJob(Zeichenfolge testId) {#ariaid-title4}

Startet einen ATF-Test oder eine Test-Suite im Cloud Runner-Browser.
{#cr-TestRunnerAPI-startJob_S__table_epx_lv4_g1c__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| TestId | Zeichenfolge | Erforderlich. Die sys_ID der ATF-Test- oder Test-Suite, die im Cloud Runner-Browser ausgeführt werden soll. Befindet sich in einer der folgenden Tabellen: * Test \[sys_atf_Test\] * Testsuiten \[sys_atf_test_suite\] {#cr-TestRunnerAPI-startJob_S__ul_gqc_yj4_l1c} |
[Tabelle : 5. Parameter]

{#cr-TestRunnerAPI-startJob_S__table_epx_lv4_g1c} {#cr-TestRunnerAPI-startJob_S__table_fpx_lv4_g1c__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Die sys_ID des BOQ-Datensatzes in der Tabelle „Browserorchestration-Warteschlange \[sn_atf_tg_sn_boq\]". |
[Tabelle : 6. Rückgaben]

{#cr-TestRunnerAPI-startJob_S__table_fpx_lv4_g1c}  
Das folgende Beispiel zeigt, wie ein Testlauf eines ATF-Tests gestartet, der Fortschritt angezeigt und der Testlauf gestoppt wird. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestRunnerAPI.startJob({
    	"testId": "<sys_id>"
    });

    gs.info(JSON.stringify(CloudRunnerAPI.TestRunnerAPI.progress({"snboqId": snboqId})));

    CloudRunnerAPI.TestRunnerAPI.cancelJob({"snboqId": snboqId});

Ausgabe:

    {progress: 64, state: running}


