- URL:
- https://<notebookserveradmin>/notebooks/executeNotebook
- Methods:
POST
- Required Capability:
- Administrator or Create and Edit
- Version Introduced:
- 10.8
Description
The execute
operation allows administrators and users with Create and Edit ArcGIS Notebooks privileges to automate notebook execution in an ArcGIS Notebook Server site. The notebook specified in the operation is run with all cells in order.
Using this operation and an external scheduling tool, you can schedule the automated execution of a notebook either once or as a regular occurrence. This allows you to automate repeating tasks such as data collection and cleaning, content updates, and portal administration. On Linux machines, use a cron job to schedule the execute
operation; on Windows machines, you can use the Task Scheduler app.
You can specify parameters to be used in the notebook at execution time. If you specify one or more parameters, they are inserted into the notebook as a new cell. This cell is placed at the beginning of the notebook, unless you added the parameters
tag to a cell.
Request parameters
Parameter | Details |
---|---|
| The portal item ID of the notebook you want to execute. You can find this value on the Example
|
| Specifies whether the notebook portal item is updated after execution. The default is Values: |
| Optional parameters in JSON format that will be added to the notebook for this execution. The parameters are inserted as a new cell directly after the cell you tagged as Example
|
| Specifies whether the Values: |
| The response format. The default response format is Values: |
Response properties
Property | Details |
---|---|
| Indicates whether the operation succeeded in executing the notebook. |
Example usage
https://gisserver.domain.com:11443/arcgis/admin/notebooks/executeNotebook
itemId=70770e46d4be426dbd3adbec5f9124c8
updatePortalItem=true
notebookParameters={
"name": "somename",
"population": 19927500,
"pop_percent": 11.94,
"lowest_elevation_ft": -220,
"highest_elevation": 12486,
"top5cities": ["City 1", "City 2", "City 3", "City 4", "City 5"],
"top5Values": [ 100, 98.2, 93.3, 89, 74],
"isTrue": false,
"value": null,
"access": { "allowed": true}
}
saveInjectedParameters=false
JSON Response example
{
"jobId": "j3a581ce0-cf2f-4190-96a5-c5bc0617dd5d",
"jobUrl": "https://mydomain.example.com/notebookserver/admin/system/jobs/j3a581ce0-cf2f-4190-96a5-c5bc0617dd5d",
"status": "success"
}