SettingsNotification

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


Properties

string
id Required

The notification id.


message Required

The notification message.


string
originator Optional

The originator of the notification. Only set if there is an originator available for this notification.


resolution Optional

The resolution message, if any. Only set if there is a resolution available for this notification.


boolean
retriable Optional

Indicates whether the error is retriable. Only set for the notification when a retriable error was reported by the task.


string as date-time
time Required

The time the notification was raised/found.


type Optional

The (@name Type} enumerated type contains the possible different types of notification.
INFO :
WARNING :
ERROR :

Possible values are: INFOWARNINGERROR

JSON Example

{
	"id": "string",
	"message": {
		"args": [
			"string"
		],
		"default_message": "string",
		"id": "string"
	},
	"time": "string"
}

Feedback

Was this page helpful?