The TMFTopicEventAPIUtilOOB script include contains functions to handle Event Notification Management Open API requests that are triggered by external trigger definitions to create, update, and delete events in the Event [em_event] table.

This script include contains the default implementation for the Event Notification Management Open API. If you want to change the default functionality of this API, you need to override all functions contained in this script include in the TMFTopicEventAPIUtil script include.

This script include runs in the sn_ind_tmf642 namespace.

For additional information on how to override these functions, see the Event Notification Management Open API Developer Guide.

For additional information on the Event Notification Management Open API, see Event Notification Management Open API.

TMFTopicEventAPIUtilOOB - getAlarmChangeEventSchema()

Returns the payload schema used when processing an alarm change event (ALARM_CHANGE_EVENT_SCHEMA).

This function is called as part of the AlarmChangeEvent flow action call process. You can change the functionality of this function by overriding the default functionality in the TMFTopicEventAPIUtil script include and the schema in the TMFAlarmAPIConstants script include.

Table 1. Parameters
Name Type Description
None
Table 2. Returns
Type Description
String Schema defined in TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA.

Example

// 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()

Returns the payload schema used when processing an alarm create event (ALARM_CREATE_EVENT_SCHEMA).

This function is called as part of the AlarmCreateEvent flow action call process. You can change the functionality of this function by overriding the default functionality in the TMFTopicEventAPIUtil script include and the schema in the TMFAlarmAPIConstants script include.

Table 3. Parameters
Name Type Description
None
Table 4. Returns
Type Description
String Schema defined in TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA

Example

// 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()

Returns the payload schema used when processing an alarm delete event (ALARM_DELETE_EVENT_SCHEMA).

This function is called as part of the AlarmDeleteEvent flow action call process. You can change the functionality of this function by overriding the default functionality in the TMFTopicEventAPIUtil script include and the schema in the TMFAlarmAPIConstants script include.

Table 5. Parameters
Name Type Description
None
Table 6. Returns
Type Description
String Schema defined in TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA.

Example

// 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)

Maps the parameters in the passed change request payload to fields in the specified record in the Event [em_event] table.

You can customize field mappings to add data to the Event [em_event] table or change the default field mappings. To modify mappings, create functions with identical names and parameters in the TMFTopicEventAPIUtil script include to override the mappings in the TMFTopicEventAPIUtilOOB script include. If you add fields to the mappings, these fields must also be added to the associated schema (TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA).

This function is called as part of the transformAndPersistChangeEvent() function.

Table 7. Parameters
Name Type Description
alarmObject Object Payload should match what is defined in the schema defined in TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA.
newEventGr GlideRecord GlideRecord of the record to updated in the Event [em_event] table.
Table 8. Returns
Type Description
None

Example

this.mapAlarmChangeObjectToEvent(additionalInfoObj, newEventGr);

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

TMFTopicEventAPIUtilOOB - mapCreateAlarmObjectToEvent(Object alarmObject, GlideRecord eventGr)

Maps the parameters in the passed create request payload to fields in the specified record in the Event [em_event] table.

You can customize field mappings to add data to the Event [em_event] table or change the default field mappings. To modify mappings, create functions with identical names and parameters in the TMFTopicEventAPIUtil script include to override the mappings in the TMFTopicEventAPIUtilOOB script include. If you add fields to the mappings, these fields must also be added to the associated schema (TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA).

This function is called as part of the transformAndPersistAlarmCreateEvent() function.

Table 9. Parameters
Name Type Description
alarmObject Object Payload should match what is defined in the schema defined in TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA.
eventGr GlideRecord GlideRecord of the record in the Event [em_event] table.
Table 10. Returns
Type Description
None

Example

this.mapCreateAlarmObjectToEvent(eventAlarmObject, eventGr);
var id = eventGr.insert();
return gs.nil(id) ? id : msgKey;

TMFTopicEventAPIUtilOOB - mapDeleteAlarmObjectToEvent(Object additionalInfoObj, GlideRecord newEventGr)

