Messages

List

Retrieve Auto-upgrade Message(s).

GET/api/VDI/HostPool/{id}/AutoUpgrade/Messages

Path parameters

id*integer (int32)

The ID of the Auto-upgrade setting for which to retrieve the messages.

Response

200401404

Success

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

enabledboolean

Enabled

messageTitlenullable string

Message title

messagenullable string

Message

sendMsgSecsinteger (int32)

Seconds before message is sent

sendMsgWhenSendMsgWhen (enum)

Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.

0 = Before,1 = After

Request

JavaScriptCurlPython

const response = await fetch('/api/VDI/HostPool/{id}/AutoUpgrade/Messages', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

[
  {
    "id": 0,
    "enabled": false,
    "messageTitle": "text",
    "message": "text",
    "sendMsgSecs": 0,
    "sendMsgWhen": [
      "0 = Before",
      "1 = After"
    ]
  }
]

Create

Create an Auto-upgrade Message.

POST/api/VDI/HostPool/{id}/AutoUpgrade/Messages

Path parameters

id*integer (int32)

The ID of the Auto-upgrade setting for which to create the message.

Body

application/json; api-version=1.0

Message settings.

enabledboolean

Whether to enable or disable the message.

messageTitle*nullable string

The title of the message.

message*nullable string

A message that should be sent to users before the job starts.

sendMsgSecsinteger (int32)

Time interval in seconds before the job starts when the message to users should be sent.

sendMsgWhenSendMsgWhen (enum)

Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.

0 = Before,1 = After

Response

201401404

Created

Request

JavaScriptCurlPython

const response = await fetch('/api/VDI/HostPool/{id}/AutoUpgrade/Messages', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "message": "text",
      "messageTitle": "text"
    }),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Get

Retrieve an Auto-upgrade Message.

GET/api/VDI/HostPool/{id}/AutoUpgrade/Messages/{messageId}

Path parameters

id*integer (int32)

The ID of the Auto-upgrade setting for which to retrieve the message.

messageId*integer (int32)

The ID of the message to retrieve.

Response

200401404

Success

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

enabledboolean

Enabled

messageTitlenullable string

Message title

messagenullable string

Message

sendMsgSecsinteger (int32)

Seconds before message is sent

sendMsgWhenSendMsgWhen (enum)

Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.

0 = Before,1 = After

Request

JavaScriptCurlPython

const response = await fetch('/api/VDI/HostPool/{id}/AutoUpgrade/Messages/{messageId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "id": 0,
  "enabled": false,
  "messageTitle": "text",
  "message": "text",
  "sendMsgSecs": 0,
  "sendMsgWhen": [
    "0 = Before",
    "1 = After"
  ]
}

Update

Update an Auto-upgrade Message.

PUT/api/VDI/HostPool/{id}/AutoUpgrade/Messages/{messageId}

Path parameters

id*integer (int32)

The ID of the Auto-upgrade setting for which to modify the message.

messageId*integer (int32)

The ID of the message to modify.

Body

application/json; api-version=1.0

Message settings.

enablednullable boolean

Whether to enable or disable the message.

messageTitlenullable string

The title of the message.

messagenullable string

A message that should be sent to users before the job starts.

sendMsgSecsnullable integer (int32)

Time interval in seconds before the job starts when the message to users should be sent.

sendMsgWhenSendMsgWhen (enum)

Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.

0 = Before,1 = After

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/VDI/HostPool/{id}/AutoUpgrade/Messages/{messageId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Delete

Delete an Auto-upgrade Message by ID.

DELETE/api/VDI/HostPool/{id}/AutoUpgrade/Messages/{messageId}

Path parameters

id*integer (int32)

The ID of the Auto-upgrade setting for which to remove the message.

messageId*integer (int32)

The ID of the message to remove.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/VDI/HostPool/{id}/AutoUpgrade/Messages/{messageId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}