获取收藏夹列表
功能介绍
获取收藏夹列表。
URI
GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/favorites
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 |
|
eihealth_project_id |
是 |
String |
平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
resource_id |
否 |
String |
资源ID。 最小长度：1 最大长度：128 |
|
offset |
否 |
Integer |
偏移量，查询起始偏移，必须由数字组成，默认为0，取值范围[0,100000000]。 最小值：0 最大值：100000000 缺省值：0 |
|
limit |
否 |
Integer |
限制量，单次查询总量，必须由数字组成，默认为100，取值范围[1,1000]。 最小值：1 最大值：1000 缺省值：100 |
|
user_name_list |
否 |
Array |
收藏人名称列表。 最小长度：1 最大长度：128 数组长度：0 - 10 |
|
resource_type_list |
否 |
Array |
资源类型列表。 最小长度：1 最大长度：128 数组长度：0 - 5 |
|
type_list |
否 |
Array |
收藏类型列表，支持MICROMOLECULE|PROTEIN。 最小长度：1 最大长度：16 数组长度：0 - 5 |
|
start_time |
否 |
Long |
查询收藏信息的起始时间，UNIX时间戳，单位毫秒，不填时默认为当前时间。 最小值：1000000000000 最大值：9999999999999 |
|
end_time |
否 |
Long |
查询收藏信息的结束时间，UNIX时间戳，单位毫秒，不填时默认为当前时间。 最小值：1000000000000 最大值：9999999999999 |
|
key_word |
否 |
String |
关键字，支持在display_info字段中内容的模糊搜索。 最小长度：0 最大长度：128 |
|
sort_dir |
否 |
String |
排序规则，目前默认时间降序。 缺省值：DESC |
|
sort_key |
否 |
String |
排序规则，目前默认按收藏时间降序，支持根据create_time|user_name|resource_name|resource_type排序。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度：1 最大长度：32768 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
favorites |
Array of FavoriteDto objects |
收藏列表。 |
|
count |
Integer |
收藏总数。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
收藏ID。 |
|
type |
String |
收藏类型。 最小长度：1 最大长度：16 |
|
user_id |
String |
收藏者的用户ID。 |
|
user_name |
String |
收藏者的用户名称。 |
|
create_time |
String |
收藏时间。 |
|
resource_id |
String |
资源ID。 |
|
resource_name |
String |
资源名称。 |
|
resource_type |
String |
资源类型。 |
|
display_info |
String |
展示信息。 最小长度：1 最大长度：1000000 |
|
location_info |
String |
定位信息。 最小长度：1 最大长度：1000000 |
请求示例
获取收藏列表。
https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/favorites
响应示例
状态码： 200
OK
{
"favorites" : [ {
"id" : "7ee3a638-aaba-469c-b3b6-a0680536517a",
"type" : "MOLECULE",
"user_id" : "c41e4714-1ca3-4613-90ae-f7d0cc7186dd",
"user_name" : "gwj-test-01",
"create_time" : "2021-01-30T02:34:36Z",
"resource_type" : "OPTIMIZATION",
"resource_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
"resource_name" : "demo-resource",
"display_info" : "{\"smiles\":\"c1ccccc1\",\"molecule_name\":\"AA-173/40757587\"}",
"location_info" : "{\"receptor_idx\":\"1\",\"result_idx\":\"1\"}"
} ],
"count" : 12
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。
