HideTasks
HTTP Request Formats
POST api/task/Hide
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/task/Hide
Description
The HideTasks REST API command can be used to either Hide or Unhide specified tasks or all assigned tasks. Tasks may be specified by either their name or group membership.
Parameters
| JSON Parameters | Body Format | Description |
|---|---|---|
| Id | "Id" : "Task1" | Parameter is a string of a single task name. Wildcards are allowed |
| IdList | "IdList": ["Task1","Task2","Task3"] | Parameter is a list of strings of task names. Wildcards are allowed |
| All | "All : "TRUE" | Optional boolean will hide all tasks within the schedule |
| Groups | "Groups" : ["TaskGroup1","TaskGroup2"] | Parameter is list of strings of task group names. Wildcards are allowed |
| Hide | "Hide" : "TRUE" | Boolean to determine if tasks should be hidden ("TRUE") or unhidden ("FALSE"). This parameter is required in all requests |
Examples
Hides tasks called DemoTask1 and DemoTask2
POST api/task/Hide
Body:
{
"IdList" : ["DemoTask1","DemoTask2"],
"Hide" : "TRUE"
}
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
