---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - fr-FR

ft:publication_title :

    - Référence de l’API Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# CheckDefinitionTestBuilder : inclus dans le champ d'application

# CheckDefinitionTestBuilder : inclus dans le champ d'application {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 minutes de lecture

L'include de script CheckDefinitionTestBuilder fournit des méthodes qui vous permettent de générer des demandes de vérification de test sur des définitions de vérification.

Cet include de script nécessite l'application Agent Client Collector de stockage Framework (sn_agent) et est fourni dans l'espace de noms `sn_agent` . Pour plus d'informations, consultez [Agent Client Collector](https://www.servicenow.com/docs/access?context=acc-landing-page&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US).

Pour la solution d'API REST, consultez [l'API Agent Client Collector](https://servicenow-prod.fluidtopics.net/QEP8zRm1ZTNaxaPmVG9qAg#agnt_clnt_cll-api "L’API Agent Client Collector fournit des points de terminaison pour gérer les actions sur les agents disponibles et les politiques de gestion.").  
Cet include de script fournit des méthodes qui activent les éléments suivants :

* Définir la définition de contrôle à tester
* Définir l'élément de configuration sur lequel exécuter le test

{#CheckDefinitionTestBuilderAPIScope__ul_tdb_gpk_5qb}Vous pouvez également spécifier l'un des identificateurs suivants à utiliser pendant le test :

<!-- -->

* Informations d'identification sys_id
* ID de l'alias d'informations d'identification
* Nom des informations d'identification
{#CheckDefinitionTestBuilderAPIScope__ul_tft_qwk_5qb}

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

Crée une instance CheckDefinitionTestBuilder.
{#CkDfTB-CheckDefinitionTestBuilder__table_ohr_4qd_bpb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 1. Paramètres]

{#CkDfTB-CheckDefinitionTestBuilder__table_ohr_4qd_bpb}  
L'exemple suivant montre comment initialiser CheckDefinitionTestBuilder.

    var builder = new sn_agent.CheckDefinitionTestBuilder();

## CheckDefinitionTestBuilder : build() {#ariaid-title3}

Génère la demande de contrôle de test avec les arguments définis.
{#CkDfTB-build__table_zk2_2g2_z4b__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 2. Paramètres]

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

| Propriétés | Description |
|-|-|
| Objet | Objet JSON avec deux attributs : l'ID d'enregistrement du résultat du test et une erreur. Si la version réussit, l'ID de résultat du test est renvoyé et l'erreur est nulle. Si une erreur se produit pendant la génération, l'ID de résultat du test est nul et l'erreur s'affiche. |
[Tableau 3. Renvoie]

{#CkDfTB-build__table_al2_2g2_z4b}  
L'exemple suivant montre comment générer une demande de vérification de test :

    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}

Définit la sys_id de la définition de contrôle à tester.
{#CkDfTB-withCheckId_S__table_zk2_2g2_z4b__entry__3}

| Nom | Type | Description |
|-|-|-|
| checkId (en anglais seulement) | Chaîne | Sys_id de la définition de vérification répertoriée dans la table Définitions de vérification \[sn_agent_check_def\]. |
[Tableau 4. Paramètres]

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

| Type | Description |
|-|-|
| CheckDefinitionTestBuilder (en anglais seulement) | Instance du générateur pour laquelle la méthode a été invoquée. |
[Tableau 5. Renvoie]

{#CkDfTB-withCheckId_S__table_al2_2g2_z4b}  
L'exemple suivant montre comment créer une vérification de test.

    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}

Définit le sys_id de l'élément de configuration par rapport auquel exécuter le test.
{#CkDfTB-withCiId_S__table_zk2_2g2_z4b__entry__3}

| Nom | Type | Description |
|-|-|-|
| ciId | Chaîne | Sys_id d'un élément de configuration CMDB. |
[Tableau 6. Paramètres]

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

| Type | Description |
|-|-|
| CheckDefinitionTestBuilder (en anglais seulement) | Instance du générateur pour laquelle la méthode a été invoquée. |
[Tableau 7. Renvoie]

{#CkDfTB-withCiId_S__table_al2_2g2_z4b}  
L'exemple suivant montre comment créer une demande de contrôle de test avec

    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}

Définit l'alias d'informations d'identification sys_id à utiliser pendant le test.
Remarque :  
L'exécution de cette opération supprime toute affectation précédente effectuée en appelant withCredentialsName, withCredentialsAliasId ou withCredentialsAliasName. {#CkDfTB-withCredentialsAliasId_S__table_zk2_2g2_z4b__entry__3}

| Nom | Type | Description |
|-|-|-|
| ID d'alias des informations d'identification | Chaîne | Sys_id d'un enregistrement d'informations d'identification. |
[Tableau 8. Paramètres]

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

| Type | Description |
|-|-|
| CheckDefinitionTestBuilder (en anglais seulement) | Instance du générateur pour laquelle la méthode a été invoquée. |
[Tableau 9. Renvoie]

{#CkDfTB-withCredentialsAliasId_S__table_bjt_555_wqb}  
L'exemple suivant montre comment créer une vérification de test et définir l'ID de l'alias d'informations d'identification.

    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 credentialsAliasName) {#ariaid-title7}

Définit le nom de l'alias d'informations d'identification à utiliser pendant le test. Si la valeur donnée correspond au nom de plusieurs enregistrements d'alias d'informations d'identification, l'un d'eux est choisi au hasard.
Remarque :  
L'exécution de cette opération supprime toute affectation précédente effectuée en appelant withCredentialsName, withCredentialsAliasId ou withCredentialsAliasName.
{#CkDfTB-withCredentialsAliasName_S__table_zk2_2g2_z4b__entry__3}

| Nom | Type | Description |
|-|-|-|
| informations d'identificationAliasName | Chaîne | Nom d'un alias d'informations d'identification. |
[Tableau 10. Paramètres]

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

| Type | Description |
|-|-|
| CheckDefinitionTestBuilder (en anglais seulement) | Instance du générateur pour laquelle la méthode a été invoquée. |
[Tableau 11. Renvoie]

{#CkDfTB-withCredentialsAliasName_S__table_al2_2g2_z4b}  
L'exemple suivant montre comment créer une vérification de test et définir le nom de l'alias d'informations d'identification.

    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(String credentialsId) {#ariaid-title8}

Définit les sys_id d'informations d'identification à utiliser pendant le test.
Remarque :  
L'exécution de cette opération supprime toute affectation précédente effectuée en appelant withCredentialsName, withCredentialsAliasId ou withCredentialsAliasName. {#CkDfTB-withCredentialsId_S__table_zk2_2g2_z4b__entry__3}

| Nom | Type | Description |
|-|-|-|
| ID d'informations d'identification | Chaîne | Sys_id d'un enregistrement d'informations d'identification. |
[Tableau 12. Paramètres]

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

| Type | Description |
|-|-|
| CheckDefinitionTestBuilder (en anglais seulement) | Instance du générateur pour laquelle la méthode a été invoquée. |
[Tableau 13. Renvoie]

{#CkDfTB-withCredentialsId_S__table_al2_2g2_z4b}  
L'exemple suivant montre comment créer une vérification de test et définir l'ID des informations d'identification.

    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(chaîne, credentialsName) {#ariaid-title9}

Définit le nom des informations d'identification à utiliser pendant le test. Si la valeur donnée est le nom de plusieurs enregistrements d'informations d'identification, l'un d'eux est choisi au hasard.
Remarque :  
L'exécution de cette opération supprime toute affectation précédente effectuée en appelant withCredentialsName, withCredentialsAliasId ou withCredentialsAliasName. {#CkDfTB-withCredentialsName_S__table_zk2_2g2_z4b__entry__3}

| Nom | Type | Description |
|-|-|-|
| nom des informations d'identification | Chaîne | Nom de l'enregistrement des informations d'identification. |
[Tableau 14. Paramètres]

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

| Type | Description |
|-|-|
| CheckDefinitionTestBuilder (en anglais seulement) | Instance du générateur pour laquelle la méthode a été invoquée. |
[Tableau 15. Renvoie]

{#CkDfTB-withCredentialsName_S__table_al2_2g2_z4b}  
L'exemple suivant montre comment créer une vérification de test et définir le nom des informations d'identification.

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