作品共享接口


注意事项

  1. 添加共享成员后,默认作品就共享给这个成员,拥有查看作品数据的权限。
  2. 删除共享数据时会删除对应的分发数据。删除分发数据时不会删除对应的共享数据权限。

保存共享

  • 接口描述:创建或修改共享数据

  • 接口地址:/api/v1/editor/creation/share/save/{creationId}?token=TOKEN&openId=OPENID

  • 请求方式:POST

  • 请求格式:json

  • 接口入参:

    参数名 必须 参数类型 参数说明
    creationId Long 作品唯一标识
    shareType Int 共享类型:1.个人 2.部门及下级部门 3全部
    relType Int 关联类型:2:成员 3:外部成员
    relId String 关联的唯一标识,当rel_type为2时为员工的id(取查询员工列表返回的id)
    relName String 关联名称,最大长度为256
  • 请求示例:

    [
    {
      "relType": 2,
      "shareType": 1,
      "creationId": 25485,
      "relName": "管理员",
      "relId": "485fb498bfb343fa9bcf883247e9b3a1"
    }
    ]
    
  • 接口出参:

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

    查询共享列表

  • 接口描述:查询共享列表

  • 接口地址:/api/v1/editor/creation/share/list?token=TOKEN&openId=OPENID

  • 请求方式:POST

  • 请求格式:json

  • 接口入参:

    参数名 必须 参数类型 参数说明
    creationId Long 作品唯一标识
  • 请求示例:

    {
    "creationId": 25485
    }
    
  • 接口出参:

    {
    "success": true,
    "code": "200",
    "msg": null,
    "obj": null,
    "map": null,
    "list": [
      {
        "creationId": 25485,
        "shareType": 3,
        "relType": 2,
        "relId": "485fb498bfb343fa9bcf883247e9b3a1",
        "relName": "管理员",
        "avatar": null,
        "staffDelFlag": 0,
        "self": 1
      }
    ]
    }
    

    参数说明

    参数名 必须 参数类型 参数说明
    shareType Int 共享类型:1.个人 2.部门及一下数据 3全部
    relType Int 关联类型:2:成员 3:外部成员
    relName String 关联名称,最大长度为256
    avatar String 头像
    staffDelFlag Int 员工是否删除 0-未删除 1-已删除
    relId String 关联id
    self Int 是否本人数据 0-否 1-是

修改共享权限

  • 接口描述:修改共享权限

  • 接口地址:/api/v1/editor/creation/share/update?token=TOKEN&openId=OPENID

  • 请求方式:POST

  • 请求格式:json

  • 接口入参:

    参数名 必须 参数类型 参数说明
    creationId Long 作品唯一标识
    shareType Int 共享类型:1.个人 2.部门及下级部门 3全部
    relType Int 关联类型:2:成员 3:外部成员
    relId String 关联id
    relName String 关联名称
  • 请求示例:

    {
    "creationId": 25940,
    "shareType": 2,
    "relType": 2,
    "relId": "046d3142b8fe4a5f925cd2ad642670dd",
    "relName": "若池"
    }
    
  • 接口出参:

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

    删除共享

  • 接口描述:删除共享数据,这里不会删除已产生的相关数据

  • 接口地址:/api/v1/editor/creation/share/delete?token=TOKEN&openId=OPENID

  • 请求方式:POST

  • 接口入参:

    参数名 必须 参数类型 参数说明
    creationId Long 作品唯一标识
    relType Int 关联类型:2:成员 3:外部成员
    relId String 关联id
  • 请求示例:

    [{
    "creationId": 25940,
    "relId": "046d3142b8fe4a5f925cd2ad642670dd",
    "relType": 2
    }]
    
  • 接口出参:

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

will 2022年9月8日 10:47 2757 收藏文档