Example
{
"id": "cfd5ebe9-bcdd-11ea-a58d-98039b07e4ec",
"progress": 0,
"status": 3,
"lastRanTimestamp": null,
"type": "wipe",
"running": false,
"paused": false,
"finished": false,
"idle": true,
"created": 1593747144,
"updated": 1593747144,
"cron": "0 0 * * 1,2,3,4,5,6,7",
"enabled": true,
"appId": null,
"appGroupId": "100303899",
"ownerId": "84",
"lastScheduledTimestamp": null,
"forkedAppId": "",
"appGroup": {
"id": "100303899"
},
"owner": {
"id": "84"
},
"filter": {
"field": "title",
"days": 30,
"unit": "s"
}
}
Fields
Identity and ownership
| Field | Type | Description |
|---|
id | String | The ID of the scheduled reindexing task. |
appId | String | The ID of the version. |
appGroupId | String | The ID of the application. |
appGroup.id | String | The ID of the application. |
ownerId | String | The ID of the owner. |
owner.id | String | The ID of the owner. |
forkedAppId | String | The ID of the source version based on which reindexing is performed. |
Scheduling
| Field | Type | Description |
|---|
cron | String | The cron expression that defines the task schedule. For example, 0 0 * * 1,2,3,4,5,6,7 runs the task at midnight every day of the week. For the full cron syntax, see Cron field in ScheduledTask. |
enabled | Boolean | Specifies whether the scheduled task is enabled. |
lastScheduledTimestamp | Integer/null | The timestamp when the task was last scheduled. |
lastRanTimestamp | Integer/null | The timestamp when the scheduled reindexing task was last run. |
Task type
| Field | Type | Description |
|---|
type | String | The type of operation the task performs. Valid values: wipe (a data deletion task), fork (a data import and reindexing task), reindex (a reindexing task), clear (a data clearing task). |
Execution state
| Field | Type | Description |
|---|
progress | Integer | The progress of the scheduled reindexing task. |
status | Integer | The current state of the task. Valid values: 0 (running), 1 (paused), 2 (complete), 3 (idle). |
running | Boolean | Specifies whether the task is currently running. Corresponds to status value 0. |
paused | Boolean | Specifies whether the task is paused. Corresponds to status value 1. |
finished | Boolean | Specifies whether the task has completed. Corresponds to status value 2. |
idle | Boolean | Specifies whether the task is idle and waiting for the next scheduled run. Corresponds to status value 3. |
Data filter
The filter object specifies which data the task deletes based on field expiration.
| Field | Type | Description |
|---|
filter | Object | The conditions used to identify and delete expired data. |
filter.field | String | The name of the index field evaluated against the expiration settings. |
filter.days | Integer | The expiration threshold in days. Data older than this value is deleted. Valid values: 7–180. |
filter.unit | String | The unit of the value stored in filter.field. Valid values: s (seconds), ms (milliseconds). |