diff --git a/docs/apis-tools/tasklist-api-rest/schemas/enums/operator.mdx b/docs/apis-tools/tasklist-api-rest/schemas/enums/operator.mdx new file mode 100644 index 0000000000..8b37adfeb6 --- /dev/null +++ b/docs/apis-tools/tasklist-api-rest/schemas/enums/operator.mdx @@ -0,0 +1,56 @@ +--- +id: operator +title: Operator +hide_table_of_contents: false +--- + +export const Bullet = () => ( + <> + +  ●  + + +); + +export const SpecifiedBy = (props) => ( + <> + Specification + + ⎘ + + +); + +export const Badge = (props) => ( + <> + {props.text} + +); + +Filter task by variables operator. + +```java +enum Operator { + eq +} +``` + +### Values + +#### [Operator.eq](#) + +> Equals + +[`TaskVariables`](../models/task-variables.mdx) diff --git a/docs/apis-tools/tasklist-api-rest/schemas/models/task-variables.mdx b/docs/apis-tools/tasklist-api-rest/schemas/models/task-variables.mdx new file mode 100644 index 0000000000..1c831541fd --- /dev/null +++ b/docs/apis-tools/tasklist-api-rest/schemas/models/task-variables.mdx @@ -0,0 +1,94 @@ +--- +id: task-variables +title: TaskVariables +hide_table_of_contents: false +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +export const Bullet = () => ( + <> + +  ●  + + +); + +export const SpecifiedBy = (props) => ( + <> + Specification + + ⎘ + + +); + +export const Badge = (props) => ( + <> + {props.text} + +); + +Filter task by Variables + + + + +```graphql +{ + "name": string, + "value": string, + "operator": Operator +} +``` + + + + + +```json +{ + "name": "variableName", + "value": "variableValue", + "operator": "eq" +} +``` + + + + +### Fields + +#### [TaskVariables.name](#)`string` + +> The name of the variable + +#### [TaskVariables.value](#)`string` + +> The value of the variable + +#### [TaskVariables.operator](#)[`Operator`](../enums/operator.mdx) + +> Define the search operator to use for the variable + +### Member of + +[`TaskSearchRequest`](../requests/task-search-request.mdx) diff --git a/docs/apis-tools/tasklist-api-rest/schemas/requests/task-search-request.mdx b/docs/apis-tools/tasklist-api-rest/schemas/requests/task-search-request.mdx index beebbe0187..ab4e7369e1 100644 --- a/docs/apis-tools/tasklist-api-rest/schemas/requests/task-search-request.mdx +++ b/docs/apis-tools/tasklist-api-rest/schemas/requests/task-search-request.mdx @@ -65,6 +65,7 @@ TaskSearchRequest - query object to search tasks by provided params. "pageSize": int, "followUpDate": DateFilter, "dueDate": DateFilter, + "taskVariables": [TaskVariables], "sort": [TaskOrderBy], "searchAfter": [string], "searchAfterOrEqual": [string], @@ -96,6 +97,13 @@ TaskSearchRequest - query object to search tasks by provided params. "from": "2023-03-29T18:38:10.491Z", "to": "2023-03-29T18:38:10.491Z" }, + "taskVariables": [ + { + "name": "variable_name", + "value": "variable_value", + "operator": "eq" + } + ], "sort": [ { "field": "completionTime", @@ -156,6 +164,10 @@ TaskSearchRequest - query object to search tasks by provided params. > Specifying a range of due dates for the tasks to search for. +#### [TaskSearchRequest.taskVariables](#)[`TaskVariables`](../models/task-variables.mdx) + +> An array of filter clauses specifying the variables to filter for. If defined, the query returns only tasks to which all clauses apply. However, it's important to note that this filtering mechanism is designed to work exclusively with truncated variables. This means variables of a larger size are not compatible with this filter, and attempts to use them may result in inaccurate or incomplete query results. + #### [TaskSearchRequest.sort](#)[`TaskOrderBy`](../models/task-order-by.mdx) > An array of objects specifying the fields to sort the results by.