---
sourceDocument: Criar ou modificar aplicações do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/application-development

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Criar ou modificar aplicações do Xanadu

ft:clusterId :

    - cadev

bundleId :

    - cadev

workflow :

    - Creator


---

# Categoria REST

# Categoria REST {#ariaid-title1}

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

Verifique a funcionalidade das chamadas REST.

## Enviar Solicitação REST -- de entrada -- Explorador de REST API {#ariaid-title2}

Esta etapa de teste começa com o Explorador de REST API. Use o Explorador de REST API para criar e especificar o método HTTP, o caminho, os parâmetros de consulta, os cabeçalhos de solicitação e o corpo de uma solicitação REST e, em seguida, enviar a solicitação REST para a instância atual.
Quando você tiver testado a solicitação, o botão Criar etapa de teste automatizado será exibido. Clique em Criar etapa de teste automatizado para criar a etapa de teste. Este botão não aparece até que a solicitação tenha sido enviada. Você não pode criar uma etapa de teste quando a carga da solicitação é maior do que a propriedade de tamanho máximo da carga da solicitação.

Esta etapa de teste cria o mesmo registro de teste que a etapa de teste Enviar solicitação REST - de entrada. Depois que a etapa de teste é criada, você não pode voltar e usar o Explorador de REST API para atualizar o teste. Todas as mudanças devem ser feitas no formulário Enviar solicitação REST - Etapa de teste de entrada.

Nenhuma validação de resposta HTTP é realizada como parte desta etapa. A etapa falhará se o tamanho da carga de resposta for muito grande, se os parâmetros da solicitação forem inválidos ou se a solicitação não puder ser enviada. Use as etapas de declaração para validar a resposta.

Você não pode usar essa etapa para enviar uma solicitação para outra instância ou terceiros/endereço remoto.

