When querying for open tasks, I want to have the option to fetch variables attached to the open tasks along with results

[prakashpalanisamy]

User Story

As a developer, I need the ability to query for the list of tasks with the option to retrieve Task Local Variables and Task Variables as part of response by passing appropriate flags.

Functional Requirements

There can be appropriate flags added to the get-taskList post-taskList APIs' requests to enable the response to include the Task Variables as part of the response. This will save multiple API call to achieve the same outcome. The default behaviour can be set to NOT retrieve the variables as part of the response to not impact load/performance.

API Endpoints in Scope:

• Endpoint: /task ; Method: GET ; Reference: https://docs.camunda.org/rest/camunda-bpm-platform/7.21/#tag/Task/operation/getTasks
• Endpoint: /task ; Method: POST ; Reference: https://docs.camunda.org/rest/camunda-bpm-platform/7.21/#tag/Task/operation/queryTasks
  
• Endpoint: /task/{id}/ Method: GET ; Reference: https://docs.camunda.org/rest/camunda-bpm-platform/7.21/#tag/Task/operation/getTask
  

Links

• This Story is related to Jira Issue When quering process instances, I want to have the option to fetch variables attached to the process instance #2334
• is related to https://jira.camunda.com/browse/SUPPORT-7712

• is related to https://jira.camunda.com/browse/SUPPORT-7713
• is related to https://jira.camunda.com/browse/SUPPORT-7714

Pull Requests

Preview Give feedback

1. Feature/git issue #4487 fetch task variables feature #4754
   +0
   

[prakashpalanisamy]

I'm willing to pick this up for implementation as well. @yanavasileva , Im tagging you so that you can take a look at the proposed Issue and provide your inputs. Thanks!!

[yanavasileva]

Looks good. To be more explicit, you can add the exact REST endpoints in the ticket's description.

[prakashpalanisamy]

Looks good. To be more explicit, you can add the exact REST endpoints in the ticket's description.

Hi @yanavasileva.. Thank you for your quick response :) I have updated the Issue description to include the API endpoint in scope. Please review.

I need few inputs from you on the below items:

1. I'm planning to introduce request parameters like withTaskVariablesInReturn and withTaskLocalVariablesInReturn
   - does the above both params make sense? or do you recommend to keep only LocalVariable in scope?
   - only on the parameters set to true explicitly on request, the users will be able to get response with variables
   - withTaskVariablesInReturn will take precedence over withTaskLocalVariablesInReturn, as the former covers the local variables as well.

Thank you!!

[yanavasileva]

• does the above both params make sense?

Yes, both make sense.

• only on the parameters set to true explicitly on request, the users will be able to get response with variables
• withTaskVariablesInReturn will take precedence over withTaskLocalVariablesInReturn, as the former covers the local variables as well.

Sounds good.