跳到主要内容

创建门户

调用本接口,新建门户


权限说明

「超管accessToken」和「权限组accessToken」都可以调用,「权限组accessToken」须具有对应应用包的门户创建权限。

请求

**请求方式:**POST

**请求地址:**https://api.qingflow.com/dash(公有云版本)

专有轻流地址示例如下:

POST https://xxx.xxxx.com/openApi/dash

其他版本请求地址:

钉钉版本:https://api.ding.qingflow.com/dash

专有轻流:http(s)://xxx.xx(自有域名)/openApi/dash

参数说明(查询参数):
请求头(Header)
参数必须说明
accessToken调用接口凭证。获取方法请查看“文档”
请求体(Body)
参数必须类型说明
dashNamestring门户名字
tagIds[array]新增应用所属的应用包,此处只能选择自定义应用包。不可选系统默认应用包
dashIconstring门户图标,支持图片链接或固定格式字符(见文末注意事项)
userIdstring门户的创建人userid,不填默认为工作区创建者;此处为外部用户id
dashAuthnumber门户的可见权限, 1-工作区可见 (默认值)2-指定用户可见3-所有人可见
authMembersobject指定用户可见的时候,可见的用户列表,不填则默认管理员可见
userIds[array]可见的用户列表;外部用户id列表
deptIds[array]可见的部门列表;外部部门id列表
roleIds[array]可见的角色列表;外部角色id列表
includeSubDepartsBoolean(应用已经使用相同字段)是否动态包含已选部门下的子部门,默认包含
请求体示例
{
"tagIds":[4386],
"dashName":"new",
"dashIcon":"{"icon":null,"iconColor":"qing-orange","iconName":null}",
"dashAuth":1
}

返回

返回体
参数必含类型说明
errCodeint错误码,非0表示失败
errMsgstring错误描述
questionRelations关联的设置,这里没用
resultobject返回结果
dashKeystring门户的ID
返回体示例
{
"errCode": 0,
"errMsg": "ok",
"result": {
"dashKey": "734wd3432"
}
}
错误码相关

注意事项

1、新增「所有人可见」门户前,请确保工作区「所有人可见」门户余额足够。

2、请求参数中,dashIcon参数为门户的图标,支持传入图片链接

  • 默认为橙色+首字,值为:{"icon":null,"iconColor":"qing-orange","iconName":null},效果如图:

文档图片

  • 图标底色(iconColor)/组件(iconName)可选值可参考