明道云开放平台

正在加载页面

鉴权方式

AppKey + Sign 是应用密钥鉴权，由管理员创建，用于以应用管理员身份访问应用数据。

版本

请求地址

GET

Path 参数

名称	类型	必填	描述
`role_id`	`string`	是	角色ID 示例值：`"role_id"`

Header 参数

名称	类型	必填	描述
`HAP-Appkey`	`string`	是	HAP应用密钥
`HAP-Sign`	`string`	是	HAP签名

响应参数

200成功获取角色详情

名称	类型	描述
`success`	`boolean`	是否调用成功
`error_code`	`integer`	错误代码
`error_msg`	`string`	错误消息
`data`	`object`	角色详情信息
`data.id`	`string`	角色 id
`data.name`	`string`	角色名称
`data.description`	`string`	角色描述
`data.permissionScope`	`string`	分发所有应用项, 80：可查看、编辑、删除所有记录; 60：可查看所有记录，但只能编辑、删除自己拥有的记录; 30：可查看加入的，只能编辑、删除自己拥有的记录; 20：对所有记录只有查看权限; 0：分发有权限应用项
`data.type`	`string`	角色类型 0：自定义角色
`data.hideAppForMembers`	`string`	是否对成员隐藏应用,true：隐藏，false：不隐藏
`data.globalPermissions`	`object`	应用全局权限，仅在permissionScope大于0时生效
`data.globalPermissions.addRecord`	`boolean`	添加记录权限，true 有权限，false 无权限
`data.globalPermissions.share`	`boolean`	视图和记录的公开分享权限，true 有权限，false 无权限
`data.globalPermissions.import`	`boolean`	导入权限，true 有权限，false 无权限
`data.globalPermissions.export`	`boolean`	导出权限，true 有权限，false 无权限
`data.globalPermissions.discuss`	`boolean`	讨论权限，true 有权限，false 无权限
`data.globalPermissions.systemPrint`	`boolean`	系统打印，true 有权限，false 无权限
`data.globalPermissions.attachmentDownload`	`boolean`	附件下载，true 有权限，false 无权限
`data.globalPermissions.log`	`boolean`	日志，true 有权限，false 无权限
`data.worksheetPermissions`	`object[]`	工作表权限明细，仅在permissionScope为0时生效
`data.worksheetPermissions.id`	`string`	工作表Id
`data.worksheetPermissions.recordDataScope`	`object`	行记录的数据权限范围
`data.worksheetPermissions.recordDataScope.read`	`integer`	查看权限范围 0：未授权 20：仅我拥有的 30：我的及下属的 100：全部的
`data.worksheetPermissions.recordDataScope.edit`	`integer`	编辑权限范围 0：未授权 20：仅我拥有的 30：我的及下属的 100：全部的
`data.worksheetPermissions.recordDataScope.delete`	`integer`	删除权限范围 0：未授权 20：仅我拥有的 30：我的及下属的 100：全部的
`data.worksheetPermissions.worksheetActions`	`object`	工作表动作权限
`data.worksheetPermissions.worksheetActions.shareView`	`boolean`	公开分享视图权限
`data.worksheetPermissions.worksheetActions.import`	`boolean`	工作表导入权限
`data.worksheetPermissions.worksheetActions.export`	`boolean`	工作表导出权限
`data.worksheetPermissions.worksheetActions.discuss`	`boolean`	工作表讨论权限
`data.worksheetPermissions.worksheetActions.batchOperation`	`boolean`	工作表批量操作权限
`data.worksheetPermissions.paymentActions`	`object`	支付权限
`data.worksheetPermissions.paymentActions.pay`	`boolean`	工作表中付款权限
`data.worksheetPermissions.recordActions`	`object`	行记录动作权限
`data.worksheetPermissions.recordActions.add`	`boolean`	添加记录权限
`data.worksheetPermissions.recordActions.share`	`boolean`	公开分享记录权限
`data.worksheetPermissions.recordActions.discuss`	`boolean`	记录讨论权限
`data.worksheetPermissions.recordActions.systemPrint`	`boolean`	记录系统打印权限
`data.worksheetPermissions.recordActions.attachmentDownload`	`boolean`	记录附件下载权限
`data.worksheetPermissions.recordActions.log`	`boolean`	记录日志权限
`data.worksheetPermissions.recordPermissionInViews`	`object[]`	在视图下的行记录权限
`data.worksheetPermissions.recordPermissionInViews.viewId`	`string`	视图ID
`data.worksheetPermissions.recordPermissionInViews.read`	`boolean`	查看行记录权限
`data.worksheetPermissions.recordPermissionInViews.edit`	`boolean`	编辑行记录权限
`data.worksheetPermissions.recordPermissionInViews.delete`	`boolean`	删除行记录权限
`data.worksheetPermissions.fieldPermissions`	`object[]`	字段权限
`data.worksheetPermissions.fieldPermissions.id`	`string`	字段ID
`data.worksheetPermissions.fieldPermissions.add`	`boolean`	新增字段权限
`data.worksheetPermissions.fieldPermissions.read`	`boolean`	查看字段权限
`data.worksheetPermissions.fieldPermissions.edit`	`boolean`	编辑字段权限
`data.worksheetPermissions.fieldPermissions.decrypt`	`boolean`	解密字段权限
`data.pagePermissions`	`object[]`	自定义页面权限明细，仅在permissionScope为0时生效
`data.pagePermissions.id`	`string`	自定义页面ID
`data.pagePermissions.enable`	`boolean`	是否可以查看自定义页面

