LockTaskAssignments
HTTP Request Formats
POST api/task/assignment/Lock
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/task/assignment/Lock
Description
The LockTaskAssignments REST API command can be used to either Lock or Unlock assignments on a task.
Parameters
All parameters are required.
| JSON Parameters | Body Format | Description |
|---|---|---|
| TaskId | "TaskId": "DemoTask1" | TaskId determines the task whose assignments will be modified. This parameter is required |
| Lock | "Lock": "TRUE" | Lock is a boolean that defines if the task assignments should be locked (TRUE) or unlocked (FALSE). This parameter is required |
| AssignmentIDList | "AssignmentIDList": ["1","3"] | The AssignmentIDList is a comma delimited list of assignments within the task. Either this parameter or All must be included. |
| All | "All": "TRUE" | All is a boolean that determines if all of the task's assignments should be modified. Either this paramter or AssignmentIDList must be included. |
Examples
Locks all assignments on task DemoTask1
POST api/task/assignment/Lock
Body:
{
"TaskId" : "DemoTask1",
"Lock" : "TRUE",
"All" : "TRUE"
}
Unlocks one assignment on task DemoTask1
POST api/task/assignment/Lock
Body:
{
"TaskId" : "DemoTask1",
"Lock" : "FALSE",
"AssignmentIDList" : ["1"]
}
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.6
