LockMultipleAssignments
HTTP Request Formats
POST api/task/{taskID}/assignment/Lock
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/task/{taskID}/assignment/Lock
Description
The LockMultipleAssignments REST API command locks or unlocks all or a subset of the assignments for a task in the active/specified schedule.
Request Body
- Lock: A boolean parameter that defines if assignments should be locked (true) or unlocked (false).
- AssignmentIDList: A comma delimited list of ID integers for the assignments to lock. Either this parameter or the "All" parameter must be included.
- All: A boolean to set in order to lock or unlock all assignments of the specified task. Either this parameter or the "AssignmentIDList" parameter must be included.
Examples
Locks assignments with IDs of 1 and 2 for a task named DemoTask
POST api/task/DemoTask/assignment/Lock
Body:
{
"Lock" : true,
"AssignmentIDList" : [1, 2]
}
Return Message
If successful, a standard response for a successful HTTP response shall be returned.
Group Membership
This command belongs to the following group(s):
Version
12.5
