Debian Codegraph @

api-ref/source/v2/task/reprocessing_parameters.yml

raw
1 path_scope_id:
2 in: path
3 description: |
4 The scope ID to retrieve.
5 type: string
6 required: true
7
8 limit:
9 in: query
10 description: |
11 For pagination. The maximum number of results to return.
12 type: int
13 required: false
14
15 offset:
16 in: query
17 description: |
18 For pagination. The index of the first element that should be returned.
19 type: int
20 required: false
21
22 scope_ids_order_query: &scope_ids_order_query
23 in: query
24 description: |
25 The order in which reprocessing tasks are returned. By default, we
26 order reprocessing tasks ``desc`` by their insertion order in the
27 database. The possible values are ``desc`` or ``asc``.
28 required: false
29 type: string
30
31 scope_ids_query: &scope_ids_query
32 in: query
33 description: |
34 The scope IDs one wants to retrieve the reprocessing tasks of. If not
35 informed, all reprocessing tasks, for all scopes are retrieved.
36 required: false
37 type: string
38
39 end_reprocess_time:
40 in: body
41 description: |
42 The end date for the reprocessing task.
43 type: iso8601 timestamp
44 required: true
45
46 reason:
47 in: body
48 description: |
49 The reason for the reprocessing to take place.
50 type: string
51 required: true
52
53 scope_ids:
54 <<: *scope_ids_query
55 in: body
56 description: |
57 The scope IDs to reprocess. Must be comma-separated to schedule more than one.
58 One can use the keyword `ALL` to schedule all scopes to be reprocessed.
59 required: true
60
61 start_reprocess_time:
62 in: body
63 description: |
64 The start date for the reprocessing task.
65 type: iso8601 timestamp
66 required: true