分组接口


分组列表

  • 接口描述:获取作品或素材的分组列表。

  • 接口地址:/api/v1/biz/group/list?token=TOKEN&openId=OPEN_ID

  • 请求方式:GET

  • 传参方式:

  • 参数列表:

    参数名 是否必须 参数类型 说明
    busType Integer 业务类型 1:作品 2:素材
    createType Integer 分组类型 1:个人
  • 返回值:

    {
    "success": true,
    "code": "200",
    "msg": null,
    "obj": null,
    "map": null,
    "list": [
      {
        "id": 129,
        "title": "test11",
        "busType": "2",
        "createType": "1",
        "createRelId": "2b9ebbb1d7a54174850addb925dcfd2d"
      },
      {
        "id": 132,
        "title": "test",
        "busType": "2",
        "createType": "1",
        "createRelId": "2b9ebbb1d7a54174850addb925dcfd2d"
      }
    ]
    }
    
  • 返回参数:

    参数 参数类型 说明
    id Long 作品ID
    title String 分组名称
    busType Integer 业务类型 1:作品 2:素材
    createType Integer 创建者类型 1:创建人 2:创建企业 3:创建平台
    createRelId String create_type为 1:创建人Id ; 2:corp_id ; 3:平台Id

新增/更新资源分组

  • 接口描述:为作品或素材新增/更新分组信息。
  • 接口地址:/api/v1/biz/group/saveOrUpdate?token=TOKEN&openId=OPEN_ID
  • 请求方式:POST
  • 传参方式:content-type:application/json
  • 参数列表:
    参数名 是否必须 参数类型 说明
    id Long 新增不需要填,更新必填
    title String 分组名称
    busType Integer 业务类型 1:作品 2:素材
    createType Integer 创建者类型 1:创建人 2:创建企业 3:创建平台
  • 返回值:
    {
    "success": true,
    "code": "200",
    "msg": null,
    "obj": 112,
    "map": null,
    "list": null
    }
    
  • 返回值说明:
    参数 参数类型 说明
    obj Long 分组ID

删除分组

  • 接口描述:根据分组ID删除一个资源分组信息。

  • 接口地址:/api/v1/biz/group/delete/${id}?token=TOKEN

  • 请求方式:POST

  • 传参方式:

  • 参数列表:

    ${id}为分组ID,可从分组列表接口等方式取得。

  • 返回值:

    {
    "success": true,
    "code": "200",
    "msg": null,
    "obj": null,
    "map": null,
    "list": null
    }
    

    将资源移动至分组

  • 接口描述:将作品、素材等资源移动至指定分组。建议使用下面新的接口

  • 接口地址:/api/v1/biz/group/setting/${groupId}?token=TOKEN

  • 请求方式:POST

  • 传参方式:content-type:application/x-www-form-urlencoded

  • 参数列表:

    参数名 是否必须 参数类型 说明
    busType Integer 业务类型 1:作品 2:素材
    busIds List 资源ID

    ${groupId}为分组ID,可从分组列表接口等方式取得。

  • 返回值:

    {
    "success": true,
    "code": "200",
    "msg": null,
    "obj": null,
    "map": null,
    "list": null
    }
    

    将资源移动至分组(新)

  • 接口描述:将作品、素材等资源移动至指定分组。

  • 接口地址:/api/v1/biz/group/setting?token=TOKEN

  • 请求方式:POST

  • 传参方式:content-type:application/json

  • 参数列表:

    参数名 是否必须 参数类型 说明
    busType Integer 业务类型 1:作品 2:素材
    busIds List 资源ID
    groupId List 为分组ID,可从分组列表接口等方式取得。
  • 请求参数:

    {
    "groupId": 1,
    "busType": 2,
    "busIds": [
      "1","2","3","4","5"
    ]
    }
    
  • 返回值:

    {
    "success": true,
    "code": "200",
    "msg": null,
    "obj": null,
    "map": null,
    "list": null
    }
    

will 2022年11月17日 17:33 2731 收藏文档