> ## Documentation Index > Fetch the complete documentation index at: https://docs.aseeflow.org/llms.txt > Use this file to discover all available pages before exploring further. # Get List > Queries for tasks that fulfill a given filter. The size of the result set can be retrieved by using the Get Task Count method. **Security Consideration:** There are several query parameters (such as assigneeExpression) for specifying an EL expression. These are disabled by default to prevent remote code execution. See the section on [security considerations](https://docs.aseeflow.org/user-guide/process-engine/securing-custom-code/) for custom code in the user guide for details. ## OpenAPI ````yaml /reference/rest/openapi-1.0.json get /task openapi: 3.0.2 info: title: ASEE Flow Platform REST API description: OpenApi Spec for ASEE Flow Platform REST API. version: 1.0.0 license: name: Apache License 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html servers: - url: http://{host}:{port}/{contextPath} description: The API server for the default process engine variables: host: default: localhost port: default: '8080' contextPath: default: engine-rest - url: http://{host}:{port}/{contextPath}/engine/{engineName} description: The API server for a named process engine variables: host: default: localhost port: default: '8080' contextPath: default: engine-rest engineName: default: default - url: '{url}' description: The API server with a custom url variables: url: default: '' security: - basicAuth: [] tags: - name: Authorization - name: Batch - name: Condition - name: Decision Definition - name: Decision Requirements Definition - name: Deployment - name: Engine - name: Event Subscription - name: Execution - name: External Task - name: Filter - name: Group - name: Historic Activity Instance - name: Historic Batch - name: Historic Decision Definition - name: Historic Decision Instance - name: Historic Decision Requirements Definition - name: Historic Detail - name: Historic External Task Log - name: Historic Identity Link Log - name: Historic Incident - name: Historic Job Log - name: Historic Process Definition - name: Historic Process Instance - name: Historic Task Instance - name: Historic User Operation Log - name: Historic Variable Instance - name: History Cleanup - name: Identity - name: Incident - name: Job - name: Job Definition - name: Message - name: Metrics - name: Migration - name: Modification - name: Process Definition - name: Process Instance - name: Signal - name: Schema Log - name: Task - name: Task Attachment - name: Task Comment - name: Task Identity Link - name: Task Local Variable - name: Task Variable - name: Telemetry - name: Tenant - name: User - name: Variable Instance - name: Version externalDocs: description: Find out more about ASEE Flow Rest API url: https://docs.aseeflow.org/reference/rest/overview/ paths: /task: get: tags: - Task summary: Get List description: >- Queries for tasks that fulfill a given filter. The size of the result set can be retrieved by using the Get Task Count method. **Security Consideration:** There are several query parameters (such as assigneeExpression) for specifying an EL expression. These are disabled by default to prevent remote code execution. See the section on [security considerations](https://docs.aseeflow.org/user-guide/process-engine/securing-custom-code/) for custom code in the user guide for details. operationId: getTasks parameters: - name: taskId in: query schema: type: string description: Restrict to task with the given id. - name: taskIdIn in: query schema: type: string description: Restrict to tasks with any of the given ids. - name: processInstanceId in: query schema: type: string description: >- Restrict to tasks that belong to process instances with the given id. - name: processInstanceIdIn in: query schema: type: string description: >- Restrict to tasks that belong to process instances with the given ids. - name: processInstanceBusinessKey in: query schema: type: string description: >- Restrict to tasks that belong to process instances with the given business key. - name: processInstanceBusinessKeyExpression in: query schema: type: string description: "Restrict to tasks that belong to process instances with the given business key which\r\nis described by an expression. See the\r\n[user guide](https://docs.aseeflow.org/user-guide/process-engine/expression-language/unified-expression-language#internal-context-functions)\r\nfor more information on available functions." - name: processInstanceBusinessKeyIn in: query schema: type: string description: "Restrict to tasks that belong to process instances with one of the give business keys.\r\nThe keys need to be in a comma-separated list." - name: processInstanceBusinessKeyLike in: query schema: type: string description: "Restrict to tasks that have a process instance business key that has the parameter\r\nvalue as a substring." - name: processInstanceBusinessKeyLikeExpression in: query schema: type: string description: "Restrict to tasks that have a process instance business key that has the parameter\r\nvalue as a substring and is described by an expression. See the\r\n[user guide](https://docs.aseeflow.org/user-guide/process-engine/expression-language/unified-expression-language#internal-context-functions)\r\nfor more information on available functions." - name: processDefinitionId in: query schema: type: string description: >- Restrict to tasks that belong to a process definition with the given id. - name: processDefinitionKey in: query schema: type: string description: >- Restrict to tasks that belong to a process definition with the given key. - name: processDefinitionKeyIn in: query schema: type: string description: "Restrict to tasks that belong to a process definition with one of the given keys. The\r\nkeys need to be in a comma-separated list." - name: processDefinitionName in: query schema: type: string description: >- Restrict to tasks that belong to a process definition with the given name. - name: processDefinitionNameLike in: query schema: type: string description: "Restrict to tasks that have a process definition name that has the parameter value as\r\na substring." - name: executionId in: query schema: type: string description: Restrict to tasks that belong to an execution with the given id. - name: caseInstanceId in: query schema: type: string description: Restrict to tasks that belong to case instances with the given id. - name: caseInstanceBusinessKey in: query schema: type: string description: >- Restrict to tasks that belong to case instances with the given business key. - name: caseInstanceBusinessKeyLike in: query schema: type: string description: "Restrict to tasks that have a case instance business key that has the parameter value\r\nas a substring." - name: caseDefinitionId in: query schema: type: string description: >- Restrict to tasks that belong to a case definition with the given id. - name: caseDefinitionKey in: query schema: type: string description: >- Restrict to tasks that belong to a case definition with the given key. - name: caseDefinitionName in: query schema: type: string description: >- Restrict to tasks that belong to a case definition with the given name. - name: caseDefinitionNameLike in: query schema: type: string description: "Restrict to tasks that have a case definition name that has the parameter value as a\r\nsubstring." - name: caseExecutionId in: query schema: type: string description: Restrict to tasks that belong to a case execution with the given id. - name: activityInstanceIdIn in: query schema: type: string description: "Only include tasks which belong to one of the passed and comma-separated activity\r\ninstance ids." - name: tenantIdIn in: query schema: type: string description: "Only include tasks which belong to one of the passed and comma-separated\r\ntenant ids." - name: withoutTenantId in: query schema: default: false type: boolean description: "Only include tasks which belong to no tenant. Value may only be `true`,\r\nas `false` is the default behavior." - name: assignee in: query schema: type: string description: Restrict to tasks that the given user is assigned to. - name: assigneeExpression in: query schema: type: string description: "Restrict to tasks that the user described by the given expression is assigned to.\r\nSee the\r\n[user guide](https://docs.aseeflow.org/user-guide/process-engine/expression-language/unified-expression-language#internal-context-functions)\r\nfor more information on available functions." - name: assigneeLike in: query schema: type: string description: "Restrict to tasks that have an assignee that has the parameter\r\nvalue as a substring." - name: assigneeLikeExpression in: query schema: type: string description: "Restrict to tasks that have an assignee that has the parameter value described by the\r\ngiven expression as a substring. See the\r\n[user guide](https://docs.aseeflow.org/user-guide/process-engine/expression-language/unified-expression-language#internal-context-functions)\r\nfor more information on available functions." - name: assigneeIn in: query schema: type: string description: "Only include tasks which are assigned to one of the passed and\r\ncomma-separated user ids." - name: assigneeNotIn in: query schema: type: string description: "Only include tasks which are not assigned to one of the passed and\r\ncomma-separated user ids." - name: owner in: query schema: type: string description: Restrict to tasks that the given user owns. - name: ownerExpression in: query schema: type: string description: "Restrict to tasks that the user described by the given expression owns. See the\r\n[user guide](https://docs.aseeflow.org/user-guide/process-engine/expression-language/unified-expression-language#internal-context-functions)\r\nfor more information on available functions." - name: candidateGroup in: query schema: type: string description: Only include tasks that are offered to the given group. - name: candidateGroupLike in: query schema: type: string description: >- Only include tasks that are offered to groups that have the parameter value as a substring. - name: candidateGroupExpression in: query schema: type: string description: "Only include tasks that are offered to the group described by the given expression.\r\nSee the\r\n[user guide](https://docs.aseeflow.org/user-guide/process-engine/expression-language/unified-expression-language#internal-context-functions)\r\nfor more information on available functions." - name: candidateUser in: query schema: type: string description: >- Only include tasks that are offered to the given user or to one of his groups. - name: candidateUserExpression in: query schema: type: string description: "Only include tasks that are offered to the user described by the given expression.\r\nSee the\r\n[user guide](https://docs.aseeflow.org/user-guide/process-engine/expression-language/unified-expression-language#internal-context-functions)\r\nfor more information on available functions." - name: includeAssignedTasks in: query schema: default: false type: boolean description: "Also include tasks that are assigned to users in candidate queries. Default is to only\r\ninclude tasks that are not assigned to any user if you query by candidate user or\r\ngroup(s)." - name: involvedUser in: query schema: type: string description: "Only include tasks that the given user is involved in. A user is involved in a task if\r\nan identity link exists between task and user (e.g., the user is the assignee)." - name: involvedUserExpression in: query schema: type: string description: "Only include tasks that the user described by the given expression is involved in.\r\nA user is involved in a task if an identity link exists between task and user\r\n(e.g., the user is the assignee). See the\r\n[user guide](https://docs.aseeflow.org/user-guide/process-engine/expression-language/unified-expression-language#internal-context-functions)\r\nfor more information on available functions." - name: assigned in: query schema: default: false type: boolean description: >- If set to `true`, restricts the query to all tasks that are assigned. - name: unassigned in: query schema: default: false type: boolean description: >- If set to `true`, restricts the query to all tasks that are unassigned. - name: taskDefinitionKey in: query schema: type: string description: Restrict to tasks that have the given key. - name: taskDefinitionKeyIn in: query schema: type: string description: "Restrict to tasks that have one of the given keys. The keys need to be in a\r\ncomma-separated list." - name: taskDefinitionKeyNotIn in: query schema: type: string description: "Exclude instances by a list of task definition keys. The keys need to be in a\r\ncomma-separated list." - name: taskDefinitionKeyLike in: query schema: type: string description: >- Restrict to tasks that have a key that has the parameter value as a substring. - name: name in: query schema: type: string description: Restrict to tasks that have the given name. - name: nameNotEqual in: query schema: type: string description: Restrict to tasks that do not have the given name. - name: nameLike in: query schema: type: string description: >- Restrict to tasks that have a name with the given parameter value as substring. - name: nameNotLike in: query schema: type: string description: "Restrict to tasks that do not have a name with the given parameter\r\nvalue as substring." - name: description in: query schema: type: string description: Restrict to tasks that have the given description. - name: descriptionLike in: query schema: type: string description: "Restrict to tasks that have a description that has the parameter\r\nvalue as a substring." - name: priority in: query schema: type: integer description: Restrict to tasks that have the given priority. - name: maxPriority in: query schema: type: integer description: Restrict to tasks that have a lower or equal priority. - name: minPriority in: query schema: type: integer description: Restrict to tasks that have a higher or equal priority. - name: dueDate in: query schema: type: string description: "Restrict to tasks that are due on the given date. By\r\n[default](https://docs.aseeflow.org/reference/rest/overview/date-format/), the date must have the\r\nformat `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g.,\r\n`2013-01-23T14:42:45.546+0200`." - name: dueDateExpression in: query schema: type: string description: "Restrict to tasks that are due on the date described by the given expression. See the\r\n[User Guide](https://docs.aseeflow.org/user-guide/process-engine/expression-language/unified-expression-language#internal-context-functions)\r\nfor more information on available functions. The expression must evaluate to a\r\n`java.util.Date` or `org.joda.time.DateTime` object." - name: dueAfter in: query schema: type: string description: "Restrict to tasks that are due after the given date. By\r\n[default](https://docs.aseeflow.org/reference/rest/overview/date-format/), the date must have\r\nthe format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g.,\r\n`2013-01-23T14:42:45.435+0200`." - name: dueAfterExpression in: query schema: type: string description: "Restrict to tasks that are due after the date described by the given expression.\r\nSee the\r\n[user guide](https://docs.aseeflow.org/user-guide/process-engine/expression-language/unified-expression-language#internal-context-functions)\r\nfor more information on available functions. The expression must evaluate to a\r\n`java.util.Date` or `org.joda.time.DateTime` object." - name: dueBefore in: query schema: type: string description: "Restrict to tasks that are due before the given date. By\r\n[default](https://docs.aseeflow.org/reference/rest/overview/date-format/), the date must have\r\nthe format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g.,\r\n`2013-01-23T14:42:45.243+0200`." - name: dueBeforeExpression in: query schema: type: string description: "Restrict to tasks that are due before the date described by the given expression.\r\nSee the\r\n[user guide](https://docs.aseeflow.org/user-guide/process-engine/expression-language/unified-expression-language#internal-context-functions)\r\nfor more information on available functions. The expression must evaluate to a\r\n`java.util.Date` or `org.joda.time.DateTime` object." - name: withoutDueDate in: query schema: default: false type: boolean description: "Only include tasks which have no due date. Value may only be `true`,\r\nas `false` is the default behavior." - name: followUpDate in: query schema: type: string description: "Restrict to tasks that have a followUp date on the given date. By\r\n[default](https://docs.aseeflow.org/reference/rest/overview/date-format/), the date\r\nmust have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g.,\r\n`2013-01-23T14:42:45.342+0200`." - name: followUpDateExpression in: query schema: type: string description: "Restrict to tasks that have a followUp date on the date described by the given\r\nexpression. See the\r\n[user guide](https://docs.aseeflow.org/user-guide/process-engine/expression-language/unified-expression-language#internal-context-functions)\r\nfor more information on available functions. The expression must evaluate to a\r\n`java.util.Date` or `org.joda.time.DateTime` object." - name: followUpAfter in: query schema: type: string description: "Restrict to tasks that have a followUp date after the given date. By\r\n[default](https://docs.aseeflow.org/reference/rest/overview/date-format/), the\r\ndate must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g.,\r\n`2013-01-23T14:42:45.542+0200`." - name: followUpAfterExpression in: query schema: type: string description: "Restrict to tasks that have a followUp date after the date described by the given\r\nexpression. See the\r\n[user guide](https://docs.aseeflow.org/user-guide/process-engine/expression-language/unified-expression-language#internal-context-functions)\r\nfor more information on available functions. The expression must evaluate to a\r\n`java.util.Date` or `org.joda.time.DateTime` object." - name: followUpBefore in: query schema: type: string description: "Restrict to tasks that have a followUp date before the given date. By\r\n[default](https://docs.aseeflow.org/reference/rest/overview/date-format/), the\r\ndate must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g.,\r\n`2013-01-23T14:42:45.234+0200`." - name: followUpBeforeExpression in: query schema: type: string description: "Restrict to tasks that have a followUp date before the date described by the given\r\nexpression. See the\r\n[user guide](https://docs.aseeflow.org/user-guide/process-engine/expression-language/unified-expression-language#internal-context-functions)\r\nfor more information on available functions. The expression must evaluate to a\r\n`java.util.Date` or `org.joda.time.DateTime` object." - name: followUpBeforeOrNotExistent in: query schema: type: string description: "Restrict to tasks that have no followUp date or a followUp date before the given date.\r\nBy [default](https://docs.aseeflow.org/reference/rest/overview/date-format/), the date must have the\r\nformat `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.432+0200`. The\r\ntypical use case is to query all `active` tasks for a user for a given date." - name: followUpBeforeOrNotExistentExpression in: query schema: type: string description: "Restrict to tasks that have no followUp date or a followUp date before the date\r\ndescribed by the given expression. See the\r\n[user guide](https://docs.aseeflow.org/user-guide/process-engine/expression-language/unified-expression-language#internal-context-functions)\r\nfor more information on available functions. The expression must evaluate to a\r\n`java.util.Date` or `org.joda.time.DateTime` object." - name: createdOn in: query schema: type: string description: "Restrict to tasks that were created on the given date. By\r\n[default](https://docs.aseeflow.org/reference/rest/overview/date-format/), the date must have\r\nthe format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.324+0200`." - name: createdOnExpression in: query schema: type: string description: "Restrict to tasks that were created on the date described by the given expression.\r\nSee the\r\n[user guide](https://docs.aseeflow.org/user-guide/process-engine/expression-language/unified-expression-language#internal-context-functions)\r\nfor more information on available functions. The expression must evaluate to a\r\n`java.util.Date` or `org.joda.time.DateTime` object." - name: createdAfter in: query schema: type: string description: "Restrict to tasks that were created after the given date. By\r\n[default](https://docs.aseeflow.org/reference/rest/overview/date-format/), the date must have the\r\nformat `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.342+0200`." - name: createdAfterExpression in: query schema: type: string description: "Restrict to tasks that were created after the date described by the given expression.\r\nSee the\r\n[user guide](https://docs.aseeflow.org/user-guide/process-engine/expression-language/unified-expression-language#internal-context-functions)\r\nfor more information on available functions. The expression must evaluate to a\r\n`java.util.Date` or `org.joda.time.DateTime` object." - name: createdBefore in: query schema: type: string description: "Restrict to tasks that were created before the given date. By\r\n[default](https://docs.aseeflow.org/reference/rest/overview/date-format/), the date must have the\r\nformat `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.332+0200`." - name: createdBeforeExpression in: query schema: type: string description: "Restrict to tasks that were created before the date described by the given expression.\r\nSee the\r\n[user guide](https://docs.aseeflow.org/user-guide/process-engine/expression-language/unified-expression-language#internal-context-functions)\r\nfor more information on available functions. The expression must evaluate to a\r\n`java.util.Date` or `org.joda.time.DateTime` object." - name: updatedAfter in: query schema: type: string description: "Restrict to tasks that were updated after the given date. Every action that fires\r\na [task update event](https://docs.aseeflow.org/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle) is considered as updating the task.\r\nBy [default](https://docs.aseeflow.org/reference/rest/overview/date-format/), the date must\r\nhave the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.332+0200`." - name: updatedAfterExpression in: query schema: type: string description: "Restrict to tasks that were updated after the date described by the given expression. Every action that fires\r\na [task update event](https://docs.aseeflow.org/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle) is considered as updating the task.\r\nSee the\r\n[user guide](https://docs.aseeflow.org/user-guide/process-engine/expression-language/unified-expression-language#internal-context-functions)\r\nfor more information on available functions. The expression must evaluate to a\r\n`java.util.Date` or `org.joda.time.DateTime` object." - name: delegationState in: query schema: enum: - PENDING - RESOLVED type: string description: "Restrict to tasks that are in the given delegation state. Valid values are\r\n`PENDING` and `RESOLVED`." - name: candidateGroups in: query schema: type: string description: "Restrict to tasks that are offered to any of the given candidate groups. Takes a\r\ncomma-separated list of group names, so for example `developers,support,sales`." - name: candidateGroupsExpression in: query schema: type: string description: "Restrict to tasks that are offered to any of the candidate groups described by the\r\ngiven expression. See the\r\n[user guide](https://docs.aseeflow.org/user-guide/process-engine/expression-language/unified-expression-language#internal-context-functions)\r\nfor more information on available functions. The expression must evaluate to\r\n`java.util.List` of Strings." - name: withCandidateGroups in: query schema: default: false type: boolean description: "Only include tasks which have a candidate group. Value may only be `true`,\r\nas `false` is the default behavior." - name: withoutCandidateGroups in: query schema: default: false type: boolean description: "Only include tasks which have no candidate group. Value may only be `true`,\r\nas `false` is the default behavior." - name: withCandidateUsers in: query schema: default: false type: boolean description: "Only include tasks which have a candidate user. Value may only be `true`,\r\nas `false` is the default behavior." - name: withoutCandidateUsers in: query schema: default: false type: boolean description: "Only include tasks which have no candidate users. Value may only be `true`,\r\nas `false` is the default behavior." - name: active in: query schema: default: false type: boolean description: "Only include active tasks. Value may only be `true`, as `false`\r\nis the default behavior." - name: suspended in: query schema: default: false type: boolean description: "Only include suspended tasks. Value may only be `true`, as\r\n`false` is the default behavior." - name: taskVariables in: query schema: type: string description: "Only include tasks that have variables with certain values. Variable filtering\r\nexpressions are comma-separated and are structured as follows:\r\n\r\nA valid parameter value has the form `key_operator_value`. `key` is the variable name,\r\n`operator` is the comparison operator to be used and `value` the variable value.\r\n\r\n**Note**: Values are always treated as String objects on server side.\r\n\r\nValid `operator` values are:\r\n`eq` - equal to;\r\n`neq` - not equal to;\r\n`gt` - greater than;\r\n`gteq` - greater than or equal to;\r\n`lt` - lower than;\r\n`lteq` - lower than or equal to;\r\n`like`.\r\n`key` and `value` may not contain underscore or comma characters." - name: processVariables in: query schema: type: string description: "Only include tasks that belong to process instances that have variables with certain\r\nvalues. Variable filtering expressions are comma-separated and are structured as\r\nfollows:\r\n\r\nA valid parameter value has the form `key_operator_value`. `key` is the variable name,\r\n`operator` is the comparison operator to be used and `value` the variable value.\r\n\r\n**Note**: Values are always treated as String objects on server side.\r\n\r\nValid `operator` values are:\r\n`eq` - equal to;\r\n`neq` - not equal to;\r\n`gt` - greater than;\r\n`gteq` - greater than or equal to;\r\n`lt` - lower than;\r\n`lteq` - lower than or equal to;\r\n`like`;\r\n`notLike`.\r\n`key` and `value` may not contain underscore or comma characters." - name: caseInstanceVariables in: query schema: type: string description: "Only include tasks that belong to case instances that have variables with certain\r\nvalues. Variable filtering expressions are comma-separated and are structured as\r\nfollows:\r\n\r\nA valid parameter value has the form `key_operator_value`. `key` is the variable name,\r\n`operator` is the comparison operator to be used and `value` the variable value.\r\n\r\n**Note**: Values are always treated as String objects on server side.\r\n\r\nValid `operator` values are:\r\n`eq` - equal to;\r\n`neq` - not equal to;\r\n`gt` - greater than;\r\n`gteq` - greater than or equal to;\r\n`lt` - lower than;\r\n`lteq` - lower than or equal to;\r\n`like`.\r\n`key` and `value` may not contain underscore or comma characters." - name: variableNamesIgnoreCase in: query schema: default: false type: boolean description: "Match all variable names in this query case-insensitively. If set\r\n`variableName` and `variablename` are treated as equal." - name: variableValuesIgnoreCase in: query schema: default: false type: boolean description: "Match all variable values in this query case-insensitively. If set\r\n`variableValue` and `variablevalue` are treated as equal." - name: parentTaskId in: query schema: type: string description: >- Restrict query to all tasks that are sub tasks of the given task. Takes a task id. - name: withCommentAttachmentInfo in: query schema: default: false type: boolean description: "Check if task has attachments and/or comments. Value may only be `true`, as\r\n`false` is the default behavior.\r\nAdding the filter will do additional attachment and comments queries to the database,\r\nit might slow down the query in case of tables having high volume of data.\r\nThis param is not considered for count queries" - name: withTaskVariablesInReturn in: query schema: default: false type: boolean description: "Indicates if all the variables visible from task should be retrieved. A variable is visible from the task\r\nif it is a local task variable or declared in a parent scope of the task. Value may only be `true`, as\r\n`false` is the default behavior." - name: withTaskLocalVariablesInReturn in: query schema: default: false type: boolean description: "Indicates if all the local variables visible from task should be retrieved. Value may only be `true`, as\r\n`false` is the default behavior." - name: sortBy in: query schema: enum: - instanceId - caseInstanceId - dueDate - executionId - caseExecutionId - assignee - created - lastUpdated - description - id - name - nameCaseInsensitive - priority - processVariable - executionVariable - taskVariable - caseExecutionVariable - caseInstanceVariable type: string description: |- Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. - name: sortOrder in: query schema: enum: - asc - desc type: string description: >- Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. - name: firstResult in: query schema: type: integer description: >- Pagination of results. Specifies the index of the first result to return. - name: maxResults in: query schema: type: integer description: >- Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/TaskWithAttachmentAndCommentDto' examples: example-1: summary: Status 200 response 1 description: >- Response for GET `/task?assignee=anAssignee&delegationState=RESOLVED&maxPriority=50` value: - id: anId name: aName assignee: anAssignee created: 2013-01-23T13:42:42.657+0200 due: 2013-01-23T13:49:42.323+0200 'followUp:': 2013-01-23T13:44:42.987+0200 'lastUpdated:': 2013-01-23T13:44:42.987+0200 delegationState: RESOLVED description: aDescription executionId: anExecution owner: anOwner parentTaskId: aParentId priority: 42 processDefinitionId: aProcDefId processInstanceId: aProcInstId caseDefinitionId: aCaseDefId caseInstanceId: aCaseInstId caseExecutionId: aCaseExecution taskDefinitionKey: aTaskDefinitionKey suspended: false formKey: aFormKey camundaFormRef: key: aCamundaFormKey binding: version version: 2 tenantId: aTenantId taskState: aTaskState example-2: summary: Status 200 response 2 description: >- Response for GET `/task?assignee=anAssignee&withCommentAttachmentInfo=true` value: - id: anId name: aName assignee: anAssignee created: 2013-01-23T13:42:42.657+0200 due: 2013-01-23T13:49:42.323+0200 'followUp:': 2013-01-23T13:44:42.987+0200 'lastUpdated:': 2013-01-23T13:44:42.987+0200 delegationState: RESOLVED description: aDescription executionId: anExecution owner: anOwner parentTaskId: aParentId priority: 42 processDefinitionId: aProcDefId processInstanceId: aProcInstId caseDefinitionId: aCaseDefId caseInstanceId: aCaseInstId caseExecutionId: aCaseExecution taskDefinitionKey: aTaskDefinitionKey suspended: false formKey: aFormKey camundaFormRef: key: aCamundaFormKey binding: version version: 2 tenantId: aTenantId attachment: false comment: false example-3: summary: Status 200 response 3 description: |- Response for GET `/task?assignee=anAssignee&withCommentAttachmentInfo=true&withTaskVariablesInReturn=true` value: - id: anId name: aName assignee: anAssignee created: 2013-01-23T13:42:42.657+0200 due: 2013-01-23T13:49:42.323+0200 'followUp:': 2013-01-23T13:44:42.987+0200 'lastUpdated:': 2013-01-23T13:44:42.987+0200 delegationState: RESOLVED description: aDescription executionId: anExecution owner: anOwner parentTaskId: aParentId priority: 42 processDefinitionId: aProcDefId processInstanceId: aProcInstId caseDefinitionId: aCaseDefId caseInstanceId: aCaseInstId caseExecutionId: aCaseExecution taskDefinitionKey: aTaskDefinitionKey suspended: false formKey: aFormKey camundaFormRef: key: aCamundaFormKey binding: version version: 2 tenantId: aTenantId variables: aVariableKey: type: String value: aVariableValue valueInfo: {} anotherVariableKey: type: String value: anotherVariableValue valueInfo: {} attachment: false comment: false example-4: summary: Status 200 response 4 description: |- Response for GET `/task?assignee=anAssignee&withCommentAttachmentInfo=true&withTaskLocalVariablesInReturn=true` value: - id: anId name: aName assignee: anAssignee created: 2013-01-23T13:42:42.657+0200 due: 2013-01-23T13:49:42.323+0200 'followUp:': 2013-01-23T13:44:42.987+0200 'lastUpdated:': 2013-01-23T13:44:42.987+0200 delegationState: RESOLVED description: aDescription executionId: anExecution owner: anOwner parentTaskId: aParentId priority: 42 processDefinitionId: aProcDefId processInstanceId: aProcInstId caseDefinitionId: aCaseDefId caseInstanceId: aCaseInstId caseExecutionId: aCaseExecution taskDefinitionKey: aTaskDefinitionKey suspended: false formKey: aFormKey camundaFormRef: key: aCamundaFormKey binding: version version: 2 tenantId: aTenantId variables: anotherVariableKey: type: String value: anotherVariableValue valueInfo: {} attachment: false comment: false description: Request successful. '400': content: application/json: schema: $ref: '#/components/schemas/ExceptionDto' description: >- Returned if some of the query parameters are invalid, for example if a `sortOrder` parameter is supplied, but no `sortBy`, or if an invalid operator for variable comparison is used. See the [Introduction](https://docs.aseeflow.org/reference/rest/overview/#error-handling) for the error response format. components: schemas: TaskWithAttachmentAndCommentDto: allOf: - type: object properties: attachment: type: boolean nullable: true description: Specifies if an attachment exists for the task. comment: type: boolean nullable: true description: Specifies if an comment exists for the task. - $ref: '#/components/schemas/TaskWithVariablesDto' ExceptionDto: title: ExceptionDto type: object properties: type: type: string nullable: true description: An exception class indicating the occurred error. message: type: string nullable: true description: A detailed message of the error. code: type: number description: >- The code allows your client application to identify the error in an automated fashion. You can look up the meaning of all built-in codes and learn how to add custom codes in the [User Guide](https://docs.aseeflow.org/user-guide/process-engine/error-handling/#exception-codes). TaskWithVariablesDto: allOf: - type: object properties: variables: type: object nullable: true additionalProperties: $ref: '#/components/schemas/VariableValueDto' description: Holds the appropriate variables for the task. - $ref: '#/components/schemas/TaskDto' VariableValueDto: type: object properties: value: $ref: '#/components/schemas/AnyValue' type: type: string nullable: true description: The value type of the variable. valueInfo: type: object additionalProperties: true description: >- A JSON object containing additional, value-type-dependent properties. For serialized variables of type Object, the following properties can be provided: * `objectTypeName`: A string representation of the object's type name. * `serializationDataFormat`: The serialization format used to store the variable. For serialized variables of type File, the following properties can be provided: * `filename`: The name of the file. This is not the variable name but the name that will be used when downloading the file again. * `mimetype`: The MIME type of the file that is being uploaded. * `encoding`: The encoding of the file that is being uploaded. The following property can be provided for all value types: * `transient`: Indicates whether the variable should be transient or not. See [documentation](https://docs.aseeflow.org/user-guide/process-engine/variables#transient-variables) for more informations. (Not applicable for `decision-definition`, ` /process-instance/variables-async`, and `/migration/executeAsync` endpoints) TaskDto: type: object properties: id: type: string nullable: true description: The task id. name: type: string nullable: true description: The task name. assignee: type: string nullable: true description: The assignee's id. owner: type: string nullable: true description: The owner's id. created: type: string format: date-time nullable: true description: >- The date the task was created on. [Default format](https://docs.aseeflow.org/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. lastUpdated: type: string format: date-time nullable: true description: >- The date the task was last updated. Every action that fires a [task update event](https://docs.aseeflow.org/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle) will update this property. [Default format](https://docs.aseeflow.org/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. due: type: string format: date-time nullable: true description: >- The task's due date. [Default format](https://docs.aseeflow.org/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. followUp: type: string format: date-time nullable: true description: >- The follow-up date for the task. [Default format](https://docs.aseeflow.org/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. delegationState: type: string nullable: true enum: - PENDING - RESOLVED description: >- The task's delegation state. Possible values are `PENDING` and `RESOLVED`. description: type: string nullable: true description: The task's description. executionId: type: string nullable: true description: The id of the execution the task belongs to. parentTaskId: type: string nullable: true description: The id the parent task, if this task is a subtask. priority: type: integer format: int32 nullable: true description: The task's priority. processDefinitionId: type: string nullable: true description: The id of the process definition the task belongs to. processInstanceId: type: string nullable: true description: The id of the process instance the task belongs to. caseExecutionId: type: string nullable: true description: The id of the case execution the task belongs to. caseDefinitionId: type: string nullable: true description: The id of the case definition the task belongs to. caseInstanceId: type: string nullable: true description: The id of the case instance the task belongs to. taskDefinitionKey: type: string nullable: true description: The task's key. suspended: type: boolean nullable: true description: Whether the task belongs to a process instance that is suspended. formKey: type: string nullable: true description: If not `null`, the form key for the task. camundaFormRef: $ref: '#/components/schemas/CamundaFormRef' tenantId: type: string nullable: true description: If not `null`, the tenant id of the task. taskState: type: string nullable: true description: The task's state. AnyValue: description: |- Can be any value - string, number, boolean, array or object. **Note**: Not every endpoint supports every type. CamundaFormRef: type: object properties: key: type: string nullable: true description: The key of the Camunda Form. binding: type: string nullable: true description: >- The binding of the Camunda Form. Can be `latest`, `deployment` or `version`. version: type: integer format: int32 nullable: true description: >- The specific version of a Camunda Form. This property is only set if `binding` is `version`. securitySchemes: basicAuth: type: http scheme: basic ````