API de compromisso proativo

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

    • . Compromisso proativo A API fornece um endpoint para criar problemas de experiência digital.

    Esta API está disponível como REST API de script personalizado. Ele requer o plug-in Proactive Engagement (proactive-engagement) e a função sn_prn.experience_issue_create. Esta API pertence ao sn_prn namespace.

    Use Compromisso proativo API para criar um problema de experiência quando um problema é detectado na instância de um usuário. O problema de experiência criada gera o engajamento com o usuário e o ajuda a resolver o problema automaticamente.

    Para usar esta API, certifique-se de que as seguintes tabelas estejam preenchidas com registros:

    • Modelo de registro de problemas [sn_pren_issue_registry_template]
    • Registro de problemas [sn_pren_issue_registry]
    • Resolução [sn_pren_resolution]
    • Conteúdo da notificação [sn_pren_notification_content]
    • Provedor [sn_pren_provider]

    Para obter mais informações, consulte Proactive Engagement.

    Compromisso proativo - CRIAR /api/sn_pren/self_remediation/experience_issue/create

    Cria um problema de experiência quando um problema é detectado no endpoint do usuário. Atualiza a tabela Problemas de experiência [sn_pren_experience_issue].

    Formato de URL

    URL padrão: /api/sn_pren/self_remediation/experience_issue/create

    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
    Nenhum(a)
    Tabela 3. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    endpoint Obrigatório. Item de configuração (IC) e informações do usuário usados para detectar detalhes do problema.
    Nota:
    Todos os parâmetros neste objeto são opcionais. Você deve passar pelo menos um parâmetro no objeto para identificar o usuário ou dispositivo."

    Tipo de dados: Objeto

    "endpoint": {
  "CI": "String",
  "email": "String",
  "user_id": "String",
  "user_name": "String"
}
    Endpoint.ci Sys_id do dispositivo de IC no qual o problema foi detectado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Computador [cmdb_ci_computer]
    endpoint.email Endereço de e-mail do usuário para quem o problema foi detectado.

    Tipo de dados: Cadeia de caracteres
    endpoint.user_id Sys_id do usuário para o qual o problema foi detectado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Usuário [sys_user]
    endpoint.user_name Nome de usuário do usuário para o qual o problema foi detectado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Usuário [sys_user]
    experience_id ID definido pelo usuário a ser atribuído ao problema criado.

    Tipo de dados: Número

    Padrão: Um ID é gerado automaticamente.
    input_parameters Parâmetros a serem passados para a ação que será executada no dispositivo. Os parâmetros de entrada enviados são passados para a ação corretiva de resolução configurada, como um subfluxo, ação de fluxo ou ação de IC.

    Tipo de dados: Objeto

    "input_parameters": {
  "process_id": "String"
}
    input_parameters.process_id Sys_id do processo a ser encerrado ou reiniciado.

    Tipo de dados: Cadeia de caracteres
    investigative_details Detalhes que podem ser úteis para uma investigação manual se a resolução da Eficácia do uso de energia (PUE) falhar. Os detalhes investigativos são copiados para o incidente, que é criado como um fallback quando a resolução de PUE falha.

    Tipo de dados: Objeto

    "investigative_details": {
  "cpu_usage": "String",
  "processes_running": "String",
  "available_memory": "String"
  }
    investigative_details.cpu_usage Uso da CPU no dispositivo.

    Tipo de dados: Número (analisado como cadeia de caracteres)
    investigative_details.processes_running Número de processos em execução no dispositivo.

    Tipo de dados: Número (analisado como cadeia de caracteres)
    investigative_details.available_memory Memória disponível no dispositivo.

    Tipo de dados: Número (analisado como cadeia de caracteres)
    issue_code Obrigatório. Código do problema a ser associado ao problema. O código do problema deve estar disponível e implantado na instância. A API retornará um erro se um problema vazio ou inválido for fornecido.

    Tipo de dados: Cadeia de caracteres

    Tabela: Registro de problemas [sn_pren_issue_registry]
    provedor Obrigatório. Código exclusivo do provedor. Este código deve corresponder a. provider_codecampo na tabela sn_pren_provider na instância.

    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 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
    Tipo de conteúdo Formato de dados do corpo da solicitação. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json

    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 .

    Código do status Descrição
    200 Um problema de experiência foi criado com sucesso.
    400 Solicitação inválida. Forneça detalhes do endpoint.

    Um vazio endpointo objeto foi enviado na solicitação.
    400 Código de problema inválido. Forneça um código de problema válido.

    Um vazio issue_codefoi enviado na solicitação.
    400 Provedor inválido, forneça um provedor válido.

    Um provedor vazio foi enviado na solicitação.
    400 Código de problema ou provedor inválido. Forneça detalhes válidos.

    O problema não pode ser detectado na instância. Verificar issue_codee. providerdetalhes.
    400 O código de problema não tem uma resolução apropriada.

    Uma resolução válida não está configurada na estrutura de PUE para o problema identificado.
    400 Não foi possível resolver o usuário a partir dos detalhes do endpoint. Forneça detalhes válidos.

    Este erro será retornado se o ID da estrutura de PUE não puder identificar o usuário a partir dos detalhes do endpoint fornecidos.
    400 Um problema de experiência está sendo resolvido com o código de problema fornecido para o usuário especificado.

    No momento, o problema de experiência especificado está em um estado em andamento ou em aberto.
    400 Problema de experiência existente com fornecido experience_idainda está em execução ou está encerrado.

    Este erro ocorre quando um problema de experiência está em um cenário de encadeamento. Por exemplo, se for um novo issue_codea chave é enviada com um existente experience_ide o problema de experiência anterior está em execução ou está no estado encerrado.

    O problema de experiência com este experience_id deve estar no estado action_wait para enviar um novo issue_code com o experience_id anterior.
    400 Ocorreu um erro ao criar o problema de experiência.

    Indica um erro técnico.

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

    Nome Descrição
    experienceId ID da experiência do problema de experiência criado. Gerado a partir de experience_idparâmetro da solicitação.

    . experience_idO parâmetro não foi passado, o ID resultante é sempre o sys_id do registro criado.

    Tabela: Problemas de experiência [sn_pren_experience_issue]

    Solicitação de curl

    O exemplo a seguir cria um problema de experiência para o usuário Abel Tuter. O código do problema no corpo permite que o Compromisso proativo identifique a resolução do modelo de registro de problemas e interaja com o usuário final por meio do Virtual Agent para ajudá-lo a resolver o problema automaticamente.

    curl  "http://instance.servicenow.com//api/sn_srf/self_remediation/experience_issue/create" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'
--data “{
  "endpoint": {
    "CI": "d049b28e936aa1106f98f6db5cba10d5",
    "user_id": "62826bf03710200044e0bfc8bcbe5df1",
    "user_name": "abel.tuter",
    "email": ""
  },
  "issue_code": "100",
  "provider": "sn",
  "experience_id": "09ed4830f393739df33",
  "input_parameters": {
    "process_id": "10644"
  },
  "investigative_details": {
    "cpu usage": "78%",
    "processes running": "35",
    "available memory": "23%"
  }
}”\

    O corpo da resposta retorna o ID da experiência, indicando que a criação do problema foi bem-sucedida.

    { 
  "result": { 
    "experience_id": “09ed4830f393739df33”
  } 
}