Essas entradas são para o Explorador de REST API. Os campos exibidos dependem da API selecionada. Para obter mais informações sobre como usar REST APIs em sua instância, consulte [REST APIs](https://www.servicenow.com/docs/access?context=c_RESTAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US).
{#atf-send-rest-inbound-explorer__table_bdv_bn1_xy__entry__2}{#atf-send-rest-inbound-explorer__namespace}{#atf-send-rest-inbound-explorer__api-name}{#atf-send-rest-inbound-explorer__api-version}{#atf-send-rest-inbound-explorer__api-path-parameters}{#atf-send-rest-inbound-explorer__api-query-parameters}{#atf-send-rest-inbound-explorer__api-request-headers}{#atf-send-rest-inbound-explorer__api-request-body}

| Campo | Descrição |
|-|-|
| Namespace | Namespace da solicitação. Selecione na lista. |
| Nome da API | API a ser usada. Selecione na lista. |
| Versão da API | Versão da API a ser usada. Selecione a versão disponível em sua instância na lista. |
| Parâmetros de caminho | A parte do caminho após o nome da API. Os parâmetros de caminho geralmente são pares de nome-valor em que os valores permitidos estão em uma lista. |
| Parâmetros de consulta | Pares de nome-valor de parâmetros de consulta adicionados ao URI após o caminho. O Explorador de REST API codifica o URI, portanto, não é necessário codificar parâmetros e valores de consulta. |
| Cabeçalhos da solicitação | Pares de nome-valor contidos no cabeçalho da solicitação. O cabeçalho de autenticação está definido como Enviar como eu para usar as credenciais do usuário atual. Para usar a etapa de teste na produção, talvez seja necessário alterar o campo Tipo de autenticação na etapa de teste Enviar REST - de entrada. Não codifique o nome ou o valor. |
| Corpo da Solicitação | O conteúdo da solicitação. Algumas solicitações não têm um corpo. |
[Tabela 1. Entradas]

{#atf-send-rest-inbound-explorer__table_bdv_bn1_xy}

## Enviar solicitação REST -- de entrada {#ariaid-title3}

Crie uma etapa de teste para enviar uma solicitação REST para a instância atual. Especifique o método HTTP, o caminho, os parâmetros de consulta, os cabeçalhos de solicitação e o corpo de uma solicitação REST.
Nenhuma validação de resposta HTTP é realizada como parte desta etapa. A etapa falhará se o tamanho da carga de resposta for muito grande, se os parâmetros da solicitação forem inválidos ou se a solicitação não puder ser enviada. Use as etapas de declaração para validar a resposta.

Você não pode usar essa etapa para enviar uma solicitação para outra instância ou terceiros/endereço remoto.

Para obter mais informações sobre como usar REST APIs, consulte [REST APIs](https://www.servicenow.com/docs/access?context=c_RESTAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US).
{#atf-send-rest-request-inbound__table_gny_jkd_yy__entry__2}{#atf-send-rest-request-inbound__atf-exec-order}{#atf-send-rest-request-inbound__atf-active}{#atf-send-rest-request-inbound__atf-application-scope}{#atf-send-rest-request-inbound__atf-test}{#atf-send-rest-request-inbound__atf-step-config}{#atf-send-rest-request-inbound__atf-description}{#atf-send-rest-request-inbound__atf-notes}{#atf-send-rest-request-inbound__basic-authentication}{#atf-send-rest-request-inbound__atf-method-send}{#atf-send-rest-request-inbound__atf-path-send}{#atf-send-rest-request-inbound__atf-query-parameters-send}{#atf-send-rest-request-inbound__atf-headers-send}{#atf-send-rest-request-inbound__atf-body-send}

| Campo | Descrição |
|-|-|
| Ordem de execução | Número inteiro que especifica a ordem na qual o teste executa esta etapa. Conforme você cria etapas, o sistema atribui automaticamente a cada etapa um valor incremental. Este valor faz com que o teste execute as etapas na ordem em que você as criou. Você pode mudar essa ordem padrão editando os valores da Ordem de execução. |
| Ativo | Opção para ativar esta etapa de teste para uso. |
| Aplicação | Escopo da aplicação no qual o sistema executa esta etapa. |
| Teste | Nome somente leitura do teste ao qual você está adicionando a etapa. |
| Configuração da etapa | Nome somente leitura da etapa. |
| Descrição | Descrição da etapa de teste. Este valor de campo é definido automaticamente com base nos valores de campo da etapa de teste. Este campo aparece depois que a etapa de teste é enviada. |
| Anotações | Anotações sobre a etapa de teste. |
| Tipo de autenticação | O tipo de autenticação a ser usado. Para APIs públicas, selecione Nenhum. Para configurar a autenticação básica ou mútua, os usuários precisam da função atf_ws_designer. Para obter mais informações, consulte [Funções Automated Test Framework](https://servicenow-prod.fluidtopics.net/yX_9SboHS6Oib18lleA5FQ "Automated Test Framework está instalado com essas funções."). |
| Autenticação básica | O perfil de autenticação básica a ser usado ao fazer o teste. Você deve criar ou selecionar um perfil de autenticação básica para atribuir às etapas de teste para evitar problemas de autenticação ao executar o teste. Para obter mais informações, consulte [Criar um perfil de autenticação básico usando o Automated Test Framework](https://servicenow-prod.fluidtopics.net/U2hshE3gRiT1GJ74NmQ~Wg "Crie perfis de autenticação básicos para especificar credenciais de autenticação básica para as etapas de teste Enviar solicitação - de entrada.").{#atf-send-rest-request-inbound__create_test_user_profile} |
| Autenticação mútua | Um certificado X.509 para autenticação mútua. Você deve criar ou selecionar um certificado de cliente para atribuir às etapas de teste para evitar problemas de autenticação ao executar o teste. Para obter mais informações, consulte [Set up Certificate-based authentication](https://www.servicenow.com/docs/access?context=set-up-mutual-auth&version=xanadu&pubname=xanadu-platform-security&ft:locale=en-US). |
| Método | O método HTTP a ser usado: * GET * POST * PUT * DELETE * PATCH |
| Caminho | O caminho a ser usado. Este campo aceita somente a parte do URI após o nome da instância. Se você usar https://\<instance name\> , você obtém um erro. |
| Parâmetros de consulta | Nomes e valores de parâmetro de consulta. Não codifique os nomes ou valores de parâmetro. |
| Cabeçalhos | Nomes e valores de cabeçalho. Não codifique os nomes ou valores do cabeçalho. |
| Corpo | O corpo da solicitação. |
[Tabela 2. Entradas]

{#atf-send-rest-request-inbound__table_gny_jkd_yy}

## Declarar Código de Status {#ariaid-title4}

Declare que o código de status de resposta HTTP tem o relacionamento especificado com o valor especificado. Você especifica um valor numérico do código de status e do relacionamento.
As etapas de declaração devem seguir imediatamente uma etapa Enviar solicitação REST - de entrada. Você pode ter várias etapas de declaração REST após uma etapa Enviar solicitação REST - Entrada, mas as etapas de declaração não podem ser separadas da etapa Enviar solicitação REST - Entrada por etapas de outras categorias de teste.
{#atf-assert-status-code__table_bgl_2b2_yy__entry__2}{#atf-assert-status-code__atf-exec-order}{#atf-assert-status-code__atf-active}{#atf-assert-status-code__atf-application-scope}{#atf-assert-status-code__atf-test}{#atf-assert-status-code__atf-step-config}{#atf-assert-status-code__atf-description}{#atf-assert-status-code__atf-notes}{#atf-assert-status-code__atf-operation}{#atf-assert-status-code__atf-status-code}

| Campo | Descrição |
|-|-|
| Ordem de execução | Número inteiro que especifica a ordem na qual o teste executa esta etapa. Conforme você cria etapas, o sistema atribui automaticamente a cada etapa um valor incremental. Este valor faz com que o teste execute as etapas na ordem em que você as criou. Você pode mudar essa ordem padrão editando os valores da Ordem de execução. |
| Ativo | Opção para ativar esta etapa de teste para uso. |
| Aplicação | Escopo da aplicação no qual o sistema executa esta etapa. |
| Teste | Nome somente leitura do teste ao qual você está adicionando a etapa. |
| Configuração da etapa | Nome somente leitura da etapa. |
| Descrição | Descrição da etapa de teste. Este valor de campo é definido automaticamente com base nos valores de campo da etapa de teste. Este campo aparece depois que a etapa de teste é enviada. |
| Anotações | Anotações sobre a etapa de teste. |
| Operação | Comparação a ser realizada entre os valores: * é * não é * menor que * maior que * menor que ou é * maior que ou é |
| Código de status | Código de status a ser testado em relação ao código de resposta. |
[Tabela 3. Entradas]

{#atf-assert-status-code__table_bgl_2b2_yy}

## Declarar Nome do Código de Status {#ariaid-title5}

Declare que o nome do código de status de resposta HTTP tem o relacionamento especificado com o valor especificado. Você especifica um valor do nome do código de status e o relacionamento.
As etapas de declaração devem seguir imediatamente uma etapa Enviar solicitação REST - de entrada. Você pode ter várias etapas de declaração REST após uma etapa Enviar solicitação REST - Entrada, mas as etapas de declaração não podem ser separadas da etapa Enviar solicitação REST - Entrada por etapas de outras categorias de teste.
{#atf-assert-status-code-name__atf-assert-status-code-name-table__entry__2}{#atf-assert-status-code-name__atf-exec-order}{#atf-assert-status-code-name__atf-active}{#atf-assert-status-code-name__atf-application-scope}{#atf-assert-status-code-name__atf-test}{#atf-assert-status-code-name__atf-step-config}{#atf-assert-status-code-name__atf-description}{#atf-assert-status-code-name__atf-notes}{#atf-assert-status-code-name__atf-operation-status-code-name}{#atf-assert-status-code-name__atf-status-code-name}

| Campo | Descrição |
|-|-|
| Ordem de execução | Número inteiro que especifica a ordem na qual o teste executa esta etapa. Conforme você cria etapas, o sistema atribui automaticamente a cada etapa um valor incremental. Este valor faz com que o teste execute as etapas na ordem em que você as criou. Você pode mudar essa ordem padrão editando os valores da Ordem de execução. |
| Ativo | Opção para ativar esta etapa de teste para uso. |
| Aplicação | Escopo da aplicação no qual o sistema executa esta etapa. |
| Teste | Nome somente leitura do teste ao qual você está adicionando a etapa. |
| Configuração da etapa | Nome somente leitura da etapa. |
| Descrição | Descrição da etapa de teste. Este valor de campo é definido automaticamente com base nos valores de campo da etapa de teste. Este campo aparece depois que a etapa de teste é enviada. |
| Anotações | Anotações sobre a etapa de teste. |
| Operação | Comparação a ser realizada entre os valores: * contém * não contém * é * não é |
| Nome do código de status | Nome do código de status a ser testado. |
[Tabela 4. Entradas]

{#atf-assert-status-code-name__atf-assert-status-code-name-table}

## Declarar tempo de resposta {#ariaid-title6}

Declare que o tempo de resposta HTTP tem o relacionamento especificado com o valor especificado. Você especifica um valor do tempo de resposta e do relacionamento.
As etapas de declaração devem seguir imediatamente uma etapa Enviar solicitação REST - de entrada. Você pode ter várias etapas de declaração REST após uma etapa Enviar solicitação REST - Entrada, mas as etapas de declaração não podem ser separadas da etapa Enviar solicitação REST - Entrada por etapas de outras categorias de teste.
{#atf-assert-response-time__atf-assert-response-time-table__entry__2}{#atf-assert-response-time__atf-exec-order}{#atf-assert-response-time__atf-active}{#atf-assert-response-time__atf-application-scope}{#atf-assert-response-time__atf-test}{#atf-assert-response-time__atf-step-config}{#atf-assert-response-time__atf-description}{#atf-assert-response-time__atf-notes}{#atf-assert-response-time__atf-operation-response-time}{#atf-assert-response-time__atf-response-time}

| Campo | Descrição |
|-|-|
| Ordem de execução | Número inteiro que especifica a ordem na qual o teste executa esta etapa. Conforme você cria etapas, o sistema atribui automaticamente a cada etapa um valor incremental. Este valor faz com que o teste execute as etapas na ordem em que você as criou. Você pode mudar essa ordem padrão editando os valores da Ordem de execução. |
| Ativo | Opção para ativar esta etapa de teste para uso. |
| Aplicação | Escopo da aplicação no qual o sistema executa esta etapa. |
| Teste | Nome somente leitura do teste ao qual você está adicionando a etapa. |
| Configuração da etapa | Nome somente leitura da etapa. |
| Descrição | Descrição da etapa de teste. Este valor de campo é definido automaticamente com base nos valores de campo da etapa de teste. Este campo aparece depois que a etapa de teste é enviada. |
| Anotações | Anotações sobre a etapa de teste. |
| Operação | Comparação a ser realizada entre o tempo de resposta inserido e o tempo de resposta real: * menor que * maior que |
| Tempo de resposta (ms) | Tempo em milissegundos a ser comparado ao tempo de resposta real. |
[Tabela 5. Entradas]

{#atf-assert-response-time__atf-assert-response-time-table}

## Declarar Cabeçalho de Resposta {#ariaid-title7}

Declare que o cabeçalho de resposta HTTP existe ou o cabeçalho tem o relacionamento especificado com o valor especificado.
As etapas de declaração devem seguir imediatamente uma etapa Enviar solicitação REST - de entrada. Você pode ter várias etapas de declaração REST após uma etapa Enviar solicitação REST - Entrada, mas as etapas de declaração não podem ser separadas da etapa Enviar solicitação REST - Entrada por etapas de outras categorias de teste.
{#atf-assert-response-header__atf-assert-response-header-table__entry__2}{#atf-assert-response-header__atf-exec-order}{#atf-assert-response-header__atf-active}{#atf-assert-response-header__atf-application-scope}{#atf-assert-response-header__atf-test}{#atf-assert-response-header__atf-step-config}{#atf-assert-response-header__atf-description}{#atf-assert-response-header__atf-notes}{#atf-assert-response-header__atf-header}{#atf-assert-response-header__atf-operation-assert-header}{#atf-assert-response-header__atf-value}

| Campo | Descrição |
|-|-|
| Ordem de execução | Número inteiro que especifica a ordem na qual o teste executa esta etapa. Conforme você cria etapas, o sistema atribui automaticamente a cada etapa um valor incremental. Este valor faz com que o teste execute as etapas na ordem em que você as criou. Você pode mudar essa ordem padrão editando os valores da Ordem de execução. |
| Ativo | Opção para ativar esta etapa de teste para uso. |
| Aplicação | Escopo da aplicação no qual o sistema executa esta etapa. |
| Teste | Nome somente leitura do teste ao qual você está adicionando a etapa. |
| Configuração da etapa | Nome somente leitura da etapa. |
| Descrição | Descrição da etapa de teste. Este valor de campo é definido automaticamente com base nos valores de campo da etapa de teste. Este campo aparece depois que a etapa de teste é enviada. |
| Anotações | Anotações sobre a etapa de teste. |
| Cabeçalho | Nome do cabeçalho. |
| Operação | Comparação a ser realizada entre os valores: * contém * não contém * é * não é * não está vazio |
| Valor | Valor do elemento a ser usado no teste. Não mostrado se a Operaçãonão estiver vazio. |
[Tabela 6. Entradas]

{#atf-assert-response-header__atf-assert-response-header-table}

## Declarar que a Carga JSON de Resposta é Válida {#ariaid-title8}

Declare que a carga de resposta está no formato JSON válido.
As etapas de declaração devem seguir imediatamente uma etapa Enviar solicitação REST - de entrada. Você pode ter várias etapas de declaração REST após uma etapa Enviar solicitação REST - Entrada, mas as etapas de declaração não podem ser separadas da etapa Enviar solicitação REST - Entrada por etapas de outras categorias de teste.
{#atf-assert-json-payload-valid__table_mcf_sxq_qfb__entry__2}{#atf-assert-json-payload-valid__atf-exec-order}{#atf-assert-json-payload-valid__atf-active}{#atf-assert-json-payload-valid__atf-application-scope}{#atf-assert-json-payload-valid__atf-test}{#atf-assert-json-payload-valid__atf-step-config}{#atf-assert-json-payload-valid__atf-description}{#atf-assert-json-payload-valid__atf-notes}

| Campo | Descrição |
|-|-|
| Ordem de execução | Número inteiro que especifica a ordem na qual o teste executa esta etapa. Conforme você cria etapas, o sistema atribui automaticamente a cada etapa um valor incremental. Este valor faz com que o teste execute as etapas na ordem em que você as criou. Você pode mudar essa ordem padrão editando os valores da Ordem de execução. |
| Ativo | Opção para ativar esta etapa de teste para uso. |
| Aplicação | Escopo da aplicação no qual o sistema executa esta etapa. |
| Teste | Nome somente leitura do teste ao qual você está adicionando a etapa. |
| Configuração da etapa | Nome somente leitura da etapa. |
| Descrição | Descrição da etapa de teste. Este valor de campo é definido automaticamente com base nos valores de campo da etapa de teste. Este campo aparece depois que a etapa de teste é enviada. |
| Anotações | Anotações sobre a etapa de teste. |
[Tabela 7. Entradas]

{#atf-assert-json-payload-valid__table_mcf_sxq_qfb}

## Declarar que a carga XML de resposta é válida {#ariaid-title9}

Declare que a carga de resposta é XML bem formado.
As etapas de declaração devem seguir imediatamente uma etapa Enviar solicitação REST - de entrada. Você pode ter várias etapas de declaração REST após uma etapa Enviar solicitação REST - Entrada, mas as etapas de declaração não podem ser separadas da etapa Enviar solicitação REST - Entrada por etapas de outras categorias de teste.
{#atf-assert-xml-payload-well-formed__table_kg2_hyq_qfb__entry__2}{#atf-assert-xml-payload-well-formed__atf-exec-order}{#atf-assert-xml-payload-well-formed__atf-active}{#atf-assert-xml-payload-well-formed__atf-application-scope}{#atf-assert-xml-payload-well-formed__atf-test}{#atf-assert-xml-payload-well-formed__atf-step-config}{#atf-assert-xml-payload-well-formed__atf-description}{#atf-assert-xml-payload-well-formed__atf-notes}

| Campo | Descrição |
|-|-|
| Ordem de execução | Número inteiro que especifica a ordem na qual o teste executa esta etapa. Conforme você cria etapas, o sistema atribui automaticamente a cada etapa um valor incremental. Este valor faz com que o teste execute as etapas na ordem em que você as criou. Você pode mudar essa ordem padrão editando os valores da Ordem de execução. |
| Ativo | Opção para ativar esta etapa de teste para uso. |
| Aplicação | Escopo da aplicação no qual o sistema executa esta etapa. |
| Teste | Nome somente leitura do teste ao qual você está adicionando a etapa. |
| Configuração da etapa | Nome somente leitura da etapa. |
| Descrição | Descrição da etapa de teste. Este valor de campo é definido automaticamente com base nos valores de campo da etapa de teste. Este campo aparece depois que a etapa de teste é enviada. |
| Anotações | Anotações sobre a etapa de teste. |
[Tabela 8. Entradas]

{#atf-assert-xml-payload-well-formed__table_kg2_hyq_qfb}

## Declarar elemento de carga XML {#ariaid-title10}

Declarar que o elemento de carga de resposta XML existe ou tem o relacionamento especificado com o valor especificado.
As etapas de declaração devem seguir imediatamente uma etapa Enviar solicitação REST - de entrada. Você pode ter várias etapas de declaração REST após uma etapa Enviar solicitação REST - Entrada, mas as etapas de declaração não podem ser separadas da etapa Enviar solicitação REST - Entrada por etapas de outras categorias de teste.
{#atf-assert-xml-payload-element__assert-xml-response-payload-element-table__entry__2}{#atf-assert-xml-payload-element__atf-exec-order}{#atf-assert-xml-payload-element__atf-active}{#atf-assert-xml-payload-element__atf-application-scope}{#atf-assert-xml-payload-element__atf-test}{#atf-assert-xml-payload-element__atf-step-config}{#atf-assert-xml-payload-element__atf-description}{#atf-assert-xml-payload-element__atf-notes}{#atf-assert-xml-payload-element__atf-element-path}{#atf-assert-xml-payload-element__atf-operation-assert-header}{#atf-assert-xml-payload-element__atf-value}

| Campo | Descrição |
|-|-|
| Ordem de execução | Número inteiro que especifica a ordem na qual o teste executa esta etapa. Conforme você cria etapas, o sistema atribui automaticamente a cada etapa um valor incremental. Este valor faz com que o teste execute as etapas na ordem em que você as criou. Você pode mudar essa ordem padrão editando os valores da Ordem de execução. |
| Ativo | Opção para ativar esta etapa de teste para uso. |
| Aplicação | Escopo da aplicação no qual o sistema executa esta etapa. |
| Teste | Nome somente leitura do teste ao qual você está adicionando a etapa. |
| Configuração da etapa | Nome somente leitura da etapa. |
| Descrição | Descrição da etapa de teste. Este valor de campo é definido automaticamente com base nos valores de campo da etapa de teste. Este campo aparece depois que a etapa de teste é enviada. |
| Anotações | Anotações sobre a etapa de teste. |
| Caminho de elemento | Caminho XML para o elemento a ser avaliado. Por exemplo, /result/short_description para { "result": { "number": "INC0020001", "short_description": "test" } } |
| Operação | Comparação a ser realizada entre os valores: * contém * não contém * é * não é * não está vazio |
| Valor | Valor do elemento a ser usado no teste. Não mostrado se a Operaçãonão estiver vazio. |
[Tabela 9. Entradas]

{#atf-assert-xml-payload-element__assert-xml-response-payload-element-table}

## Declarar Elemento de Carga de Resposta JSON {#ariaid-title11}

Declarar que o elemento de carga de resposta JSON existe ou tem o relacionamento especificado com o valor especificado.
As etapas de declaração devem seguir imediatamente uma etapa Enviar solicitação REST - de entrada. Você pode ter várias etapas de declaração REST após uma etapa Enviar solicitação REST - Entrada, mas as etapas de declaração não podem ser separadas da etapa Enviar solicitação REST - Entrada por etapas de outras categorias de teste.
{#atf-assert-json-payload-element__assert-json-response-payload-element-table__entry__2}{#atf-assert-json-payload-element__atf-exec-order}{#atf-assert-json-payload-element__atf-active}{#atf-assert-json-payload-element__atf-application-scope}{#atf-assert-json-payload-element__atf-test}{#atf-assert-json-payload-element__atf-step-config}{#atf-assert-json-payload-element__atf-description}{#atf-assert-json-payload-element__atf-notes}{#atf-assert-json-payload-element__atf-json-element-path}{#atf-assert-json-payload-element__atf-operation-assert-header}{#atf-assert-json-payload-element__atf-value}

| Campo | Descrição |
|-|-|
| Ordem de execução | Número inteiro que especifica a ordem na qual o teste executa esta etapa. Conforme você cria etapas, o sistema atribui automaticamente a cada etapa um valor incremental. Este valor faz com que o teste execute as etapas na ordem em que você as criou. Você pode mudar essa ordem padrão editando os valores da Ordem de execução. |
| Ativo | Opção para ativar esta etapa de teste para uso. |
| Aplicação | Escopo da aplicação no qual o sistema executa esta etapa. |
| Teste | Nome somente leitura do teste ao qual você está adicionando a etapa. |
| Configuração da etapa | Nome somente leitura da etapa. |
| Descrição | Descrição da etapa de teste. Este valor de campo é definido automaticamente com base nos valores de campo da etapa de teste. Este campo aparece depois que a etapa de teste é enviada. |
| Anotações | Anotações sobre a etapa de teste. |
| Caminho de elemento | Caminho SNC para o elemento a ser avaliado. Por exemplo, /result/short_description para { "result": { "number": "INC0020001", "short_description": "test" } } Consulte [Importação de arquivos JSON](https://www.servicenow.com/docs/access?context=json-data-source-examples&version=xanadu&pubname=xanadu-integrate-applications&ft:locale=en-US) para obter mais informações. |
| Operação | Comparação a ser realizada entre os valores: * contém * não contém * é * não é * não está vazio |
| Valor | Valor do elemento a ser usado no teste. Não mostrado se a Operaçãonão estiver vazio. |
[Tabela 10. Entradas]

{#atf-assert-json-payload-element__assert-json-response-payload-element-table}

## Declarar Carga de Resposta {#ariaid-title12}

Declarar que a carga de resposta HTTP tem o relacionamento especificado com o valor especificado. Você especifica o valor e o relacionamento.
As etapas de declaração devem seguir imediatamente uma etapa Enviar solicitação REST - de entrada. Você pode ter várias etapas de declaração REST após uma etapa Enviar solicitação REST - Entrada, mas as etapas de declaração não podem ser separadas da etapa Enviar solicitação REST - Entrada por etapas de outras categorias de teste.  
Nota:  
A carga inteira é usada para procurar uma correspondência. Uma carga grande pode afetar o desempenho. {#atf-assert-response-payload__assert-response-payload-table__entry__2}{#atf-assert-response-payload__atf-exec-order}{#atf-assert-response-payload__atf-active}{#atf-assert-response-payload__atf-application-scope}{#atf-assert-response-payload__atf-test}{#atf-assert-response-payload__atf-step-config}{#atf-assert-response-payload__atf-description}{#atf-assert-response-payload__atf-notes}{#atf-assert-response-payload__atf-operation-assert-header}{#atf-assert-response-payload__atf-response-body}

| Campo | Descrição |
|-|-|
| Ordem de execução | Número inteiro que especifica a ordem na qual o teste executa esta etapa. Conforme você cria etapas, o sistema atribui automaticamente a cada etapa um valor incremental. Este valor faz com que o teste execute as etapas na ordem em que você as criou. Você pode mudar essa ordem padrão editando os valores da Ordem de execução. |
| Ativo | Opção para ativar esta etapa de teste para uso. |
| Aplicação | Escopo da aplicação no qual o sistema executa esta etapa. |
| Teste | Nome somente leitura do teste ao qual você está adicionando a etapa. |
| Configuração da etapa | Nome somente leitura da etapa. |
| Descrição | Descrição da etapa de teste. Este valor de campo é definido automaticamente com base nos valores de campo da etapa de teste. Este campo aparece depois que a etapa de teste é enviada. |
| Anotações | Anotações sobre a etapa de teste. |
| Operação | Comparação a ser realizada entre os valores: * contém * não contém * é * não é * não está vazio |
| Corpo da resposta | O valor do corpo da resposta a ser usado no teste. Deve conter o nome e o valor a serem comparados conforme aparecem na carga de resposta. Não deve conter chaves. Não mostrado se a Operaçãonão estiver vazio. |
[Tabela 11. Entradas]

{#atf-assert-response-payload__assert-response-payload-table}  
Para verificar a descrição resumida na carga de resposta

    {"result":{"number":"INC0010040","short_description":"Test ATF Incident"}}

o corpo da resposta deve conter

    "short_description":"Test ATF Incident"

Esses formatos estão incorretos e a etapa falha.

* `{"short_description":"Testar incidente de ATF"}`
* `"{"short_description":"Testar incidente de ATF"}"`
* `short_description: testar incidente de ATF`
* `short_description:"Testar incidente de ATF"`
{#atf-assert-response-payload__ul_j1g_cjv_lz}