Advisory

Advisory
Advisory

A message specified by a system administrator org administrator. It is to be displayed to users to alert them to general conditions that may affect them.

JSON Example 
{
    "id": "string",
    "targetId": "string",
    "message": "string",
    "priority": "string",
    "displayStart": "string",
    "displayEnd": "string",
    "source": "string"
}
string
id
Optional

A unique identifier for the advisory (read-only).

string
targetId
Required

The id reference to the target entity this advisory is for.

string
message
Required

A localized message for this advisory.

string
priority
Optional

Priority for an advisory that indicates the level of urgency. These priorities are listed in ascending sort order.

  • MANDATORY: A mandatory message which is always displayed; these advisories cannot be snoozed or dismissed (see documentation on displayStart and displayEnd)
  • CRITICAL: A high priority, potentially actionable message which can be snoozed or dismissed
  • IMPORTANT: A potentially actionable message which can be snoozed or dismissed
  • NOTICE: An informational message which can be dismissed (but not snoozed)
string As date-time As date-time
displayStart
Optional

The ISO-8601 timestamp from which this advisory is applicable. Defaults to the server's current time if unspecified. If permissible, users may update this value to a time in the future to snooze this advisory.

string As date-time As date-time
displayEnd
Required

The ISO-8601 timestamp representing when this advisory is no longer applicable. If permissible, users may update this value to a time in the past to dismiss this advisory. The displayEnd timestamp must be >= displayStart.

string
source
Optional

Represents where the advisory is being generated from. This is a read-only field. Can be of type USER or INTERNAL.

Availability
Added in 35.0
Used By
Parameter To
Returned By