curl -X GET "https://example.com/v3/app/roles/role_id" \  -H "HAP-Appkey: {{HAP-Appkey}}" \  -H "HAP-Sign: {{HAP-Sign}}"

{  "data": {    "id": "role123",    "name": "管理员",    "description": "系统管理员角色",    "permissionScope": "80",    "type": "0",    "hideAppForMembers": "false",    "globalPermissions": {      "addRecord": true,      "share": true,      "import": true,      "export": true,      "discuss": true,      "systemPrint": true,      "attachmentDownload": true,      "log": true    },    "worksheetPermissions": [      {        "id": "worksheet123",        "recordDataScope": {          "read": 100,          "edit": 100,          "delete": 100        },        "worksheetActions": {          "shareView": true,          "import": true,          "export": true,          "discuss": true,          "batchOperation": true        }      }    ],    "pagePermissions": [      {        "id": "page123",        "enable": true      }    ]  },  "success": true}

名称

类型

必填

描述

role_id

string

是

角色ID

示例值："role_id"

名称

类型

必填

描述

HAP-Appkey

string

是

HAP应用密钥

HAP-Sign

string

是

HAP签名

名称

类型

描述

success

boolean

是否调用成功

error_code

integer

错误代码

error_msg

string

错误消息

data

object

角色详情信息

data.id

string

角色 id

data.name

string

角色名称

data.description

string

角色描述

data.permissionScope

string

分发所有应用项, 80：可查看、编辑、删除所有记录; 60：可查看所有记录，但只能编辑、删除自己拥有的记录; 30：可查看加入的，只能编辑、删除自己拥有的记录; 20：对所有记录只有查看权限; 0：分发有权限应用项

data.type

string

角色类型 0：自定义角色

data.hideAppForMembers

string

是否对成员隐藏应用,true：隐藏，false：不隐藏

data.globalPermissions

object

应用全局权限，仅在permissionScope大于0时生效

data.globalPermissions.addRecord

boolean

添加记录权限，true 有权限，false 无权限

data.globalPermissions.share

boolean

视图和记录的公开分享权限，true 有权限，false 无权限

data.globalPermissions.import

boolean

导入权限，true 有权限，false 无权限

data.globalPermissions.export

boolean

导出权限，true 有权限，false 无权限

data.globalPermissions.discuss

boolean

讨论权限，true 有权限，false 无权限

