功能描述
用于查询指定媒体库下的群组列表,支持按父群组过滤和游标分页。
接口说明
分页使用
marker + limit 游标分页,首次请求不传 marker,后续传上次响应的 nextMarker。可通过
parent_group_id 参数过滤指定父群组下的子群组。请求
请求示例
GET /api/v1/group/{LibraryId}?access_token={AccessToken}&parent_group_id={ParentGroupId}&marker={Marker}&limit={Limit}
请求参数
请求参数 | 描述 | 类型 | 是否必选 |
LibraryId | 媒体库 ID | String | 是 |
AccessToken | 访问令牌 | String | 是 |
ParentGroupId | 过滤指定父群组下的子群组 | String | 否 |
Marker | 游标,首次请求不传,后续传上次响应的 nextMarker | String | 否 |
Limit | 每页数量,默认 20,最大 100 | Integer | 否 |
请求体
无
响应
响应码
获取成功,返回 HTTP 200 OK
响应体
application/json
响应体示例:
{"nextMarker": "xxx","contents": [{"libraryId": "smhxxx","groupId": "a1b2c3d4e5f67890a1b2c3d4e5f67890","groupName": "研发部","description": "研发团队","parentGroupId": "0f1e2d3c4b5a69780f1e2d3c4b5a6978","creator": "admin_001","creationTime": "2024-01-01T10:00:00.000Z","modifyTime": "2024-01-01T10:00:00.000Z"}]}
响应体字段说明:
节点名称(关键字) | 描述 | 类型 |
nextMarker | 下一页游标,最后一页为空字符串 "" | String |
contents | 群组信息列表;字段与查询群组详情响应一致 | Array |
contents[].libraryId | 媒体库 ID | String |
contents[].groupId | 群组唯一标识 | String |
contents[].groupName | 群组名称 | String |
contents[].description | 描述 | String |
contents[].parentGroupId | 父群组 ID;根群组为空串 "" | String |
contents[].creator | 创建者用户 ID | String |
contents[].creationTime | 创建时间,ISO 8601 格式,例如 2024-01-01T10:00:00.000Z | String |
contents[].modifyTime | 最后修改时间,ISO 8601 格式 | String |