---
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


---

# PrüfdefinitionTestBuilder -- Umfang

# PrüfdefinitionTestBuilder -- Umfang {#ariaid-title1}

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

Die PrüfdefinitionTestBuilder Die Skripteinbindung bietet Methoden, mit denen Sie Testprüfungsanforderungen für Prüfungsdefinitionen erstellen können.

Diese Skripteinbindung erfordert Agent Client CollectorFramework (sn_Agent) Store-Anwendung und wird in bereitgestellt `sn_Agent `Namespace. Weitere Informationen finden Sie unter [Agent-Clientsammler](https://www.servicenow.com/docs/access?context=acc-landing-page&version=yokohama&pubname=yokohama-it-operations-management&ft:locale=en-US).

Informationen zur REST-API-Lösung finden Sie unter [Agent-Clientsammler-API](https://servicenow-prod.fluidtopics.net/AbwUoa793pJM25astiJUmA#agnt_clnt_cll-api "Die Agent-Clientsammler Die API stellt Endpunkte zur Verwaltung von Aktionen für verfügbare Agenten und zur Verwaltung von Richtlinien bereit.").  
Diese Skripteinbindung bietet Methoden, die Folgendes aktivieren:

* Legen Sie die zu testende Prüfungsdefinition fest
* Legen Sie das Konfigurationselement fest, für das der Test ausgeführt werden soll

{#CheckDefinitionTestBuilderAPIScope__ul_tdb_gpk_5qb}Sie können auch einen der folgenden Bezeichner angeben, die während des Tests verwendet werden sollen:

<!-- -->

* Sys_ID der Anmeldeinformationen
* ID des Anmeldeinformationsalias
* Anmeldeinformationsname
{#CheckDefinitionTestBuilderAPIScope__ul_tft_qwk_5qb}

## CheckDefinitionTestBuilder -- CheckDefinitionTestBuilder() {#ariaid-title2}

Erstellt eine CheckDefinitionTestBuilder-Instanz.
{#CkDfTB-CheckDefinitionTestBuilder__table_ohr_4qd_bpb__entry__3}

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

{#CkDfTB-CheckDefinitionTestBuilder__table_ohr_4qd_bpb}  
Das folgende Beispiel zeigt, wie initialisiert wird PrüfdefinitionTestBuilder .

    var builder = new sn_agent.CheckDefinitionTestBuilder();

## CheckDefinitionTestBuilder -- Build() {#ariaid-title3}

Erstellt die Testprüfungsanforderung mit den festgelegten Argumenten.
{#CkDfTB-build__table_zk2_2g2_z4b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 2. Parameter]

{#CkDfTB-build__table_zk2_2g2_z4b} {#CkDfTB-build__table_al2_2g2_z4b__entry__2}

| Eigenschaften | Beschreibung |
|-|-|
| Objekt | JSON-Objekt mit zwei Attributen -- der Testergebnisdatensatz-ID und einem Fehler. Wenn der Build erfolgreich ist, wird die Testergebnis-ID zurückgegeben, und der Fehler ist null. Wenn während des Builds ein Fehler auftritt, ist die Testergebnis-ID null, und der Fehler wird angezeigt. |
[Tabelle : 3. Rückgaben]

{#CkDfTB-build__table_al2_2g2_z4b}  
Das folgende Beispiel zeigt, wie eine Testprüfungsanforderung erstellt wird:

    var checkId = "158279505372b30034b8ddeeff7b1270";
    var ciId = "cc0dcc855374301062d1ddeeff7b12b0";
    var builder = new sn_agent.CheckDefinitionTestBuilder();

    var testResultJson = builder.withCheckId(checkId).withCiId(ciId).build();

    if (!gs.nil(testResultJson.error))
    	gs.error(testResultJson.error);

## CheckDefinitionTestBuilder -- withCheckId (Zeichenfolge checkId) {#ariaid-title4}

Legt die sys_ID der zu testenden Prüfungsdefinition fest.
{#CkDfTB-withCheckId_S__table_zk2_2g2_z4b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| CheckId | Zeichenfolge | SYS_ID der Prüfungsdefinition, die in der Tabelle „Prüfungsdefinitionen" \[sn_agent_check_def\] aufgeführt ist. |
[Tabelle : 4. Parameter]

{#CkDfTB-withCheckId_S__table_zk2_2g2_z4b} {#CkDfTB-withCheckId_S__table_al2_2g2_z4b__entry__2}

| Typ | Beschreibung |
|-|-|
| PrüfdefinitionTestBuilder | Die Generatorinstanz, für die die Methode aufgerufen wurde. |
[Tabelle : 5. Rückgaben]

{#CkDfTB-withCheckId_S__table_al2_2g2_z4b}  
Das folgende Beispiel zeigt, wie eine Testprüfung erstellt wird.

    var checkId = "158279505372b30034b8ddeeff7b1270";
    var ciId = "cc0dcc855374301062d1ddeeff7b12b0";
    var builder = new sn_agent.CheckDefinitionTestBuilder();
    var testResultJson = builder.withCheckId(checkId).withCiId(ciId).build();
    if (!gs.nil(testResultJson.error))
    	gs.error(testResultJson.error);

## CheckDefinitionTestBuilder -- withCiId (Zeichenfolge ciId) {#ariaid-title5}

Legt die sys_ID des Konfigurationselements fest, für das der Test ausgeführt werden soll.
{#CkDfTB-withCiId_S__table_zk2_2g2_z4b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| ciId | Zeichenfolge | SYS_ID eines CMDB-Konfigurationselements. |
[Tabelle : 6. Parameter]

{#CkDfTB-withCiId_S__table_zk2_2g2_z4b} {#CkDfTB-withCiId_S__table_al2_2g2_z4b__entry__2}

| Typ | Beschreibung |
|-|-|
| PrüfdefinitionTestBuilder | Die Generatorinstanz, für die die Methode aufgerufen wurde. |
[Tabelle : 7. Rückgaben]

{#CkDfTB-withCiId_S__table_al2_2g2_z4b}  
Das folgende Beispiel zeigt, wie eine Testprüfungsanforderung mit erstellt wird

    var checkId = "158279505372b30034b8ddeeff7b1270";
    var ciId = "cc0dcc855374301062d1ddeeff7b12b0";
    var builder = new sn_agent.CheckDefinitionTestBuilder();
    var testResultJson = builder.withCheckId(checkId).withCiId(ciId).build();
    if (!gs.nil(testResultJson.error))
    	gs.error(testResultJson.error);

## CheckDefinitionTestBuilder -- withCredentialsAliasId(Zeichenfolge credentialsAliasId) {#ariaid-title6}

Legt die sys_ID des Anmeldeinformationsalias fest, der während des Tests verwendet werden soll.
Hinweis:  
Wenn Sie diese Option ausführen, werden alle vorherigen Zuweisungen entfernt, die durch Aufrufen von „withCredentialsName", „withCredentialsAliasId" oder „withCredentialsAliasName" vorgenommen wurden. {#CkDfTB-withCredentialsAliasId_S__table_zk2_2g2_z4b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| CredentialsAliasId | Zeichenfolge | SYS_ID eines Anmeldeinformationsdatensatzes. |
[Tabelle : 8. Parameter]

{#CkDfTB-withCredentialsAliasId_S__table_zk2_2g2_z4b} {#CkDfTB-withCredentialsAliasId_S__table_bjt_555_wqb__entry__2}

| Typ | Beschreibung |
|-|-|
| PrüfdefinitionTestBuilder | Die Generatorinstanz, für die die Methode aufgerufen wurde. |
[Tabelle : 9. Rückgaben]

{#CkDfTB-withCredentialsAliasId_S__table_bjt_555_wqb}  
Das folgende Beispiel zeigt, wie Sie eine Testprüfung erstellen und die Alias-ID für Anmeldeinformationen festlegen.

    var checkId = "158279505372b30034b8ddeeff7b1270";
    var credAlias = "<sys_id>";
    var builder = new sn_agent.CheckDefinitionTestBuilder();
    var testResultJson = builder.withCheckId(checkId).withCredentialsAliasId(credAlias).build();
    if (!gs.nil(testResultJson.error))
    	gs.error(testResultJson.error);

## CheckDefinitionTestBuilder -- withCredentialsAliasName(Zeichenfolge credentialsAliasName) {#ariaid-title7}

Legt den Aliasnamen für Anmeldeinformationen fest, der während des Tests verwendet werden soll. Wenn der angegebene Wert mit dem Namen mehrerer Anmeldeinformationsaliasse-Datensätze übereinstimmt, wird einer davon zufällig ausgewählt.
Hinweis:  
Wenn Sie diese Option ausführen, werden alle vorherigen Zuweisungen entfernt, die durch Aufrufen von „withCredentialsName", „withCredentialsAliasId" oder „withCredentialsAliasName" vorgenommen wurden.
{#CkDfTB-withCredentialsAliasName_S__table_zk2_2g2_z4b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| CredentialsAliasName | Zeichenfolge | Name eines Anmeldeinformationsalias. |
[Tabelle : 10. Parameter]

{#CkDfTB-withCredentialsAliasName_S__table_zk2_2g2_z4b} {#CkDfTB-withCredentialsAliasName_S__table_al2_2g2_z4b__entry__2}

| Typ | Beschreibung |
|-|-|
| PrüfdefinitionTestBuilder | Die Generatorinstanz, für die die Methode aufgerufen wurde. |
[Tabelle : 11. Rückgaben]

{#CkDfTB-withCredentialsAliasName_S__table_al2_2g2_z4b}  
Das folgende Beispiel zeigt, wie Sie eine Testprüfung erstellen und den Aliasnamen für Anmeldeinformationen festlegen.

    var checkId = "158279505372b30034b8ddeeff7b1270";
    var credentialsAliasName = "credentialsAliasName";
    var builder = new sn_agent.CheckDefinitionTestBuilder();
    var testResultJson = builder.withCheckId(checkId).withCredentialsAliasName(credentialsAliasName).build();
    if (!gs.nil(testResultJson.error))
    	gs.error(testResultJson.error);

## CheckDefinitionTestBuilder -- withCredentialsId(Zeichenfolge credentialsId) {#ariaid-title8}

Legt die sys_ID der Anmeldeinformationen fest, die während des Tests verwendet werden sollen.
Hinweis:  
Wenn Sie diese Option ausführen, werden alle vorherigen Zuweisungen entfernt, die durch Aufrufen von „withCredentialsName", „withCredentialsAliasId" oder „withCredentialsAliasName" vorgenommen wurden. {#CkDfTB-withCredentialsId_S__table_zk2_2g2_z4b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| AnmeldeinformationenId | Zeichenfolge | SYS_ID eines Anmeldeinformationsdatensatzes. |
[Tabelle : 12. Parameter]

{#CkDfTB-withCredentialsId_S__table_zk2_2g2_z4b} {#CkDfTB-withCredentialsId_S__table_al2_2g2_z4b__entry__2}

| Typ | Beschreibung |
|-|-|
| PrüfdefinitionTestBuilder | Die Generatorinstanz, für die die Methode aufgerufen wurde. |
[Tabelle : 13. Rückgaben]

{#CkDfTB-withCredentialsId_S__table_al2_2g2_z4b}  
Das folgende Beispiel zeigt, wie Sie eine Testprüfung erstellen und die Anmeldeinformations-ID festlegen.

    var checkId = "158279505372b30034b8ddeeff7b1270";
    var credID = "<sys_id>";
    var builder = new sn_agent.CheckDefinitionTestBuilder();
    var testResultJson = builder.withCheckId(checkId).withCredentialsId(credID).build();
    if (!gs.nil(testResultJson.error))
    	gs.error(testResultJson.error);

## CheckDefinitionTestBuilder -- withCredentialsName(Zeichenfolge credentialsName) {#ariaid-title9}

Legt den Anmeldeinformationsnamen fest, der während des Tests verwendet werden soll. Wenn der angegebene Wert der Name mehrerer Anmeldeinformationsdatensätze ist, wird einer davon zufällig ausgewählt.
Hinweis:  
Wenn Sie diese Option ausführen, werden alle vorherigen Zuweisungen entfernt, die durch Aufrufen von „withCredentialsName", „withCredentialsAliasId" oder „withCredentialsAliasName" vorgenommen wurden. {#CkDfTB-withCredentialsName_S__table_zk2_2g2_z4b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Anmeldeinformationsname | Zeichenfolge | Name des Anmeldeinformationsdatensatzes. |
[Tabelle : 14. Parameter]

{#CkDfTB-withCredentialsName_S__table_zk2_2g2_z4b} {#CkDfTB-withCredentialsName_S__table_al2_2g2_z4b__entry__2}

| Typ | Beschreibung |
|-|-|
| PrüfdefinitionTestBuilder | Die Generatorinstanz, für die die Methode aufgerufen wurde. |
[Tabelle : 15. Rückgaben]

{#CkDfTB-withCredentialsName_S__table_al2_2g2_z4b}  
Das folgende Beispiel zeigt, wie Sie eine Testprüfung erstellen und den Anmeldeinformationsnamen festlegen.

    var checkId = "158279505372b30034b8ddeeff7b1270";
    var credname = "credentialsName";
    var builder = new sn_agent.CheckDefinitionTestBuilder();
    var testResultJson = builder.withCheckId(checkId).withCredentialsName(credName).build();
    if (!gs.nil(testResultJson.error))
    	gs.error(testResultJson.error);


