Skip to content

批量获取对象的标签状态(星标、常用)

适用版本>=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_idsstring[]标签id列表,<= 1024 items [ items <= 1024 characters ]
label_typestring[]标签类型列表,sys系统标签 cus客制标签
objectsobject[]被打标签对象列表,[ 1 .. 100 ] items
idstring被打标签对象id,<= 1024 characters
typestringEnum: "file" "drive",被打标签对象类型

label_ids和label_type二选一,都不传时无法筛选到数据,都传则会报错。

若想获取某个对象的所有标签,可通过label_type同时传syscus实现

请求体示例

{
  "label_ids": [
    "string"
  ],
  "label_type": [
    "sys"
  ],
  "objects": [
    {
      "id": "string",
      "type": "file"
    }
  ]
}

响应体(Response)

名称类型说明
codeinteger错误码
detailstring详细信息
msgstring状态信息
dataobject文件存储的介质
itemsobject[]标签集合,<= 1024 items
labelsint创建时间
idstring标签ID,<= 1024 characters
namestring标签名称, 例如:星标、常用等等,<= 1024 characters
typestringEnum: "sys" "cus",标签的类型
objectobject被打标签对象
idstring被打标签对象id,<= 1024 characters
typestringEnum: "file" "drive",被打标签对象类型

响应体示例

{
  "data": {
    "items": [
      {
        "labels": [
          {
            "id": "string",
            "name": "string",
            "type": "sys"
          }
        ],
        "object": {
          "id": "string",
          "type": "file"
        }
      }
    ]
  },
  "code": 0,
  "detail": "string",
  "msg": "string"
}