Maps the parameters in the passed delete request payload to fields in the specified record in the Event [em_event] table.

You can customize field mappings to add data to the Event [em_event] table or change the default field mappings. To modify mappings, create functions with identical names and parameters in the TMFTopicEventAPIUtil script include to override the mappings in the TMFTopicEventAPIUtilOOB script include. If you add fields to the mappings, these fields must also be added to the associated schema (TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA).

This function is called as part of the transformAndPersistDeleteEvent() function.

Table 11. Parameters
Name Type Description
alarmObject Object Payload should match what is defined in the schema defined in TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA.
newEventGr GlideRecord GlideRecord of the record to use to map the fields in the payload to those in the Event [em_event] table.
Table 12. Returns
Type Description
None

Example

this.mapDeleteAlarmObjectToEvent(additionalInfoObj, newEventGr);
var id = newEventGr.insert();
return gs.nil(id) ? id : newEventGr.message_key;

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

Generates the response object after event creation or update, including the clearing of an event.

This function is called by the processAlarmCreateEvent(), processChangeAlarm(), and processDeleteAlarmEvent() functions. You can change the functionality of this function by overriding the default functionality in the TMFTopicEventAPIUtil script include.

Table 13. Parameters
NameTypeDescription
msgKey String Message key. This key is generated when an event is created. Located in the Message key field in the Events [em_event] table.
alarmObject Object Event payload to process. The format of this payload should correlate to the event type that is being processed. The schemas for these payloads are defined in the TMFAlarmAPIConstants script include.
responseObject Object Empty response object. Use this object to record any issues with the verification of the payload schema.
Data type: Object
"responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
responseObject.​responseError Object Details about any error that occurred during validation.
"responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
responseObject.​responseError.​details Array Any additional information to pass back to the calling routine.
For example:
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.​errorMessage String Error message that describes the error that occurred. The available error messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​responseError.​errorReason String Reason why the endpoint failed. The available error reasons are defined in the TMFAlarmAPIConstants script include.
responseObject.​status String Status of the function call. The available status messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​successResponse Object Successful response from the function call. For example, you could store the payload object in this value.
Table 14. Returns
TypeDescription
responseObject Details about the status of the function call.
"responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
responseObject.​status Status of the function call. The available status messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​successResponse Successful response from the function call. For example, you could store the payload object in this value.
responseObject.​responseError Details about any error that occurred during validation.
"responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
responseObject.​responseError.​details Any additional information to pass back to the calling routine.
For example:
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.​errorMessage Error message that describes the error that occurred. The available error messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​responseError.​errorReason Reason why the endpoint failed. The available error reasons are defined in the TMFAlarmAPIConstants script include.

Example

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)

Starts the process of updating a record in the Event [em_event] table when the eventType is set to AlarmChangeNotification.

This function is called by the AlarmChangeEvent flow action. You can change the functionality of this function by overriding the default functionality in the TMFTopicEventAPIUtil script include.

Table 15. Parameters
Name Type Description
changeAlarm​Payload Object Event change payload to process. The payload should match the schema defined in TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA.
Table 16. Returns
TypeDescription
responseObject Details about the status of the function call.
"responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
responseObject.​responseError Details about any error that occurred during validation.
"responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
responseObject.​responseError.​details Any additional information to pass back to the calling routine.
For example:
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.​errorMessage Error message that describes the error that occurred. The available error messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​responseError.​errorReason Reason why the endpoint failed. The available error reasons are defined in the TMFAlarmAPIConstants script include.
responseObject.​status Status of the function call. The available status messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​successResponse Successful response from the function call. For example, you could store the payload object in this value.

Example

Called by the AlarmChangeEvent flow action

TMFTopicEventAPIUtilOOB - processAlarmCreateEvent(Object eventAlarmObject)

Starts the process of creating a record in the Event [em_event] table when the eventType is set to AlarmCreateNotification.