data.globalPermissions.systemPrint

boolean

系统打印，true 有权限，false 无权限

data.globalPermissions.attachmentDownload

boolean

附件下载，true 有权限，false 无权限

data.globalPermissions.log

boolean

日志，true 有权限，false 无权限

data.worksheetPermissions

object[]

工作表权限明细，仅在permissionScope为0时生效

data.worksheetPermissions.id

string

工作表Id

data.worksheetPermissions.recordDataScope

object

行记录的数据权限范围

data.worksheetPermissions.recordDataScope.read

integer

查看权限范围 0：未授权 20：仅我拥有的 30：我的及下属的 100：全部的

data.worksheetPermissions.recordDataScope.edit

integer

编辑权限范围 0：未授权 20：仅我拥有的 30：我的及下属的 100：全部的

data.worksheetPermissions.recordDataScope.delete

integer

删除权限范围 0：未授权 20：仅我拥有的 30：我的及下属的 100：全部的

data.worksheetPermissions.worksheetActions

object

工作表动作权限

data.worksheetPermissions.worksheetActions.shareView

boolean

公开分享视图权限

data.worksheetPermissions.worksheetActions.import

boolean

工作表导入权限

data.worksheetPermissions.worksheetActions.export

boolean

工作表导出权限

data.worksheetPermissions.worksheetActions.discuss

boolean

工作表讨论权限

data.worksheetPermissions.worksheetActions.batchOperation

boolean

工作表批量操作权限

data.worksheetPermissions.paymentActions

object

支付权限

data.worksheetPermissions.paymentActions.pay

boolean

工作表中付款权限

data.worksheetPermissions.recordActions

object

行记录动作权限

data.worksheetPermissions.recordActions.add

boolean

添加记录权限

data.worksheetPermissions.recordActions.share

boolean

公开分享记录权限

data.worksheetPermissions.recordActions.discuss

boolean

记录讨论权限

data.worksheetPermissions.recordActions.systemPrint

boolean

记录系统打印权限

data.worksheetPermissions.recordActions.attachmentDownload

boolean

记录附件下载权限

data.worksheetPermissions.recordActions.log

boolean

记录日志权限

data.worksheetPermissions.recordPermissionInViews

object[]

在视图下的行记录权限

data.worksheetPermissions.recordPermissionInViews.viewId

string

视图ID

data.worksheetPermissions.recordPermissionInViews.read

boolean

查看行记录权限

data.worksheetPermissions.recordPermissionInViews.edit

boolean

编辑行记录权限

data.worksheetPermissions.recordPermissionInViews.delete

boolean

删除行记录权限

data.worksheetPermissions.fieldPermissions

object[]

字段权限

data.worksheetPermissions.fieldPermissions.id

string

字段ID

data.worksheetPermissions.fieldPermissions.add

boolean

新增字段权限

data.worksheetPermissions.fieldPermissions.read

boolean

查看字段权限

data.worksheetPermissions.fieldPermissions.edit

boolean

编辑字段权限

data.worksheetPermissions.fieldPermissions.decrypt

boolean

解密字段权限

data.pagePermissions

object[]

自定义页面权限明细，仅在permissionScope为0时生效

data.pagePermissions.id

string

自定义页面ID

data.pagePermissions.enable

boolean

是否可以查看自定义页面

{ "data": { "id": "role123", "name": "管理员", "description": "系统管理员角色", "permissionScope": "80", "type": "0", "hideAppForMembers": "false", "globalPermissions": { "addRecord": true, "share": true, "import": true, "export": true, "discuss": true, "systemPrint": true, "attachmentDownload": true, "log": true }, "worksheetPermissions": [ { "id": "worksheet123", "recordDataScope": { "read": 100, "edit": 100, "delete": 100 }, "worksheetActions": { "shareView": true, "import": true, "export": true, "discuss": true, "batchOperation": true } } ], "pagePermissions": [ { "id": "page123", "enable": true } ] }, "success": true}