- URL:
- https://<root>/notebooks/snippets/import
- Methods:
POST- Required Capability:
- Access allowed with "Create and edit notebooks" privilege
- Version Introduced:
- 11.4
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.domain.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"
}