Import code snippets

URL:: https://<notebookserveradmin>/notebooks/snippets/import
Methods:: POST
Required Capability:: Owner and Create and Edit
Version Introduced:: 11.2

Description

The import operation adds code snippets from an input file to a notebook code snippet library. This operation can either add only the code snippets that do not currently exist in the library or overwrite all code snippets in the library with the code snippets from the input file.

Request parameters

Parameter Details

Parameter	Details
`itemId` (Required)	The item ID (GUID) of the notebook code snippet library where the code snippets will be imported.
`file` (Required)	A zipped file containing `.py` files of code snippets. The following is an example of the format for the `.py` file: Use dark colors for code blocksCopy 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 snippet_properties = { "notebookRuntimeName": "ArcGIS Notebook Python 3 Standard", "lastUpdated": "", "deprecated": False, "name": "Check remaining credits (ArcGIS Online only)", "description": "Checks the remaining credits of an ArcGIS Online organization. The GIS must be an administrator instance.", "language": "Python", "snippetLibrary": "GIS Administration", "tags": "arcgis, agol, credits, admin", "notebookRuntimeVersion": "9.0" } ##### SNIPPET BEGIN ##### from arcgis.gis import GIS def check_org_credits_agol(gis: GIS) -> None: if "admin" in gis.__dict__: credits = gis.admin.credits.credits print(f"This ArcGIS Online organization has {credits} credits.") else: print("Please connect to the ArcGIS Online organization as an administrator to check credits.") # check_org_credits_agol(GIS) ##### SNIPPET END #####
`overwrite` (Required)	A Boolean that specifies whether existing code snippets in the snippet library will be removed (overwritten), and all code snippets in the input file will be imported (`true` ). When set to `false` , only the code snippets in the input file that do not already exist in the library will be imported. Values: `true` \|`false`
`f`	The response format. The default response format is `html` . Values: `html` \| `json` \| `pjson`

itemId

(Required)

The item ID (GUID) of the notebook code snippet library where the code snippets will be imported.

file

(Required)

A zipped file containing *.py files of code snippets.

The following is an example of the format for the *.py file:

Use dark colors for code blocksCopy
snippet_properties = {
"notebookRuntimeName": "ArcGIS Notebook Python 3 Standard",
"lastUpdated": "",
"deprecated": False,
"name": "Check remaining credits (ArcGIS Online only)",
"description": "Checks the remaining credits of an ArcGIS Online organization. The GIS must be an administrator instance.",
"language": "Python",
"snippetLibrary": "GIS Administration",
"tags": "arcgis, agol, credits, admin",
"notebookRuntimeVersion": "9.0"
}

##### SNIPPET BEGIN #####
from arcgis.gis import GIS

def check_org_credits_agol(gis: GIS) -> None:
if "admin" in gis.__dict__:
credits = gis.admin.credits.credits
print(f"This ArcGIS Online organization has {credits} credits.")
else:
print("Please connect to the ArcGIS Online organization as an administrator to check credits.")

# check_org_credits_agol(GIS)
##### SNIPPET END #####

overwrite

(Required)

A Boolean that specifies whether existing code snippets in the snippet library will be removed (overwritten), and all code snippets in the input file will be imported (true ).

When set to false , only the code snippets in the input file that do not already exist in the library will be imported.

Values: true |false

f

The response format. The default response format is html .

Values: html | json | pjson

Example usage

Use dark colors for code blocksCopy
https://<notebookserveradmin>/notebooks/snippets/import
itemId = 3fe64164ea484f008ce873c780426ac9
file = (binary)
overwrite = false
f = pjson

JSON Response syntax

At ArcGIS Enterprise 11.3, the JSON response has been updated to the following format:

Use dark colors for code blocksCopy
{
    "message": "<message>",
    "status": "success"
}

The JSON response is formatted the following way for deployments using ArcGIS Enterprise 11.2:

Use dark colors for code blocksCopy
{
  "message": "<message>"
}

JSON Response example

The JSON response returned at 11.3:

Use dark colors for code blocksCopy
{
    "message": "Code snippet(s) imported successfully.",
    "status": "success"
}

The JSON response returned at 11.2:

Use dark colors for code blocksCopy
{
  "message": "Code snippet(s) imported successfully."
}