成员

获取工作区成员

GET /openapi/v1/workspaces/{workspaceId}/members/

请求体

{
 "name": "xxxx", // 非必填项，可以模糊匹配用户的 name 进行筛选，针对 account
 "status": 1, // 非必填项，可通过 status 筛选不同状态的成员，针对 account
 "role": 1, // 非必填项，可通过 role 筛选不同角色的成员，针对 member
 "tier": 1 // 非必填项，可通过 tier 筛选不同等级的成员，针对 account
}

返回结果

{
 "errcode": 200,
 "errmsg": "success",
 "data": [
  {
            "account": {
                "desc": "xxxxx",
                "email": "xxxx@xxx",
                "nickname": "xxxx",
                "status": 1,
                "uid": "xxxxxx"
            },
            "role": 1,
            "uid": "xxxxx"
        }
 ]
}

参数说明

参数	类型	说明
data.account.desc	string	用户说明
data.account.email	string	用户邮箱
data.account.nickname	string	用户名称
data.account.status	int	用户状态
data.account.uid	string	用户 uid
data.role	int	成员角色
data.uid	string	成员 uid

添加用户到工作区

POST /openapi/v1/workspaces/{workspaceId}/members/

请求体

{
 "uids": ["xxxxx", "xxxx"]
}

参数说明

参数	类型	是否必填	说明
uids	array	是	要添加至该工作区的用户 uid 数组

返回结果

{
 "errcode": 200,
 "errmsg": "success",
    "data": [
        {
        "account": {
            "uid": "xxxxx",
            "desc": "xxx",
            "email": "xxxx@xxx",
            "nickname": "xxxxx",
            "status": 1
        },
        "ddra": 0,
        "ddya": 0,
        "dt": 0,
        "role": 0,
        "uid": "xxxxx"
        }
    ]
}

编辑工作区成员

PUT /openapi/v1/workspaces/{workspaceId}/members/{memberUid}/

请求体

{
    "role": 1
}

参数说明

参数	类型	说明
role	int	用户角色

返回结果

{
 "errcode": 200,
 "errmsg": "success",
 "data": {
        "account": {
            "desc": "xxxxx",
            "email": "xxxx@xxx",
            "nickname": "xxxx",
            "status": 1,
            "uid": "xxxxxx"
        },
        "role": 1,
        "uid": "xxxxx"
 }
}

参数说明

参数	类型	说明
data.account.desc	string	用户说明
data.account.email	string	用户邮箱
data.account.nickname	string	用户名称
data.account.status	int	用户状态
data.account.uid	string	用户 uid
data.role	int	成员角色
data.uid	string	成员 uid

获取成员的搜索记录

GET /openapi/v1/workspaces/{workspaceId}/members/{memberUid}/history/

请求参数

参数	类型	说明
count	int	是否获取记录总数
offset	int	翻页 offset
limit	int	翻页 limit
q	str	搜索内容

返回结果

{
    "errcode": 200,
    "errmsg": "success",
    "data": [
        "今年耐克近3月每周利润趋势比较",
        "门店营业额前十",
        "门店面积后十营业额门店面积",
        "门店面积降序前十营业额门店面积"
    ]
}

批量编辑工作区成员

PUT /openapi/v1/workspaces/{workspaceId}/members/update-members/

请求体

{
    "members": [
     {
      "uid": "xxxxx",
      "role": 1
     }
    ]
}

返回结果

{
 "errcode": 200,
 "errmsg": "success",
 "data": [
  {
   "account": {
                "desc": "xxxxx",
                "email": "xxxx@xxx",
                "nickname": "xxxx",
                "status": 1,
                "uid": "xxxxxx"
            },
            "role": 1,
            "uid": "xxxxx"
  }
 ]
}

从工作区删除用户

DELETE /openapi/v1/workspaces/{workspaceId}/members/{memberUid}/

返回结果

{
 "errcode": 200,
 "errmsg": "success"
}

从工作区批量删除用户

DELETE /openapi/v1/workspaces/{workspaceId}/members/delete-members/

请求体

{
 "memberUids": ["xxx", "xxxx"]
}

返回结果

{
 "errcode": 200,
 "errmsg": "success"
}