Create notebook preview

URL:
https://<notebookserveradmin>/notebooks/createNotebookPreview
Methods:
POST
Version Introduced:
11.2

Description

The createNotebookPreview operation allows administrators and notebook authors to create previews for notebooks and notebook snapshots.

Request parameters

ParameterDetails

itemId

The notebook item for which the preview will be generated. If itemId is the only parameter provided, a preview will be generated for the notebook.

snapshotResourceKey

(Optional)

The notebook snapshot resource key.

f

(Optional)

The response format. The default response format is html .

Values: html

Response properties

PropertyDetails

status

Indicates whether the operation succeeded in creating the notebook preview.

Values: success

Example usage

1
2
3
HTTP POST
https://notebookserver.domain.com:11443/arcgis/admin/notebooks/createNotebookPreview
itemId=70770e46d4be426dbd3adbec5f9124c8&snapshotResourceKey=snapshot-f1d7700ffdc34a879a6f7f030916bc73.json

JSON Response syntax

1
{"status":"success"}

JSON Response example

1
{"status":"success"}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close