call(action, args)

Signature

public Object call(String action, Map<String, Object> args)

Parameters

action

Type: String

The action to call. The value must be one of the following:

• getAlertsByWhatId — Returns all active Record Alerts with the specified Id, where SnoozeUntilDate < now < ValidUntilDate.
• getAlertsByWhatIdBatch — Returns all active record alerts with one of the specified Ids, where SnoozeUntilDate < now < ValidUntilDate.
• snoozeAlert — Snoozes the Record Alert with the specified Id until the snoozeUntilDate value.
• dismissAlert — Dismisses the record alert with the specified Id by setting the isActive field to false.

args

Type: Map<String, Object>

The arguments passed to the corresponding action:

• getAlertsByWhatId

  • String Id — The Id of the what Id field to fetch Record alerts.

  • boolean IsFSC — Set to true to group results by Financial Account and Record Alert Category.

  • int Limit — Maximum number of alerts to return. Allowed values are 1-20.

  • int childLimit — Maximum number of aggregated alerts to return. Allowed values are 1-10.

• getAlertsByWhatIdBatch

  • List<String> Ids — The Ids of the what Id field to fetch Record alerts.

  • boolean IsFSC — Set to true to group results by Financial Account and Record Alert Category.

  • int Limit — Maximum number of alerts to return. Allowed values are 1-20.

  • int childLimit — Maximum number of aggregated alerts to return. Allowed values are 1-10.

• snoozeAlert

  • String Id — The id of the Record Alert to snooze.

  • Date snoozeUntilDate — The date at which the Record Alert is no longer snoozed.

• dismissAlert
  • String Id — The id of the record alert to dismiss.

Return Value

The data returned by getAlertsByWhatId and getAlertsByWhatIdBatch looks like this:

{
  "numAlerts": 2,
  "groupedAlerts": [
    {
      "Subject": "Sample Alert",
      "Description": "Sample Description",
      "WhatId": "0x0000002c4d4eM",
      "StartDate": "2022-11-30T15:05:47",
      "ValidUntilDate": "2023-11-30T15:05:47",
      "SnoozeUntilDate": "2022-12-05T15:05:47"
    }
  ],
  "alerts": [
    {
      "Subject": "Sample Alert",
      "Description": "Sample Description",
      "WhatId": "0x0000002c4d4eM",
      "StartDate": "2022-11-30T15:05:47",
      "ValidUntilDate": "2023-11-30T15:05:47",
      "SnoozeUntilDate": "2022-12-05T15:05:47"
    }
  ]
}

Usage

To use this class in an Integration Procedure, specify the class in the Remote Class property, the action in the Remote Method property, and the arguments in the Additional Input property.