This function is called by the AlarmCreateEvent flow action. You can change the functionality of this function by overriding the default functionality in the TMFTopicEventAPIUtil script include.

Table 17. Parameters
Name Type Description
eventAlarm​Object Object Event create payload to process. The payload should match the schema defined in TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA.
Table 18. Returns
TypeDescription
responseObject Details about the status of the function call.
"responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
responseObject.​responseError Details about any error that occurred during validation.
"responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
responseObject.​responseError.​details Any additional information to pass back to the calling routine.
For example:
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.​errorMessage Error message that describes the error that occurred. The available error messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​responseError.​errorReason Reason why the endpoint failed. The available error reasons are defined in the TMFAlarmAPIConstants script include.
responseObject.​status Status of the function call. The available status messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​successResponse Successful response from the function call. For example, you could store the payload object in this value.

Example

Called by AlarmCreateEvent flow action.

TMFTopicEventAPIUtilOOB - processDeleteAlarmEvent(Object deleteAlarmPayload)

Starts the process of clearing the alarm event in the Event [em_event] table when the eventType is set to AlarmDeleteNotification.

This function clears the state field and closes the event alarm. It also updates any parameters in the passed payload.

This function is called by the AlarmDeleteEvent flow action. You can change the functionality of this function by overriding the default functionality in the TMFTopicEventAPIUtil script include.

Table 19. Parameters
Name Type Description
deleteAlarm​Payload Object Event delete payload to process. The payload should match the schema defined in TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA.
Table 20. Returns
TypeDescription
responseObject Details about the status of the function call.
"responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
responseObject.​responseError Details about any error that occurred during validation.
"responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
responseObject.​responseError.​details Any additional information to pass back to the calling routine.
For example:
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.​errorMessage Error message that describes the error that occurred. The available error messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​responseError.​errorReason Reason why the endpoint failed. The available error reasons are defined in the TMFAlarmAPIConstants script include.
responseObject.​status Status of the function call. The available status messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​successResponse Successful response from the function call. For example, you could store the payload object in this value.

Example

Called by AlarmDeleteEvent flow action.

TMFTopicEventAPIUtilOOB - transformAndPersistChangeEvent(Object additionalInfoObj, GlideRecord existingGr)

Transforms the passed in change event payload using the associated change event mapping values and stores the updated information in the passed GlideRecord within the Event [em_event] table.

This function is called by the processAlarmChangeEvent() function as part of the flow action. You can change the functionality of this function by overriding the default functionality in the TMFTopicEventAPIUtil script include.

Table 21. Parameters
Name Type Description
additional​InfoObj Object Payload to use to update the fields in the record specified in the existingGr parameter. The payload should match the schema defined in TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA.
existingGr GlideRecord GlideRecord of the event record in the Event [em_event] table to update.
Table 22. Returns
Type Description
String Unique ID (Message key) of the event.

Example

This function is only called by the AlarmChangeEvent flow action, so no code example is provided.

TMFTopicEventAPIUtilOOB - transformAndPersistAlarmCreateEvent(Object alarmObject)

Transforms the passed in create event payload using the associated create event mapping values and stores the information in Event [em_event] table.

This function is called by the processAlarmCreateEvent() function as part of the flow action. You can change the functionality of this function by overriding the default functionality in the TMFTopicEventAPIUtil script include.

Table 23. Parameters
Name Type Description
alarmObject Object Payload to use to create a record in the Event [em_event] table. The payload should match the schema defined in TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA.
Table 24. Returns
Type Description
String Unique ID (Message key) of the event.

Example

This function is only called by the AlarmCreateEvent flow action, so no code example is provided.

TMFTopicEventAPIUtilOOB - transformAndPersistDeleteEvent(Object additionalInfoObj GlideRecord existingGr)

Transforms the passed in delete (clear) event payload using the associated delete event mapping values and stores the updated information in the passed GlideRecord within the Event [em_event] table.

