Skip to content

获取指定角色信息

获取指定角色信息

请求说明

请求地址配置域名+/o/woa/api/v1/announce/developer/role
请求方法GET
签名方式wps-4
支持应用类型企业自建应用、第三方企业应用
权限要求批量导入公告权限角色(kso.announce_role.readwrite)

请求头

Header名称是否必填说明
Content-Type目前固定为:"application/json"
Wps-Docs-Date取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT
Wps-Docs-Authorization计算方法参考签名说明
Authorizationaccess_token(企业授权获取的token)

请求地址示例

http
[GET] 配置域名+/o/woa/api/v1/announce/developer/role?operator=123?role_id=123?role_name=aaa

查询参数(Query)

名称类型是否必填说明
operatorint操作人(wpsUid)
role_idint角色id,当此值不为空时使用该值查询角色信息
role_nameint角色名,当此值不为空且role_id为空时使用该值查询角色信息

请求体(body)

响应体

名称类型说明
resultstringok:成功,其他-失败
dataobject响应数据
 ∟ role_idint角色id
 ∟ role_namestring角色名称
 ∟ role_tabs[]string权限范围列表
 ∟ users[]object角色下用户id列表
  ∟ corp_idstring用户公司id
  ∟ user_idstring用户id
 ∟ send_range[]object公告发送范围
  ∟ corp_idstring发送范围全公司时,公司id
  ∟ departments[]object发送范围为部门时,部门信息
   ∟ corp_idstring公司id
   ∟ dept_idstring部门id
  ∟ users[]object可发送的用户
   ∟ corp_idstring用户公司id
   ∟ user_idstring用户id

响应体示例

json
{
  "data": {
    "role_id": 7,
    "role_name": "测试角色666",
    "role_tabs": ["announcement_management"],
    "users": [
      {
        "user_id": "96",
        "corp_id": "0"
      }
    ],
    "send_range": {
      "corp_id": "0",
      "departments": [
        {
          "dept_id": "16",
          "corp_id": "3"
        }
      ],
      "users": [
        {
          "user_id": "97",
          "corp_id": "3"
        },
        {
          "user_id": "98",
          "corp_id": "3"
        },
        {
          "user_id": "99",
          "corp_id": "3"
        }
      ]
    }
  },
  "result": "ok"
}