- URL:
- https://<root>/notebooks/snippets/import
- Methods:
POST- Version Introduced:
- 11.4
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
To access notebook-related endpoints, administrators must be assigned a custom role that includes any of the privileges listed above as well as the Create and edit notebooks privilege.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
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 |
|---|---|
(Required) | The item ID (GUID) of the notebook code snippet library where the code snippets will be imported. |
(Required) | A zipped file containing *.py files of code snippets. The following is an example of the format for the *.py file: |
(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 ( Values: |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the import operation:
POST /<context>/admin/notebooks/snippets/import HTTP/1.1
Host: organization.example.com
Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryn5e81RgWj5QE2Ocz
Content-Length: []
------WebKitFormBoundaryn5e81RgWj5QE2Ocz
Content-Disposition: form-data; name="itemId"
00d461400981492e95622ea024d52cf2
------WebKitFormBoundaryn5e81RgWj5QE2Ocz
Content-Disposition: form-data; name="file"; filename="Test-1713927792623.zip"
Content-Type: application/zip
------WebKitFormBoundaryn5e81RgWj5QE2Ocz
Content-Disposition: form-data; name="overwrite"
false
------WebKitFormBoundaryn5e81RgWj5QE2Ocz
Content-Disposition: form-data; name="f"
pjsonJSON Response example
{
"message": "Code snippet(s) imported successfully.",
"status": "success"
}