GET /people/{personId}/favorites
基本信息
获取个人personId的favorites favoriteId 。
您可以使用-me-
字符串代替<personid>
来代表当前通过身份验证的用户。
您可以使用where参数将列表限制为对特定种类的条目的响应。 where参数采用一个值。 该值是单个谓词,可以包含一个或多个EXISTS条件。 EXISTS条件使用单个操作数将列表限制为包括包含该属性的条目。 属性值为:
target/file
target/folder
target/site
例如,以下where参数将返回的列表限制为某个人的文件favorites:
(EXISTS(target/file))
您可以使用OR指定多个条件。 谓词必须用括号括起来。
例如,以下where参数将返回的列表限制为某个人的文件和favorites文件夹:
(EXISTS(target/file) OR EXISTS(target/folder))
请求方式: GET
请求API: /people/{personId}/favorites
响应等级(状态200)
成功回应
{ "list": { "pagination": { "count": 0, "hasMoreItems": true, "totalItems": 0, "skipCount": 0, "maxItems": 0 }, "entries": [ { "entry": { "targetGuid": "string", "createdAt": "2021-01-08T08:52:11.250Z", "target": {} } } ] } }
响应内容类型 applicaiton/json
Query参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
skipCount | integer | 否 | 0 | 在list中跳过指定数量的数据。 如果未提供,则默认值为0。 |
maxItems | integer | 否 | 100 | list中要返回的最大项目数。 如果未提供,则默认值为100。 |
where | string | 否 | 一个字符串,通过使用谓词来限制返回的对象。 | |
include | Array[string] | 否 | 返回有关favorites的其他信息,可以请求以下可选字段:path(注意,这仅适用于文件和文件夹) | |
fields | Array[string] | 否 | field名称的list。 例如,如果您想节省整体带宽,则可以使用此参数来限制响应中返回的field。 例如,如果您想节省整体带宽,则可以使用此参数来限制响应中返回的field。 该列表适用于返回的单个实体或集合中的条目。 如果API方法也支持include参数,则除了在fields参数中指定的fields外,还返回include参数中指定的fields。 |
Path参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
personId | string | 是 | 个人的标识符。 |
错误信息描述
状态码 | 原因 |
400 | 无效的参数:maxItems,skipCount或where无效的值 |
401 | 验证失败 |
404 | personId不存在或当前用户无权访问personId的favorites |
default | 意外错误 |
返回结果示例
{ "error": { "errorKey": "string", "statusCode": 0, "briefSummary": "string", "stackTrace": "string", "descriptionURL": "string", "logId": "string" } }