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.
Properties
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.
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.
A unique identifier for the advisory (read-only).
A localized message for this advisory.
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)
Represents where the advisory is being generated from. This is a read-only field. Can be of type USER or INTERNAL.
The id reference to the target entity this advisory is for.
JSON Example
{
"displayEnd": "string",
"displayStart": "string",
"id": "string",
"message": "string",
"priority": "string",
"source": "string",
"targetId": "string"
}
Vendor Extensions
x-vcloud-property-annotations:
id:
x-vcloud-constraints:
- args:
- arg: advisory
constraint: Urn
- constraint: NonSortable
- constraint: ReadOnly
message:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
source:
x-vcloud-constraints:
- constraint: ReadOnly
targetId:
x-vcloud-constraints:
- args:
- arg: org
- arg: site
constraint: Urn
Availability
Property Of
InlineAdvisories1
Parameter To
Update Advisory
Returned By
Get Advisory
Update Advisory
Used By
AdvisoryDefinition
