REST API do usuário de teste do executor na nuvem

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 12 min. de leitura

    • Gerencia trabalhos do usuário de teste a serem executados em um executor de nuvem para Automated Test Framework (ATF).

    . Usuário de teste do executor na nuvem A API requer ATF Test Generator and Cloud Runner plug-in (sn_atf_tg). Os métodos disponíveis com esta API são executados no agora Namespace e pode ser chamado usando o Nome da API, Teste de regressão com um clique para ATF , No Explorador DA REST API. A função de administrador é necessária para acessar esta API.

    Você pode usar esta API para as seguintes tarefas:
    • Inicie o trabalho de teste do usuário.
    • Defina o usuário da nuvem.
    • Verifique se o usuário especificado é válido.
    • Verifique o andamento do trabalho de teste do usuário.
    • Cancele o trabalho de teste.

    . Executor de teste do Cloud Runner A API pode ser usada em conjunto com REST API de geração de testes do Cloud Runner e. REST API do usuário de teste do executor na nuvem. Por exemplo, você pode gerar um teste (API de geração de testes do Cloud Runner) e obter o andamento do teste na fila de orquestração do navegador (API de geração de TESTES DO Cloud Runner) e verificar o número de testes aprovados ou reprovados.

    Para exibir a documentação de referência da API do Server desta API, consulte TestUserApi do executor na nuvem - escopo, global.

    Usuário de teste do Cloud Runner - OBTENHA /now/sn_atf_tg/test_user_progress

    Fornece o status do trabalho do usuário de teste para um registro BOQ (Fila de Orquestração do Navegador) fornecido.

    Formato de URL

    URL padrão: GET /api/now/sn_atf_tg/test_user_progress

    Parâmetros de solicitação compatíveis

    Tabela 1. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    SnboqId Obrigatório. Sys_id do registro BOQ do trabalho do usuário de teste para obter o andamento.

    Tipo de dados: Cadeia de caracteres

    Tabela: BOQ [sn_atf_tg_sn_boq]
    Tabela 3. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

    Tabela 4. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json
    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

    Tabela 6. Códigos de status
    Código do status Descrição
    200 Andamento do trabalho do usuário de teste recuperado com sucesso.
    400 Erro ao obter o status do registro BOQ. Retorna uma das seguintes mensagens:
    • Nenhum ID de BOQ passado - Nenhum ID de BOQ foi fornecido. Adicione o ID DO BOQ ao corpo da solicitação.
    • Registro BOQ - SYS ID inválido. Verifique se o sys_id do registro BOQ é válido e se o registro existe.
    403 Erro ao conceder acesso do usuário ao endpoint. Certifique-se de que o usuário tenha a função de administrador.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    resultado Objeto que contém os resultados de andamento do trabalho executor de testes ou uma mensagem explicando por que a solicitação falhou.
    "result": { 
    "progress": 100, 
    "state": "completed" 
  }

    Ou:

    "result": { 
    "message": "String"
}

    Tipo de dados: Objeto
    resultado.mensagem Mensagem de erro detalhando por que o andamento do executor de teste não pode ser recuperado. O parâmetro de mensagem não é retornado em uma resposta bem-sucedida.

    Tipo de dados: Cadeia de caracteres
    result.progress Percentual que indica o quão próximo um teste está da conclusão de um teste enquanto estiver em um estado em execução.

    Tipo de dados: Número
    result.state Status atual do registro BOQ.

    Valores possíveis:

    • Navegadores solicitados: Uma solicitação foi enviada para a infraestrutura de nuvem para iniciar os navegadores para geração de teste ou execução de teste.
    • Concluída: A tarefa de teste está concluída.
    • Estado com falha: Falha na tarefa de teste.
    • Pendente: A atividade de teste solicitada foi criada e aguardando para ser executada.
    • Processamento: A instância está verificando registros para garantir que os rastreadores de execução sejam marcados para executor de nuvem antes que a solicitação seja enviada para a infraestrutura de nuvem.
    • Em execução: Os navegadores de infraestrutura em nuvem encontram e executam testes pendentes.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    O exemplo de solicitação a seguir mostra como verificar o andamento de um trabalho do usuário de teste.

    curl "https://instance.service-now.com/api/now/sn_atf_tg/test_user_progress?snboqId=<sys_id of SNBOQ record>" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user "username:password"

    Corpo da resposta:

    { 
  "result": { 
    "progress": 100, 
    "state": "completed" 
  } 
}

    Usuário de teste do Cloud Runner - OBTENHA /now/sn_atf_tg/is_valid_cloud_user

    Verifica se um usuário fornecido é um usuário de nuvem válido.

    Este método verifica se o usuário passa pelos seguintes critérios:
    • Existe,
    • Ativo,
    • Não está bloqueado,
    • Precisa de uma redefinição de senha,
    • É um administrador,
    • Somente leitura,
    • Somente serviços da web

    Formato de URL

    URL padrão: GET /api/now/sn_atf_tg/is_valid_cloud_user

    Parâmetros de solicitação compatíveis

    Tabela 7. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 8. Parâmetros de consulta
    Nome Descrição
    nome do usuário Obrigatório. Nome de usuário do sys_user para verificar se o usuário passa pelos seguintes critérios de linha de base.
    • Existe,
    • Ativo,
    • Não está bloqueado,
    • Precisa de uma redefinição de senha,
    • É um administrador,
    • Somente leitura,
    • Somente serviços da web

    Se qualquer uma dessas condições falhar, a API retornará um booliano falso com uma mensagem sobre qual critério falhou.

    Tipo de dados: Cadeia de caracteres
    Tabela 9. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

    Tabela 10. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json
    Tabela 11. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

    Tabela 12. Códigos de status
    Código do status Descrição
    200 Retorna verdadeiro ou falso se o usuário for válido e atender aos critérios do usuário na nuvem.
    403 Erro ao conceder acesso do usuário ao endpoint. Certifique-se de que o usuário tenha a função de administrador.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    resultado Objeto que contém os resultados da solicitação.
    
  "result": { 
    "validUser": Boolean 
  }

    Tipo de dados: Objeto
    Result.validUser Sinalizador que indica se o usuário atende aos critérios do usuário na nuvem. Quando verdadeiro, o usuário atende aos critérios.

    Tipo de dados: Booliano

    Solicitação de curl

    A solicitação a seguir verifica se o sys_user fornecido atende aos critérios para usar a funcionalidade de nuvem.

    curl "http://instance.service-now.com/api/now/sn_atf_tg/is_valid_cloud_user?username=<username of sys_user to check>" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user "username:password"

    Corpo da resposta:

    { 
  "result": { 
    "validUser": <Boolean value indicating whether user is valid cloud user> 
  } 
}

    Usuário de teste do Cloud Runner - POST /now/sn_atf_tg/test_user

    Insere um trabalho do usuário de teste na tabela BOQ [sn_atf_tg_sn_boq] para um determinado nome de usuário, que é executado no executor da nuvem.

    Formato de URL

    URL padrão: PUBLICAÇÃO /api/now/sn_atf_tg/test_user

    Parâmetros de solicitação compatíveis

    Tabela 13. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 14. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 15. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    nome do usuário Obrigatório. Nome de usuário do sys_user para testar a infraestrutura de ponta a ponta do executor de nuvem.

    Tipo de dados: Cadeia de caracteres

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

    Tabela 16. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json
    Tipo de conteúdo Formato de dados do corpo da solicitação. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json
    Tabela 17. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

    Tabela 18. Códigos de status
    Código do status Descrição
    200 Trabalho BOQ do usuário de teste inserido com sucesso.
    400 Erro ao iniciar o trabalho do usuário de teste.

    Se um nome de usuário vazio for fornecido ou um usuário não puder ser encontrado na tabela sys_user, o servidor gerará um erro.
    403 Erro ao conceder acesso do usuário ao endpoint. Certifique-se de que o usuário tenha a função de administrador.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    resultado Objeto que contém os resultados da solicitação.
    
  "result": { 
    "snboqId": String
  }

    Ou:

    "result": { 
    "message": "String"
}

    Tipo de dados: Objeto
    resultado.mensagem Mensagem de erro detalhando por que o nome de usuário não pode ser atribuído aos recursos de teste. O parâmetro de mensagem não é retornado em uma resposta bem-sucedida.

    Tipo de dados: Cadeia de caracteres
    SnboqId Sys_id do registro BOQ que é inserido quando o trabalho do usuário de teste é iniciado com sucesso.

    Tipo de dados: Cadeia de caracteres

    Tabela: BOQ [sn_atf_tg_sn_boq]

    Solicitação de curl

    O exemplo de solicitação a seguir mostra como inserir um trabalho de usuário de teste na tabela BOQ [sn_atf_tg_sn_boq] para um determinado nome de usuário.

    curl "http://instance.service-now.com/api/now/sn_atf_tg/test_user" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{\"username\":\"<username of sys_user to test cloud infrastructure>\"}" \ 
--user "username:password"

    A resposta retorna um sys_id do registro BOQ que é inserido quando o trabalho do usuário de teste é iniciado.

    { 
  "result": { 
    "snboqId": "<sys_id of newly inserted BOQ record>" 
  } 
}

    O exemplo a seguir retorna uma mensagem de erro 400 quando nenhum nome de usuário ou um nome de usuário inválido é passado.

    curl "https://instance.service-now.com/api/now/sn_atf_tg/test_user" \
--request POST \
--header "Accept:application/json" \
--user "username:password"

    Resposta:

    {
  "result": {
    "message": "Unable to set cloud user as cloud user not valid"
  }
}

    Usuário de teste do Cloud Runner - POST /now/sn_atf_tg/cancel_test_user

    Define o status do trabalho do usuário de teste na tabela Fila de Orquestração do Navegador (BOQ) [sn_atf_tg_sn_boq] como concluído.

    Formato de URL

    URL padrão: PUBLICAÇÃO /api/now/sn_atf_tg/cancel_test_user

    Parâmetros de solicitação compatíveis

    Tabela 19. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 20. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 21. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    SnboqId Obrigatório. Sys_id do registro BOQ a ser cancelado associado ao trabalho do usuário de teste.

    Tipo de dados: Cadeia de caracteres

    Tabela: SNBOQ [sn_atf_tg_sn_boq]

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

    Tabela 22. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json
    Tipo de conteúdo Formato de dados do corpo da solicitação. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json
    Tabela 23. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

    Tabela 24. Códigos de status
    Código do status Descrição
    200 Trabalho BOQ cancelado com sucesso.
    400 Erro ao cancelar o trabalho. Retorna uma das seguintes mensagens:
    • Nenhum ID de BOQ passado - Nenhum ID de BOQ foi fornecido. Adicione o ID DO BOQ ao corpo da solicitação.
    • Registro BOQ - SYS ID inválido. Verifique se o sys_id do registro BOQ é válido e se o registro existe.
    403 Erro ao conceder acesso do usuário ao endpoint. Certifique-se de que o usuário tenha a função de administrador.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    resultado Objeto que contém os resultados da solicitação.
    
  "result": { 
    "message": String
  }

    Tipo de dados: Objeto
    resultado.mensagem Mensagem detalhando se o cancelamento do usuário de teste foi bem-sucedido.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    A solicitação a seguir demonstra como cancelar um trabalho do usuário de teste na tabela Fila de Orquestração do navegador [sn_atf_tg_sn_boq].

    curl "https://instance.service-now.com/api/now/sn_atf_tg/cancel_test_user" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{\"snboqId\":\"<sys_id of BOQ record>\"}" \ 
--user "username:password"

    Corpo da resposta bem-sucedida:

    { 
  "result": { 
    "message": "success" 
  } 
}

    Usuário de teste do Cloud Runner - POST /now/sn_atf_tg/select_cloud_user

    Inicia um trabalho do usuário de teste de ponta a ponta no executor da nuvem. Se o usuário puder fazer login com a função de administrador, a propriedade do usuário na nuvem será padronizada para este usuário para execuções de testes e gerações de testes futuras.

    Formato de URL

    URL padrão: PUBLICAÇÃO /api/now/sn_atf_tg/select_cloud_user

    Parâmetros de solicitação compatíveis

    Tabela 25. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 26. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 27. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    nome do usuário Obrigatório. Nome de usuário do sys_user para testar e definir o usuário da nuvem para futuros executores de testes e trabalhos de geração de testes.

    Tipo de dados: Cadeia de caracteres

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

    Tabela 28. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json
    Tipo de conteúdo Formato de dados do corpo da solicitação. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json
    Tabela 29. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

    Tabela 30. Códigos de status
    Código do status Descrição
    200 Testado com sucesso a infraestrutura completa do executor de nuvem e definiu o usuário de nuvem para futuros trabalhos de execução de teste e geração de testes.
    400 Erro ao testar a infraestrutura completa do executor de nuvem de ponta a ponta e definir o usuário de nuvem. Certifique-se de que o nome de usuário não esteja vazio ou que o usuário exista na tabela sys_user para um determinado nome de usuário.
    403 Erro ao conceder acesso do usuário ao endpoint. Certifique-se de que o usuário tenha a função de administrador.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    resultado Objeto que contém os resultados da solicitação.
    
  "result": { 
    "message": "String"
  }

    Tipo de dados: Objeto
    resultado.mensagem Mensagem detalhando se o usuário foi selecionado com sucesso para execuções de teste futuras e gerações de teste na infraestrutura do executor de nuvem.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    O exemplo a seguir mostra como solicitar que um usuário específico seja selecionado para execuções de teste futuras e gerações de teste na infraestrutura do executor de nuvem.

    curl "https://instance.service-now.com/api/now/sn_atf_tg/select_cloud_user" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{\"username\":\"<username of sys_user to set as cloud user>\"}" \ 
--user "username:password"

    O corpo da resposta retorna uma mensagem de sucesso indicando que o usuário da nuvem foi selecionado com sucesso para execuções de teste e gerações.

    { 
  "result": { 
    "message": "success" 
  } 
}