Skip To Content ArcGIS for Developers Sign In Dashboard

Execute Notebook

  • URL:https://<notebookserveradmin>/notebooks/executeNotebook(POST only)
  • Required Capability:Administrator
  • Version Introduced:10.8

Description

The Execute Notebook operation allows administrators to automate notebook execution in their ArcGIS Notebook Server site. The notebook specified in the operation will be 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 executeNotebook operation; on Windows machines, you can use the Task Scheduler app.

Note:

To run this operation, you must be logged in with an ArcGIS Enterprise portal account. You cannot execute notebooks from the ArcGIS Notebook Server primary site administrator account.

You can specify parameters to be used in the notebook at execution time. If you've specified one or more parameters, they'll be inserted into the notebook as a new cell. This cell will be placed at the beginning of the notebook, unless you have added the tag parameters to a cell.

Tip:

To add a tag to a notebook cell, click View > Cell Toolbar > Tags in the notebook editor's menu ribbon, select a cell, then type the tag's value and click Add tag.

Request parameters

ParameterDetails
itemId

The portal item ID of the ArcGIS Notebook you want to execute. You can find this value on the Notebook resource in this directory, or in the portal as part of the item details page's URL. Ensure that the notebook is using an runtime that's compatible with your software version.

Example

itemId=70770e46d4be426dbd3adbec5f9124c8
updatePortalItem

Specifies whether you want to update the notebook's portal item after execution. The default is true. You may want to specify true when the notebook you're executing contains information that needs to be updated, such as a workflow that collects the most recent version of a dataset. It may not be important to update the portal item if the notebook won't store any new information after executing, such as an administrative notebook that sends email reminders to inactive users.

Values: true | false

notebookParameters

An optional array of parameters to add to the notebook for this execution. The parameters will be inserted as a new cell directly after the cell you have tagged "parameters." Separate the parameters with a comma. Use the format "x":1 when defining parameters with numbers, and "y":"text" when defining parameters with text strings.

Example

notebookParameters=["city":"BuenosAires","buffer_size":5]
saveInjectedParameters

Specifies whether the notebookParameters cell should be saved in the notebook for future use. The default is false.

Values: true | false

f

The response format. The default response format is html.

Values: html | json | pjson

Response properties

PropertyDetails
status

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=["city":"BuenosAires","buffer_size":5]
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'}