This function is called by the >processAlarmDeleteEvent() function as part of the flow action. You can change the functionality of this function by overriding the default functionality in the TMFTopicEventAPIUtil script include.

Table 25. Parameters
Name Type Description
additional​InfoObj Object Payload to use to update the clear event fields in the record specified in the existingGr parameter. The payload should match the schema defined in TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA.
existingGr GlideRecord GlideRecord of the event record in the Event [em_event] table for which to clear the alarm.
Table 26. Returns
Type Description
String Unique ID (Message key) of the event.

Example

This function is only called by the AlarmDeleteEvent flow action, so no code example is provided.

TMFTopicEventAPIUtilOOB - validateSubscription(Object eventAlarmObject, Object responseObject)

Performs validation on the subscription.

This validation includes checking if the callback URL used to make the event notification and the eventType in the payload are registered.

This function is called by the processAlarmCreateEvent(), processChangeAlarm(), and processDeleteAlarmEvent() functions. You can change the functionality of this function by overriding the default functionality in the TMFTopicEventAPIUtil script include.

Table 27. Parameters
NameTypeDescription
eventAlarm​Object Object Event payload to validate. The format of this payload should correlate to the event type that is being processed. The schemas for these payloads are defined in the TMFAlarmAPIConstants script include.
responseObject Object Empty response object. Use this object to record any issues with the verification of the payload schema.
Data type: Object
"responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
responseObject.​status String Status of the function call. The available status messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​successResponse Object Successful response from the function call. For example, you could store the payload object in this value.
responseObject.​responseError Object Details about any error that occurred during validation.
"responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
responseObject.​responseError.​details Array Any additional information to pass back to the calling routine.
For example:
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.​errorMessage String Error message that describes the error that occurred. The available error messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​responseError.​errorReason String Reason why the endpoint failed. The available error reasons are defined in the TMFAlarmAPIConstants script include.
Table 28. Returns
TypeDescription
responseObject Details about the status of the function call.
"responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
responseObject.​responseError Details about any error that occurred during validation.
"responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
responseObject.​responseError.​details Any additional information to pass back to the calling routine.
For example:
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.​errorMessage Error message that describes the error that occurred. The available error messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​responseError.​errorReason Reason why the endpoint failed. The available error reasons are defined in the TMFAlarmAPIConstants script include.
responseObject.​status Status of the function call. The available status messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​successResponse Successful response from the function call. For example, you could store the payload object in this value.

Example

This function is only called by the AlarmCHANGEEvent flow action, so no code example is provided.

TMFTopicEventAPIUtilOOB - verifyAlarmChangeEventPayload(Object changeAlarmPayload, Object responseObject )

Provides the ability to define additional verification of the passed in change event payload.

This function is called by the processAlarmChangeEvent() function as part of the flow action. Currently there is no additional payload verification provided for the change payload. You can add functionality for this function by overriding the default functionality in the TMFTopicEventAPIUtil script include.

Table 29. Parameters
NameTypeDescription
changeAlarm​Payload Object Payload to verify. Payload should match the schema defined in TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA.
responseObject Object Empty response object. Use this object to record any issues with the verification of the payload schema.
Data type: Object
"responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
responseObject.​responseError Object Details about any error that occurred during validation.
"responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
responseObject.​responseError.​details Array Any additional information to pass back to the calling routine.
For example:
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.​errorMessage String Error message that describes the error that occurred. The available error messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​responseError.​errorReason String Reason why the endpoint failed. The available error reasons are defined in the TMFAlarmAPIConstants script include.
responseObject.​status String Status of the function call. The available status messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​successResponse Object Successful response from the function call. For example, you could store the payload object in this value.
Table 30. Returns
TypeDescription
responseObject Details about the status of the function call.
"responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
responseObject.​responseError Details about any error that occurred during validation.
"responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
responseObject.​responseError.​details Any additional information to pass back to the calling routine.
For example:
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.​errorMessage Error message that describes the error that occurred. The available error messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​responseError.​errorReason Reason why the endpoint failed. The available error reasons are defined in the TMFAlarmAPIConstants script include.
responseObject.​status Status of the function call. The available status messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​successResponse Successful response from the function call. For example, you could store the payload object in this value.

