/createTask: Create Task

URL:: https://[root]/community/users/[userName]/tasks/createTask
Methods:: POST
Version Introduced:: ArcGIS Enterprise 10.8.1

Example usage

The following is a sample ArcGIS Online POST request for the createTask operation, demonstrating how to create a task for a scene service:

Use dark colors for code blocksCopy
POST /sharing/rest/community/users/NBadmin/tasks/a7ce628005004e758f3387d735b3e1ca/createTask HTTP/1.1
Host: org.arcgis.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

title=OnceAnHour30Times&type=ExecuteSceneCook&parameters={"service_url": "https://machine.esri.com/webadaptor/rest/services/Hosted/ServiceName/SceneServer", "num_of_caching_service_instances": 2, "layer": "{}", "update_mode": "PARTIAL_UPDATE_NODES"}&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 createTask operation, demonstrating how to create a task for a scene service:

Use dark colors for code blocksCopy
POST /webadaptor/sharing/rest/community/users/NBadmin/tasks/a7ce628005004e758f3387d735b3e1ca/createTask HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

title=OnceAnHour30Times&type=ExecuteSceneCook&parameters={"service_url": "https://machine.esri.com/webadaptor/rest/services/Hosted/ServiceName/SceneServer", "num_of_caching_service_instances": 2, "layer": "{}", "update_mode": "PARTIAL_UPDATE_NODES"}&itemId=029b61ca770e428d9468a2a55f40b9fb&startDate=1589428800000&endDate=1589428800000&minute=*/1&hour=*&dayOfMonth=*&month=*&dayOfWeek=?&maxOccurrences=30&f=pjson

Description

The createTask operation creates a scheduled task for a specified Notebook Server installation, Insights workbook, scene service, ArcGIS Workflow Manager workflow, and administrative report. Once the task has been created, it can be updated using the update operation. Additionally, scheduled tasks can be disabled, re-enabled, and deleted.

Request parameters

Parameter Details

Parameter	Details
`title` (Optional)	Title of the task. Example: Use dark colors for code blocksCopy `1 title=OnceAMinute30Times`
`type` (Required)	The type of task that will be run on the specified item. Values: `ExecuteNotebook` \| `UpdateInsightsWorkbook` \| `ExecuteSceneCook` \| `ExecuteWorkflowManager` \| `ExecuteReport` \| `GPService`
`taskURL` (Optional; required for geoprocessing service)	The URL of the task of an asynchronous geoprocessing service on any of the federated servers of your portal. Example: `https://machine.domain.com/webadaptor/rest/services/ServiceName/GPServer/TaskName`
`parameters` (Optional; required for scene services, administrative reports, and geoprocessing service)	A JSON object of additional parameters that will be added to the task run request. This parameter is required for scene services. Syntax example for a scene service (formatted for readability): Use dark colors for code blocksCopy `1 2 3 4 5 6 7 8 { "service_url": <scene service URL>, "num_of_caching_service_instances": 2, //2 instances are required "layer": "{<list of scene layers to cook>}", //The default is all layers "update_mode": "PARTIAL_UPDATE_NODES" //RECREATE_ALL_NODES (Re-cook full scene cache) \| PARTIAL_UPDATE_NODES //(Update scene cache from latest edits to the scene service) \| PARTIAL_UPDATE_ATTRIBUTES //(Update only attributes and not geometries) }` Scene service example: Use dark colors for code blocksCopy `1 2 parameters={"service_url": https://machine.esri.com/wedadaptor/rest/services/Hosted/ServiceName/SceneServer, "num_of_caching_service_instances": 2, "layer": "{}", "update_mode":"PARTIAL_UPDATE_NODES"}` Administrative reports example: Use dark colors for code blocksCopy `1 parameters={"reportType":"org","reportSubType":"activity","timeDuration":"daily", "title":"MyTitle"}` Geoprocessing service example (formatted for readability): Use dark colors for code blocksCopy `1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 { "in_features": { "url": "https://machine.domain.com/webadaptor/rest/services/Hosted/ServiceName/FeatureServer/0" }, "buffer_distance_or_field": { "distance": 5, "units": "esriKilometers" }, "esri_out_feature_service_name": { "serviceProperties": { "serviceUrl": "https://machine.domain.com/server/rest/services/Hosted/OutputFeatureServiceName/FeatureServer" }, "itemProperties": { "overwrite": true, "newFeatureServiceOnOverwriteFail": true } } }`
`itemId` (Required; optional for administrative reports)	Item ID of the item the scheduled task will be run on. Example: Use dark colors for code blocksCopy `1 itemId=029b61ca770e428d9468a2a55f40b9fb`
`startDate` (Optional)	The date, in Epoch milliseconds, the scheduled task will begin running. Example: Use dark colors for code blocksCopy `1 startDate=1589428800000`
`endDate` (Optional)	The date, in Epoch milliseconds, the scheduled task will stop running. Example: Use dark colors for code blocksCopy `1 endDate=1589428800000`
`minute` (Required)	A valid CRON expression (`,` `-` `` `/`) that specifies the minute value for the task's schedule. Example: Use dark colors for code blocksCopy `1 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: Use dark colors for code blocksCopy `1 2 hour=3 hour=`
`dayOfMonth` (Required)	A valid CRON expression (`,` `-` `` `?` `/` `L` `W` `C`) that specifies the day of the month for the task's schedule. Adjust the `dayOfMonth` value 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: Use dark colors for code blocksCopy `1 2 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). Examples: Use dark colors for code blocksCopy `1 2 3 4 5 6 7 8 //Any month month= //A specific month (August) month=8 //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. Adjust the `dayOfWeek` value 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. Example: Use dark colors for code blocksCopy `1 2 dayOfWeek=2 dayOfWeek=?`
`maxOccurrences` (Optional)	The maximum number of times this task will run. Example: Use dark colors for code blocksCopy `1 maxOccurrences=30`
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

