External Task

Lock an external task by a given id for a specified worker and amount of time.

post/external-task/{id}/lock

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/external-task/{id}/lock
  • Auth: HTTP basic

Path parameters

idstring required

The id of the external task.

Request body

lockDurationinteger

The duration to lock the external task for in milliseconds. Note: Attempting to lock an already locked external task with the same workerId will succeed and a new lock duration will be set, starting from the current moment.

workerIdstring

Mandatory. The ID of the worker who is performing the operation on the external task. If the task is already locked, must match the id of the worker who has most recently locked the task.

Response

Request successful.

Changes

No recorded changes to this operation across all 1 revision of this API.