GET /people/{personId}/sites
基本信息
获取个人personId的sites成员资格信息列表。
您可以使用-me-
字符串代替<personid>
来代表当前通过身份验证的用户。
您可以使用where参数按可见性(visibility)或sites预设过滤(preset)返回的sites。
根据可见性(visibility)进行过滤的示例,使用以下任一方法:
(visibility='PRIVATE') (visibility='PUBLIC') (visibility='MODERATED')
根据sites预设进行过滤(preset)的示例:
(preset='site-dashboard')
返回列表的默认排序顺序是按标题升序对sites进行排序。 您可以使用orderBy参数覆盖默认值。 您可以在orderBy参数中指定以下一个或多个字段:
- ID(id)
- 标题(title)
- 角色(role)
请求方式: GET
请求API: / people / {personId} / sites
响应等级(状态200)
成功回应
{ "list": { "pagination": { "count": 0, "hasMoreItems": true, "totalItems": 0, "skipCount": 0, "maxItems": 0 }, "entries": [ { "entry": { "site": { "id": "string", "guid": "string", "title": "string", "description": "string", "visibility": "PRIVATE", "preset": "string", "role": "SiteConsumer" }, "id": "string", "guid": "string", "role": "SiteConsumer" } } ] } }
响应内容类型 applicaiton/json
Query参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
skipCount | integer | 否 | 0 | 在list中跳过指定数量的数据。 如果未提供,则默认值为0。 |
maxItems | integer | 否 | 100 | list中要返回的最大项目数。 如果未提供,则默认值为100。 |
orderBy | Array[string] | 否 | 控制list中entities退回顺序的string。您可以使用orderBy参数通过一个或多个fields对列表进行排序。每个fields都有一个默认的排序顺序,通常是升序的。阅读API方法实践说明以检查是否所有fields使用这个方法将默认搜索顺序设为降序。要按照特殊顺序对entities进行排序的话,您可以使用ASC和DESC关键字对fields进行排序。 | |
where | string | 否 | 通过使用谓词来限制返回的对象的一个字符串。 | |
relations | Array[string] | 否 | 使用关系参数可在一个响应中包含一个或多个相关实体。 | |
fields | Array[string] | 否 | field名称的list。 例如,如果您想节省整体带宽,则可以使用此参数来限制响应中返回的field。 例如,如果您想节省整体带宽,则可以使用此参数来限制响应中返回的field。 该列表适用于返回的单个实体或集合中的条目。 如果API方法也支持include参数,则除了在fields参数中指定的fields外,还返回include参数中指定的fields。 |
Path参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
personId | string | 是 | 个人的标识符。 |
错误信息描述
状态码 | 原因 |
400 | 无效的参数:maxItems,skipCount,orderBy的值或where无效的值 |
401 | 验证失败 |
404 | personId不存在 |
default | 意外错误 |
返回结果示例
{ "error": { "errorKey": "string", "statusCode": 0, "briefSummary": "string", "stackTrace": "string", "descriptionURL": "string", "logId": "string" } }