title

(Optional)

Title of the task.

Example:

Use dark colors for code blocksCopy
title=OnceAMinute30Times

type

(Required)

The type of task that will be run on the specified item.

taskURL

(Optional; required for geoprocessing service)

The URL of the task of an asynchronous geoprocessing service on any of the federated servers of your portal.

Example: https://machine.domain.com/webadaptor/rest/services/ServiceName/GPServer/TaskName

parameters

(Optional; required for scene services, administrative reports, and geoprocessing service)

A JSON object of additional parameters that will be added to the task run request. This parameter is required for scene services.

Syntax example for a scene service (formatted for readability):

Use dark colors for code blocksCopy
{
  "service_url": <scene service URL>,
  "num_of_caching_service_instances": 2, //2 instances are required
  "layer": "{<list of scene layers to cook>}", //The default is all layers
  "update_mode": "PARTIAL_UPDATE_NODES" //RECREATE_ALL_NODES (Re-cook full scene cache) |
                  PARTIAL_UPDATE_NODES //(Update scene cache from latest edits to the scene service) |
                  PARTIAL_UPDATE_ATTRIBUTES //(Update only attributes and not geometries)
}

Scene service example:

Use dark colors for code blocksCopy
parameters={"service_url": https://machine.esri.com/wedadaptor/rest/services/Hosted/ServiceName/SceneServer,
            "num_of_caching_service_instances": 2, "layer": "{}", "update_mode":"PARTIAL_UPDATE_NODES"}

Administrative reports example:

Use dark colors for code blocksCopy
parameters={​​"reportType":"org","reportSubType":"activity","timeDuration":"daily", "title":"MyTitle"}​​

Geoprocessing service example (formatted for readability):

Use dark colors for code blocksCopy
{
    "in_features": {
        "url": "https://machine.domain.com/webadaptor/rest/services/Hosted/ServiceName/FeatureServer/0"
    },
    "buffer_distance_or_field": {
        "distance": 5,
        "units": "esriKilometers"
    },
    "esri_out_feature_service_name": {
        "serviceProperties": {
            "serviceUrl":
            "https://machine.domain.com/server/rest/services/Hosted/OutputFeatureServiceName/FeatureServer"
        },
        "itemProperties": {
            "overwrite": true,
            "newFeatureServiceOnOverwriteFail": true
        }
    }
}

itemId

(Required; optional for administrative reports)

Item ID of the item the scheduled task will be run on.

Example:

Use dark colors for code blocksCopy
itemId=029b61ca770e428d9468a2a55f40b9fb

startDate

(Optional)

The date, in Epoch milliseconds, the scheduled task will begin running.

Example:

Use dark colors for code blocksCopy
startDate=1589428800000

endDate

(Optional)

The date, in Epoch milliseconds, the scheduled task will stop running.

Example:

Use dark colors for code blocksCopy
endDate=1589428800000

minute

(Required)

A valid CRON expression (, - * /) that specifies the minute value for the task's schedule.

Example:

