TMFTopicEventAPIUtilOOB - Com escopo

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 22 min. de leitura

    • . TMFTopicEventAPIUtilOOB a inclusão de script contém funções a serem manipuladas Gestão de notificações de eventos aberta Solicitações de API acionadas por definições de gatilho externo para criar, atualizar e excluir eventos na tabela de evento [em_event].

    Esta inclusão de script contém a implementação padrão para Gestão de notificações de eventos aberta API. Se você quiser mudar a funcionalidade padrão desta API, será necessário substituir as funções contidas nesta inclusão de script no TMFTopicEventAPIUtil inclusão de script.

    Esta inclusão de script é executada no sn_ind_tmf642 E requer a ativação do plug-in da API aberta de Gestão de alarmes de telecomunicações (app-ind-tmfapi-alarm).

    Para obter informações adicionais sobre como substituir essas funções, consulte Guia do desenvolvedor de API aberta da Gestão de notificações de eventos.

    Para obter informações adicionais sobre Gestão de notificações de eventos aberta API, consulte API aberta da Gestão de notificações de eventos.

    TMFTopicEventAPIUtilOOB - getAlarmChangeEventSchema()

    Retorna o esquema de carga usado ao processar um evento de mudança de alarme (ALARM_CHANGE_EVENT_SCHEMA).

    Esta função é chamada como parte do AlarmChangeEvent processo de chamada de ação de fluxo. Você pode alterar a funcionalidade desta função substituindo a funcionalidade padrão no TMFTopicEventAPIUtil inclusão de script e o esquema no TMFAlarmAPIConstantes inclusão de script.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 2. Retorna
    Tipo Descrição
    Cadeia de caracteres Esquema definido em TMFALARMAPICONSTANTS.ALARM_CHANGE_EVENT_SCHEMA . 
    // Schema validation
