添加收藏
功能介绍
添加收藏。
URI
POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/favorites
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 最小长度:1 最大长度:128 |
eihealth_project_id |
是 |
String |
参数解释: 平台空间ID,您可以在平台单击所需的空间名称,进入空间设置页面查看。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 最小长度:1 最大长度:128 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 最小长度:1 最大长度:32768 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
type |
是 |
String |
参数解释: 收藏类型。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 最小长度:1 最大长度:16 |
resource_id |
是 |
String |
参数解释: 收藏的资源ID。 约束限制: 不涉及 取值范围: 长度范围为1到128个字符,仅支持字母、数字、下划线和中划线。 默认取值: 不涉及 最小长度:1 最大长度:128 |
resource_name |
是 |
String |
参数解释: 收藏的资源名称。 约束限制: 不涉及 取值范围: 长度范围为1到128个字符,正则匹配中文,英文字母和数字及下划线。 默认取值: 不涉及 最小长度:1 最大长度:128 |
resource_type |
是 |
String |
参数解释: 收藏的资源类型。 约束限制: 不涉及 取值范围: 长度范围为1到128个字符,正则匹配英文字母和数字及下划线。 默认取值: 不涉及 最小长度:1 最大长度:128 |
display_info |
是 |
String |
参数解释: 展示信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 最小长度:1 最大长度:65535 |
location_info |
是 |
String |
参数解释: 定位信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 最小长度:1 最大长度:65535 |
响应参数
状态码:201
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 收藏记录ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
添加收藏分子类型。
https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/favorites { "type" : "MOLECULE", "resource_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "resource_name" : "demo-resource", "resource_type" : "OPTIMIZATION", "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 |
添加收藏成功响应。 |
错误码
请参见错误码。