LockTasks
HTTP Request Formats
POST api/task/Lock
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/task/Lock
Description
The LockTasks REST API command can be used to either Lock or UnLock specified tasks or all assigned tasks. Tasks may be specified either by their name, priority value, group membership, or by their assigned time.
Parameters
Only the "Lock" parameter is required.
| JSON Parameters | Body Format | Description |
|---|---|---|
| Lock | "Lock" : "TRUE" | Lock is a boolean that defines if tasks should be locked (TRUE)or unlocked (FALSE). This parameter is required |
| TaskIDList | "TaskIDList": ["Task1","Task2","Task3"] | The TaskIDList is a comma delimited list of tasks. |
| GroupIDList | "GroupIDList": "Group1,Group2,Group3" | GroupIDList is a comma delimited list of task group names. |
| All | "All" : "TRUE" | All is a boolean that defines that all tasks in the schedule will be locked/unlocked |
| MinPriority MaxPriority | "MinPriority": "1" "MaxPriority": "10" | Min Priority is the minimum priority value for tasks that will be effected by this command. -1
may be used to specify that there is no lower boundary. Max Priority is the maximum priority value for tasks that will be effected by this command. -1 may be used to specify that there is no upper boundary. |
| StartTime StopTime | "StartTime" : "YYYY/MM/DD_HH:MM:SS" "StopTime" : "YYYY/MM/DD_HH:MM:SS" | Start Time is the beginning of the time window that will be used to specify tasks that will be
affected by this command. Stop Time is the end of the time window used to specify tasks that will be affected by this command. Any assigned tasks that fall partially or entirely between the defined Start and Stop Times will be affected. Time Formats are YYYY/MM/DD_HH:MM:SS , YYYY/MM/DD_HH:MM:SS.fff, YYYY-DDD_HH:MM:SS, or YYYY-DDD_HH:MM:SS.fff |
Examples
Locks tasks called: DemoTask1 and DemoTask2
POST api/task/Lock
Body:
{
"Lock" : "TRUE",
"TaskIDList" : ["DemoTask1","DemoTask2"]
}
Return Message
If activated, a standard response for a successful HTTP response shall appear.
Group Membership
This command belongs to the following group(s):
Version
12.3
