Task

URL:
https://<root>/system/tasks/<taskID>
Methods:
GET
Operations:
Edit Task, Delete Task, Enable Task, Disable Task
Child Resources:
Runs
Required Capability:
Access allowed only with the default administrator role
Version Introduced:
10.9

Description

The resource for an individual task, returning information such as the task's title, parameters, and schedule.

Request parameters

ParameterDetails

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample request URL used to access an individual task resource:

1
https://organization.domain.com/context/admin/system/tasks/87b8a97828e647e8af5d634774b2b8a7?f=pjson

JSON Response examples

The following is a sample JSON response returned for a CleanGPJobs task:

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
{
  "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 CreateBackup task:

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
{
  "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 BackupRetentionCleaner:

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

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