EditTask

HTTP Request Format

PATCH api/task/{taskName}

To specify the schedule the command shall be sent to:

PATCH api/schedule/{scheduleName}/task/{taskName}

Description

The EditTask REST API command edits the attributes of a task in Astro Scheduler Engine. This command can be used to edit a single task attribute or multiple attributes of a single task. When editing multiple task attributes, all attributes will be applied to the task in the order in which they appear in the command with four exceptions. The Locked, Deferred, Assignmentsand OperationalStatus keywords get applied in the order listed here after all other keywords get applied.

All tasks are initially created with default attribute values unless otherwise specified.

Anytime a parent definition is edited, it will cause its children to be recreated. The newly created children will not have any assignments until the schedule is deconflicted.

The order of keywords should follow the order shown in the command description table below, as this follows the GUI field ordering and the order necessary for proper task creation.

Examples

Changes the values of the Description, Priority, and RecurringDiscreteWindows attributes of the SSRDump task in the active schedule to "This is a test", 7, and 2002/05/20 12:00:00.456 2002/05/20 12:52:00 "Demo comment", respectively

PATCH api/task/SSRDump

Body:

{

"Description" : "This is a test",

"Priority" : "7",

"RecurringDiscreteWindows" : {

"Start" : "2002/05/20_12:00:00.456"

"Stop" : "2002/05/20_12:52:00",

"Comment" : "Demo comment" }

}

Return Message

If activated, a standard response for a successful HTTP response shall appear.

Group Membership

This command belongs to the following group(s):

Scheduler

Version

12.3