POST /people/{personId}/favorites
基本信息
favorites中的站点(site),文件(file)或文件夹( folder)。
您可以使用-me-
字符串代替<personid>
来代表当前通过身份验证的用户。
Note: 您可以通过在JSON主体中指定对象列表来favorites多个实体,如下所示:
[ { "target": { "file": { "guid": "abcde-01234-...." } } }, { "target": { "file": { "guid": "abcde-09863-...." } } }, ]
如果将列表指定为输入,则在响应正文中返回分页列表而不是条目。 例如:
{ "list": { "pagination": { "count": 2, "hasMoreItems": false, "totalItems": 2, "skipCount": 0, "maxItems": 100 }, "entries": [ { "entry": { ... } }, { "entry": { ... } } ] } }
请求方式: POST
请求API: / people / {personId} / favorites
响应等级(状态201)
成功回应
{ "entry": { "targetGuid": "string", "createdAt": "2021-01-08T08:52:11.257Z", "target": {} } }
响应内容类型 applicaiton/json
Query参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
include | Array[string] | 否 | 返回有关favorites夹的其他信息,可以请求以下可选字段:path(注意,这仅适用于文件和文件夹) | |
fields | Array[string] | 否 | field名称的list。 例如,如果您想节省整体带宽,则可以使用此参数来限制响应中返回的field。 例如,如果您想节省整体带宽,则可以使用此参数来限制响应中返回的field。 该列表适用于返回的单个实体或集合中的条目。 如果API方法也支持include参数,则除了在fields参数中指定的fields外,还返回include参数中指定的fields。 |
Path参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
personId | string | 是 | 个人的标识符。 |
Body参数(favoriteBodyCreate)
request body示例
{ "target": {} }
错误信息描述
状态码 | 原因 |
400 | 无效的参数:favoriteBodyCreate无效 |
401 | 验证失败 |
404 | personId不存在,或者目标实体不存在,或者具有指定ID的favorites已经存在,或者存在具有发布对象的ID但与发布对象类型不同的实体 |
409 | 目标guid已被favorites |
default | 意外错误 |
返回结果示例
{ "error": { "errorKey": "string", "statusCode": 0, "briefSummary": "string", "stackTrace": "string", "descriptionURL": "string", "logId": "string" } }