跳到主要内容

查询应用包基本信息

调用本接口,获取应用包基本信息


权限说明

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

请求

**请求方式:**GET

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

其他版本请求地址:

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

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

参数说明(查询参数):
参数必须说明
tagId应用包id,不填则查询工作区内所有应用包详细信息
pageSize每页数据条数
pageNum请求页码

请求头(Header)

参数必须说明
accessToken调用接口凭证。获取方法请查看“文档”

返回

返回体
参数必含类型说明
errCodeint错误码,非0表示失败
errMsgstring错误描述
questionRelationsarray关联的设置,这里没用
resultobject返回结果
pageNumint请求页码
pageSizeint每页数据条数
resultAmountint总数据条数
pageAmountint总页数
resultarray
tagIdint应用包id
tagName应用包名称
tagAuthint应用包的可见权限, 1-2分别代表:工作区可查看、指定用户可见
authMembersobject指定用户可见的时候,可见的用户列表
usersarray用户列表
userIdstring用户id
userNamestring用户昵称
deptsarray部门列表
deptIdint部门id
deptNamestring部门名称
rolesarray角色列表
roleIdint角色id
roleNamestring角色名称
creatorobject应用包创建者
userIdstring应用包创建者的userid
nickNamestring应用包创建者的昵称
headImgstring应用包创建者的头像
createTimestring应用包的创建时间
tagIconstring应用包的图标
appListarray应用列表(包含未发布状态应用)
appKeystring应用id
appNamestring应用名称
dashListarray门户列表(包含未发布状态门户)
dashKeystring门户id
dashNamestring门户名称
返回体示例
{
"errCode": 0,
"errMsg": null,
"questionRelations": [],
"result": {
"pageAmount": 17,
"pageNum": 1,
"pageSize": 1,
"result": [
{
"appList": [
{
"appKey": "6029er18",
"appName": "当前应用"
},
{
"appKey": "d4dbc3ff",
"appName": "目标应用"
}
],
"authMembers": {
"depts": [],
"roles": [],
"users": [
{
"userId": "9050",
"userName": "snow"
}
]
},
"createTime": "2022-01-26T11:33:29",
"creator": {
"headImg": "https://file.qingflow.com/assets/contact/aar1.png",
"nickName": "",
"userId": "6892"
},
"dashList": [
{
"dashKey": "fae003c3",
"dashName": "门户"
}
],
"tagAuth": 2,
"tagIcon": "{\"icon\":null,\"iconColor\":\"qing-orange\",\"iconName\":null}",
"tagId": 9051,
"tagName": "nihao"
}
],
"resultAmount": 17
}
}
错误码相关

注意事项

1、返回参数中,tagIcon参数为应用包的图标,可能的值为图片链接(自定义图标)或如下字符串:

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

文档图片

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