---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Evento - Global

# Evento - Global {#ariaid-title1}

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

A API de eventos fornece métodos que permitem a configuração e a obtenção de valores em um evento.

Esses eventos são enviados de uma instância MID Server para uma instância ServiceNow. Antes que você possa enviar eventos com sucesso, a conexão entre as instâncias MID Server e ServiceNow deve ser definida.

Use a API de eventos para adicionar/atualizar campos em um evento. Use a API SNEventSenderProvider para criar uma instância de um objeto de remetente de evento. Em seguida, use a API IEventSender para enviar o evento para uma instância ServiceNow.

Você deve ativar o plug-in Gestão de eventos (com.glideapp.itom.snac) antes de tentar acessar esta API. O plug-in Gestão de eventos requer uma assinatura separada e deve ser ativado. Este plug-in inclui dados de demonstração e ativa plug-ins relacionados, caso ainda não estejam ativos.

Para obter informações adicionais sobre gestão de eventos, consulte [Gestão de eventos](https://www.servicenow.com/docs/access?context=c_EM&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US).

## Evento - Evento() {#ariaid-title2}

Instancia um construtor de eventos.
{#Event-Event__table_zk1_mcl_jkb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 1. Parâmetros]

{#Event-Event__table_zk1_mcl_jkb}  

    var event = new Event();
    var esource = event.getField("source");
    var eseverity = event.getField("severity");       

## Evento - getField(String field) {#ariaid-title3}

Retorna o valor atual do campo de gestão de eventos aprovado.
{#Event-getField_S__table_ky4_4mk_jkb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Assunto: | Cadeia de caracteres | Nome do valor do campo de gestão de eventos a ser retornado. |
[Tabela 2. Parâmetros]

{#Event-getField_S__table_ky4_4mk_jkb} {#Event-getField_S__table_ly4_4mk_jkb__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Valor do campo de gestão de eventos solicitado. |
[Tabela 3. Retorna]

{#Event-getField_S__table_ly4_4mk_jkb}  

    var event = new Event();
    var eventSource = event.getField("source");
    var eventSeverity = event.getField("severity");       

## Evento - setAdditionalInfo(String additionalInfo) {#ariaid-title4}

Substitui o campo additional_info existente no evento associado pela cadeia de caracteres JSON passada.
Nota:  
Você pode usar o método [setField()](https://servicenow-prod.fluidtopics.net/6hqc27VmgUsvI4sm18BJSA#Event-setField_S_S "Define o campo especificado no evento associado.") para atualizar um campo específico dentro do campo additional_info.
{#Event-setAdditionalInfo_S__table_pc2_dbh_kkb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| additionalInfo | Cadeia de caracteres | Cadeia de caracteres JSON (pares de chave/valor) a ser salva no campo additional_info. Nota: Este parâmetro substitui as informações existentes. Ele não atualiza os campos existentes. |
[Tabela 4. Parâmetros]

{#Event-setAdditionalInfo_S__table_pc2_dbh_kkb} {#Event-setAdditionalInfo_S__table_qc2_dbh_kkb__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 5. Retorna]

{#Event-setAdditionalInfo_S__table_qc2_dbh_kkb}  

    event.setAdditionalInfo("{\"evtComponent\":\"Microsoft-Windows- WindowsUpdateClient\",\"evtMessage\":\"Installation Failure: Windows failed. Error 0x80070490\"}");

## Evento - setField(cadeia de caracteres chave, valor de cadeia de caracteres) {#ariaid-title5}

Define o campo especificado no evento associado.
Se o passado em key corresponder a um campo de evento predefinido, o método atualizará o campo de evento correspondente. Caso contrário, o método adicionará o parâmetro \[ key à seção additional_info do evento antes de aplicar o passado em value.

A seguir estão os campos de evento predefinidos que você pode modificar usando este método:
{#Event-setField_S_S__table_ddd_32g_pkb__entry__2}

| Campo | Descrição |
|-|-|
| adicional_info | Par de chave-valor a ser adicionado ao campo additional_info do evento associado. Se a chave passada já existir, seu valor será substituído. Tamanho máximo: 4.000 caracteres Campo de IU associado: informações adicionais |
| identificador_ci | Cadeia de caracteres JSON que identifica exclusivamente um item de configuração. Por exemplo, `{"name":"SAP ORA01","type":"Oracle"}`. Tamanho máximo: 1.000 caracteres |
| cmdb_ci | Sys_id do registro do item de configuração \[cmdb_ci\] ao qual o evento será vinculado. Padrão: nulo |
| descrição | Descrição de forma livre do evento. Tamanho máximo: 4.000 caracteres Campo de IU associado: Descrição Padrão: nulo |
| event_class | Enterprise Message Service (EMS) que gerou o evento. Por exemplo, "SolarWinds" ou "SCOM". Tamanho máximo: 100 Campo de IU associado: instância de origem Padrão: nulo |
| message_key | Identificador de evento exclusivo. Para substituir a gravidade de um evento existente, use o mesmo valor message_key. Tamanho máximo: 1024 caracteres Campo de IU associado: chave de mensagem Padrão: combinação de source, node, type, resourcee metric name. |
| resolução_estado | Estado de resolução de eventos. Valores válidos: * Novo: o estado de resolução do evento correspondente está aberto. * Encerramento: o estado de resolução do evento correspondente é encerramento/fechado. {#Event-setField_S_S__ul_szv_dmg_pkb} Campo de IU associado: estado de resolução Padrão: novo |
| recurso | Recurso de nó a ser associado ao evento. Por exemplo, "Disco C:", "CPI-1" ou o nome de um processo ou serviço. Tamanho máximo: 100 caracteres Campo de IU associado: Recurso |
| severidade | Gravidade do evento. Valores válidos: * 0: Limpar - Nenhuma ação é necessária. Um alerta não foi criado a partir deste evento. Os alertas existentes são encerrados. * 1: OK - Um alerta foi criado. O recurso ainda está funcional. * 2: Aviso - Requer atenção, embora o recurso ainda esteja funcional. * 3: Secundário - Ocorreu uma perda parcial e não crítica de funcionalidade ou degradação do desempenho. * 4: Principal - A funcionalidade principal está gravemente prejudicada ou o desempenho foi degradado. * 5: Crítico - É necessária uma ação imediata. O recurso não está funcional ou há problemas críticos iminentes. {#Event-setField_S_S__ul_ol1_d4g_pkb} Campo de IU associado: gravidade Padrão: nulo |
| origem | Instância do EMS que acionou o evento. Normalmente, o nome da instância do conector. Tamanho máximo: 200 caracteres Campo de IU associado: origem Padrão: nulo |
| time_of_event | Hora UTC em que o evento ocorreu no sistema de origem. Formato: "aaaa-MM-dd HH:mm:ss" Tamanho máximo: 40 caracteres Campo de IU associado: hora do evento Padrão: data/hora atual |
| tipo | Tipo de métrica ao qual o evento está relacionado, como Disco ou CPU. Este valor é usado para identificar um registro de evento a partir do qual os alertas são criados. Tamanho máximo: 100 caracteres Campo de IU associado: tipo Padrão: nulo |
[ ]

{#Event-setField_S_S__table_ddd_32g_pkb}  
Nota:  
Você também pode usar o método [setText()](https://servicenow-prod.fluidtopics.net/6hqc27VmgUsvI4sm18BJSA#Event-setText_S "Define o campo description do evento associado ao valor passado.") para atualizar o campo description e o método [setTimeOfEvent()](https://servicenow-prod.fluidtopics.net/6hqc27VmgUsvI4sm18BJSA#Event-setTimeOfEvent_S "Define o campo time_of_event no evento associado ao valor de hora UTC passado.") para atualizar a hora do evento.

Para obter informações adicionais sobre eventos, consulte [Gestão de eventos](https://www.servicenow.com/docs/access?context=c_EM&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US).
{#Event-setField_S_S__table_ijd_4ck_jkb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| chave | Cadeia de caracteres | Nome da chave a ser adicionada ou atualizada no evento. Para obter informações adicionais sobre os campos de evento predefinidos, consulte [Formato do campo de evento para coleção de eventos](https://www.servicenow.com/docs/access?context=c_EMIntegrateRequirementEvent&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US). |
| valor | Cadeia de caracteres | Informações a serem armazenadas no campo de evento associado. Nota: A cadeia de caracteres value é ajustada antes de ser armazenada, em que vários espaços são substituídos por um único espaço. |
[Tabela 6. Parâmetros]

{#Event-setField_S_S__table_ijd_4ck_jkb} {#Event-setField_S_S__table_jjd_4ck_jkb__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 7. Retorna]

{#Event-setField_S_S__table_jjd_4ck_jkb}  

    var event = new Event();
    event.setField("source","SAP Solman");
    event.setField("severity","3");
    event.setField("time_of_event", "2019-18-05 13:12:05");
    event.setField("type", "SAP object");
    event.setField("user", "admin"); // parameter will be added to additional_info section       

## Evento - setText(cadeia de caracteres text) {#ariaid-title6}

Define o campo description do evento associado ao valor passado.
Nota:  
Você também pode usar o método [Evento - setField(cadeia de caracteres chave, valor de cadeia de caracteres)](https://servicenow-prod.fluidtopics.net/6hqc27VmgUsvI4sm18BJSA#Event-setField_S_S "Define o campo especificado no evento associado.") para definir o campo text no evento atual. Ao contrário do método setField(), este método não apara o texto passado.
{#Event-setText_S__table_r2j_mgh_kkb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| texto | Cadeia de caracteres | Texto a ser armazenado no campo description do evento associado. Tamanho máximo: 4000 caracteres |
[Tabela 8. Parâmetros]

{#Event-setText_S__table_r2j_mgh_kkb} {#Event-setText_S__table_s2j_mgh_kkb__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 9. Retorna]

{#Event-setText_S__table_s2j_mgh_kkb}  

    var event = new Event();
    event.setText("SAP Solman");       

## Evento - setTimeOfEvent(String timeOfEvent) {#ariaid-title7}

Define o campo time_of_event no evento associado ao valor de hora UTC passado.
Nota:  
Você também pode usar o método [Evento - setField(cadeia de caracteres chave, valor de cadeia de caracteres)](https://servicenow-prod.fluidtopics.net/6hqc27VmgUsvI4sm18BJSA#Event-setField_S_S "Define o campo especificado no evento associado.") para definir o campo time_of_event.
{#Event-setTimeOfEvent_S__table_m43_kwg_kkb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| timeOfEvent | Cadeia de caracteres | Valor de hora UTC a ser definido no campo time_of_event. Formato: "aaaa-MM-dd HH:mm:ss" Tamanho máximo: 40 caracteres |
[Tabela 10. Parâmetros]

{#Event-setTimeOfEvent_S__table_m43_kwg_kkb} {#Event-setTimeOfEvent_S__table_n43_kwg_kkb__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 11. Retorna]

{#Event-setTimeOfEvent_S__table_n43_kwg_kkb}  

    var event = new Event();
    event.setTimeOfEvent("2019-18-05 13:12:05");