文档首页/医疗智能体/API参考/API（医疗智能体平台）/项目管理/收藏管理/添加收藏
更新时间：2024-12-13 GMT+08:00
查看PDF
分享

添加收藏

功能介绍

添加收藏。

URI

POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/favorites

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，您可以从获取项目ID中获取。

最小长度：1

最大长度：128

eihealth_project_id

是

String

平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。

最小长度：1

最大长度：128

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。

最小长度：1

最大长度：32768

表3 请求Body参数

参数

是否必选

参数类型

描述

type

是

String

收藏类型。

最小长度：1

最大长度：16

resource_id

是

String

收藏的资源ID。

最小长度：1

最大长度：128

resource_name

是

String

收藏的资源名称，正则匹配中文，英文字母和数字及下划线。

最小长度：1

最大长度：128

resource_type

是

String

收藏的资源类型，正则匹配英文字母和数字及下划线。

最小长度：1

最大长度：128

display_info

是

String

展示信息。

最小长度：1

最大长度：65535

location_info

是

String

定位信息。

最小长度：1

最大长度：65535

响应参数

状态码： 201

表4 响应Body参数

参数

参数类型

描述

id

String

收藏记录ID。

请求示例

添加收藏分子类型。

https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/favorites

{
  "type" : "MOLECULE",
  "resource_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
  "resource_type" : "OPTIMIZATION",
  "resource_name" : "demo-resource",
  "display_info" : "{\"smiles\":\"c1ccccc1\",\"molecule_name\":\"AA-173/40757587\"}",
  "location_info" : "{\"receptor_idx\":\"1\",\"result_idx\":\"1\"}"
}

响应示例

状态码： 201

添加收藏成功响应。

{
  "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1"
}

状态码

状态码

描述

201

添加收藏成功响应。

错误码

请参见错误码。

父主题：收藏管理

相关文档