Previous page

Next page

Locate page in Contents

Print this page

update

Summary:

Updates an existing task.

Request specification:

Name

Min/Max

Type

Description

update

1..1

 

 

{

 

 

 

task

1..1

taskType

Task definition.

}

 

 

 

Returns:

OK/Errors.

Description:

The update call completely removes the specified task first and then inserts the new values, thus completely replacing the existing task (the task ID is preserved, however). If you would like to update a specific parameter (for example, to disable a task or to change its schedule policy), you will first have to retrieve the entire task definition using the list call. Once you have the original task data, update the parameters in this structure as needed, and then pass the updated structure to the update call.

Example:

<packet xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="4.0.0">

<target>scheduler</target>

<data>

<scheduler>

<update>

<task>

<id>f40d0ba4-e561-4d4a-a1f4-01e0156a91f5</id>

<title>Test-Backup</title>

<triggers>

<trigger xsi:type="daily_triggerType">

<start_time>2007-03-01T00:00:00-0500</start_time>

<end_time>2007-05-01T00:00:00-0500</end_time>

<days_interval>1</days_interval>

</trigger>

</triggers>

<packet>The actual task (XML) goes here</packet>

<disabled>true</disabled>

</task>

</update>

</scheduler>

</data>

</packet>

Please send us your feedback on this help page