Windows Scheduled Task

PreviousWindows Component NextWindows Service

Was this helpful?

List

get

Retrieve Default Windows Scheduled Task

Query parameters

siteIdinteger · int32optional

The Site Id of the optimization setting to retrieve the windows scheduled task.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings/Optimization/WindowsScheduledTask'

200

401

404

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

Success

Add

post

Adds a Windows Scheduled task to default optimization.

Query parameters

siteIdinteger · int32optional

The Site Id of the Optimization settings to retrieve the windows scheduled task.

Body

taskstring | nullablerequired

Scheduled Task Name

locationstring | nullablerequired

Scheduled Task Location

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/RDSDefaultSettings/Optimization/WindowsScheduledTask' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "task": "text",
    "location": "text"
  }'

201

401

404

409

No Content

Created

Delete

delete

Removes Default Windows Scheduled Task From Optimization.

Query parameters

siteIdinteger · int32optional

The Site Id of the optimization setting to remove the windows scheduled task.

Body

taskstring | nullablerequired

Scheduled Task

locationstring | nullablerequired

Scheduled Task Location

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/RDSDefaultSettings/Optimization/WindowsScheduledTask' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "task": "text",
    "location": "text"
  }'

204

401

404

No Content