Update

• URL:https://[root]/community/users/[userName]/tasks/[taskID]/update(POST only)
  
• Version Introduced:10.8.1

Description

This operation allows you to edit and update the properties of a preexisting task. Updates that have been made to a task will go into effect during its next scheduled execution.

Request parameters

Parameter	Details
title (Optional)	Title of the task. Example title=OnceAMinute30Times
type (Required)	The type of task, either executing a notebook or updating an Insights workbook, that will be executed against the specified item. Note: Support for scene services and ArcGIS Workflow Manager was added at ArcGIS Enterprise 10.9. Values: ExecuteNotebook | UpdateInsightsWorkbook | ExecuteSceneCook | ExecuteWorkflowManager | ExecuteReport Note: The ExecuteReport type is only applicable to ArcGIS Online organizations.
parameters (Optional; required for administrative reports)	JSON object of additional parameters that will be added to the task run request. Administrative reports example parameters={​​"reportType":"org","reportSubType":"activity","timeDuration":"daily", "title":"MyTitle"}​​
itemId (Required; optional for administrative reports)	Item ID of the item the scheduled task will be run against. itemID=029b61ca770e428d9468a2a55f40b9fb
startDate (Optional)	Defines the date, in Epoch milliseconds, of when the scheduled task should begin running. Example startDate=1589428800000
endDate (Optional)	Defines the date, in Epoch milliseconds, of when the scheduled task should stop running. Example endDate=1589428800000
minute (Required)	A valid CRON expression (, - * /) that specifies the minute value for the task's schedule. Example minute=*/1
hour (Required)	A valid CRON expression (, - * /) that specifies the hour value for the task's schedule. The hour, dayOfWeek, and dayOfMonth parameters must be adjusted for UTC. Example hour=3 hour=*
dayOfMonth (Required)	A valid CRON expression (, - * ? / L W C) that specifies the day of the month for the task's schedule. dayOfMonth should be adjusted to UTC hours. For example, 8:00 p.m. PDT on the fourth day of the month would be 3:00 a.m. UTC on the fifth day of the month. Values for this parameter can be 1 through 31, representing a day of the month. Example dayOfMonth=5 dayOfMonth=*
month (Required)	A valid CRON expression (, - * /) that specifies the month for the task's schedule. To represent a specific month, use values 1 through 12 (January to December). Example 1: Any month month=* Example 2: Specific month (August) month=8 Example 3: Every two months month=*/2
dayOfWeek (Required)	A valid CRON expression (, - * ? / L C #) that specifies the day of the week for the task's schedule. The dayOfWeek parameter should be adjusted to UTC hours. For example, Monday, 8:00 p.m. PDT would be Tuesday, 3:00 a.m. UTC. Values for this parameter can be 1 through 7, representing Sunday through Saturday, respectively. Example dayOfWeek=2 dayOfWeek=?
maxOccurrences (Optional)	The maximum number of occurrences this task should execute. Example maxOccurrences=30
f	The response format. The default format is html. Values: html | json | pjson

Example usage

The following is a sample POST request for update:

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&parameters=&itemId=029b61ca770e428d9468a2a55f40b9fb&startDate=1589428800000&endDate=1589428800000&minute=*/1&hour=*&dayOfMonth=*&month=*&dayOfWeek=?&maxOccurrences=30&f=pjson

JSON Response example

{
  "success": true,
  "taskId": "a7ce628005004e758f3387d735b3e1ca"
}