---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# CheckInstanceTestBuilder - com escopo

# CheckInstanceTestBuilder - com escopo {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 min. de leitura

A inclusão de script CheckInstanceTestBuilder fornece métodos que permitem a criação de solicitações de verificação de teste em instâncias de verificação.

Esta inclusão de script requer a aplicação da loja Agent Client Collector Framework (sn_agent) e é fornecida no namespace `sn_agent`. Para obter mais informações, consulte [Agent Client Collector](https://www.servicenow.com/docs/access?context=acc-landing-page&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US).

Para a solução REST API, consulte [Agent Client Collector API](https://servicenow-prod.fluidtopics.net/0hS64SPtXLuUBX2LjwGOfg#agnt_clnt_cll-api "A API Agent Client Collector fornece endpoints para gerenciar ações em agentes disponíveis e gerenciar políticas.").  
Esta inclusão de script fornece métodos que habilitam o seguinte:

* Definir a instância de verificação como teste
* Definir o item de configuração para executar o teste

{#CheckInstanceTestBuilderAPIScoped__ul_tdb_gpk_5qb}Você também pode especificar um dos seguintes identificadores para usar durante o teste:

<!-- -->

* sys_id de credencial
* ID do alias de credencial
* Nome da credencial
{#CheckInstanceTestBuilderAPIScoped__ul_tft_qwk_5qb}

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

Cria uma instância CheckInstanceTestBuilder.
{#CkInTB-CheckInstanceTestBuilder__table_ohr_4qd_bpb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum(a) |   |   |
[Tabela 1. Parâmetros]

{#CkInTB-CheckInstanceTestBuilder__table_ohr_4qd_bpb}  
O exemplo a seguir mostra como inicializar CheckInstanceTestBuilder.

    var builder = new sn_agent.CheckInstanceTestBuilder();

## CheckInstanceTestBuilder - compilação () {#ariaid-title3}

Cria a solicitação de verificação de teste com o conjunto de argumentos.
{#CkInTB-build__table_zk2_2g2_z4b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 2. Parâmetros]

{#CkInTB-build__table_zk2_2g2_z4b} {#CkInTB-build__table_al2_2g2_z4b__entry__2}

| Propriedades | Descrição |
|-|-|
| Objeto | Objeto JSON com dois atributos: o ID de registro do resultado de testes e um erro. Se a compilação for bem-sucedida, o ID do resultado do teste retornará e o erro será nulo. Se ocorrer um erro durante a compilação, o ID do resultado do teste será nulo e o erro será exibido. |
[Tabela 3. Retorna]

{#CkInTB-build__table_al2_2g2_z4b}  
O exemplo a seguir mostra como criar uma solicitação de verificação de teste:

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

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

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

## CheckInstanceTestBuilder - withCheckId(cadeia de caracteres checkId) {#ariaid-title4}

Define o sys_id da definição de verificação a ser testada.
{#CkInTB-withCheckId_S__table_zk2_2g2_z4b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| checkId | Cadeia de caracteres | Sys_id da definição de verificação listada na tabela Definições de verificação \[sn_agent_check_def\]. |
[Tabela 4. Parâmetros]

{#CkInTB-withCheckId_S__table_zk2_2g2_z4b} {#CkInTB-withCheckId_S__table_al2_2g2_z4b__entry__2}

| Tipo | Descrição |
|-|-|
| CheckInstanceTestBuilder | A instância do construtor para a qual o método foi invocado. |
[Tabela 5. Retorna]

{#CkInTB-withCheckId_S__table_al2_2g2_z4b}  
O exemplo a seguir mostra como criar uma verificação de teste.

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

## CheckInstanceTestBuilder - withCiId(cadeia de caracteres ciId) {#ariaid-title5}

Define o sys_id do item de configuração para executar o teste.
{#CkInTB-withCiId_S__table_zk2_2g2_z4b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| ciId | Cadeia de caracteres | Sys_id de um item de configuração do CMDB. |
[Tabela 6. Parâmetros]

{#CkInTB-withCiId_S__table_zk2_2g2_z4b} {#CkInTB-withCiId_S__table_al2_2g2_z4b__entry__2}

| Tipo | Descrição |
|-|-|
| CheckInstanceTestBuilder | A instância do construtor para a qual o método foi invocado. |
[Tabela 7. Retorna]

{#CkInTB-withCiId_S__table_al2_2g2_z4b}  
O exemplo a seguir mostra como criar uma solicitação de verificação de teste com

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

## CheckInstanceTestBuilder - withCredentialsAliasId(cadeia de caracteres credenciaisAliasId) {#ariaid-title6}

Define o alias de credenciais sys_id a ser usado durante o teste.
Nota:  
A execução desta remove qualquer atribuição anterior feita chamando withCredentialsName, withCredentialsAliasId ou withCredentialsAliasName. {#CkInTB-withCredentialsAliasId_S__table_zk2_2g2_z4b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| credenciaisAliasId | Cadeia de caracteres | Sys_id de um registro de alias de credenciais. |
[Tabela 8. Parâmetros]

{#CkInTB-withCredentialsAliasId_S__table_zk2_2g2_z4b} {#CkInTB-withCredentialsAliasId_S__table_bjt_555_wqb__entry__2}

| Tipo | Descrição |
|-|-|
| CheckInstanceTestBuilder | A instância do construtor para a qual o método foi invocado. |
[Tabela 9. Retorna]

{#CkInTB-withCredentialsAliasId_S__table_bjt_555_wqb}  
O exemplo a seguir mostra como criar uma verificação de teste e definir o ID do alias de credenciais.

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

## CheckInstanceTestBuilder - withCredentialsAliasName(cadeia de caracteres credenciaisAliasName) {#ariaid-title7}

Define o nome do alias de credenciais a ser usado durante o teste. Se o valor fornecido corresponder ao nome de vários registros de aliases de credenciais, um deles será escolhido aleatoriamente.
Nota:  
A execução desta remove qualquer atribuição anterior feita chamando withCredentialsName, withCredentialsAliasId ou withCredentialsAliasName.
{#CkInTB-withCredentialsAliasName_S__table_zk2_2g2_z4b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| credenciaisAliasName | Cadeia de caracteres | Nome de um alias de credenciais. |
[Tabela 10. Parâmetros]

{#CkInTB-withCredentialsAliasName_S__table_zk2_2g2_z4b} {#CkInTB-withCredentialsAliasName_S__table_al2_2g2_z4b__entry__2}

| Tipo | Descrição |
|-|-|
| CheckInstanceTestBuilder | A instância do construtor para a qual o método foi invocado. |
[Tabela 11. Retorna]

{#CkInTB-withCredentialsAliasName_S__table_al2_2g2_z4b}  
O exemplo a seguir mostra como criar uma verificação de teste e definir o nome do alias das credenciais.

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

## CheckInstanceTestBuilder - withCredentialsId(cadeia de caracteres credenciaisId) {#ariaid-title8}

Define as credenciais sys_id a serem usadas durante o teste.
Nota:  
A execução desta remove qualquer atribuição anterior feita chamando withCredentialsName, withCredentialsAliasId ou withCredentialsAliasName. {#CkInTB-withCredentialsId_S__table_zk2_2g2_z4b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| credenciaisId | Cadeia de caracteres | Sys_id de um registro de credenciais. |
[Tabela 12. Parâmetros]

{#CkInTB-withCredentialsId_S__table_zk2_2g2_z4b} {#CkInTB-withCredentialsId_S__table_al2_2g2_z4b__entry__2}

| Tipo | Descrição |
|-|-|
| CheckInstanceTestBuilder | A instância do construtor para a qual o método foi invocado. |
[Tabela 13. Retorna]

{#CkInTB-withCredentialsId_S__table_al2_2g2_z4b}  
O exemplo a seguir mostra como criar uma verificação de teste e definir o ID de credenciais.

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

## CheckInstanceTestBuilder - withCredentialsName(cadeia de caracteres credenciaisName) {#ariaid-title9}

Define o nome das credenciais a serem usadas durante o teste. Se o valor fornecido for o nome de vários registros de credenciais, um deles será escolhido aleatoriamente.
Nota:  
A execução desta remove qualquer atribuição anterior feita chamando withCredentialsName, withCredentialsAliasId ou withCredentialsAliasName. {#CkInTB-withCredentialsName_S__table_zk2_2g2_z4b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| credenciaisNome | Cadeia de caracteres | Nome do registro de credenciais. |
[Tabela 14. Parâmetros]

{#CkInTB-withCredentialsName_S__table_zk2_2g2_z4b} {#CkInTB-withCredentialsName_S__table_al2_2g2_z4b__entry__2}

| Tipo | Descrição |
|-|-|
| CheckInstanceTestBuilder | A instância do construtor para a qual o método foi invocado. |
[Tabela 15. Retorna]

{#CkInTB-withCredentialsName_S__table_al2_2g2_z4b}  
O exemplo a seguir mostra como criar uma verificação de teste e definir o nome das credenciais.

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

## CheckInstanceTestBuilder - withProxyAgentId(cadeia de caracteres agentId) {#ariaid-title10}

Define o agente para executar o teste. Permitido somente se a instância de verificação e a política testadas forem proxy.
{#CkInTB-withProxyAgentId_S__table_zk2_2g2_z4b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| agentId | Cadeia de caracteres | ID exclusivo de um proxy do agente para executar esta verificação. Este valor está listado na coluna ID do agente da tabela Agent Client Collectors \[sn_agent_cmdb_ci_agent\]. |
[Tabela 16. Parâmetros]

{#CkInTB-withProxyAgentId_S__table_zk2_2g2_z4b} {#CkInTB-withProxyAgentId_S__table_al2_2g2_z4b__entry__2}

| Tipo | Descrição |
|-|-|
| CheckInstanceTestBuilder | A instância do construtor para a qual o método foi invocado. |
[Tabela 17. Retorna]

{#CkInTB-withProxyAgentId_S__table_al2_2g2_z4b}  
O exemplo a seguir mostra como criar uma verificação de teste e definir o ID do agente de proxy.

    var checkId = "158279505372b30034b8ddeeff7b1270";
    var agentId = "<agentID>";
    var builder = new sn_agent.CheckInstanceTestBuilder();
    var testResultJson = builder.withCheckId(checkId).withAgentId(agentId).build();
    if (!gs.nil(testResultJson.error))
    	gs.error(testResultJson.error);