REST API - notification

appliance infraprofile: notification

The notification structure contains fields to describe any info/warning/error messages that Tasks can raise.

Representation:

JSON
LEGACY JSON

{
    "notification" : "obj-103",
    "time" : "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"
            }
        ]
    },
    "resolution" : {
        "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"
            }
        ]
    }
}

Attributes:

Name	Type	Description
Required
-.notification	string	The notification id. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.infraprofile.notification`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.infraprofile.notification`.
-.message	localizable_message	The notification message.
-.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.
-.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.
-.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.
-.resolution.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.
-.resolution.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.
-.resolution.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.
Optional
-.time	date_time	The time the notification was raised/found. Optional. Only set if the time information is available.
-.message.params	object	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.
-.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.
-.resolution	localizable_message	The resolution message, if any. Optional. Only set for warnings and errors.
-.resolution.params	object	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.
-.resolution.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.

Attributes:

Name	Type	Description
Required
notification	string	The notification id. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.infraprofile.notification`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.infraprofile.notification`.
message	localizable_message	The notification message.
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.
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.
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.
resolution.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.
resolution.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.
resolution.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.
Optional
time	date_time	The time the notification was raised/found. Optional. Only set if the time information is available.
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.
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.
resolution	localizable_message	The resolution message, if any. Optional. Only set for warnings and errors.
resolution.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.
resolution.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.