Windows Scheduled Task

PreviousWindows Component NextWindows Service

Last updated 10 months ago

Was this helpful?

List

Retrieve Windows Scheduled Task

GET/api/AVD/Template/{id}/Optimization/WindowsScheduledTask

Path parameters

id*integer (int32)

The ID of the optimization setting to retrieve the windows scheduled task.

Response

Success

Body

tasknullable string

Scheduled Task

locationnullable string

Scheduled Task Location

typeenum

Whether file type is a folder or a task.

0 = Folder,1 = Task

Request

const response = await fetch('/api/AVD/Template/{id}/Optimization/WindowsScheduledTask', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "task": "text",
    "location": "text",
    "type": [
      "0 = Folder",
      "1 = Task"
    ]
  }
]

Add

Adds a Windows Scheduled task to optimization.

POST/api/AVD/Template/{id}/Optimization/WindowsScheduledTask

Path parameters

id*integer (int32)

The ID of the Optimization settings to retrieve the windows scheduled task.

Body

Windows Scheduled Task Settings.

task*nullable string

Scheduled Task Name

location*nullable string

Scheduled Task Location

Response

Created

Request

const response = await fetch('/api/AVD/Template/{id}/Optimization/WindowsScheduledTask', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "task": "text",
      "location": "text"
    }),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Delete

Removes Windows Scheduled Task From Optimization.

DELETE/api/AVD/Template/{id}/Optimization/WindowsScheduledTask

Path parameters

id*integer (int32)

The ID of the optimization setting to remove the windows scheduled task.

Body

Windows Scheduled Task Settings

task*nullable string

Scheduled Task

location*nullable string

Scheduled Task Location

Response

No Content

Request

const response = await fetch('/api/AVD/Template/{id}/Optimization/WindowsScheduledTask', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "task": "text",
      "location": "text"
    }),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}