GET /groups
基本信息
Note: 该端点在Alfresco 5.2.1和更高版本中可用。
获取groups列表。
您可以使用include参数返回其他信息。
您可以使用where参数通过isRoot过滤返回的groups。例如,以下where子句将仅返回根groups:
(isRoot = true)
where参数还可用于按区域过滤。 可以将其与isRoot结合使用以进一步缩小结果集的范围。 例如,以下where子句将仅返回属于MY.ZONE
区域的groups。
where=(zones in ('MY.ZONE'))
可以将其与isRoot过滤器结合使用,如下所示:
where=(isRoot=false AND zones in ('MY.ZONE'))
Note: 限制包括
- 结合使用
isRoot
和zones
过滤器时,AND
是唯一受支持的运算符 - 过滤器仅支持一个区域
- 带引号的区域名称必须放在括号中,如果省略,则会导致400错误。
返回列表的默认排序顺序是按显示名称升序对groups进行排序的。 您可以使用orderBy参数覆盖默认值。 您可以在orderBy参数中指定以下一个或多个字段:
- ID
- 显示名称(displayName)
请求方式:GET
请求API: / groups
响应等级(状态200)
成功回应
{ "list": { "pagination": { "count": 0, "hasMoreItems": true, "totalItems": 0, "skipCount": 0, "maxItems": 0 }, "entries": [ { "entry": { "id": "string", "displayName": "string", "isRoot": true, "parentIds": [ "string" ], "zones": [ "string" ] } } ] } }
响应内容类型 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进行排序。 | |
include | Array[string] | 否 | 返回有关该groups的其他信息。 可以请求以下可选字段:parentIds;zones | |
where | string | 否 | 一个字符串,通过使用谓词来限制返回的对象。 | |
fields | Array[string] | 否 | field名称的list。 例如,如果您想节省整体带宽,则可以使用此参数来限制响应中返回的field。 例如,如果您想节省整体带宽,则可以使用此参数来限制响应中返回的field。 该列表适用于返回的单个实体或集合中的条目。 如果API方法也支持include参数,则除了在fields参数中指定的fields外,还返回include参数中指定的fields。 |
错误信息描述
状态码 | 原因 |
400 | 无效的参数:maxItems,where,skipCount,orderBy或者where的值无效 |
401 | 验证失败 |
default | 意外错误 |
返回结果示例
{ "error": { "errorKey": "string", "statusCode": 0, "briefSummary": "string", "stackTrace": "string", "descriptionURL": "string", "logId": "string" } }