---
sourceDocument: Xanadu-API-Referenz
sourceDocumentLink: https://www.servicenow.com/docs/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


---

# CheckDefinitionTestBuilder: Bereichsbezogen

# CheckDefinitionTestBuilder: Bereichsbezogen {#ariaid-title1}

* Freigeben Version: Xanadu
* 
* Aktualisiert 1. August 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 Minuten Lesedauer

Die CheckDefinitionTestBuilder-Skripteinbindung stellt Methoden bereit, mit denen Sie Testprüfungsanforderungen für Prüfungsdefinitionen erstellen können.

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

Informationen zur REST-API-Lösung finden Sie unter [Agent Client Collector API](https://www.servicenow.com/docs/cJjDnd2cBThck5ShtcSWYw#agnt_clnt_cll-api "Die Agent Client Collector API bietet Endpunkte zum Verwalten von Aktionen für verfügbare Agents und zum Verwalten von Richtlinien.").  
Diese Skripteinbindung stellt Methoden bereit, die Folgendes ermöglichen:

* Legen Sie die Prüfungsdefinition auf „Test" fest
* Legen Sie das Configuration Item fest, für das der Test ausgeführt werden soll

{#CheckDefinitionTestBuilderAPIScope__ul_tdb_gpk_5qb}Sie können auch einen der folgenden Bezeichner für den Test angeben:

<!-- -->

* sys_id der Anmeldeinformationen
* Alias-ID für Anmeldeinformationen
* 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 CheckDefinitionTestBuilderinitialisiert wird.

    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 Datensatz-ID des Testergebnisses 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. Ergebnisse]

{#CkDfTB-build__table_al2_2g2_z4b}  
Das folgende Beispiel zeigt, wie eine Testüberprü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(String checkId) {#ariaid-title4}

Legt die sys_id der Prüfungsdefinition auf „test" fest.
{#CkDfTB-withCheckId_S__table_zk2_2g2_z4b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Prüf-ID | 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 |
|-|-|
| CheckDefinitionTestBuilder | Die Builder-Instanz, für die die Methode aufgerufen wurde. |
[Tabelle : 5. Ergebnisse]

{#CkDfTB-withCheckId_S__table_al2_2g2_z4b}  
Das folgende Beispiel zeigt, wie Sie einen Testcheck erstellen.

    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(String 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 |
|-|-|
| CheckDefinitionTestBuilder | Die Builder-Instanz, für die die Methode aufgerufen wurde. |
[Tabelle : 7. Ergebnisse]

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

    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(String CredentialsAliasId) {#ariaid-title6}

Legt die Anmeldeinformations-Alias-sys_id fest, die während des Tests verwendet werden soll.
Hinweis:  
Wenn Sie diese Option ausführen, werden alle vorherigen Zuweisungen entfernt, die durch den Aufruf von withCredentialsName, withCredentialsAliasId oder withCredentialsAliasName durchgeführt wurden. {#CkDfTB-withCredentialsAliasId_S__table_zk2_2g2_z4b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Anmeldeinformationsalias-ID | 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 |
|-|-|
| CheckDefinitionTestBuilder | Die Builder-Instanz, für die die Methode aufgerufen wurde. |
[Tabelle : 9. Ergebnisse]

{#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(String incidentalsAliasName) {#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 Aliasse für Anmeldeinformationen übereinstimmt, wird einer davon zufällig ausgewählt.
Hinweis:  
Wenn Sie diese Option ausführen, werden alle vorherigen Zuweisungen entfernt, die durch den Aufruf von withCredentialsName, withCredentialsAliasId oder withCredentialsAliasName durchgeführt wurden.
{#CkDfTB-withCredentialsAliasName_S__table_zk2_2g2_z4b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| AnmeldeinformationenAliasName | Zeichenfolge | Name des Alias für Anmeldeinformationen |
[Tabelle : 10. Parameter]

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

| Typ | Beschreibung |
|-|-|
| CheckDefinitionTestBuilder | Die Builder-Instanz, für die die Methode aufgerufen wurde. |
[Tabelle : 11. Ergebnisse]

{#CkDfTB-withCredentialsAliasName_S__table_al2_2g2_z4b}  
Das folgende Beispiel zeigt, wie Sie eine Testprüfung erstellen und den Namen des Alias 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 den Aufruf von withCredentialsName, withCredentialsAliasId oder withCredentialsAliasName durchgeführt wurden. {#CkDfTB-withCredentialsId_S__table_zk2_2g2_z4b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Anmeldeinformations-ID | 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 |
|-|-|
| CheckDefinitionTestBuilder | Die Builder-Instanz, für die die Methode aufgerufen wurde. |
[Tabelle : 13. Ergebnisse]

{#CkDfTB-withCredentialsId_S__table_al2_2g2_z4b}  
Das folgende Beispiel zeigt, wie Sie einen Testcheck 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(String incidentalname) {#ariaid-title9}

Legt den Namen der Anmeldeinformationen fest, die während des Tests verwendet werden sollen. Wenn der angegebene Wert der Name mehrerer Datensätze mit Anmeldeinformationen ist, wird einer davon zufällig ausgewählt.
Hinweis:  
Wenn Sie diese Option ausführen, werden alle vorherigen Zuweisungen entfernt, die durch den Aufruf von withCredentialsName, withCredentialsAliasId oder withCredentialsAliasName durchgeführt wurden. {#CkDfTB-withCredentialsName_S__table_zk2_2g2_z4b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| AnmeldeinformationenName | 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 |
|-|-|
| CheckDefinitionTestBuilder | Die Builder-Instanz, für die die Methode aufgerufen wurde. |
[Tabelle : 15. Ergebnisse]

{#CkDfTB-withCredentialsName_S__table_al2_2g2_z4b}  
Das folgende Beispiel zeigt, wie Sie eine Testüberprüfung erstellen und den Namen der Anmeldeinformationen 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);