Skip To Content
ArcGIS Developers
Dashboard

/allScheduledTasks: All Scheduled Tasks (Organization)

  • URL:https://[root]/portals/[portalID]/allScheduledTasks
  • Version Introduced:10.8.1

Example usage

Below is a sample ArcGIS Enterprise request URL used to filter the results of allScheduledTasks 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=pjson

Description

This operation returns a list of all scheduled tasks that exist within 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 tasks 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

itemId=b181b9ab14d0442faa183215ec2c615e
active

(Optional)

Specifies whether the tasks should 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

userFilter=NBdmin
types

(Optional)

Specifies the task type.

Note:

Support for Scene Services and ArcGIS Workflow Manager was added at ArcGIS Enterprise 10.9.

Values: ExecuteNotebook | UpdateInsightsWorkbook | ExecuteSceneCook | ExecuteWorkflowManager

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"
    }
  ]
}