/allScheduledTasks: All Scheduled Tasks (Organization)

URL:
https://[root]/portals/[portalID]/allScheduledTasks
Methods:
POST
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):

1
https://org.arcgis.com/sharing/rest/portals/0123456789ABCDEF/allScheduledTasks?types=ExecuteNotebook&userFilter=NBadmin&active=true&f=pjson

The 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):

1
https://machine.domain.com/webadaptor/sharing/rest/portals/0123456789ABCDEF/allScheduledTasks?types=ExecuteNotebook&userFilter=NBadmin&active=true&f=pjson

Description

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

ParameterDetails

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

1
itemId=b181b9ab14d0442faa183215ec2c615e

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

1
userFilter=NBdmin

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
{
  "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"
    }
  ]
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close