---
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-TestanwenderApi -- Umfang, Global

# Cloud Runner-TestanwenderApi -- Umfang, Global {#ariaid-title1}

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

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.  
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.
{#cloudrnr-TestUserAPI-scoped__cloudrnr-TestUserAPI-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 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 Test Runner REST API](https://servicenow-prod.fluidtopics.net/n0cULYjO5Joy1UGTlBoqPQ#cloudrunner-testrunner-api "Verwaltet Tests, die in einem Cloud Runner für automatisiertes Test-Framework (ATF) ausgeführt werden sollen.")
{#cloudrnr-TestUserAPI-scoped__ul_gd4_zsn_31c}

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

Legt den Status des Testanwenderauftrags in der Tabelle „Browserorchestration-Warteschlange \[sn_atf_tg_sn_boq\]" auf „Abgeschlossen" fest.
{#cr-TestUserAPI-cancelJob_S__table_epx_lv4_g1c__entry__3}{#cr-TestUserAPI-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-TestUserAPI-cancelJob_S__table_epx_lv4_g1c} {#cr-TestUserAPI-cancelJob_S__table_fpx_lv4_g1c__entry__2}

| Typ | Beschreibung |
|-|-|
| Null | Null, wenn erfolgreich, andernfalls Fehlermeldung. |
| 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-TestUserAPI-cancelJob_S__ul_wqr_slb_j1c} |
[Tabelle : 2. Rückgaben]

{#cr-TestUserAPI-cancelJob_S__table_fpx_lv4_g1c}  
Das folgende Beispiel zeigt, wie Sie einen Testanwender für den Administratoranwender starten, den Fortschritt abrufen und den Testanwender abbrechen. Nachdem der gesperrte Anwender als gültiger Cloud-Anwender bestätigt wurde, legt der Code den Cloud-Anwender als ITIL-Administrator fest. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

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

    CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

    gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

    CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

Ausgabe:

    {progress: 64, state: running}
    User is missing the following criteria: 
    	User is locked out
    False

## TestUserApi -- isValidCloudUser(Zeichenfolgenanwendername) {#ariaid-title3}

Überprüft, ob ein angegebener Anwender ein gültiger Cloud-Anwender ist.
{#cr-TestUserAPI-isValidCloudUser_S__table_epx_lv4_g1c__entry__3}{#cr-TestUserAPI-isValidCloudUser_S__cr-userNm-ph-desc}

| Name | Typ | Beschreibung |
|-|-|-|
| username | Objekt | Erforderlich. Anwender-ID eines gültigen Anwenders, der in der Tabelle Anwender \[sys_user\] aufgeführt ist. Dieser Wert wird als Zeichenfolge in einem JSON-Objekt bereitgestellt. Beispiel: `{Anwendername: „abel.tuter"} `. |
[Tabelle : 3. Parameter]

{#cr-TestUserAPI-isValidCloudUser_S__table_epx_lv4_g1c} {#cr-TestUserAPI-isValidCloudUser_S__table_fpx_lv4_g1c__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | Kennzeichnung, die angibt, ob der angegebene Anwender ein gültiger Cloud-Anwender ist. Gültige Werte: * Wahr: Der angegebene Anwender ist ein gültiger Cloud-Anwender. * Falsch: Der angegebene Anwender ist aus mindestens einem der folgenden Gründe ungültig: * Der Anwender wurde nicht gefunden. * Der Anwender ist inaktiv. * Der Anwender ist gesperrt. * Der Anwender benötigt eine Passwortzurücksetzung. * Der Anwender hat keine Administratorrolle. * Der Anwender hat schreibgeschützten Zugriff. * Der Anwender hat nur Zugriff auf Webservices. {#cr-TestUserAPI-isValidCloudUser_S__ul_gzz_dcg_m1c} {#cr-TestUserAPI-isValidCloudUser_S__ul_ofc_wzf_m1c} |
[Tabelle : 4. Rückgaben]

{#cr-TestUserAPI-isValidCloudUser_S__table_fpx_lv4_g1c}  
Das folgende Beispiel zeigt, wie Sie einen Testanwender für den Administratoranwender starten, den Fortschritt abrufen und den Testanwender abbrechen. Nachdem der gesperrte Anwender als gültiger Cloud-Anwender bestätigt wurde, legt der Code den Cloud-Anwender als ITIL-Administrator fest. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

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

    CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

    gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

    CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

Ausgabe:

    {progress: 64, state: running}
    User is missing the following criteria: 
    	User is locked out
    False

## TestUserApi -- Fortschritt (Zeichenfolge snboqId) {#ariaid-title4}

Stellt den Status jedes Anwendertests für einen angegebenen BOQ-Datensatz (BrowserOrchestration Queue) bereit.
{#cr-TestUserAPI-progress_S__table_epx_lv4_g1c__entry__3}{#cr-TestUserAPI-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 : 5. Parameter]

{#cr-TestUserAPI-progress_S__table_epx_lv4_g1c} {#cr-TestUserAPI-progress_S__table_fpx_lv4_g1c__entry__2}{#cr-TestUserAPI-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-TestUserAPI-progress_S__cr-prog-state-li-pending} {#cr-TestUserAPI-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-TestUserAPI-progress_S__cr-prog-state-li-brsreq} {#cr-TestUserAPI-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-TestUserAPI-progress_S__cr-prog-state-li-complete} {#cr-TestUserAPI-progress_S__cr-prog-state-li-complete} * Status „Fehlgeschlagen": Die Testaufgabe ist fehlgeschlagen.{#cr-TestUserAPI-progress_S__cr-prog-state-li-failed} {#cr-TestUserAPI-progress_S__cr-prog-state-li-failed} {#cr-TestUserAPI-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-TestUserAPI-progress_S__ul_wqr_slb_j1c} |
[Tabelle : 6. Rückgaben]

{#cr-TestUserAPI-progress_S__table_fpx_lv4_g1c}  
Das folgende Beispiel zeigt, wie Sie einen Testanwender für den Administratoranwender starten, den Fortschritt abrufen und den Testanwender abbrechen. Nachdem der gesperrte Anwender als gültiger Cloud-Anwender bestätigt wurde, legt der Code den Cloud-Anwender als ITIL-Administrator fest. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

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

    CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

    gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

    CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

Ausgabe:

    {progress: 64, state: running}
    User is missing the following criteria: 
    	User is locked out
    False

## TestUserApi -- selectCloudUser(Anwendername der Zeichenfolge) {#ariaid-title5}

Startet einen End-to-End-Test-Anwenderauftrag im Cloud Runner. Wenn der Anwender sich mit der Administratorrolle richtig anmelden kann, wird die Cloud-Anwendereigenschaft als dieser Anwender für zukünftige Testläufe und Testgenerierungen in der Cloud Runner-Infrastruktur festgelegt.
{#cr-TestUserAPI-selectCloudUser_S__table_epx_lv4_g1c__entry__3}{#cr-TestUserAPI-selectCloudUser_S__cr-userNm-ph-desc}

| Name | Typ | Beschreibung |
|-|-|-|
| username | Objekt | Erforderlich. Anwender-ID eines gültigen Anwenders, der in der Tabelle Anwender \[sys_user\] aufgeführt ist. Dieser Wert wird als Zeichenfolge in einem JSON-Objekt bereitgestellt. Beispiel: `{Anwendername: „abel.tuter"} `. |
[Tabelle : 7. Parameter]

{#cr-TestUserAPI-selectCloudUser_S__table_epx_lv4_g1c} {#cr-TestUserAPI-selectCloudUser_S__table_fpx_lv4_g1c__entry__2}

| Typ | Beschreibung |
|-|-|
| Null | Null, wenn erfolgreich. Fehlermeldung andernfalls. Cloud-Anwender kann nicht festgelegt werden, da Cloud-Anwender ungültig ist -- Dieser Fehler gibt an, dass der angegebene Anwender aus mindestens einem der folgenden Gründe ungültig ist: * Der Anwender wurde nicht gefunden. * Der Anwender ist inaktiv. * Der Anwender ist gesperrt. * Der Anwender benötigt eine Passwortzurücksetzung. * Der Anwender hat keine Administratorrolle. * Der Anwender hat schreibgeschützten Zugriff. * Der Anwender hat nur Zugriff auf Webservices. {#cr-TestUserAPI-selectCloudUser_S__ul_gzz_dcg_m1c} |
[Tabelle : 8. Rückgaben]

{#cr-TestUserAPI-selectCloudUser_S__table_fpx_lv4_g1c}  
Das folgende Beispiel zeigt, wie Sie einen Testanwender für den Administratoranwender starten, den Fortschritt abrufen und den Testanwender abbrechen. Nachdem der gesperrte Anwender als gültiger Cloud-Anwender bestätigt wurde, legt der Code den Cloud-Anwender als ITIL-Administrator fest. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

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

    CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

    gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

    CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

Ausgabe:

    {progress: 64, state: running}
    User is missing the following criteria: 
    	User is locked out
    False

## TestUserApi -- startJob(Anwendername der Zeichenfolge) {#ariaid-title6}

Startet einen End-to-End-Test-Anwenderauftrag im Cloud Runner.
{#cr-TestUserAPI-startJob_S__table_epx_lv4_g1c__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| username | Zeichenfolge | Erforderlich. Anwendername von sys_user zum Testen der End-to-End-Infrastruktur des Cloud Runners. |
[Tabelle : 9. Parameter]

{#cr-TestUserAPI-startJob_S__table_epx_lv4_g1c} {#cr-TestUserAPI-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 : 10. Rückgaben]

{#cr-TestUserAPI-startJob_S__table_fpx_lv4_g1c}  
Das folgende Beispiel zeigt, wie Sie einen Testanwender für den Administratoranwender starten, den Fortschritt abrufen und den Testanwender abbrechen. Nachdem der gesperrte Anwender als gültiger Cloud-Anwender bestätigt wurde, legt der Code den Cloud-Anwender als ITIL-Administrator fest. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg.

    var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"});

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

    CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId});

    gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: <name of the user who has been locked out>}));

    CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"});

Ausgabe:

    {progress: 64, state: running}
    User is missing the following criteria: 
    	User is locked out
    False


