<notebooks_uri>/{id}[.<format>]
notebookShareSetting、notebookContent
notebook 资源是单个 Notebook 资源的基本信息。支持查看 Notebook 基本信息,支持编辑更新 Notebook 基本信息,支持删除 Notebook。
支持的方法:
支持的表述格式:RJSON、JSON、HTML、XML。
对如下 URI 执行 HTTP 请求,以 rjson 输出格式为例加以说明,其中,supermapiportal 是服务器名。
http://supermapiportal:8190/iportal/web/notebooks/{id}.rjson
获取由数据项 id 指定的 Notebook 的基本信息。
对 notebook 资源执行 GET 请求,返回的资源表述结构如下:
字段 | 类型 | 说明 |
authorizeSetting | List<IportalAuthorizeEntity> | Notebook 的授权信息。 |
content | String | Notebook 的具体内容,包括元数据、单元格类型、输入与输出结果。 |
creatTime | Long | Notebook 的创建时间。 |
description | String | Notebook 的描述信息。 |
id | Integer | Notebook 的 id 标识。 |
name | String | Notebook 的名称。 |
nickname | String | Notebook 创建者的昵称。 |
userName | String | Notebook 创建者的名称。 |
tags | List<String> | Notebook 的标签。 |
thumbnail | String | Notebook 的缩略图路径。 |
updateTime | Long | Notebook 的更新时间。 |
visitCount | Integer | Notebook 的访问次数。 |
对 notebook 资源:http://localhost:8190/iportal/web/notebooks/590871626.rjson 执行 GET 请求,返回的 rjson 格式响应结果如下:
{
"thumbnail": "http://127.0.0.1:8190/iportal/services/../web/static/portal/img/notebook/defaultThumbnail.png",
"visitCount": 1,
"createTime": 1597903014058,
"name": "notebook_1",
"nickname": "Nick",
"authorizeSetting": [
{
"permissionType": "DELETE",
"aliasName": "Nick",
"entityRoles": [],
"entityType": "USER",
"entityName": "user_1",
"entityId": null
}
],
"description": null,
"updateTime": 1597903014058,
"id": 590871626,
"userName": "user_1",
"content": "{\"nbformat_minor\":4,\"metadata\":{\"language_info\":{\"name\":\"\"},\"kernelspec\":{\"name\":\"\",\"display_name\":\"\"}},\"cells\":[{\"outputs\":[],\"metadata\":{},\"source\":\"int\",\"cell_type\":\"code\"}],\"nbformat\":4}",
"tags": []
}
更新指定的 Notebook 的基本信息。除管理员和 Notebook 创建者外,其他用户只能对权限是可编辑的 Notebook 的基本信息进行修改。
发送请求时,需要在请求体中包含如下参数:
字段 | 类型 | 说明 |
name |
String | Notebook 的名称。 |
description |
String | Notebook 的描述信息。 |
tags |
List<String> | Notebook 的标签。 |
thumbnail | String | Notebook 的缩略图路径。 |
返回的资源表述结构如下:
字段 | 类型 | 说明 |
succeed | boolean | 更新 Notebook 是否成功。 |
error | Httperror | 出错信息,如果更新成功,则没有本字段。 |
修改 Notebook 名称为:notebook_2,并添加标签和描述信息,对 notebook 资源:http://localhost:8190/iportal/web/notebooks/590871626.rjson 执行 PUT 请求,发送请求体如下:
{
"name": "notebook_2",
"description": "第一个Notebook。",
"tags": [
"用户数据"
],
"thumbnail": "http://127.0.0.1:8190/iportal/services/../web/static/portal/img/notebook/defaultThumbnail.png"
}
则返回的 rjson 格式的表述如下:
{ "succeed": true}
删除指定的 Notebook。
返回的资源表述结构如下:
字段 | 类型 | 说明 |
succeed | boolean | 删除 Notebook 是否成功。 |
error | Httperror | 出错信息,如果删除 Notebook 成功,则没有本字段。 |
对 notebook 资源:http://localhost:8190/iportal/web/notebooks/590871626.rjson 执行 DELETE 请求,返回的 rjson 格式响应结果如下:
{ "succeed": true}
返回跟 GET 请求一样的 HTTP 响应头,但是没有响应实体。可以在不必传输整个响应内容的情况下,获取包含在响应消息头中的元数据信息。元数据信息包括媒体类型,字符编码,压缩编码,实体内容长度等。
HEAD 请求可以用来判断 notebook 资源是否存在,或者客户端是否有权限访问 notebook 资源。通过对加.<format>的 URI 执行 HEAD 请求,还可以快速判断 notebook 资源是否支持<format>格式的表述。