You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: reference/api/tasks.md
+4-10Lines changed: 4 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -67,15 +67,13 @@ Task results are [paginated](#paginating-tasks) and can be [filtered](#filtering
67
67
68
68
You can filter the task list by the value of the `status`, `type`, or `indexUid` fields. For example, the following command returns all tasks belonging to the index `movies`. Note that the `indexUid` is case-sensitive:
69
69
70
-
<CodeSamplesid="get_all_tasks_by_index_1" />
70
+
<CodeSamplesid="get_all_tasks_filtering_1" />
71
71
72
72
Use the ampersand character `&` to combine filters, equivalent to a logical `AND`. Use the comma character `,` to add multiple filter values for a single field.
73
73
74
74
For example, the following command would return all `documentAdditionOrUpdate` tasks that either `succeeded` or `failed`:
75
75
76
-
```bash
77
-
curl -X GET 'http://localhost:7700/tasks?status=succeeded,failed&type=documentAdditionOrUpdate'
78
-
```
76
+
<CodeSamplesid="get_all_tasks_filtering_2" />
79
77
80
78
At this time, `OR` operations between different filters are not supported. For example, you cannot view only tasks which have a type of `documentAddition`**or** a status of `failed`.
81
79
@@ -89,9 +87,7 @@ For each call to this endpoint, the response will include the `next` field: this
89
87
90
88
This command returns tasks two at a time starting from task `uid``10`.
91
89
92
-
```bash
93
-
curl -X GET 'http://localhost:7700/tasks?limit=2&from=10
94
-
```
90
+
<CodeSamplesid="get_all_tasks_paginating_1" />
95
91
96
92
**Response:**
97
93
@@ -133,9 +129,7 @@ curl -X GET 'http://localhost:7700/tasks?limit=2&from=10
133
129
134
130
To view the next page of results, you would repeat the same query, replacing the value of `from` with the value of `next`:
135
131
136
-
```bash
137
-
curl -X GET 'http://localhost:7700/tasks?limit=2&from=8
138
-
```
132
+
<CodeSamplesid="get_all_tasks_paginating_2" />
139
133
140
134
When the returned value of `next` is `null`, you have reached the final page of results.
0 commit comments