- URL: https://<notebookserveradmin>/services/analyzeNotebook(POST only)
- Required Capability:Administrator or Create and Edit ArcGIS Notebooks
- Version Introduced:11.0
Description
The analyzeNotebook operation validates sources in a saved notebook using the input and output parameters for publishing the notebook as a web tool.
Note:
Notebook server administrators can analyze all notebooks; nonadministrative notebook users can only analyze notebooks they own.
Request parameters
Parameter | Details |
---|---|
itemId | The portal item ID of the notebook to analyze. |
f | The response format. The default response format is html. Values: html | json | pjson |
Example usage
https://notebookserver.domain.com:11443/arcgis/admin/services/analyzeNotebook
itemId=5dbacb22922d4ead9b8b065f3ea448b8
JSON Response syntax
{
"errors": [<errors>],
"warnings": [<warnings>],
"messages": [<messages>],
"status": "success"
}
JSON Response example when no itemID is provided
{
"errors": ["An empty Notebook ItemID is not allowed for this operation."],
"warnings": [],
"messages": [],
"status": "success"
}
JSON Response example with no input parameter and an invalid output parameter
{
"errors": [],
"warnings": [
"Unable to find webtool input parameter 'I2' in the Notebook.",
"Invalid webtool output parameter."
],
"messages": [],
"status": "success"
}