Description | Example | Return Message | Group(s)

LockSingleAssignment

HTTP Request Formats

POST api/task/{taskID}/assignment/{assignmentID}/Lock

To specify the schedule the command shall be sent to:

POST api/schedule/{scheduleName}/task/{taskID}/assignment/{assignmentID}/Lock

Description

The LockSingleAssignment REST API command locks or unlocks a single assignment 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).

Examples

Locks an assignment with an ID of 1 for a task named DemoTask

POST api/task/DemoTask/assignment/1/Lock

Body:

{

"Lock" : true

}

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):

Scheduler

Version

12.5