PUT v1/bunits/{bunitId}/datacenters/{dataCenterId}/spservers/{spServerId}/domains/{domainId}/schedules/{scheduleId}
Update a schedule.
(SP)
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
bunitId |
The ID of the business unit of the data center | integer |
Required |
dataCenterId |
The ID of the data center of the server | integer |
Required |
spServerId |
The ID of the server of the domain | integer |
Required |
domainId |
The ID of the domain of the schedule | integer |
Required |
scheduleId |
The ID of the schedule to update | integer |
Required |
Body Parameters
The schedule to update
ScheduleName | Description | Type | Additional information |
---|---|---|---|
Name |
The name of the schedule |
string |
Required. |
Description |
Description of the schedule |
string |
None. |
Domain |
The domain of the schedule |
Domain |
None. |
Action |
Action of the schedule |
Action |
None. |
Objects |
Object of the schedule |
string |
None. |
Options |
Options of the schedule |
string |
None. |
AsNodeNames |
Collection of string |
None. |
|
StartTime |
The time the schedule starts |
date |
None. |
Period |
Period of the schedule |
integer |
None. |
PeriodUnit |
Units of the period |
PeriodUnit |
None. |
Duration |
Duration of the schedule |
integer |
None. |
DurationUnit |
Units of the duration |
DurationUnit |
None. |
Priority |
Priority of the schedule is a number between 1 and 10 with 5 being default that defines the priority when backing up. A schedule with a higher priority will run before one with lower if they have the same start time |
integer |
None. |
DayOfWeek |
The days of the week the schedule will run |
string |
None. |
Monday |
Whether or not schedule runs on mondays |
boolean |
None. |
Tuesday |
Whether or not schedule runs on tuesdays |
boolean |
None. |
Wednesday |
Whether or not schedule runs on wednesdays |
boolean |
None. |
Thursday |
Whether or not schedule runs on thursdays |
boolean |
None. |
Friday |
Whether or not schedule runs on fridays |
boolean |
None. |
Saturday |
Whether or not schedule runs on saturdays |
boolean |
None. |
Sunday |
Whether or not schedule runs on sundays |
boolean |
None. |
Id |
A unique ID for the object. |
integer |
Read-only. |
CreatedDate |
Time and date the object was created. |
date |
Read-only. |
ArchivedDate |
Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate |
date |
Read-only. |
Operations |
Collection of OperationResult |
None. |
Request Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
Response Information
Resource Description
The updated schedule
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.