- URL:https://[root]/portals/[portalID]/allScheduledTasks
- Version Introduced:10.8.1
Example usage
The following is a sample ArcGIS Online request URL used to access the allScheduledTasks resource, demonstrating how to filter the results by tasks with a type of ExecuteNotebook, owned by the user NBadmin, that are currently active (true):
https://org.arcgis.com/sharing/rest/portals/0123456789ABCDEF/allScheduledTasks?types=ExecuteNotebook&userFilter=NBadmin&active=true&f=pjsonThe following is a sample ArcGIS Enterprise request URL used to access the allScheduledTasks resource, demonstrating how to filter the results by tasks with a type of ExecuteNotebook, owned by the user NBadmin, that are currently active (true):
https://machine.domain.com/webadaptor/sharing/rest/portals/0123456789ABCDEF/allScheduledTasks?types=ExecuteNotebook&userFilter=NBadmin&active=true&f=pjsonDescription
The allScheduledTasks resource returns a list of all scheduled tasks that exist in the organization. The results can be filtered by specifying the item ID of an item a task is assigned to, the username of the task's owner, as well as the task type and the task's active status.
Request parameters
Note:
Support for scene services and ArcGIS Workflow Manager was added at Enterprise 10.9. Support for administrative reports (ExecuteReport) was added at Enterprise 11.0.
| Parameter | Details |
|---|---|
| itemId (Optional) | The ID of an item that has a scheduled task associated with it. Only one task item ID can be entered at a time. Example |
| active (Optional) | Specifies whether the tasks will be filtered by active (true) tasks. Values: true | false |
| userFilter (Optional) | Filters tasks by the username of the task owner. Only one username can be entered at a time. Example |
| types (Optional) | Specifies the task type. Values: ExecuteNotebook | UpdateInsightsWorkbook | ExecuteSceneCook | ExecuteWorkflowManager | ExecuteReport |
| f | The response format. The default response is html. Values: html | json | pjson |
JSON Response example
{
"total": 2,
"start": 1,
"num": 2,
"nextStart": -1,
"tasks": [
{
"id": "d08b95a4b1ff4f85b927ef8dfc62a668",
"itemId": "a4b0cfc8fc354a0eb2502976f6138b77",
"type": "ExecuteNotebook",
"title": "FiveTimesOnceAMinute",
"userId": "NBadmin",
"cronSchedule": {
"minute": "*/1",
"hour": "*",
"dayOfMonth": "*",
"month": "*",
"dayOfWeek": "?"
},
"runIntervalSeconds": 0,
"maxOccurrences": 5,
"parameters": {
"updatePortalItem": true,
"saveInjectedParameters": false,
"notebookParameters": "{}"
},
"created": 1589460357000,
"updated": 1589460357000,
"startDate": 1589428800000,
"active": true,
"taskState": "active"
},
{
"id": "5837c7bc37ac404e8e3c16d9022b2b59",
"itemId": "029b61ca770e428d9468a2a55f40b9fb",
"type": "ExecuteNotebook",
"title": "OnceAMinute10times",
"userId": "NBadmin",
"cronSchedule": {
"minute": "*/1",
"hour": "*",
"dayOfMonth": "*",
"month": "*",
"dayOfWeek": "?"
},
"runIntervalSeconds": 60,
"lastStart": 1589457360000,
"maxOccurrences": 10,
"parameters": {
"updatePortalItem": true,
"saveInjectedParameters": false,
"notebookParameters": "{}"
},
"created": 1589456737000,
"updated": 1589457404000,
"startDate": 1589428800000,
"active": true,
"taskState": "active"
}
]
}