Analyze Notebook

URL:
https://<notebookserveradmin>/services/analyzeNotebook
Methods:
POST
Required Capability:
Administrator or Create and Edit
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.

Request parameters

ParameterDetails

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

1
2
https://notebookserver.domain.com:11443/arcgis/admin/services/analyzeNotebook
itemId=5dbacb22922d4ead9b8b065f3ea448b8

JSON Response syntax

1
2
3
4
5
6
{
  "errors": [<errors>],
  "warnings": [<warnings>],
  "messages": [<messages>],
  "status": "success"
}

JSON Response example when no itemID is provided

1
2
3
4
5
6
{
 "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

1
2
3
4
5
6
7
8
9
{
  "errors": [],
  "warnings": [
    "Unable to find webtool input parameter 'I2' in the Notebook.",
    "Invalid webtool output parameter."
  ],
  "messages": [],
  "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