Skip to content

Latest commit

 

History

History
99 lines (94 loc) · 21.7 KB

TaskQueryDto.md

File metadata and controls

99 lines (94 loc) · 21.7 KB

TaskQueryDto

Properties

Name Type Description Notes
process_instance_id Option<String> Restrict to tasks that belong to process instances with the given id. [optional]
process_instance_id_in Option<Vec> Restrict to tasks that belong to process instances with the given ids. [optional]
process_instance_business_key Option<String> Restrict to tasks that belong to process instances with the given business key. [optional]
process_instance_business_key_expression Option<String> Restrict to tasks that belong to process instances with the given business key which is described by an expression. See the user guide for more information on available functions. [optional]
process_instance_business_key_in Option<Vec> 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. [optional]
process_instance_business_key_like Option<String> Restrict to tasks that have a process instance business key that has the parameter value as a substring. [optional]
process_instance_business_key_like_expression Option<String> 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 for more information on available functions. [optional]
process_definition_id Option<String> Restrict to tasks that belong to a process definition with the given id. [optional]
process_definition_key Option<String> Restrict to tasks that belong to a process definition with the given key. [optional]
process_definition_key_in Option<Vec> 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. [optional]
process_definition_name Option<String> Restrict to tasks that belong to a process definition with the given name. [optional]
process_definition_name_like Option<String> Restrict to tasks that have a process definition name that has the parameter value as a substring. [optional]
execution_id Option<String> Restrict to tasks that belong to an execution with the given id. [optional]
case_instance_id Option<String> Restrict to tasks that belong to case instances with the given id. [optional]
case_instance_business_key Option<String> Restrict to tasks that belong to case instances with the given business key. [optional]
case_instance_business_key_like Option<String> Restrict to tasks that have a case instance business key that has the parameter value as a substring. [optional]
case_definition_id Option<String> Restrict to tasks that belong to a case definition with the given id. [optional]
case_definition_key Option<String> Restrict to tasks that belong to a case definition with the given key. [optional]
case_definition_name Option<String> Restrict to tasks that belong to a case definition with the given name. [optional]
case_definition_name_like Option<String> Restrict to tasks that have a case definition name that has the parameter value as a substring. [optional]
case_execution_id Option<String> Restrict to tasks that belong to a case execution with the given id. [optional]
activity_instance_id_in Option<Vec> Only include tasks which belong to one of the passed and comma-separated activity instance ids. [optional]
tenant_id_in Option<Vec> Only include tasks which belong to one of the passed and comma-separated tenant ids. [optional]
without_tenant_id Option<bool> Only include tasks which belong to no tenant. Value may only be true, as false is the default behavior. [optional][default to false]
assignee Option<String> Restrict to tasks that the given user is assigned to. [optional]
assignee_expression Option<String> Restrict to tasks that the user described by the given expression is assigned to. See the user guide for more information on available functions. [optional]
assignee_like Option<String> Restrict to tasks that have an assignee that has the parameter value as a substring. [optional]
assignee_like_expression Option<String> Restrict to tasks that have an assignee that has the parameter value described by the given expression as a substring. See the user guide for more information on available functions. [optional]
assignee_in Option<Vec> Only include tasks which are assigned to one of the passed and comma-separated user ids. [optional]
owner Option<String> Restrict to tasks that the given user owns. [optional]
owner_expression Option<String> Restrict to tasks that the user described by the given expression owns. See the user guide for more information on available functions. [optional]
candidate_group Option<String> Only include tasks that are offered to the given group. [optional]
candidate_group_expression Option<String> Only include tasks that are offered to the group described by the given expression. See the user guide for more information on available functions. [optional]
candidate_user Option<String> Only include tasks that are offered to the given user or to one of his groups. [optional]
candidate_user_expression Option<String> Only include tasks that are offered to the user described by the given expression. See the user guide for more information on available functions. [optional]
include_assigned_tasks Option<bool> 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). [optional][default to false]
involved_user Option<String> 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). [optional]
involved_user_expression Option<String> Only include tasks that the user described by the given expression 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). See the user guide for more information on available functions. [optional]
assigned Option<bool> If set to true, restricts the query to all tasks that are assigned. [optional][default to false]
unassigned Option<bool> If set to true, restricts the query to all tasks that are unassigned. [optional][default to false]
task_definition_key Option<String> Restrict to tasks that have the given key. [optional]
task_definition_key_in Option<Vec> Restrict to tasks that have one of the given keys. The keys need to be in a comma-separated list. [optional]
task_definition_key_like Option<String> Restrict to tasks that have a key that has the parameter value as a substring. [optional]
name Option<String> Restrict to tasks that have the given name. [optional]
name_not_equal Option<String> Restrict to tasks that do not have the given name. [optional]
name_like Option<String> Restrict to tasks that have a name with the given parameter value as substring. [optional]
name_not_like Option<String> Restrict to tasks that do not have a name with the given parameter value as substring. [optional]
description Option<String> Restrict to tasks that have the given description. [optional]
description_like Option<String> Restrict to tasks that have a description that has the parameter value as a substring. [optional]
priority Option<i32> Restrict to tasks that have the given priority. [optional]
max_priority Option<i32> Restrict to tasks that have a lower or equal priority. [optional]
min_priority Option<i32> Restrict to tasks that have a higher or equal priority. [optional]
due_date Option<String> Restrict to tasks that are due on the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.546+0200. [optional]
due_date_expression Option<String> Restrict to tasks that are due on the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object. [optional]
due_after Option<String> Restrict to tasks that are due after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.435+0200. [optional]
due_after_expression Option<String> Restrict to tasks that are due after the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object. [optional]
due_before Option<String> Restrict to tasks that are due before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.243+0200. [optional]
due_before_expression Option<String> Restrict to tasks that are due before the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object. [optional]
follow_up_date Option<String> Restrict to tasks that have a followUp date on the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.342+0200. [optional]
follow_up_date_expression Option<String> Restrict to tasks that have a followUp date on the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object. [optional]
follow_up_after Option<String> Restrict to tasks that have a followUp date after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.542+0200. [optional]
follow_up_after_expression Option<String> Restrict to tasks that have a followUp date after the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object. [optional]
follow_up_before Option<String> Restrict to tasks that have a followUp date before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.234+0200. [optional]
follow_up_before_expression Option<String> Restrict to tasks that have a followUp date before the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object. [optional]
follow_up_before_or_not_existent Option<String> Restrict to tasks that have no followUp date or a followUp date before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.432+0200. The typical use case is to query all active tasks for a user for a given date. [optional]
follow_up_before_or_not_existent_expression Option<String> Restrict to tasks that have no followUp date or a followUp date before the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object. [optional]
created_on Option<String> Restrict to tasks that were created on the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.324+0200. [optional]
created_on_expression Option<String> Restrict to tasks that were created on the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object. [optional]
created_after Option<String> Restrict to tasks that were created after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.342+0200. [optional]
created_after_expression Option<String> Restrict to tasks that were created after the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object. [optional]
created_before Option<String> Restrict to tasks that were created before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.332+0200. [optional]
created_before_expression Option<String> Restrict to tasks that were created before the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object. [optional]
delegation_state Option<String> Restrict to tasks that are in the given delegation state. Valid values are PENDING and RESOLVED. [optional]
candidate_groups Option<Vec> Restrict to tasks that are offered to any of the given candidate groups. Takes a comma-separated list of group names, so for example developers,support,sales. [optional]
candidate_groups_expression Option<String> Restrict to tasks that are offered to any of the candidate groups described by the given expression. See the user guide for more information on available functions. The expression must evaluate to java.util.List of Strings. [optional]
with_candidate_groups Option<bool> Only include tasks which have a candidate group. Value may only be true, as false is the default behavior. [optional][default to false]
without_candidate_groups Option<bool> Only include tasks which have no candidate group. Value may only be true, as false is the default behavior. [optional][default to false]
with_candidate_users Option<bool> Only include tasks which have a candidate user. Value may only be true, as false is the default behavior. [optional][default to false]
without_candidate_users Option<bool> Only include tasks which have no candidate users. Value may only be true, as false is the default behavior. [optional][default to false]
active Option<bool> Only include active tasks. Value may only be true, as false is the default behavior. [optional][default to false]
suspended Option<bool> Only include suspended tasks. Value may only be true, as false is the default behavior. [optional][default to false]
task_variables Option<Veccrate::models::VariableQueryParameterDto> A JSON array to only include tasks that have variables with certain values. The array consists of JSON objects with three properties name, operator and value. name is the variable name, operator is the comparison operator to be used and value the variable value. value may be of type String, Number or Boolean. Valid operator values are: eq - equal to; neq - not equal to; gt - greater than; gteq - greater than or equal to; lt - lower than; lteq - lower than or equal to; like. key and value may not contain underscore or comma characters. [optional]
process_variables Option<Veccrate::models::VariableQueryParameterDto> A JSON array to only include tasks that belong to a process instance with variables with certain values. The array consists of JSON objects with three properties name, operator and value. name is the variable name, operator is the comparison operator to be used and value the variable value. value may be of type String, Number or Boolean. Valid operator values are: eq - equal to; neq - not equal to; gt - greater than; gteq - greater than or equal to; lt - lower than; lteq - lower than or equal to; like. key and value may not contain underscore or comma characters. [optional]
case_instance_variables Option<Veccrate::models::VariableQueryParameterDto> A JSON array to only include tasks that belong to a case instance with variables with certain values. The array consists of JSON objects with three properties name, operator and value. name is the variable name, operator is the comparison operator to be used and value the variable value. value may be of type String, Number or Boolean. Valid operator values are: eq - equal to; neq - not equal to; gt - greater than; gteq - greater than or equal to; lt - lower than; lteq - lower than or equal to; like. key and value may not contain underscore or comma characters. [optional]
variable_names_ignore_case Option<bool> Match all variable names in this query case-insensitively. If set variableName and variablename are treated as equal. [optional][default to false]
variable_values_ignore_case Option<bool> Match all variable values in this query case-insensitively. If set variableValue and variablevalue are treated as equal. [optional][default to false]
parent_task_id Option<String> Restrict query to all tasks that are sub tasks of the given task. Takes a task id. [optional]
or_queries Option<Veccrate::models::TaskQueryDto> A JSON array of nested task queries with OR semantics. A task matches a nested query if it fulfills at least one of the query's predicates. With multiple nested queries, a task must fulfill at least one predicate of each query (Conjunctive Normal Form). All task query properties can be used except for: sorting, withCandidateGroups, withoutCandidateGroups, withCandidateUsers, withoutCandidateUsers See the User guide for more information about OR queries. [optional]
sorting Option<Veccrate::models::TaskQueryDtoSorting> Apply sorting of the result [optional]

[Back to Model list] [Back to API list] [Back to README]