Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/git issue #4487 fetch task variables feature #4754

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Feature/git issue #4487 fetch task variables feature #4754

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
ce9e0f6
get process and local scoped varaibles when querying an open task via…
prakashpalanisamy Oct 4, 2024
c210094
added tests for VariablesInReturnForaTaskId
prakashpalanisamy Oct 20, 2024
97f1254
Merge branch 'master' into feature/git-issue-4487-fetch-task-variable…
prakashpalanisamy Oct 20, 2024
efcbc73
addressed an issue and removed duplicated code.
prakashpalanisamy Oct 21, 2024
a686db9
adding variable response for list of tasks get and post
prakashpalanisamy Oct 28, 2024
149e3aa
openapi spec changes
prakashpalanisamy Nov 5, 2024
cd15246
reversal of unwanted auto formats.
prakashpalanisamy Nov 5, 2024
4c12656
reverting to original for formatting issues
prakashpalanisamy Nov 5, 2024
11de7ad
updates
prakashpalanisamy Nov 5, 2024
5625e6f
minor change to example number in openapi spec documentation
prakashpalanisamy Nov 13, 2024
d75434f
simplified the logic
prakashpalanisamy Jan 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
updates
  • Loading branch information
@prakashpalanisamy
prakashpalanisamy committed Nov 5, 2024
commit 11de7ad3fe4d92e262c77dde8906d2fce7fbf3ec
89 changes: 52 additions & 37 deletions engine-rest/engine-rest-openapi/src/main/templates/lib/commons/task-query-params.ftl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,29 +26,29 @@
<@lib.parameter name = "processInstanceBusinessKeyExpression"
location = "query"
type = "string"
desc = "Restrict to tasks that belong to process instances with the given business key which
is described by an expression. See the
desc = "Restrict to tasks that belong to process instances with the given business key which
is described by an expression. See the
[user guide](${docsUrl}/user-guide/process-engine/expression-language/#internal-context-functions)
for more information on available functions." />

<@lib.parameter name = "processInstanceBusinessKeyIn"
location = "query"
type = "string"
desc = "Restrict to tasks that belong to process instances with one of the give business keys.
desc = "Restrict to tasks that belong to process instances with one of the give business keys.
The keys need to be in a comma-separated list." />

<@lib.parameter name = "processInstanceBusinessKeyLike"
location = "query"
type = "string"
desc = "Restrict to tasks that have a process instance business key that has the parameter
desc = "Restrict to tasks that have a process instance business key that has the parameter
value as a substring." />

<@lib.parameter name = "processInstanceBusinessKeyLikeExpression"
location = "query"
type = "string"
desc = "Restrict to tasks that have a process instance business key that has the parameter
desc = "Restrict to tasks that have a process instance business key that has the parameter
value as a substring and is described by an expression. See the
[user guide](${docsUrl}/user-guide/process-engine/expression-language/#internal-context-functions)
[user guide](${docsUrl}/user-guide/process-engine/expression-language/#internal-context-functions)
for more information on available functions." />

<@lib.parameter name = "processDefinitionId"
Expand All @@ -64,7 +64,7 @@
<@lib.parameter name = "processDefinitionKeyIn"
location = "query"
type = "string"
desc = "Restrict to tasks that belong to a process definition with one of the given keys. The
desc = "Restrict to tasks that belong to a process definition with one of the given keys. The
keys need to be in a comma-separated list." />

<@lib.parameter name = "processDefinitionName"
Expand All @@ -75,7 +75,7 @@
<@lib.parameter name = "processDefinitionNameLike"
location = "query"
type = "string"
desc = "Restrict to tasks that have a process definition name that has the parameter value as
desc = "Restrict to tasks that have a process definition name that has the parameter value as
a substring." />

<@lib.parameter name = "executionId"
Expand All @@ -96,7 +96,7 @@
<@lib.parameter name = "caseInstanceBusinessKeyLike"
location = "query"
type = "string"
desc = "Restrict to tasks that have a case instance business key that has the parameter value
desc = "Restrict to tasks that have a case instance business key that has the parameter value
as a substring." />

<@lib.parameter name = "caseDefinitionId"
Expand All @@ -117,7 +117,7 @@
<@lib.parameter name = "caseDefinitionNameLike"
location = "query"
type = "string"
desc = "Restrict to tasks that have a case definition name that has the parameter value as a
desc = "Restrict to tasks that have a case definition name that has the parameter value as a
substring." />

<@lib.parameter name = "caseExecutionId"
Expand All @@ -128,20 +128,20 @@
<@lib.parameter name = "activityInstanceIdIn"
location = "query"
type = "string"
desc = "Only include tasks which belong to one of the passed and comma-separated activity
desc = "Only include tasks which belong to one of the passed and comma-separated activity
instance ids." />

<@lib.parameter name = "tenantIdIn"
location = "query"
type = "string"
desc = "Only include tasks which belong to one of the passed and comma-separated
desc = "Only include tasks which belong to one of the passed and comma-separated
tenant ids." />

<@lib.parameter name = "withoutTenantId"
location = "query"
type = "boolean"
defaultValue = "false"
desc = "Only include tasks which belong to no tenant. Value may only be `true`,
desc = "Only include tasks which belong to no tenant. Value may only be `true`,
as `false` is the default behavior." />

<@lib.parameter name = "assignee"
Expand All @@ -152,29 +152,29 @@
<@lib.parameter name = "assigneeExpression"
location = "query"
type = "string"
desc = "Restrict to tasks that the user described by the given expression is assigned to.
See the
[user guide](${docsUrl}/user-guide/process-engine/expression-language/#internal-context-functions)
desc = "Restrict to tasks that the user described by the given expression is assigned to.
See the
[user guide](${docsUrl}/user-guide/process-engine/expression-language/#internal-context-functions)
for more information on available functions." />

<@lib.parameter name = "assigneeLike"
location = "query"
type = "string"
desc = "Restrict to tasks that have an assignee that has the parameter
desc = "Restrict to tasks that have an assignee that has the parameter
value as a substring." />

<@lib.parameter name = "assigneeLikeExpression"
location = "query"
type = "string"
desc = "Restrict to tasks that have an assignee that has the parameter value described by the
given expression as a substring. See the
[user guide](${docsUrl}/user-guide/process-engine/expression-language/#internal-context-functions)
desc = "Restrict to tasks that have an assignee that has the parameter value described by the
given expression as a substring. See the
[user guide](${docsUrl}/user-guide/process-engine/expression-language/#internal-context-functions)
for more information on available functions." />

<@lib.parameter name = "assigneeIn"
location = "query"
type = "string"
desc = "Only include tasks which are assigned to one of the passed and
desc = "Only include tasks which are assigned to one of the passed and
comma-separated user ids." />

<@lib.parameter name = "assigneeNotIn"
Expand All @@ -191,8 +191,8 @@
<@lib.parameter name = "ownerExpression"
location = "query"
type = "string"
desc = "Restrict to tasks that the user described by the given expression owns. See the
[user guide](${docsUrl}/user-guide/process-engine/expression-language/#internal-context-functions)
desc = "Restrict to tasks that the user described by the given expression owns. See the
[user guide](${docsUrl}/user-guide/process-engine/expression-language/#internal-context-functions)
for more information on available functions." />

<@lib.parameter name = "candidateGroup"
Expand All @@ -208,9 +208,9 @@
<@lib.parameter name = "candidateGroupExpression"
location = "query"
type = "string"
desc = "Only include tasks that are offered to the group described by the given expression.
See the
[user guide](${docsUrl}/user-guide/process-engine/expression-language/#internal-context-functions)
desc = "Only include tasks that are offered to the group described by the given expression.
See the
[user guide](${docsUrl}/user-guide/process-engine/expression-language/#internal-context-functions)
for more information on available functions." />

<@lib.parameter name = "candidateUser"
Expand All @@ -221,23 +221,23 @@
<@lib.parameter name = "candidateUserExpression"
location = "query"
type = "string"
desc = "Only include tasks that are offered to the user described by the given expression.
See the
[user guide](${docsUrl}/user-guide/process-engine/expression-language/#internal-context-functions)
desc = "Only include tasks that are offered to the user described by the given expression.
See the
[user guide](${docsUrl}/user-guide/process-engine/expression-language/#internal-context-functions)
for more information on available functions." />

<@lib.parameter name = "includeAssignedTasks"
location = "query"
type = "boolean"
defaultValue = "false"
desc = "Also include tasks that are assigned to users in candidate queries. Default is to only
desc = "Also include tasks that are assigned to users in candidate queries. Default is to only
include tasks that are not assigned to any user if you query by candidate user or
group(s)." />

<@lib.parameter name = "involvedUser"
location = "query"
type = "string"
desc = "Only include tasks that the given user is involved in. A user is involved in a task if
desc = "Only include tasks that the given user is involved in. A user is involved in a task if
an identity link exists between task and user (e.g., the user is the assignee)." />

<@lib.parameter name = "involvedUserExpression"
Expand Down Expand Up @@ -378,7 +378,7 @@
location = "query"
type = "boolean"
defaultValue = "false"
desc = "Only include tasks which have no due date. Value may only be `true`,
desc = "Only include tasks which have no due date. Value may only be `true`,
as `false` is the default behavior." />

<@lib.parameter name = "followUpDate"
Expand Down Expand Up @@ -500,15 +500,15 @@
<@lib.parameter name = "updatedAfter"
location = "query"
type = "string"
desc = "Restrict to tasks that were updated after the given date. Every action that fires
desc = "Restrict to tasks that were updated after the given date. Every action that fires
a [task update event](${docsUrl}/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle) is considered as updating the task.
By [default](${docsUrl}/reference/rest/overview/date-format/), the date must
have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.332+0200`." />

<@lib.parameter name = "updatedAfterExpression"
location = "query"
type = "string"
desc = "Restrict to tasks that were updated after the date described by the given expression. Every action that fires
desc = "Restrict to tasks that were updated after the date described by the given expression. Every action that fires
a [task update event](${docsUrl}/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle) is considered as updating the task.
See the
[user guide](${docsUrl}/user-guide/process-engine/expression-language/#internal-context-functions)
Expand Down Expand Up @@ -603,7 +603,7 @@
<@lib.parameter name = "processVariables"
location = "query"
type = "string"
desc = "Only include tasks that belong to process instances that have variables with certain
desc = "Only include tasks that belong to process instances that have variables with certain
values. Variable filtering expressions are comma-separated and are structured as
follows:

Expand Down Expand Up @@ -668,9 +668,24 @@
location = "query"
type = "boolean"
defaultValue = "false"
last = last
desc = "Check if task has attachments and/or comments. Value may only be `true`, as
`false` is the default behavior.
Adding the filter will do additional attachment and comments queries to the database,
it might slow down the query in case of tables having high volume of data.
This param is not considered for count queries" />
This param is not considered for count queries" />

<@lib.parameter name = "withTaskVariablesInReturn"
location = "query"
type = "boolean"
defaultValue = "false"
desc = "Indicates if all the variables visible from task should be retrieved. A variable is visible from the task
if it is a local task variable or declared in a parent scope of the task. Value may only be `true`, as
`false` is the default behavior." />

<@lib.parameter name = "withTaskLocalVariablesInReturn"
location = "query"
type = "boolean"
defaultValue = "false"
last = last
desc = "Indicates if all the local variables visible from task should be retrieved. Value may only be `true`, as
`false` is the default behavior." />