Use dark colors for code blocksCopy
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:

Use dark colors for code blocksCopy
hour=3
hour=*

dayOfMonth

(Required)

A valid CRON expression (, - * ? / L W C) that specifies the day of the month for the task's schedule. Adjust the
dayOfMonth value 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:

Use dark colors for code blocksCopy
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).

Examples:

Use dark colors for code blocksCopy
//Any month
month=*

//A specific month (August)
month=8

//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. Adjust the dayOfWeek value 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.

Example:

Use dark colors for code blocksCopy
dayOfWeek=2
dayOfWeek=?

maxOccurrences

(Optional)

The maximum number of times this task will run.

Example:

Use dark colors for code blocksCopy
maxOccurrences=30

f

The response format. The default format is html.

Values: html | json | pjson

Additional example usage 1

The following is a sample ArcGIS Enterprise POST request for createTask, demonstrating creating a task for a notebook:

Use dark colors for code blocksCopy
POST /webadaptor/sharing/rest/community/users/NBadmin/tasks/a7ce628005004e758f3387d735b3e1ca/createTask 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

Additional example usage 2

The following is a sample ArcGIS Enterprise POST request for createTask, demonstrating creating a task for a geoprocessing service:

Schedule a pairwise buffer geoprocessing service with an overwritten output feature service. You can have a customized boundary for your request. You need to provide a valid administrator token.

Use dark colors for code blocksCopy
POST /webadaptor/sharing/rest/community/users/GPadmin/createTask HTTP/2
Host: machine.domain.com
Content-Type:	multipart/form-data; boundary=---------------------------4137116237415213046158097313
Content-Length: 2490

-----------------------------4137116237415213046158097313
Content-Disposition: form-data; name="title"

TestGPServiceTask
-----------------------------4137116237415213046158097313
Content-Disposition: form-data; name="type"

GPService
-----------------------------4137116237415213046158097313
Content-Disposition: form-data; name="taskURL"

https://machine.domain.com/webadaptor/rest/services/Level1_Async/GPServer/Pairwise%20Buffer
-----------------------------4137116237415213046158097313
Content-Disposition: form-data; name="parameters"

{
    "in_features": {
        "url": "https://machine.domain.com/webadaptor/rest/services/Hosted/ServiceName/FeatureServer/0"
    },
    "buffer_distance_or_field": {
        "distance": 5,
        "units": "esriKilometers"
    },
    "esri_out_feature_service_name": {
        "serviceProperties": {
            "serviceUrl": "https://machine.domain.com/server/rest/services/Hosted/OutputFeatureServiceName/FeatureServer"
        },
        "itemProperties": {
            "overwrite": true,
            "newFeatureServiceOnOverwriteFail": true
        }
    }
}
-----------------------------4137116237415213046158097313
Content-Disposition: form-data; name="itemId"

9512500fb1ac443baf943f418400b661
-----------------------------4137116237415213046158097313
Content-Disposition: form-data; name="startDate"

1691451979521
-----------------------------4137116237415213046158097313
Content-Disposition: form-data; name="endDate"

-----------------------------4137116237415213046158097313
Content-Disposition: form-data; name="minute"

*/10
-----------------------------4137116237415213046158097313
Content-Disposition: form-data; name="hour"

*
-----------------------------4137116237415213046158097313
Content-Disposition: form-data; name="dayOfMonth"

*
-----------------------------4137116237415213046158097313
Content-Disposition: form-data; name="month"

*
-----------------------------4137116237415213046158097313
Content-Disposition: form-data; name="dayOfWeek"

?
-----------------------------4137116237415213046158097313
Content-Disposition: form-data; name="maxOccurrences"

5
-----------------------------4137116237415213046158097313
Content-Disposition: form-data; name="f"

json
-----------------------------4137116237415213046158097313
Content-Disposition: form-data; name="token"

j18phrBxUy4tX_JAIGFEDqCsVkNsPZfwt-1X2ehnRqcihHaJ54Lbt97Y6pOn83jD6ytI8x9tMkqod3uQ6HYqvIqwUTEdKkkNQiEM2S_ehwGuUuIiQkmKbo6KdnUeuVqKmxaWdAXCy2nftfxKhW47rd_jAccwT8bQyls5p8f14Nts5I5_4fS2URnQ70H5W83O
-----------------------------4137116237415213046158097313--

JSON Response example

Use dark colors for code blocksCopy
{
  "success": true,
  "taskId": "ddea837537ef435c9496c5fc22799973"
}