REST API - set
  1. Operations
  2. vcenter
  3. system
  4. announcements

vcenter system announcements: set

Set announcement properties.

Request:

HTTP request

PUT https://{server}/rest/vcenter/system/announcements/{announcement}

Path Parameters

Name Type Description
Required
announcement string Identifier of the announcement. If such identifier exists then the object will be updated with the new values. If such identifier doesn't exist a new object with this identifier will be created.

Request Body Structure:

{
    "spec" : {
        "severity" : "CRITICAL",
        "expires_at" : "2015-01-01T22:13:05.651Z",
        "message" : {
            "args" : [
                "string",
                "string"
            ],
            "default_message" : "string",
            "localized" : "string",
            "id" : "string",
            "params" : [
                {
                    "value" : {
                        "dt" : "2015-01-01T22:13:05.651Z",
                        "s" : "string",
                        "d" : 1.5,
                        "precision" : 1,
                        "format" : "SHORT_DATE",
                        "i" : 1,
                        "l" : {
                            "id" : "string",
                            "params" : [
                                {
                                    "value" : {
                                        "dt" : "2015-01-01T22:13:05.651Z",
                                        "s" : "string",
                                        "d" : 1.5,
                                        "precision" : 1,
                                        "format" : "SHORT_DATE",
                                        "i" : 1,
                                        "l" : {
                                            "id" : "string",
                                            "params" : [
                                                {
                                                    "key" : "string"
                                                }
                                            ]
                                        }
                                    },
                                    "key" : "string"
                                }
                            ]
                        }
                    },
                    "key" : "string"
                }
            ]
        }
    }
}

Request Body Parameters:

Name Type Description
bold = required
spec spec Spec structure defining the announcement properties.
spec.message localizable_message Message to display
spec.message.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
spec.message.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
spec.message.args string[] Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments.
spec.message.params list Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.0.

Optional. Unset means that the message template requires no arguments or positional arguments are used.
spec.message.localized string Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0.0.

Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources.
spec.severity string Message severity

Defines the severity of the announcements. Value is one of:
CRITICAL: Critical problem.
WARNING: Warning.
INFO: Information.
spec.expires_at date_time Date and time when the announcement will expire

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
500 error Generic error