- URL:
- https://<root>/system/tasks/<taskID>
- Methods:
GET- Operations:
- Edit Task, Delete Task, Enable Task, Disable Task
- Child Resources:
- Runs
- Version Introduced:
- 10.9
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The resource for an individual task, returning information such as the task's title, parameters, and schedule.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample request URL used to access an individual task resource:
https://organization.example.com/<context>/admin/system/tasks/87b8a97828e647e8af5d634774b2b8a7?f=pjsonJSON Response examples
The following is a sample JSON response returned for a Clean task:
{
"generation": 4,
"created": "Apr 21, 2021, 10:42:17 PM",
"active": true,
"ownerId": "c076e404cec9497488f008fc5b83e6fa",
"type": "GP_JOBS_CLEANER_TASK_TYPE",
"orgId": "0123456789ABCDEF",
"cronSchedule": {
"dayOfWeek": "?",
"hour": "*",
"month": "*",
"dayOfMonth": "*",
"minute": "0"
},
"cronExpression": "0 0 * * * ?",
"itemId": "0a78247d-0d0d-4b69-a658-03104e15bd66",
"runIntervalSeconds": 3600,
"taskType": "CleanGPJobs",
"taskState": "active",
"taskTitle": "gpCleanerTask",
"maxOccurrences": -1,
"id": "2a1ba86743414f929c0c1f38b32f1c9c",
"lastStart": "Apr 22, 2021, 2:00:00 AM",
"updated": "Apr 21, 2021, 10:42:17 PM",
"taskId": "2a1ba86743414f929c0c1f38b32f1c9c"
}The following is a sample JSON response returned for a Create task:
{
"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": "{crypt}3ngE7lQuQGDfaiab4uogjg=="
},
"updated": 1635343062131,
"taskId": "5f0cdc50cf36460990bb6edfe9b60e08",
"startDate": 1634961600000
}The following is a sample JSON response returned for Backup:
{
"generation": 129,
"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": 1635375600000,
"updated": 1634917446184,
"taskId": "05422480f3014101a467314182f5d858"
}