跳到主要内容

查询门户基本信息

调用本接口,查询门户的基本信息


权限说明

仅「超管accessToken」拥有调用权限。(权限组accessToken无法调用)

请求

请求方式:GET

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

其他版本请求地址:

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

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

参数说明(查询参数):
参数必须说明
dashKey
门户ID,可查询指定门户的基本信息,不填则查询所有门户信息
pageSize每页数据条数
pageNum页码
请求头(Header)
参数必须说明
accessToken调用接口凭证。获取方法请查看“文档”

返回

返回体
参数必含类型说明
errCodeint错误码,非0表示失败
errMsgstring错误描述
questionRelations关联的设置,这里没用
resultobject返回结果
resultAmountnumber结果数量
pageAmountnumber页数
pageNumnumber页码
pageSizenumber每页数据量
resultobject
dashKeystring门户ID
dashNamestring门户名称
dashIconstring门户图标
dashAuthnumber门户的可见权限, 1-3分别代表:工作区可查看,指定用户可见,所有人可见
authMembersobject指定用户可见的时候,可见的用户列表,不支持动态负责人
users[array]用户列表
userIdstring外部id
userNamestring用户昵称
depts[array]部门列表
deptIdnumber外部部门id
deptNamestring部门名称
roles[array]角色列表
roleIdnumber外部角色id
roleNamestring角色名称
creatorobject门户创建者
userIdstring外部id
nickNamestring昵称
headImgstring头像
createTimestring创建时间
tags[array]应用所属的应用包
tagIdnumber应用包id
tagNamestring应用包名称
dashPublishStatusnumber门户状态
返回体示例
{
"errCode": 0,
"errMsg": "ok",
"result": {
"resultAmount": 10,
"resultFormat": "json"
}
}
错误码相关

注意事项