PUT /groups/{groupId}
基本信息
Note: 该端点在Alfresco 5.2.1和更高版本中可用。
更新groups groupId的详细信息(displayName)。
您必须具有管理员权限才能更新groups。
请求方式:PUT
请求API :/groups / {groupId}
响应等级(状态200)
成功回应
{ "entry": { "id": "string", "displayName": "string", "isRoot": true, "parentIds": [ "string" ], "zones": [ "string" ] } }
响应内容类型 applicaiton/json
Query参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
include | Array[string] | 否 | 返回有关该groups的其他信息。 可以请求以下可选字段:parentIds;zones | |
fields | Array[string] | 否 | field名称的list。 例如,如果您想节省整体带宽,则可以使用此参数来限制响应中返回的field。 例如,如果您想节省整体带宽,则可以使用此参数来限制响应中返回的field。 该列表适用于返回的单个实体或集合中的条目。 如果API方法也支持include参数,则除了在fields参数中指定的fields外,还返回include参数中指定的fields。 |
Path参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
groupId | string | 是 | groups的标识符。 |
Body参数(groupBodyUpdate)
request body示例
{ "displayName": "string" }
错误信息描述
状态码 | 原因 |
400 | 无效的参数:groupId或groupBodyCreate无效 |
401 | 验证失败 |
403 | 用户无权创建groups成员身份 |
404 | groupId不存在 |
409 | 尝试修改预定义的系统groups,例如GROUP_EVERYONE。 |
default | 意外错误 |
返回结果示例
{ "error": { "errorKey": "string", "statusCode": 0, "briefSummary": "string", "stackTrace": "string", "descriptionURL": "string", "logId": "string" } }