Execute Notebook

itemId

The portal item ID of the 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 URL. Ensure that the notebook is using a runtime that's compatible with your software version.

Example

1
itemId=70770e46d4be426dbd3adbec5f9124c8

updatePortalItem

Specifies whether the notebook portal item is updated after execution. The default is true . You can 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 new information after execution, such as an administrative notebook that sends email reminders to inactive users.

Values: true | false

notebookParameters

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 parameters . The following data types are supported for task parameters: string, long, Boolean, date, feature set, and record set.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
notebookParameters=
{
	"myLongVariable": 100,
	"epochSecondsDate": 1632326711000,
	"myStringVariable": "secret.pwd",
	"myDoubleVariable": 3.14,
	"myBooleanVariable": false,
	"myLinearUnitDictionary": {
		"distance": 345.678,
		"units": "esriMiles"
	},
	"myFeatureSetJSON": {
		"geometryType": "esriGeometryPoint",
		"spatialReference": {
			"wkid": 4326
		},
		"fields": [{
				"name": "Id",
				"type": "esriFieldTypeOID",
				"alias": "Id"
			},
			{
				"name": "Name",
				"type": "esriFieldTypeString",
				"alias": "Name"
			}
		],
		"features": [{
				"geometry": {
					"x": -104.44,
					"y": 34.83
				},
				"attributes": {
					"Id": 43,
					"Name": "Feature 1"
				}
			},
			{
				"geometry": {
					"x": -100.65,
					"y": 33.69
				},
				"attributes": {
					"Id": 67,
					"Name": "Feature 2"
				}
			}
		]
	}
}

saveInjectedParameters

Specifies whether the notebookParameters cell is 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

status

Indicates whether the operation succeeded in executing the notebook.