[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Update Advisory

Description

Updates an advisory for the active session using a specified id. Advisories that have a MANDATORY priority may not be updated.

Request

Request

URL

URL


put
https://{api_host}/cloudapi/1.0.0/advisories/{advisoryId}
Copy

Path Parameters

Path Parameters

string
advisoryId Required

advisory URN


Request Body

Request Body

Advisory of type(s) application/json Required
{
	"displayEnd": "string",
	"displayStart": "string",
	"id": "string",
	"message": "string",
	"priority": "string",
	"source": "string",
	"targetId": "string"
}
string as date-time
displayEnd Optional

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 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
id Optional

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


string
message Optional

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
source Optional

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


string
targetId Optional

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

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns Advisory of type(s) application/json;version=37.0
{
	"displayEnd": "string",
	"displayStart": "string",
	"id": "string",
	"message": "string",
	"priority": "string",
	"source": "string",
	"targetId": "string"
}
string as date-time
displayEnd Optional

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 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
id Optional

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


string
message Optional

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
source Optional

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


string
targetId Optional

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

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"displayEnd":"string","displayStart":"string","id":"string","message":"string","priority":"string","source":"string","targetId":"string"}' https://{api_host}/cloudapi/1.0.0/advisories/{advisoryId}


[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Feedback

Was this page helpful?