ManageEngine® SQLDBManager Plus


Edit Downtime Scheduler Tasks

<< Prev

Home

Next >>

EditMaintenanceTask API

 

This API allows the user to edit downtime schedules in SQLDBManagerPlus. Users can edit schedules with the following recurring types:

Editing Downtime Schedule with Recurring type Daily

Sample Request:

http://[Host]:[Port]/AppManager/xml/EditMaintenanceTask?apikey=[APIKEY]&taskMethod=[TASKMETHOD]&taskStartTime=[TASKSTARTTIME]
&taskEndTime=[TASKENDTIME]&taskStatus=[TASKSTATUS]&taskEffectFrom=[TASKEFFECTFROM]&taskName=[TASKNAME]&taskType=[TASKTYPE]
&resourceid=[RESOURCEID]&taskid=[TASKID]

Request Parameters

The parameters involved in the API request are described below. Also, refer the list of common Request Parameters involved in executing the EditMaintenanceTask API requests.

 

Field Description        
taskMethod Denotes the recurring frequency of the maintenance schedule, 'daily' indicates the schedule runs every day.
taskStartTime The time when the maintenance task starts running
taskEndTime The time when the maintenance task stops running
taskEffectFrom The date and time from which the maintenance task becomes active

 

 

Example:

http://sqldbm-windows:9433/AppManager/xml/EditMaintenanceTask?apikey=095cb3835ff015b01a3b3a6c4ab2c38a&taskMethod=daily
&taskStartTime=20:00&taskEndTime=21:00&taskStatus=enable&taskEffectFrom=2010-06-05%2016:48&taskName=june4a
&taskType=monitor&resourceid=10000059&taskid=10000003

Example output:

 

<AppManager-response uri="/AppManager/xml/EditMaintenanceTask">
   <result>
      <response response-code="4000">
         <message>Maintenance Task successfully edited.</message>
      </response>
   </result>
</AppManager-response>

 

Top

Editing Downtime Schedule with Recurring type Weekly

Sample Request:

http://[Host]:[Port]/AppManager/xml/EditMaintenanceTask?apikey=[APIKEY]&taskType=[TASKTYPE]&resourceid=[RESOURCEID]&totalNumber=[TOTALNUMBER]
&taskMethod=[TASKMETHOD]&taskDescription=[TASKDESCRIPTION]&taskStatus=[TASKSTATUS]&taskEffectFrom=[DATETIME]&startDay1=[STARTDAY1]
&startTime1=[STARTTIME1]&endDay1=[ENDDAY1]&endTime1=[ENDTIME1]&taskName=[TASKNAME]&taskid=[TASKID]

Request Parameters


The parameters involved in the API request are described below. Also, refer the list of common Request Parameters involved in executing the EditMaintenanceTask API requests.

 

Field Description        
totalNumber The number of schedules to be created. You can create a maximum of 7 weekly schedules
taskMethod Denotes the recurring frequency of the maintenance schedule, 'weekly' indicates the schedule runs every week.
taskDescription The description of what the maintenance schedule does, optional value.
taskEffectFrom The date and time from which the maintenance task becomes active
startDay[n] The day on which the maintenance task starts running. The allowed values for n are 1,2,3,4,5,6 and 7
startTime[n] The time when the maintenance task starts running. The allowed values for n are 1,2,3,4,5,6 and 7
endDay[n] The day on which the maintenance task stops running. The allowed values for n are 1,2,3,4,5,6 and 7
endTime[n] The time at which the maintenance task stops running. The allowed values for n are 1,2,3,4,5,6 and 7

 

Example:

http://sqldbm-windows:9433/AppManager/xml/EditMaintenanceTask?apikey=095cb3835ff015b01a3b3a6c4ab2c38a&taskType=monitor
&resourceid=10000028&totalNumber=1&taskMethod=weekly&taskDescription=&taskStatus=enable&taskEffectFrom=2010-06-01%2011:25
&startDay1=tuesday&startTime1=10:00&endDay1=friday&endTime1=12:00&taskName=week1&taskid=10000004

Top

Downtime Schedule with Recurring type Once

Sample Request:

http://[Host]:[Port]/AppManager/xml/EditMaintenanceTask?apikey=[APIKEY]&taskMethod=[TASKMETHOD]&customTaskStartTime=[CUSTOMTASKSTARTTIME]
&customTaskEndTime=[CUSTOMTASKENDTIME]&taskStatus=[TASKSTATUS]&taskName=[TASKNAME]&taskType=[TASKTYPE]
&taskDescription=[TASKDESCRIPTION]&resourceid=[RESOURCEID]&taskid=[TASKID]

Request Parameters

The parameters involved in the API request are described below:

 

Field Description        
taskMethod Denotes the recurring frequency of the maintenance schedule, 'weekly' indicates the schedule runs every week.
customTaskStartTime The date and time when the schedule starts running
customTaskEndTime The date and time when the schedule stops running
taskDescription The description of what the maintenance schedule does. This parameter is optional.

 

Example:

 

http://sqldbm-windows:9433/AppManager/xml/EditMaintenanceTask?apikey=095cb3835ff015b01a3b3a6c4ab2c38a&taskMethod=once
&customTaskStartTime=2010-06-03%2012:46&customTaskEndTime=2010-06-05%2012:46&taskStatus=enable&taskName=once1
&taskType=monitor&taskDescription=&resourceid=10000322&taskid=10000005

 

 

Top

 

 

<< Prev

Home

Next >>

Delete Downtime Scheduler Tasks

List Downtime Scheduler Tasks