Example

 // 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)

Provides the ability to define additional verification of the passed in create event payload.

This function is called by the processAlarmCreateEvent() function as part of the flow action. Currently there is no additional payload verification provided for the create payload. You can add functionality for this function by overriding the default functionality in the TMFTopicEventAPIUtil script include.

Table 31. Parameters
NameTypeDescription
alarmPayload Object Payload to verify. Payload should match the schema defined in TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA.
responseObject Object Empty response object. Use this object to record any issues with the verification of the payload schema.
Data type: Object
"responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
responseObject.​status String Status of the function call. The available status messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​successResponse Object Successful response from the function call. For example, you could store the payload object in this value.
responseObject.​responseError Object Details about any error that occurred during validation.
"responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
responseObject.​responseError.​details Array Any additional information to pass back to the calling routine.
For example:
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.​errorMessage String Error message that describes the error that occurred. The available error messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​responseError.​errorReason String Reason why the endpoint failed. The available error reasons are defined in the TMFAlarmAPIConstants script include.
Table 32. Returns
TypeDescription
responseObject Details about the status of the function call.
"responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
responseObject.​responseError Details about any error that occurred during validation.
"responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
responseObject.​responseError.​details Any additional information to pass back to the calling routine.
For example:
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.​errorMessage Error message that describes the error that occurred. The available error messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​responseError.​errorReason Reason why the endpoint failed. The available error reasons are defined in the TMFAlarmAPIConstants script include.
responseObject.​status Status of the function call. The available status messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​successResponse Successful response from the function call. For example, you could store the payload object in this value.

Example

// 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)

Provides the ability to define additional verification of the passed in delete event payload.

This function is called by the processDeleteAlarmEvent() function as part of the flow action. Currently there is no additional payload verification provided for the delete payload. You can add functionality for this function by overriding the default functionality in the TMFTopicEventAPIUtil script include.

Table 33. Parameters
NameTypeDescription
deleteAlarm​Payload Object Payload to verify. Payload should match the schema defined in TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA.
responseObject Object Empty response object. Use this object to record any issues with the verification of the payload schema.
Data type: Object
"responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
responseObject.​status String Status of the function call. The available status messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​successResponse Object Successful response from the function call. For example, you could store the payload object in this value.
responseObject.​responseError Object Details about any error that occurred during validation.
"responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
responseObject.​responseError.​details Array Any additional information to pass back to the calling routine.
For example:
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.​errorMessage String Error message that describes the error that occurred. The available error messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​responseError.​errorReason String Reason why the endpoint failed. The available error reasons are defined in the TMFAlarmAPIConstants script include.
Table 34. Returns
TypeDescription
responseObject Details about the status of the function call.
"responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
responseObject.​responseError Details about any error that occurred during validation.
"responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
responseObject.​responseError.​details Any additional information to pass back to the calling routine.
For example:
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.​errorMessage Error message that describes the error that occurred. The available error messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​responseError.​errorReason Reason why the endpoint failed. The available error reasons are defined in the TMFAlarmAPIConstants script include.
responseObject.​status Status of the function call. The available status messages are defined in the TMFAlarmAPIConstants script include.
responseObject.​successResponse Successful response from the function call. For example, you could store the payload object in this value.

Example

// Apply customized validations if applicable, defaults to no error
var deletePayloadResponse = this.verifyDeleteEventPayload(deleteAlarmPayload, this.responseObject);
if (!gs.nil(deletePayloadResponse.responseError.errorMessage))
  return deletePayloadResponse;