Package org.bonitasoft.web.client.api

Interface UserTaskApi

    • Method Detail

      • executeUserTask

        void executeUserTask​(String id,
                     Map<String,​Object> body,
                     Boolean assign)
        Execute the UserTask Execute the UserTask. In order to execute a task, the task contract values have to be provided.
        Parameters:
        id - ID of the UserTask to execute (required)
        body - A JSON object matching task contract. Execute a task providing correct contract values. (required)
        assign - if true, assign the task to the current user and execute the task (optional)

      • executeUserTask

        void executeUserTask​(String id,
                     Map<String,​Object> body,
                     Map<String,​Object> queryParams)
        Execute the UserTask Execute the UserTask. In order to execute a task, the task contract values have to be provided. Note, this is equivalent to the other executeUserTask method, but with the query parameters collected into a single Map parameter. This is convenient for services with optional query parameters, especially when used with the UserTaskApi.ExecuteUserTaskQueryParams class that allows for building up this map in a fluent style.
        Parameters:
        id - ID of the UserTask to execute (required)
        body - A JSON object matching task contract. Execute a task providing correct contract values. (required)
        queryParams - Map of query parameters as name-value pairs

        The following elements may be specified in the query map:

        • assign - if true, assign the task to the current user and execute the task (optional)

      • getContextByUserTaskId

        Map<String,​Object> getContextByUserTaskId​(String id)
        Finds the Context by UserTask ID Returns the Context for the given UserTask ID
        Parameters:
        id - ID of the UserTask that has the Context to return (required)
        Returns:
        Map<String, Object>

      • getContractByUserTaskId

        Contract getContractByUserTaskId​(String id)
        Finds the Contract by UserTask ID Returns the Contract for the given UserTask ID
        Parameters:
        id - ID of the UserTask that has the Contract to return (required)
        Returns:
        Contract

      • getUserTaskById

        UserTask getUserTaskById​(String id)
        Finds the UserTask by ID Returns the single UserTask for the given ID
        Parameters:
        id - ID of the UserTask to return (required)
        Returns:
        UserTask

      • searchUserTasks

        List<UserTask> searchUserTasks​(Integer p,
                               Integer c,
                               List<String> f,
                               String o,
                               String s)
        Finds UserTasks Finds UserTasks with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName`
        Parameters:
        p - index of the page to display (required)
        c - maximum number of elements to retrieve (required)
        f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
        o - can order on attributes (optional)
        s - can search on attributes (optional)
        Returns:
        List<UserTask>

      • searchUserTasks

        List<UserTask> searchUserTasks​(Map<String,​Object> queryParams)
        Finds UserTasks Finds UserTasks with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName` Note, this is equivalent to the other searchUserTasks method, but with the query parameters collected into a single Map parameter. This is convenient for services with optional query parameters, especially when used with the UserTaskApi.SearchUserTasksQueryParams class that allows for building up this map in a fluent style.
        Parameters:
        queryParams - Map of query parameters as name-value pairs

        The following elements may be specified in the query map:

        • p - index of the page to display (required)
        • c - maximum number of elements to retrieve (required)
        • f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
        • o - can order on attributes (optional)
        • s - can search on attributes (optional)
        Returns:
        List<UserTask>

      • updateUserTaskById

        void updateUserTaskById​(String id,
                        UserTaskUpdateRequest userTaskUpdateRequest)
        Update the UserTask by ID Update the UserTask for the given ID. Fields that can be updated are `assigned_id` and `state`. The only value that can be set for the state is `skipped`. You only need to specify the fields that are to be updated.
        Parameters:
        id - ID of the UserTask to return (required)
        userTaskUpdateRequest - Partial UserTask description (required)