- URL:
- https://[root]/community/users/[userName]/tasks/[taskID]/update
- Methods:
POST
- Version Introduced:
- ArcGIS Enterprise 10.8.1
Example usage
The following is a sample ArcGIS Online POST request for the update
operation:
POST /sharing/rest/community/users/NBadmin/tasks/a7ce628005004e758f3387d735b3e1ca/update HTTP/1.1
Host: org.arcgis.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
title=OnceAMinute30Times&type=ExecuteNotebook¶meters=&itemId=029b61ca770e428d9468a2a55f40b9fb&startDate=1589428800000&endDate=1589428800000&minute=*/1&hour=*&dayOfMonth=*&month=*&dayOfWeek=?&maxOccurrences=30&f=pjson
The following is a sample ArcGIS Enterprise POST request for the update
operation:
POST /webadaptor/sharing/rest/community/users/NBadmin/tasks/a7ce628005004e758f3387d735b3e1ca/update HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
title=OnceAMinute30Times&type=ExecuteNotebook¶meters=&itemId=029b61ca770e428d9468a2a55f40b9fb&startDate=1589428800000&endDate=1589428800000&minute=*/1&hour=*&dayOfMonth=*&month=*&dayOfWeek=?&maxOccurrences=30&f=pjson
Description
The update
operation allows you to edit and update the properties of a preexisting task. Updates made to a task take effect during its next scheduled run.
Request parameters
Parameter | Details |
---|---|
(Optional) | Title of the task. Example:
|
(Required) | The type of task, either running a notebook or updating an Insights workbook, that will be run on the specified item. Values: |
(Optional; required for administrative reports) | JSON object of additional parameters that will be added to the task run request. Administrative reports example
|
(Required; optional for administrative reports) | Item ID of the item the scheduled task will be run on. Example:
|
(Optional) | The date, in Epoch milliseconds, the scheduled task will begin running. Example:
|
(Optional) | The date, in Epoch milliseconds, the scheduled task will stop running. Example:
|
(Required) | A valid CRON expression ( Example:
|
(Required) | A valid CRON expression ( Example:
|
(Required) | A valid CRON expression ( Example:
|
(Required) | A valid CRON expression ( Examples:
|
(Required) | A valid CRON expression ( Example:
|
(Optional) | The maximum number of times the task will run. Example:
|
| The response format. The default format is Values: |
JSON Response example
{
"success": true,
"taskId": "a7ce628005004e758f3387d735b3e1ca"
}