Optional options: { Optional config?: DeepPartial<CamundaPlatform8Configuration>Optional oconst tasklist = new TasklistApiClient()
const tasks = await tasklist.getTasks({ state: TaskState.CREATED })
Private oPrivate restPrivate userOptional allowOptional assignee?: stringAssign a task with taskId to assignee or the active user.
Status 400 - An error is returned when the task is not active (not in the CREATED state). Status 400 - An error is returned when task was already assigned, except the case when JWT authentication token used and allowOverrideAssignment = true. Status 403 - An error is returned when user doesn't have the permission to assign another user to this task. Status 404 - An error is returned when the task with the taskId is not found.
Optional variables: JSONDocComplete a task with taskId and optional variables
Status 400 An error is returned when the task is not active (not in the CREATED state).
Status 400 An error is returned if the task was not claimed (assigned) before.
Status 400 An error is returned if the task is not assigned to the current user.
Status 403 User has no permission to access the task (Self-managed only).
Status 404 An error is returned when the task with the taskId is not found.
Private getReturn a task by id, or throw if not found.
Will throw if no task of the given taskId exists
https://docs.camunda.io/docs/apis-clients/tasklist-api/queries/variable/
Throws 404 if no variable of the id is found
Optional includeOptional variableThis method returns a list of task variables for the specified taskId and variableNames. If the variableNames parameter is empty, all variables associated with the task will be returned.
Private replaceQuery Tasklist for a list of tasks. See the API documentation.
Status 400 - An error is returned when more than one search parameters among [searchAfter, searchAfterOrEqual, searchBefore, searchBeforeOrEqual] are present in request
const tasklist = new TasklistApiClient()
async function getTasks() {
const res = await tasklist.searchTasks({
state: TaskState.CREATED
})
console.log(res ? 'Nothing' : JSON.stringify(res, null, 2))
return res
}
Unassign a task with taskId
Status 400 An error is returned when the task is not active (not in the CREATED state).
Status 400 An error is returned if the task was not claimed (assigned) before.
Status 404 An error is returned when the task with the taskId is not found.
Generated using TypeDoc
Description
The high-level client for the Tasklist REST API
Example