PT
Español
English
Português
    Obtenha Tokens de Pesquisa

    Esse endpoint retorna a lista de pesquisas (e seus tokens) associadas a um caso específico. O token obtido é então usado para consultar as respostas de cada pesquisa pelo endpoint Receba respostas de pesquisas.

    Detalhes da petição

    • URL base: {host}/ASMSAPI/
    • Uri: /api/v9/item/{itemId}/{itemType}/surveys/answered
    • Tipo: GET
    • Títulos obrigatórios:

    • tipo de conteúdo: application/json
    • Autorização X: Portador {token}

    Descrição do URL

    • {host}: Ele representa o domínio do ambiente no qual a API está localizada.
    • ASMSAPI/: Prefixo de API fixo.
    • URI: Ponto de extremidade específico para a solicitação.


    ⚐ URL DE EXEMPLO:

    https://{host}/ASMSAPI/api/v9/item/{itemId}/{itemType}/surveys/answered
    


    Parâmetros

    Nome Tipo de dado Obrigatório Descrição
    ID do item Número Sim Identificador do caso sobre o qual as pesquisas são consultadas
    tipo de item Número Sim Identificador de Tipo de Caso – Incidente = 1 - Problema = 2 - Mudança = 3 - Requisito de serviço = 4 - Lançamento = 13

    Corpo da petição

    N/A

    Exemplos de uri

    • API/v9/item/10920/4/pesquisas/respondido

    Responder

    {
    
          "count": 2,
    
          "list": [
    
                {
    
                      "description": "Encuestas RQ",
    
                      "id": 3,
    
                      "name": "Encuestas RQ",
    
                      "title": "Encuestas RQ",
    
                      "token": "1077a718-fb20-463e-94d4-8581362269c9"
    
                },
    
                {
    
                      "description": "Encuestas RQ 2",
    
                      "id": 17,
    
                      "name": "Encuestas RQ 2",
    
                      "title": "Encuestas RQ 2",
    
                      "token": "b0f298f8-0766-40c0-b147-cfcef8cfb65e"
    
                }
    
          ],
    
          "result": true
    
    }
    

    ⚐ Nota: Se o caso não tiver levantamentos associados (ou o itemId não existe), a resposta é 200 OK com {"count":0,"list":null,"result":false}.

    Parâmetros de resposta

    Nome Tipo de dado Descrição
    contar Número Número de pesquisas associadas ao caso
    Lista Lista Lista de pesquisas associadas ao caso. É null quando não há pesquisas associadas
    Id Número ID da pesquisa
    Nome Texto Nome da pesquisa
    Descrição Texto Descrição da pesquisa
    título Texto Título da Pesquisa
    Símbolo Texto Token único da pesquisa; usado para consultar suas respostas usando Receba respostas de pesquisas
    resultado Booleano Indica se pesquisas associadas ao caso foram encontradas

    Mensagens de erro

    Código Status HTTP Mensagem de erro
    400 Solicitação BadRequest FailureHasSurvey - \r\nNome do parâmetro: itemType