AvaliaçãoCriação - Global

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 4 min. de leitura
  • . AvaliaçãoCriação A API fornece métodos que os administradores podem usar para gerar avaliações e pesquisas.

    Há várias maneiras de chamar o. CreateAssessments() método. Você deve definir typeIDparâmetro em todos os casos para identificar um tipo de métrica ou definição de pesquisa.

    Alguns dos fatores que influenciam o comportamento do método incluem:
    • Se o destino é uma avaliação ou pesquisa
    • Se o tipo de programação de avaliação é Sob demanda ou Programado
    • Períodos de programação de pesquisa
    • Parâmetros fornecidos

    Por exemplo, quando o método é chamado somente com typeIDconjunto de parâmetros, o método pesquisa partes interessadas ou usuários de pesquisa para enviar convites. Em contraste, quando o método é chamado com typeIDe. userIDconjunto de parâmetros, ele tenta enviar convites para os usuários especificados.

    AssessmentCreation - createAssessments (cadeia de caracteres TypeID, cadeia de caracteres sourceRecordID, cadeia de caracteres UserId)

    Cria uma ou mais avaliações ou pesquisas para o tipo de métrica especificado ou definição de pesquisa.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    TypeID Cadeia de caracteres O sys_id do tipo de métrica ou definição de pesquisa para a qual serão geradas avaliações ou pesquisas.
    SourceRecordID Cadeia de caracteres Uma ou mais sys_ids de definição de pesquisa separada por vírgulas para incluir nas avaliações geradas. Deve haver um registro avaliável associado ao tipo de métrica especificado para cada registro de origem. Se este parâmetro for deixado em branco, as avaliações geradas incluirão todos os registros avaliáveis para o tipo especificado. Este parâmetro deve ser usado somente com avaliações.
    userID Cadeia de caracteres Um ou mais sys_ids separados por vírgulas de usuários para os quais enviar instâncias de avaliação ou pesquisa. Se este parâmetro for deixado em branco, as partes interessadas da avaliação ou os usuários da pesquisa receberão instâncias. Este parâmetro é necessário para avaliações sob demanda.
    Tabela 2. Retornos
    Tipo Descrição
    Cadeia de caracteres Se o método for bem-sucedido, ele retornará uma cadeia de caracteres separada por vírgulas, como 7a2ad2253784200044e0bfc8bcbe5de1, 10, b7e8b5b5d4c0a80169008b49e468920048 (ID da instância, Número de instâncias, ID do grupo) com os seguintes valores:
    • Sys_id da instância de avaliação ou pesquisa criada, se houver apenas uma. Sys_id de uma das instâncias, se houver várias. Se houver várias instâncias, use o ID do grupo para recuperar dados.
    • Número de instâncias de avaliação ou pesquisa criadas.
    • GroupID: Sys_id do grupo de avaliação que contém as instâncias de avaliação ou pesquisa criadas.

    Se o método não puder gerar avaliações ou pesquisas, ele retornará um dos códigos de erro.

    Códigos de Erros
    • Isscheduled - Indica que userIDou sourceRecordIDo parâmetro não deve ter sido usado. . typeIDO valor representa um tipo de métrica com o campo Tipo de programação definido como Programado, typeIDparâmetro é o único parâmetro que pode ser usado.
    • Draft_state - Indica que typeIDo valor é um tipo de métrica ou definição de pesquisa que não foi publicado. Publique o tipo de métrica ou a definição de pesquisa.
    • Invalidtype - Indica que não há nenhum tipo de métrica existente que corresponda a. typeIDvalor.
    • Inativo - Indica que typeIDo valor é um tipo de métrica ou definição de pesquisa que não está ativo. Navegue até o tipo de métrica ou a definição de pesquisa e selecione Ativo caixa de seleção.
    • Not_available - Indica que typeIDo valor é um tipo de métrica ou definição de pesquisa que não tem métricas ou perguntas de pesquisa. Adicione pelo menos uma métrica ou pergunta de pesquisa.
    • Notyet - Indica que pelo menos um dos usuários no userIDuma instância de pesquisa é atribuída a uma instância de pesquisa para a definição de pesquisa especificada, que ainda não expirará. O código de erro retorna a data de expiração.
    • wip - Indica que pelo menos um dos usuários no userIDo valor já foi atribuído a uma instância de pesquisa para a pesquisa.
    • Not_authorized - Indica que pelo menos um dos usuários em userIDo valor não está autorizado a responder à pesquisa. Verifique se uma das seguintes opções é verdadeira:
      • Não há usuários de pesquisa para a definição de pesquisa especificada.
      • Todos os usuários no UserId os valores são salvos como usuários de pesquisa para a definição de pesquisa especificada.
    • Concluído - Indica que typeIDO valor é uma definição de pesquisa com o campo Período de programação definido como apenas uma vez e que pelo menos um dos usuários no userIDo valor já concluiu uma instância de pesquisa para essa definição de pesquisa.
    • Nosers - Indica que userIDo parâmetro não foi usado e uma das seguintes opções é verdadeira:
      • Não há partes interessadas associadas ao tipo de métrica especificado. Defina userIDou crie pelo menos uma parte interessada.
      • Não há usuários de pesquisa associados à definição de pesquisa especificada. Defina userIDou crie pelo menos um usuário de pesquisa.
    • Nosources - Indica que typeIDO valor é um tipo de métrica com o campo Tipo de programação definido como Sob demanda e que nem é userIDnor sourceRecordIDo parâmetro foi usado. Defina pelo menos um desses parâmetros.

    Este exemplo de código mostra como gerar uma instância de avaliação em um widget do portal de serviços. Este exemplo não funcionará se o Tipo de programação estiver definido como Sob demanda.

    (function() {
      var gdtSurvey = new GlideDateTime();
      if (gdtSurvey.getDayOfMonthUTC() == 23) {
        (new SNC.AssessmentCreation()).createAssessments('d902e09a075730101263f19d7c1ed03a', // Assessment metric type sys_id
          '4baec2fe07d3f0101263f19d7c1ed0a6', // Assessable record which is the source of the assessment
          gs.getUserID()); // Users ID to send the assessment instances to
      }
    })();

    Resultados de retorno:

    bbf0b9b8072330101263f19d7c1ed00b,1,33f0f978072330101263f19d7c1ed05f