Package org.alfresco.rest.requests

Class Task

java.lang.Object
org.alfresco.rest.requests.ModelRequest<Task>
org.alfresco.rest.requests.Task
public class Task extends ModelRequest<Task>

  • Constructor Details

    • Task

      public Task(RestWrapper restWrapper)

    • Task

      public Task(RestWrapper restWrapper, org.alfresco.utility.model.TaskModel task)

  • Method Details

    • getTasks

      public RestTaskModelsCollection getTasks()
      Retrieve a list of tasks visible for the authenticated user using GET call on "/tasks"
      Returns:

    • getTask

      public RestTaskModel getTask()
      Retrieve the tasks identified by taskId using GET call on "/tasks/{taskId}"
      Parameters:
      taskId -
      Returns:

    • updateTask

      public RestTaskModel updateTask(String newStateValue)
      Update task using PUT put /tasks/{taskId} call
      Parameters:
      newStateValue -
      Returns:
      Throws:
      JsonToModelConversionException

    • updateTask

      public RestTaskModel updateTask(jakarta.json.JsonObject inputJson)
      Update task using PUT put /tasks/{taskId} cal
      Parameters:
      inputJson - the json used as input for PUT call
      Returns:

    • getTaskVariables

      public RestVariableModelsCollection getTaskVariables()
      Retrieve the task variables using GET call on "/tasks/{taskId}/variables"
      Parameters:
      taskId -
      Returns:

    • updateTaskVariable

      public RestVariableModel updateTaskVariable(RestVariableModel variableModel)
      Update/Add task variable using PUT put /tasks/{taskId}/variables/{variableName} call
      Parameters:
      taskId -
      variableName -
      Returns:
      Throws:
      JsonToModelConversionException

    • addTaskVariable

      public RestVariableModel addTaskVariable(RestVariableModel variableModel)
      Add task variable using POST /tasks/{taskId}/variables call
      Parameters:
      taskId -
      Returns:
      Throws:
      JsonToModelConversionException

    • addTaskVariables

      public RestVariableModelsCollection addTaskVariables(RestVariableModel... taskVariablesModel)
      Add task variables using POST /tasks/{taskId}/variables call
      Parameters:
      taskId -
      Returns:
      Throws:
      JsonToModelConversionException

    • deleteTaskVariable

      public void deleteTaskVariable(RestVariableModel variableModel)
      Delete task variable using DELETE /tasks/{taskId}/variables/{variableName} call
      Parameters:
      taskId -
      variableName -
      Throws:
      JsonToModelConversionException

    • addTaskItem

      public RestItemModel addTaskItem(org.alfresco.utility.model.FileModel fileModel)
      Add task item using POST /tasks/{taskId}/items
      Parameters:
      processId -
      Returns:
      Throws:
      JsonToModelConversionException

    • addTaskItems

      public RestItemModelsCollection addTaskItems(org.alfresco.utility.model.FileModel... fileModels)
      Add task items using POST /tasks/{taskId}/items
      Parameters:
      fileModels -
      Returns:
      Throws:
      JsonToModelConversionException

    • getTaskItems

      public RestItemModelsCollection getTaskItems()
      Retrieve the task items using GET call on "/tasks/{taskId}/items"
      Parameters:
      taskId -
      Returns:

    • getTaskFormModel

      public RestFormModelsCollection getTaskFormModel()
      Retrieves models of the task form type definition
      Parameters:
      taskModel -
      Returns:

    • deleteTaskItem

      public void deleteTaskItem(RestItemModel itemModel)
      Delete a task item using DELETE call on tasks/{taskId}/items/{itemId}
      Parameters:
      taskId -
      itemId -

    • getTaskCandidates

      public RestCandidateModelsCollection getTaskCandidates()
      Retrieve the task candidates (users and groups) using GET call on "/tasks/{taskId}/candidates"
      Parameters:
      taskId -
      Returns: