批量获取对象的标签状态(星标、常用)
适用版本>=v7.0.2402.20240222
接口说明:批量获取对象的标签状态(星标、常用)
请求说明
| 请求地址 | 配置域名+/graph+/v7/drive_label/items/batch_get |
|---|---|
| 请求方法 | POST |
| 签名方式 | WPS-4签名/WPS-4-GM签名(配置域名+/graph不参与签名) |
| 权限要求 | 更新文件(用户授权) kso.file.write |
请求头(Header)
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考签名说明 |
| Authorization | 是 | 授权凭证,格式为: Bearer {access_token} |
请求体(Body)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| label_ids | string[] | 否 | 标签id列表,<= 1024 items [ items <= 1024 characters ] |
| label_type | string[] | 否 | 标签类型列表,sys系统标签 cus客制标签 |
| objects | object[] | 是 | 被打标签对象列表,[ 1 .. 100 ] items |
| ∟ id | string | 是 | 被打标签对象id,<= 1024 characters |
| ∟ type | string | 是 | Enum: "file" "drive",被打标签对象类型 |
label_ids和label_type二选一,都不传时无法筛选到数据,都传则会报错。
若想获取某个对象的所有标签,可通过label_type同时传
sys和cus实现
请求体示例
{
"label_ids": [
"string"
],
"label_type": [
"sys"
],
"objects": [
{
"id": "string",
"type": "file"
}
]
}响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| code | integer | 错误码 |
| detail | string | 详细信息 |
| msg | string | 状态信息 |
| data | object | 文件存储的介质 |
| ∟ items | object[] | 标签集合,<= 1024 items |
| ∟ ∟ labels | int | 创建时间 |
| ∟ ∟ ∟ id | string | 标签ID,<= 1024 characters |
| ∟ ∟ ∟ name | string | 标签名称, 例如:星标、常用等等,<= 1024 characters |
| ∟ ∟ ∟ type | string | Enum: "sys" "cus",标签的类型 |
| ∟ ∟ object | object | 被打标签对象 |
| ∟ ∟ ∟ id | string | 被打标签对象id,<= 1024 characters |
| ∟ ∟ ∟ type | string | Enum: "file" "drive",被打标签对象类型 |
响应体示例
{
"data": {
"items": [
{
"labels": [
{
"id": "string",
"name": "string",
"type": "sys"
}
],
"object": {
"id": "string",
"type": "file"
}
}
]
},
"code": 0,
"detail": "string",
"msg": "string"
}