- URL:https://<notebookserveradmin>/notebooks/createNotebookPreview(POST only)
- Version Introduced:11.2
Description
The createNotebookPreview operation allows administrators and notebook authors to create previews for notebooks and notebook snapshots.
Note:
The user must be the owner of the notebook item.
Request parameters
| Parameter | Details |
|---|---|
| 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. Note:If snapshotResourceKey is also provided, a preview will be generated for the snapshot. |
| snapshotResourceKey (Optional) | The notebook snapshot resource key. |
| f (Optional) | The response format. The default response format is html. Values: html |
Response properties
| Property | Details |
|---|---|
| status | Indicates whether the operation succeeded in creating the notebook preview. Values: success |
Example usage
HTTP POST
https://notebookserver.domain.com:11443/arcgis/admin/notebooks/createNotebookPreview
itemId=70770e46d4be426dbd3adbec5f9124c8&snapshotResourceKey=snapshot-f1d7700ffdc34a879a6f7f030916bc73.jsonJSON Response syntax
{"status":"success"}
JSON Response example
{"status":"success"}