明道云开放平台

正在加载页面

鉴权方式

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

版本

请求地址

POST

Header 参数

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

Body 参数

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

响应参数

200成功创建角色

名称	类型	描述
`success`	`boolean`	是否调用成功
`error_code`	`integer`	错误代码
`error_msg`	`string`	错误消息
`data`	`object`	角色信息
`data.id`	`string`	角色 id
`data.name`	`string`	角色名称
`data.roleType`	`integer`	角色类型
`data.desc`	`string`	描述
`data.users`	`string[]`	用户信息
`data.departments`	`string[]`	部门
`data.departmentTrees`	`string[]`	部门树
`data.projectOrganizes`	`string[]`	组织角色
`data.jobs`	`string[]`	职位

curl -X POST "https://example.com/v3/app/roles" \  -H "HAP-Appkey: {{HAP-Appkey}}" \  -H "HAP-Sign: {{HAP-Sign}}" \  -H "Content-Type: application/json" \  -d '{    "name": "测试角色1",    "description": "测试创建角色",    "hideAppForMembers": "false",    "type": "0",    "permissionScope": "30"  }'

{  "data": {    "id": "6825715d-92cc-4e15-83ce-8e39d1a667bc",    "name": "新角色40",    "roleType": 0,    "desc": "",    "users": [],    "departments": [],    "departmentTrees": [],    "projectOrganizes": [],    "jobs": []  },  "success": true}

名称

类型

必填

描述

HAP-Appkey

string

是

HAP应用密钥

HAP-Sign

string

是

HAP签名

Body 参数

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

名称

类型

描述

success

boolean

是否调用成功

error_code

integer

错误代码

error_msg

string

错误消息

data

object

角色信息

data.id

string

角色 id

data.name

string

角色名称

data.roleType

integer

角色类型

data.desc

string

描述

data.users

string[]

用户信息

data.departments

string[]

部门

data.departmentTrees

string[]

部门树

data.projectOrganizes

string[]

组织角色

data.jobs

string[]

职位

curl -X POST "https://example.com/v3/app/roles" \ -H "HAP-Appkey: {{HAP-Appkey}}" \ -H "HAP-Sign: {{HAP-Sign}}" \ -H "Content-Type: application/json" \ -d '{ "name": "测试角色1", "description": "测试创建角色", "hideAppForMembers": "false", "type": "0", "permissionScope": "30" }'

{ "data": { "id": "6825715d-92cc-4e15-83ce-8e39d1a667bc", "name": "新角色40", "roleType": 0, "desc": "", "users": [], "departments": [], "departmentTrees": [], "projectOrganizes": [], "jobs": [] }, "success": true}