var schema = this.getAlarmChangeEventSchema();
var validationResults = this.schemaValidator.validateJSON(changeAlarmPayload, schema);
if (validationResults.length > 0) {
  this.responseObject.status = TMFAlarmAPIConstants.EVENT_TRANSFORMATION_ERROR;
  this.responseObject.responseError.errorMessage = TMFAlarmAPIConstants.MESSAGES.CHANGE_ERROR;
  this.responseObject.responseError.errorReason = TMFAlarmAPIConstants.MESSAGES.CHANGE_ERROR_PAYLOAD;
  var messageDetails = [];
  for (var i = 0; i < validationResults.length; i++)
    messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
  this.responseObject.responseError.details = messageDetails;
  return this.responseObject;

    TMFTopicEventAPIUtilOOB - getAlarmCreateEventSchema()

    Retorna o esquema de carga usado ao processar um evento de criação de alarme (ALARM_CREATE_EVENT_SCHEMA).

    Esta função é chamada como parte do Criar evento processo de chamada de ação de fluxo. Você pode alterar a funcionalidade desta função substituindo a funcionalidade padrão no TMFTopicEventAPIUtil inclusão de script e o esquema no TMFAlarmAPIConstantes inclusão de script.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 4. Retorna
    Tipo Descrição
    Cadeia de caracteres Esquema definido em TMFALARMAPICONSTANTS.ALARM_CREATE_EVENT_SCHEMA 
    // Schema validation
var schema = this.getAlarmCreateEventSchema();
var validationResults = this.schemaValidator.validateJSON(eventAlarmObject, schema);
if (validationResults.length > 0) {
  this.responseObject.status = TMFAlarmAPIConstants.EVENT_TRANSFORMATION_ERROR;
  this.responseObject.responseError.errorMessage = TMFAlarmAPIConstants.MESSAGES.CREATE_ERROR;
  this.responseObject.responseError.errorReason = TMFAlarmAPIConstants.MESSAGES.CREATE_ERROR_PAYLOAD;
  var messageDetails = [];
  for (var i = 0; i < validationResults.length; i++)
    messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
  this.responseObject.responseError.details = messageDetails;
  return this.responseObject;
}

    TMFTopicEventAPIUtilOOB - getAlarmDeleteEventSchema()

    Retorna o esquema de carga usado ao processar um evento de exclusão de alarme (ALARM_DELETE_EVENT_SCHEMA).

    Esta função é chamada como parte do AlarmdeleteEvent processo de chamada de ação de fluxo. Você pode alterar a funcionalidade desta função substituindo a funcionalidade padrão no TMFTopicEventAPIUtil inclusão de script e o esquema no TMFAlarmAPIConstantes inclusão de script.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 6. Retorna
    Tipo Descrição
    Cadeia de caracteres Esquema definido em TMFALARMAPICONSTANTS.ALARM_DELETE_EVENT_SCHEMA . 
    // Schema validation
var schema = this.getAlarmDeleteEventSchema();
var validationResults = this.schemaValidator.validateJSON(deleteAlarmPayload, schema);
if (validationResults.length > 0) {
  this.responseObject.status = TMFAlarmAPIConstants.EVENT_TRANSFORMATION_ERROR;
  this.responseObject.responseError.errorMessage = TMFAlarmAPIConstants.MESSAGES.CLEAR_ERROR;
  this.responseObject.responseError.errorReason = TMFAlarmAPIConstants.MESSAGES.CLEAR_ERROR_PAYLOAD;
  var messageDetails = [];
  for (var i = 0; i < validationResults.length; i++)
    messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
  this.responseObject.responseError.details = messageDetails;
  return this.responseObject;
}

    TMFTopicEventAPIUtilOOB - mapAlarmChangeObjectToEvent(alarmObject, GlideRecord newEventGr)

    Mapeia os parâmetros na carga de solicitação de mudança aprovada para campos no registro especificado na tabela de evento [em_event].

    Você pode personalizar mapeamentos de campo para adicionar dados à tabela de evento [em_event] ou alterar os mapeamentos de campo padrão. Para modificar mapeamentos, crie funções com nomes e parâmetros idênticos no TMFTopicEventAPIUtil inclusão de script para substituir os mapeamentos no TMFTopicEventAPIUtilOOB inclusão de script. Se você adicionar campos aos mapeamentos, esses campos também deverão ser adicionados ao esquema associado ( TMFALARMAPICONSTANTS.ALARM_CHANGE_EVENT_SCHEMA ).

    Esta função é chamada como parte do TransformAndPersistChangeEvent() função.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    Objeto alarm Objeto A carga deve corresponder ao que está definido no esquema definido em TMFALARMAPICONSTANTS.ALARM_CHANGE_EVENT_SCHEMA .
    NovoEventGr GlideRecord GlideRecord do registro a ser atualizado na tabela de evento [em_event].
    Tabela 8. Retornos
    Tipo Descrição
    Nenhum 
    this.mapAlarmChangeObjectToEvent(additionalInfoObj, newEventGr);

var id = newEventGr.insert();
return gs.nil(id) ? id : newEventGr.message_key;

    TMFTopicEventAPIUtilOOB - mapCreateAlarmObjectToEvent(Object alarmObject, GlideRecord eventGr)

    Mapeia os parâmetros na carga de solicitação de criação aprovada para campos no registro especificado na tabela de evento [em_event].

    Você pode personalizar mapeamentos de campo para adicionar dados à tabela de evento [em_event] ou alterar os mapeamentos de campo padrão. Para modificar mapeamentos, crie funções com nomes e parâmetros idênticos no TMFTopicEventAPIUtil inclusão de script para substituir os mapeamentos no TMFTopicEventAPIUtilOOB inclusão de script. Se você adicionar campos aos mapeamentos, esses campos também deverão ser adicionados ao esquema associado ( TMFALARMAPICONSTANTS.ALARM_CREATE_EVENT_SCHEMA ).

    Esta função é chamada como parte do TransformAndPersistAlarmCreateEvent() função.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    Objeto alarm Objeto A carga deve corresponder ao que está definido no esquema definido em TMFALARMAPICONSTANTS.ALARM_CREATE_EVENT_SCHEMA .
    eventGr GlideRecord GlideRecord do registro na tabela de evento [em_event].
    Tabela 10. Retornos
    Tipo Descrição
    Nenhum 
    this.mapCreateAlarmObjectToEvent(eventAlarmObject, eventGr);
var id = eventGr.insert();
return gs.nil(id) ? id : msgKey;

    TMFTopicEventAPIUtilOOB - mapDeleteAlarmObjectToEvent(Object additionalInfoObj, GlideRecord newEventGr)

    Mapeia os parâmetros na carga de solicitação de exclusão aprovada para campos no registro especificado na tabela de evento [em_event].

    Você pode personalizar mapeamentos de campo para adicionar dados à tabela de evento [em_event] ou alterar os mapeamentos de campo padrão. Para modificar mapeamentos, crie funções com nomes e parâmetros idênticos no TMFTopicEventAPIUtil inclusão de script para substituir os mapeamentos no TMFTopicEventAPIUtilOOB inclusão de script. Se você adicionar campos aos mapeamentos, esses campos também deverão ser adicionados ao esquema associado ( TMFALARMAPICONSTANTS.ALARM_DELETE_EVENT_SCHEMA ).

    Esta função é chamada como parte do TransformAndPersistDeleteEvent() função.

    Tabela 11. Parâmetros
    Nome Tipo Descrição
    Objeto alarm Objeto A carga deve corresponder ao que está definido no esquema definido em TMFALARMAPICONSTANTS.ALARM_DELETE_EVENT_SCHEMA .
    NovoEventGr GlideRecord GlideRecord do registro a ser usado para mapear os campos na carga para aqueles na tabela de evento [em_event].
    Tabela 12. Retornos
    Tipo Descrição
    Nenhum 
    this.mapDeleteAlarmObjectToEvent(additionalInfoObj, newEventGr);
var id = newEventGr.insert();
return gs.nil(id) ? id : newEventGr.message_key;

    TMFTopicEventAPIUtilOOB - prepareEventAlarmRecordResponse(String msgKey Object alarmObject, Object responseObject)

    Gera o objeto de resposta após a criação ou atualização do evento, incluindo a limpeza de um evento.

    Esta função é chamada pelo ProcessAlarmCreateEvent() , ProcessChangeAlarm() e. ProcessDeleteAlarmEvent() funções. Você pode alterar a funcionalidade desta função substituindo a funcionalidade padrão no TMFTopicEventAPIUtil inclusão de script.

    Tabela 13. Parâmetros
    Nome Tipo Descrição
    MsgKey Cadeia de caracteres Chave de mensagem Esta chave é gerada quando um evento é criado.

    Tabela: No campo Chave de mensagem na tabela Eventos [em_event].
    Objeto alarm Objeto Carga do evento a ser processada. O formato desta carga deve estar correlacionado ao tipo de evento que está sendo processado. Os esquemas para essas cargas são definidos no TMFAlarmAPIConstantes inclusão de script.
    responseObject Objeto Objeto de resposta vazio. Use este objeto para registrar todos os problemas com a verificação do esquema de carga.
    Tipo de dados: Objeto
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    ResponseObject. ​ResponseError Objeto Detalhes sobre qualquer erro que ocorreu durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    ResponseObject. ​ResponseError. ​detalhes Matriz Qualquer informação adicional a ser passada de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    ResponseObject. ​ResponseError. ​Mensagem de erro Cadeia de caracteres Mensagem de erro que descreve o erro que ocorreu. As mensagens de erro disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​ResponseError. ​Erro Cadeia de caracteres Motivo pelo qual o endpoint falhou. Os motivos do erro disponíveis são definidos em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​status Cadeia de caracteres Status da chamada de função. As mensagens de status disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​Resposta bem-sucedida Objeto Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor.
    Tabela 14. Retornos
    Tipo Descrição
    responseObject Detalhes sobre o status da chamada de função.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    ResponseObject. ​status Status da chamada de função. As mensagens de status disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​Resposta bem-sucedida Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor.
    ResponseObject. ​ResponseError Detalhes sobre qualquer erro que ocorreu durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    ResponseObject. ​ResponseError. ​detalhes Qualquer informação adicional a ser passada de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    ResponseObject. ​ResponseError. ​Mensagem de erro Mensagem de erro que descreve o erro que ocorreu. As mensagens de erro disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​ResponseError. ​Erro Motivo pelo qual o endpoint falhou. Os motivos do erro disponíveis são definidos em TMFAlarmAPIConstantes inclusão de script. 
    processDeleteAlarm: function(additionalInfoObj, gr, deleteAlarmPayload, responseObject) {
var msgKey = this.transformAndPersistDeleteEvent(additionalInfoObj, gr);
var responsePayload = this.prepareEventAlarmRecordResponse(msgKey, deleteAlarmPayload, responseObject);
this._logger.logDebug("processDeleteAlarmEvent");
return responsePayload;
},

    TMFTopicEventAPIUtilOOB - processAlarmChangeEvent(Object changeAlarmPayload)

    Inicia o processo de atualização de um registro na tabela de evento [em_event] quando o. eventTypeestá definido como AlarmChangeNotification .

    Esta função é chamada pelo AlarmChangeEvent ação de fluxo. Você pode alterar a funcionalidade desta função substituindo a funcionalidade padrão no TMFTopicEventAPIUtil inclusão de script.

    Tabela 15. Parâmetros
    Nome Tipo Descrição
    ​Carga do Alarme de Mudança Objeto Carga de mudança de evento para processar. A carga deve corresponder ao esquema definido em TMFALARMAPICONSTANTS.ALARM_CHANGE_EVENT_SCHEMA .
    Tabela 16. Retornos
    Tipo Descrição
    responseObject Detalhes sobre o status da chamada de função.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    ResponseObject. ​ResponseError Detalhes sobre qualquer erro que ocorreu durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    ResponseObject. ​ResponseError. ​detalhes Qualquer informação adicional a ser passada de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    ResponseObject. ​ResponseError. ​Mensagem de erro Mensagem de erro que descreve o erro que ocorreu. As mensagens de erro disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​ResponseError. ​Erro Motivo pelo qual o endpoint falhou. Os motivos do erro disponíveis são definidos em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​status Status da chamada de função. As mensagens de status disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​Resposta bem-sucedida Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor. 
    Called by the AlarmChangeEvent flow action

    TMFTopicEventAPIUtilOOB - processAlarmCreateEvent(Object eventAlarmObject)

    Inicia o processo de criação de um registro na tabela de evento [em_event] quando o. eventTypeestá definido como Criar Notificação .

    Esta função é chamada pelo Criar evento ação de fluxo. Você pode alterar a funcionalidade desta função substituindo a funcionalidade padrão no TMFTopicEventAPIUtil inclusão de script.

    Tabela 17. Parâmetros
    Nome Tipo Descrição
    ​Objeto eventAlarm Objeto Carga de criação de evento para processar. A carga deve corresponder ao esquema definido em TMFALARMAPICONSTANTS.ALARM_CREATE_EVENT_SCHEMA .
    Tabela 18. Retornos
    Tipo Descrição
    responseObject Detalhes sobre o status da chamada de função.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    ResponseObject. ​ResponseError Detalhes sobre qualquer erro que ocorreu durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    ResponseObject. ​ResponseError. ​detalhes Qualquer informação adicional a ser passada de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    ResponseObject. ​ResponseError. ​Mensagem de erro Mensagem de erro que descreve o erro que ocorreu. As mensagens de erro disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​ResponseError. ​Erro Motivo pelo qual o endpoint falhou. Os motivos do erro disponíveis são definidos em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​status Status da chamada de função. As mensagens de status disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​Resposta bem-sucedida Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor. 
    Called by AlarmCreateEvent flow action.

    TMFTopicEventAPIUtilOOB - processDeleteAlarmEvent(Object deleteAlarmPayload)

    Inicia o processo de limpar o evento de alarme na tabela de evento [em_event] quando o. eventTypeestá definido como AlarmDeleteNotification .

    Esta função limpa o campo de estado e fecha o alarme de evento. Ele também atualiza todos os parâmetros na carga aprovada.

    Esta função é chamada pelo AlarmdeleteEvent ação de fluxo. Você pode alterar a funcionalidade desta função substituindo a funcionalidade padrão no TMFTopicEventAPIUtil inclusão de script.

    Tabela 19. Parâmetros
    Nome Tipo Descrição
    ExcluteAlarm​Payload Objeto Carga de exclusão do evento a ser processada. A carga deve corresponder ao esquema definido em TMFALARMAPICONSTANTS.ALARM_DELETE_EVENT_SCHEMA .
    Tabela 20. Retornos
    Tipo Descrição
    responseObject Detalhes sobre o status da chamada de função.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    ResponseObject. ​ResponseError Detalhes sobre qualquer erro que ocorreu durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    ResponseObject. ​ResponseError. ​detalhes Qualquer informação adicional a ser passada de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    ResponseObject. ​ResponseError. ​Mensagem de erro Mensagem de erro que descreve o erro que ocorreu. As mensagens de erro disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​ResponseError. ​Erro Motivo pelo qual o endpoint falhou. Os motivos do erro disponíveis são definidos em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​status Status da chamada de função. As mensagens de status disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​Resposta bem-sucedida Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor. 
    Called by AlarmDeleteEvent flow action.

    TMFTopicEventAPIUtilOOB - transformAndPersistAlarmCreateEvent(Object alarmObject)

    Transforma a carga de criação de evento aprovada usando os valores de mapeamento de criação de evento associados e armazena as informações na tabela de evento [em_event].

    Esta função é chamada pelo ProcessAlarmCreateEvent() função como parte da ação de fluxo. Você pode alterar a funcionalidade desta função substituindo a funcionalidade padrão no TMFTopicEventAPIUtil inclusão de script.

    Tabela 21. Parâmetros
    Nome Tipo Descrição
    Objeto alarm Objeto Carga a ser usada para criar um registro na tabela de evento [em_event]. A carga deve corresponder ao esquema definido em TMFALARMAPICONSTANTS.ALARM_CREATE_EVENT_SCHEMA .
    Tabela 22. Retornos
    Tipo Descrição
    Cadeia de caracteres ID exclusivo (chave de mensagem) do evento.

    Esta função só é chamada pelo Criar evento ação de fluxo, portanto, nenhum exemplo de código é fornecido.

    TMFTopicEventAPIUtilOOB - transformAndPersistChangeEvent(Objeto additionalInfoObj, GlideRecord existente)

    Transforma a carga de evento de mudança aprovada usando os valores de mapeamento de evento de mudança associados e armazena as informações atualizadas no GlideRecord aprovado na tabela de evento [em_event].

    Esta função é chamada pelo ProcessAlarmChangeEvent() função como parte da ação de fluxo. Você pode alterar a funcionalidade desta função substituindo a funcionalidade padrão no TMFTopicEventAPIUtil inclusão de script.

    Tabela 23. Parâmetros
    Nome Tipo Descrição
    ​Obj de informação adicional Objeto Carga a ser usada para atualizar os campos no registro especificado no existingGrparâmetro. A carga deve corresponder ao esquema definido em TMFALARMAPICONSTANTS.ALARM_CHANGE_EVENT_SCHEMA .
    Gr existente GlideRecord GlideRecord do registro de evento na tabela de evento [em_event] a ser atualizado.
    Tabela 24. Retornos
    Tipo Descrição
    Cadeia de caracteres ID exclusivo (chave de mensagem) do evento.

    Esta função só é chamada pelo AlarmChangeEvent ação de fluxo, portanto, nenhum exemplo de código é fornecido.

    TMFTopicEventAPIUtilOOB - transformAndPersistDeleteEvent(Object additionalInfoObj GlideRecord existente)

    Transforma a carga de evento de exclusão aprovada (limpar) usando os valores de mapeamento de evento de exclusão associados e armazena as informações atualizadas no GlideRecord aprovado na tabela de evento [em_event].

    Esta função é chamada pelo ProcessAlarmDeleteEvent() função como parte da ação de fluxo. Você pode alterar a funcionalidade desta função substituindo a funcionalidade padrão no TMFTopicEventAPIUtil inclusão de script.

    Tabela 25. Parâmetros
    Nome Tipo Descrição
    ​Obj de informação adicional Objeto Carga a ser usada para atualizar os campos Limpar evento no registro especificado no existingGrparâmetro. A carga deve corresponder ao esquema definido em TMFALARMAPICONSTANTS.ALARM_DELETE_EVENT_SCHEMA .
    Gr existente GlideRecord GlideRecord do registro de evento na tabela de evento [em_event] para o qual limpar o alarme.
    Tabela 26. Retornos
    Tipo Descrição
    Cadeia de caracteres ID exclusivo (chave de mensagem) do evento.

    Esta função só é chamada pelo AlarmdeleteEvent ação de fluxo, portanto, nenhum exemplo de código é fornecido.

    TMFTopicEventAPIUtilOOB - validateSubscription(Object eventAlarmObject, Object responseObject)

    Executa a validação na assinatura.

    Esta validação inclui verificar se o URL de retorno de chamada usado para fazer a notificação do evento e o. eventTypena carga são registrados.

    Esta função é chamada pelo ProcessAlarmCreateEvent() , ProcessChangeAlarm() e. ProcessDeleteAlarmEvent() funções. Você pode alterar a funcionalidade desta função substituindo a funcionalidade padrão no TMFTopicEventAPIUtil inclusão de script.

    Tabela 27. Parâmetros
    Nome Tipo Descrição
    ​Objeto eventAlarm Objeto Carga do evento a ser validada. O formato desta carga deve estar correlacionado ao tipo de evento que está sendo processado. Os esquemas para essas cargas são definidos no TMFAlarmAPIConstantes inclusão de script.
    responseObject Objeto Objeto de resposta vazio. Use este objeto para registrar todos os problemas com a verificação do esquema de carga.
    Tipo de dados: Objeto
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    ResponseObject. ​status Cadeia de caracteres Status da chamada de função. As mensagens de status disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​Resposta bem-sucedida Objeto Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor.
    ResponseObject. ​ResponseError Objeto Detalhes sobre qualquer erro que ocorreu durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    ResponseObject. ​ResponseError. ​detalhes Matriz Qualquer informação adicional a ser passada de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    ResponseObject. ​ResponseError. ​Mensagem de erro Cadeia de caracteres Mensagem de erro que descreve o erro que ocorreu. As mensagens de erro disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​ResponseError. ​Erro Cadeia de caracteres Motivo pelo qual o endpoint falhou. Os motivos do erro disponíveis são definidos em TMFAlarmAPIConstantes inclusão de script.
    Tabela 28. Retornos
    Tipo Descrição
    responseObject Detalhes sobre o status da chamada de função.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    ResponseObject. ​ResponseError Detalhes sobre qualquer erro que ocorreu durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    ResponseObject. ​ResponseError. ​detalhes Qualquer informação adicional a ser passada de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    ResponseObject. ​ResponseError. ​Mensagem de erro Mensagem de erro que descreve o erro que ocorreu. As mensagens de erro disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​ResponseError. ​Erro Motivo pelo qual o endpoint falhou. Os motivos do erro disponíveis são definidos em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​status Status da chamada de função. As mensagens de status disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​Resposta bem-sucedida Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor.

    Esta função só é chamada pelo AlarmCHANGEEvent ação de fluxo, portanto, nenhum exemplo de código é fornecido.

    TMFTopicEventAPIUtilOOB - verifyAlarmChangeEventPayload(Object changeAlarmPayload, Object responseObject )

    Fornece a capacidade de definir verificação adicional da carga do evento de mudança aprovada.

    Esta função é chamada pelo ProcessAlarmChangeEvent() função como parte da ação de fluxo. No momento, não há verificação de carga adicional fornecida para a carga de mudança. Você pode adicionar funcionalidade a esta função substituindo a funcionalidade padrão no TMFTopicEventAPIUtil inclusão de script.

    Tabela 29. Parâmetros
    Nome Tipo Descrição
    ​Carga do Alarme de Mudança Objeto Carga a ser verificada. A carga deve corresponder ao esquema definido em TMFALARMAPICONSTANTS.ALARM_CHANGE_EVENT_SCHEMA .
    responseObject Objeto Objeto de resposta vazio. Use este objeto para registrar todos os problemas com a verificação do esquema de carga.
    Tipo de dados: Objeto
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    ResponseObject. ​ResponseError Objeto Detalhes sobre qualquer erro que ocorreu durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    ResponseObject. ​ResponseError. ​detalhes Matriz Qualquer informação adicional a ser passada de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    ResponseObject. ​ResponseError. ​Mensagem de erro Cadeia de caracteres Mensagem de erro que descreve o erro que ocorreu. As mensagens de erro disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​ResponseError. ​Erro Cadeia de caracteres Motivo pelo qual o endpoint falhou. Os motivos do erro disponíveis são definidos em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​status Cadeia de caracteres Status da chamada de função. As mensagens de status disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​Resposta bem-sucedida Objeto Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor.
    Tabela 30. Retornos
    Tipo Descrição
    responseObject Detalhes sobre o status da chamada de função.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    ResponseObject. ​ResponseError Detalhes sobre qualquer erro que ocorreu durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    ResponseObject. ​ResponseError. ​detalhes Qualquer informação adicional a ser passada de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    ResponseObject. ​ResponseError. ​Mensagem de erro Mensagem de erro que descreve o erro que ocorreu. As mensagens de erro disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​ResponseError. ​Erro Motivo pelo qual o endpoint falhou. Os motivos do erro disponíveis são definidos em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​status Status da chamada de função. As mensagens de status disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​Resposta bem-sucedida Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor. 
     // Apply customized validations if applicable, defaults to no error
var changePayloadResponse = this.verifyAlarmChangeEventPayload(changeAlarmPayload, this.responseObject);
if (!gs.nil(changePayloadResponse.responseError.errorMessage))
  return changePayloadResponse;

    TMFTopicEventAPIUtilOOB - verifyAlarmCreateEventPayload(Object alarmObject, Object responseObject)

    Fornece a capacidade de definir verificação adicional da carga aprovada na criação de evento.

    Esta função é chamada pelo ProcessAlarmCreateEvent() função como parte da ação de fluxo. No momento, não há verificação adicional de carga fornecida para a criação de carga. Você pode adicionar funcionalidade a esta função substituindo a funcionalidade padrão no TMFTopicEventAPIUtil inclusão de script.

    Tabela 31. Parâmetros
    Nome Tipo Descrição
    AlarmPayload Objeto Carga a ser verificada. A carga deve corresponder ao esquema definido em TMFALARMAPICONSTANTS.ALARM_CREATE_EVENT_SCHEMA .
    responseObject Objeto Objeto de resposta vazio. Use este objeto para registrar todos os problemas com a verificação do esquema de carga.
    Tipo de dados: Objeto
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    ResponseObject. ​status Cadeia de caracteres Status da chamada de função. As mensagens de status disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​Resposta bem-sucedida Objeto Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor.
    ResponseObject. ​ResponseError Objeto Detalhes sobre qualquer erro que ocorreu durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    ResponseObject. ​ResponseError. ​detalhes Matriz Qualquer informação adicional a ser passada de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    ResponseObject. ​ResponseError. ​Mensagem de erro Cadeia de caracteres Mensagem de erro que descreve o erro que ocorreu. As mensagens de erro disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​ResponseError. ​Erro Cadeia de caracteres Motivo pelo qual o endpoint falhou. Os motivos do erro disponíveis são definidos em TMFAlarmAPIConstantes inclusão de script.
    Tabela 32. Retornos
    Tipo Descrição
    responseObject Detalhes sobre o status da chamada de função.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    ResponseObject. ​ResponseError Detalhes sobre qualquer erro que ocorreu durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    ResponseObject. ​ResponseError. ​detalhes Qualquer informação adicional a ser passada de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    ResponseObject. ​ResponseError. ​Mensagem de erro Mensagem de erro que descreve o erro que ocorreu. As mensagens de erro disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​ResponseError. ​Erro Motivo pelo qual o endpoint falhou. Os motivos do erro disponíveis são definidos em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​status Status da chamada de função. As mensagens de status disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​Resposta bem-sucedida Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor. 
    // Apply customized validations if applicable, defaults to no error
var creatPayloadResponse = this.verifyAlarmCreateEventPayload(eventAlarmObject, this.responseObject);
if (!gs.nil(creatPayloadResponse.responseError.errorMessage))
  return creatPayloadResponse;

    TMFTopicEventAPIUtilOOB - verifyDeleteEventPayload(Object deleteAlarmPayload, Object responseObject)

    Fornece a capacidade de definir verificação adicional da carga de evento aprovada na exclusão.

    Esta função é chamada pelo ProcessDeleteAlarmEvent() função como parte da ação de fluxo. No momento, não há verificação adicional de carga fornecida para a exclusão de carga. Você pode adicionar funcionalidade a esta função substituindo a funcionalidade padrão no TMFTopicEventAPIUtil inclusão de script.

    Tabela 33. Parâmetros
    Nome Tipo Descrição
    ExcluteAlarm​Payload Objeto Carga a ser verificada. A carga deve corresponder ao esquema definido em TMFALARMAPICONSTANTS.ALARM_DELETE_EVENT_SCHEMA .
    responseObject Objeto Objeto de resposta vazio. Use este objeto para registrar todos os problemas com a verificação do esquema de carga.
    Tipo de dados: Objeto
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    ResponseObject. ​status Cadeia de caracteres Status da chamada de função. As mensagens de status disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​Resposta bem-sucedida Objeto Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor.
    ResponseObject. ​ResponseError Objeto Detalhes sobre qualquer erro que ocorreu durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    ResponseObject. ​ResponseError. ​detalhes Matriz Qualquer informação adicional a ser passada de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    ResponseObject. ​ResponseError. ​Mensagem de erro Cadeia de caracteres Mensagem de erro que descreve o erro que ocorreu. As mensagens de erro disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​ResponseError. ​Erro Cadeia de caracteres Motivo pelo qual o endpoint falhou. Os motivos do erro disponíveis são definidos em TMFAlarmAPIConstantes inclusão de script.
    Tabela 34. Retornos
    Tipo Descrição
    responseObject Detalhes sobre o status da chamada de função.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    ResponseObject. ​ResponseError Detalhes sobre qualquer erro que ocorreu durante a validação.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    ResponseObject. ​ResponseError. ​detalhes Qualquer informação adicional a ser passada de volta para a rotina de chamada.
    Por exemplo:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    ResponseObject. ​ResponseError. ​Mensagem de erro Mensagem de erro que descreve o erro que ocorreu. As mensagens de erro disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​ResponseError. ​Erro Motivo pelo qual o endpoint falhou. Os motivos do erro disponíveis são definidos em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​status Status da chamada de função. As mensagens de status disponíveis são definidas em TMFAlarmAPIConstantes inclusão de script.
    ResponseObject. ​Resposta bem-sucedida Resposta bem-sucedida da chamada de função. Por exemplo, você pode armazenar o objeto de carga neste valor. 
    // Apply customized validations if applicable, defaults to no error
var deletePayloadResponse = this.verifyDeleteEventPayload(deleteAlarmPayload, this.responseObject);
if (!gs.nil(deletePayloadResponse.responseError.errorMessage))
  return deletePayloadResponse;