- URL:
- https://<root>/system/tasks
- Methods:
GET- Operations:
- Create Task
- Child Resources:
- Task
- Required Capability:
- Access allowed only with the default administrator role
- Version Introduced:
- 10.9
Description
The tasks resource returns a list of tasks (Clean, Backup, Create) that exist within your deployment.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample request URL used to access the task resource:
https://organization.domain.com/context/admin/system/tasks?f=pjsonJSON Response example
{
"result": [
{
"generation": 2,
"created": 1634933908445,
"active": false,
"ownerId": "f4630325200d48d3bd1c763e6d0dd904",
"type": "CREATE_BACKUP_TASK_TYPE",
"orgId": "0123456789ABCDEF",
"cronSchedule": {
"dayOfWeek": "7",
"hour": "4",
"month": "*",
"dayOfMonth": "?",
"minute": "0"
},
"cronExpression": "0 0 4 ? * 7",
"runIntervalSeconds": 604800,
"taskType": "CreateBackup",
"taskState": "paused",
"taskTitle": "schedule2",
"maxOccurrences": -1,
"id": "5f0cdc50cf36460990bb6edfe9b60e08",
"lastStart": 1634961600000,
"parameters": {
"itemId": "",
"metaData": {
"recurring": true,
"startTime": "04:00",
"retention": {
"type": "day",
"value": 14
}
},
"retentionOffset": 1209600000,
"name": "schedule2",
"storeName": "default",
"passcode": "otherPassCode!"
},
"updated": 1635343062131,
"taskId": "5f0cdc50cf36460990bb6edfe9b60e08",
"startDate": 1634961600000
},
{
"generation": 116,
"created": 1634930439965,
"active": false,
"ownerId": "f4630325200d48d3bd1c763e6d0dd904",
"type": "CREATE_BACKUP_TASK_TYPE",
"orgId": "0123456789ABCDEF",
"cronSchedule": {
"dayOfWeek": "?",
"hour": "*/1",
"month": "*",
"dayOfMonth": "*",
"minute": "0"
},
"cronExpression": "0 0 */1 * * ?",
"runIntervalSeconds": 3600,
"taskType": "CreateBackup",
"taskState": "paused",
"taskTitle": "schedule1",
"maxOccurrences": -1,
"id": "059ac9ad30ad4ac18d92faec93715428",
"lastStart": 1635339600000,
"parameters": {
"itemId": "",
"metaData": {
"recurring": true,
"startTime": "20:00",
"retention": {
"type": "day",
"value": 14
}
},
"retentionOffset": 1209600000,
"name": "schedule1",
"storeName": "default",
"passcode": "passCode"
},
"updated": 1635343065085,
"taskId": "059ac9ad30ad4ac18d92faec93715428",
"startDate": 1634932800000
},
{
"generation": 128,
"created": 1634917446184,
"active": true,
"ownerId": "f4630325200d48d3bd1c763e6d0dd904",
"type": "BACKUP_RETENTION_TASK_TYPE",
"orgId": "0123456789ABCDEF",
"cronSchedule": {
"dayOfWeek": "?",
"hour": "*",
"month": "*",
"dayOfMonth": "*",
"minute": "0"
},
"cronExpression": "0 0 * * * ?",
"itemId": "f50816a3-6f67-4df0-879b-00bf39f5c7c3",
"runIntervalSeconds": 3600,
"taskType": "BackupRetentionCleaner",
"taskState": "active",
"taskTitle": "backupRetentionCleanerTask",
"maxOccurrences": -1,
"id": "05422480f3014101a467314182f5d858",
"lastStart": 1635372000000,
"updated": 1634917446184,
"taskId": "05422480f3014101a467314182f5d858"
},
{
"generation": 129,
"created": 1634911716168,
"active": true,
"ownerId": "f4630325200d48d3bd1c763e6d0dd904",
"type": "GP_JOBS_CLEANER_TASK_TYPE",
"orgId": "0123456789ABCDEF",
"cronSchedule": {
"dayOfWeek": "?",
"hour": "*",
"month": "*",
"dayOfMonth": "*",
"minute": "0"
},
"cronExpression": "0 0 * * * ?",
"itemId": "032f58d7-956e-4bd4-8f6f-994187a70dfa",
"runIntervalSeconds": 3600,
"taskType": "CleanGPJobs",
"taskState": "active",
"taskTitle": "gpCleanerTask",
"maxOccurrences": -1,
"id": "e34d3851b7f34510a3097f23cb7adab3",
"lastStart": 1635372000000,
"updated": 1634911716168,
"taskId": "e34d3851b7f34510a3097f23cb7adab3"
}
],
"total": 4,
"num": 4,
"start": 0,
"nextStart": 0
}