weda API

简介:weda API

HOST:https://{envId}.ap-shanghai.tcb-api.tencentcloudapi.com/weda

联系人:

Version:1.0

接口路径:/v3/api-docs/EnterpriseAPI

[TOC]

企业工作台

查询应用列表

接口地址:/enterprise/v1/getAppListByAppName

请求方式:GET

请求数据类型:application/json

响应数据类型:*/*

接口描述:

查询应用列表

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envId	环境id	query	true	string
envType	环境类型	query	true	string
uid	用户id	query	true	string
appName	应用名称	query	false	string
appStatus	应用状态	query	false	string
includeCustomized	是否自定义应用	query	false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponse应用列表出参

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为应用列表出参	公共出参对象，data类型为应用列表出参
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		应用列表出参	应用列表出参
appList		array	应用数据
appId	应用id	string
appName	应用名称	string
appType	应用类型	integer
appUrl	应用访问地址	string
thumbNail	缩略图	string
themeColor	主题颜色	string
lmenuEnabled	是否开启菜单导航	boolean
extInfo	扩展信息	string
categoryId	分类id	string
statusEnabled	状态是否可用	boolean

响应示例:

{
    "response": {
        "requestId": "",
        "error": {
            "code": "",
            "message": ""
        },
        "data": {
            "appList": [
                {
                    "appId": "app-wesacp",
                    "appName": "模型应用",
                    "appType": 1,
                    "appUrl": "http:aaa.bbb.com/app-seaswe",
                    "thumbNail": "http:aaa.bbb.com/app-seaswe.jpg",
                    "themeColor": "#f000",
                    "lmenuEnabled": true,
                    "extInfo": "{a:b}",
                    "categoryId": "123",
                    "statusEnabled": true
                }
            ]
        }
    }
}

创建应用分类

接口地址:/enterprise/v1/{envType}/createAppCategory

请求方式:POST

请求数据类型:application/json,application/json

响应数据类型:*/*

接口描述:

创建应用分类

请求示例:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID,用户管理取值 10001001",
  "Uid": "100111",
  "Data": [
    {
      "CategoryId": "225",
      "CategoryName": "教育",
      "Order": 1,
      "Enabled": true,
      "AppIds": "[app-wesacp,app-wesdfsdf]"
    }
  ]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType		path	true	string
创建应用分类入参	创建应用分类入参	body	true	创建应用分类入参	创建应用分类入参
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
Uid	用户id		false	string
Data	应用分类详情		false	array	应用分类详情
CategoryId	应用分类id		false	string
CategoryName	应用分类名称		true	string
Order	应用分类排序		false	integer
Enabled	应用分类是否启用		false	boolean
AppIds	应用分类应用id列表		false	array	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponse创建应用分类出参

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为创建应用分类出参	公共出参对象，data类型为创建应用分类出参
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		创建应用分类出参	创建应用分类出参
Data	创建应用分类结果	array	CreateAppCategoryData
CategoryId	应用分类id	string
CategoryName	应用分类名称	string
Order	应用分类排序	integer
Enabled	应用分类是否启用	boolean
AppIds	应用分类应用id列表	array	string

响应示例:

{
    "response": {
        "requestId": "",
        "error": {
            "code": "",
            "message": ""
        },
        "data": {
            "Data": [
                {
                    "CategoryId": "225",
                    "CategoryName": "教育",
                    "Order": 1,
                    "Enabled": true,
                    "AppIds": "[app-wesacp,app-wesdfsdf]"
                }
            ]
        }
    }
}

查询应用分类

接口地址:/enterprise/v1/{envType}/getAppCategory

请求方式:POST

请求数据类型:application/json,application/json

响应数据类型:*/*

接口描述:

查询应用分类

请求示例:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID,用户管理取值 10001001",
  "Uid": "100111",
  "CategoryName": "教育"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType		path	true	string
查询应用分类入参	查询应用分类入参	body	true	查询应用分类入参	查询应用分类入参
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
Uid	用户id		false	string
CategoryName	应用分类名称		false	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponse查询应用分类返回参数

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为查询应用分类返回参数	公共出参对象，data类型为查询应用分类返回参数
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		查询应用分类返回参数	查询应用分类返回参数
data	应用分类列表	array	GetAppCategoryInfo
Id	应用分类id	string
CategoryName	应用分类名称	string
Order	应用分类排序	integer
Enabled	应用分类是否启用	boolean
AppCount	应用分类应用中应用数量	integer
EnterpriseApps	应用分类-应用详情	array	应用详情
AppId	应用id	string
AppName	应用名称	string
AppType	应用类型	boolean
AppUrl	应用访问url	string
ThumbNail	缩略图	string
ThemeColor	主题颜色	string
LmenuEnabled	是否开启菜单导航	boolean
ExtInfo	扩展信息	string

响应示例:

{
    "response": {
        "requestId": "",
        "error": {
            "code": "",
            "message": ""
        },
        "data": {
            "data": [
                {
                    "Id": "225",
                    "CategoryName": "教育",
                    "Order": 1,
                    "Enabled": true,
                    "AppCount": 2,
                    "EnterpriseApps": [
                        {
                            "AppId": "app-wesacp",
                            "AppName": "模型应用-1015",
                            "AppType": false,
                            "AppUrl": "http://lowcode-sdfsddfl-1001/a/",
                            "ThumbNail": "http:aaa.bbb.com/app-seaswe.jpg",
                            "ThemeColor": "#f000",
                            "LmenuEnabled": true,
                            "ExtInfo": "{a:b}"
                        }
                    ]
                }
            ]
        }
    }
}

更新应用分类

接口地址:/enterprise/v1/{envType}/updateAppCategory

请求方式:POST

请求数据类型:application/json,application/json

响应数据类型:*/*

接口描述:

更新应用分类

请求示例:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID,用户管理取值 10001001",
  "Uid": "100111",
  "Data": [
    {
      "Id": "225",
      "CategoryName": "教育",
      "Order": 1,
      "Enabled": true,
      "AppIds": "[app-wesacp,app-wesdfsdf]"
    }
  ]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType		path	true	string
更新应用分类入参	更新应用分类入参	body	true	更新应用分类入参	更新应用分类入参
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
Uid	用户id		true	string
Data	应用分类详情		true	array	UpdateAppCategoryData
Id	应用分类id		false	string
CategoryName	应用分类名称		false	string
Order	应用分类排序		false	integer
Enabled	应用分类是否启用		false	boolean
AppIds	应用分类应用id列表		false	array	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponseUpdateAppCategoryResponse

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为UpdateAppCategoryResponse	公共出参对象，data类型为UpdateAppCategoryResponse
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		UpdateAppCategoryResponse	UpdateAppCategoryResponse

响应示例:

{
    "response": {
        "requestId": "",
        "error": {
            "code": "",
            "message": ""
        },
        "data": {}
    }
}

删除应用分类

接口地址:/enterprise/v1/{envType}/deleteAppCategory

请求方式:POST

请求数据类型:application/json,application/json

响应数据类型:*/*

接口描述:

删除应用分类

请求示例:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID,用户管理取值 10001001",
  "Uid": "100111",
  "CategoryIds": [
    225,
    226
  ]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType		path	true	string
删除应用分类入参	删除应用分类入参	body	true	删除应用分类入参	删除应用分类入参
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
Uid	用户id		false	string
CategoryIds	应用分类id列表		true	array	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponseDeleteAppCategoryResponse

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为DeleteAppCategoryResponse	公共出参对象，data类型为DeleteAppCategoryResponse
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		DeleteAppCategoryResponse	DeleteAppCategoryResponse

响应示例:

{
    "response": {
        "requestId": "",
        "error": {
            "code": "",
            "message": ""
        },
        "data": {}
    }
}

查询常用应用

接口地址:/enterprise/v1/{envType}/getMyLruApp

请求方式:POST

请求数据类型:application/json,application/json

响应数据类型:*/*

接口描述:

查询常用应用

请求示例:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID,用户管理取值 10001001",
  "Uid": "100111",
  "UserId": "100111"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType		path	true	string
查询常用应用入参	查询常用应用入参	body	true	查询常用应用入参	查询常用应用入参
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
Uid	用户id,废弃		false	string
UserId	用户id		true	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponse查询常用应用出参

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为查询常用应用出参	公共出参对象，data类型为查询常用应用出参
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		查询常用应用出参	查询常用应用出参
AppLru		AppLru	AppLru
AppIds	常用应用id列表	array	string

响应示例:

{
    "response": {
        "requestId": "",
        "error": {
            "code": "",
            "message": ""
        },
        "data": {
            "AppLru": {
                "AppIds": "[app-wesacp,app-wesdfsdf]"
            }
        }
    }
}

用户设置常用应用

接口地址:/enterprise/v1/{envType}/setCommonApp

请求方式:POST

请求数据类型:application/json,application/json

响应数据类型:*/*

接口描述:

用户设置常用应用

请求示例:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID,用户管理取值 10001001",
  "UserId": "100111",
  "AppLru": {
    "AppIds": "[app-wesacp,app-wesdfsdf]"
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType		path	true	string
设置常用应用入参	设置常用应用入参	body	true	设置常用应用入参	设置常用应用入参
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
UserId	用户id		true	string
AppLru	常用应用详情		true	常用应用id列表	常用应用id列表
AppIds	常用应用id列表		true	array	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponseSetCommonAppResponse

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为SetCommonAppResponse	公共出参对象，data类型为SetCommonAppResponse
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		SetCommonAppResponse	SetCommonAppResponse

响应示例:

{
    "response": {
        "requestId": "",
        "error": {
            "code": "",
            "message": ""
        },
        "data": {}
    }
}

修改第三方应用

接口地址:/enterprise/v1/{envType}/updateEnterpriseApp

请求方式:POST

请求数据类型:application/json,application/json

响应数据类型:*/*

接口描述:

修改第三方应用

请求示例:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "app-wesacp",
  "Uid": "100111",
  "AppName": "模型应用-1023",
  "CategoryId": "225",
  "AppType": 1,
  "AppUrl": "http:aaa.bbb.com/app-seaswe",
  "ThumbNail": "http:aaa.bbb.com/app-seaswe.jpg",
  "ThemeColor": "#f000",
  "LmenuEnabled": true,
  "ExtInfo": "{a:b}",
  "StatusEnabled": true
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType		path	true	string
修改企业工作台应用入参	修改企业工作台应用入参	body	true	修改企业工作台应用入参	修改企业工作台应用入参
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId	应用id		true	string
Uid	用户id		false	string
AppName	应用名称		false	string
CategoryId	应用分类id		true	string
AppType	应用类型		false	integer(int32)
AppUrl	应用访问地址		false	string
ThumbNail	缩略图		false	string
ThemeColor	主题颜色		false	string
LmenuEnabled	是否开启菜单导航		false	boolean
ExtInfo	扩展信息		false	string
StatusEnabled	是否开启		false	boolean

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponseUpdateEnterpriseAppResponse

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为UpdateEnterpriseAppResponse	公共出参对象，data类型为UpdateEnterpriseAppResponse
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		UpdateEnterpriseAppResponse	UpdateEnterpriseAppResponse

响应示例:

{
    "response": {
        "requestId": "",
        "error": {
            "code": "",
            "message": ""
        },
        "data": {}
    }
}

新增第三方应用

接口地址:/enterprise/v1/{envType}/createEnterpriseApp

请求方式:POST

请求数据类型:application/json,application/json

响应数据类型:*/*

接口描述:

新增第三方应用

请求示例:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "app-wesacp",
  "Uid": "100111",
  "AppName": "模型应用-1023",
  "CategoryId": "225",
  "AppType": 1,
  "AppUrl": "http:aaa.bbb.com/app-seaswe",
  "ThumbNail": "http:aaa.bbb.com/app-seaswe.jpg",
  "ThemeColor": "#f000",
  "LmenuEnabled": true,
  "ExtInfo": "{a:b}"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType		path	true	string
创建企业工作台应用入参	创建企业工作台应用入参	body	true	创建企业工作台应用入参	创建企业工作台应用入参
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId	应用id		true	string
Uid	用户id		false	string
AppName	应用名称		false	string
CategoryId	应用分类id		true	string
AppType	应用类型		false	integer(int32)
AppUrl	应用访问地址		false	string
ThumbNail	缩略图		false	string
ThemeColor	主题颜色		false	string
LmenuEnabled	是否开启菜单导航		false	boolean
ExtInfo	扩展信息		false	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponseCreateEnterpriseAppResponse

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为CreateEnterpriseAppResponse	公共出参对象，data类型为CreateEnterpriseAppResponse
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		CreateEnterpriseAppResponse	CreateEnterpriseAppResponse

响应示例:

{
    "response": {
        "requestId": "",
        "error": {
            "code": "",
            "message": ""
        },
        "data": {}
    }
}

获取全部用户初始化信息

接口地址:/enterprise/v1/{envType}/getAdminAllInfo

请求方式:POST

请求数据类型:application/json,application/json

响应数据类型:*/*

接口描述:

获取全部用户初始化信息

请求示例:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID,用户管理取值 10001001",
  "Uid": "100111",
  "Source": 1,
  "IncludeCustomized": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType		path	true	string
getAdminAllInfoRequest	GetAdminAllInfoRequest	body	true	GetAdminAllInfoRequest	GetAdminAllInfoRequest
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
Uid	用户id		true	string
Source	用户来源		true	integer(int32)
IncludeCustomized	是否包含自定义应用		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponseGetAdminAllInfoResponse

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为GetAdminAllInfoResponse	公共出参对象，data类型为GetAdminAllInfoResponse
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		GetAdminAllInfoResponse	GetAdminAllInfoResponse
Data		GetAdminAllInfoRespData	GetAdminAllInfoRespData
Apps		array	AdminAppInfo
Id		string
Name		string
DeployUrl		string
AppCustomNav		AppCustomNav	AppCustomNav
navigationStyle		string
isMultiTerminal		boolean
menuData		array	CustomMenu
Key		string
title		string
type		string
path		string
iconUrl		string
children		array	CustomMenu
linkTargetBlank		boolean
level		integer
IconPath		string
LinkUrl		string
mobileMenuData		array	CustomMenu
Key		string
title		string
type		string
path		string
iconUrl		string
children		array	CustomMenu
linkTargetBlank		boolean
level		integer
IconPath		string
LinkUrl		string
homePageId		string
showNav		boolean
NavVersion		integer
thrumbNail		string
themeColor		string
lmenuEnabled		boolean
appUrl		string
extInfo		string
AppType		integer
ConfigInfo		array	string
UserInfo		CurrentUser	CurrentUser
accessibleService		array	string
avatar		string
uin		string
type		integer
email		string
name		string
envId		string
userId		string
uuid		string
phone		string
RelatedRoles		array	WedaRole
name		string
roleIdentity		string
id		string
parentRoleId		string
childRoleId		string
envIdentity		string
isReleased		string
UserExtend		string
PrimaryColumn		string
UserDesc		string
NickName		string
MainOrg		Org	Org
orgId		string
orgName		string
orgIdentity		string
level		integer
Orgs		array	Org
orgId		string
orgName		string
orgIdentity		string
level		integer
Corp		Corp	Corp
id		string
name		string
ProdAppTotal		integer
PreviewAppTotal		integer
ThirdApps		array	AdminAppInfo
Id		string
Name		string
DeployUrl		string
AppCustomNav		AppCustomNav	AppCustomNav
navigationStyle		string
isMultiTerminal		boolean
menuData		array	CustomMenu
Key		string
title		string
type		string
path		string
iconUrl		string
children		array	CustomMenu
linkTargetBlank		boolean
level		integer
IconPath		string
LinkUrl		string
mobileMenuData		array	CustomMenu
Key		string
title		string
type		string
path		string
iconUrl		string
children		array	CustomMenu
linkTargetBlank		boolean
level		integer
IconPath		string
LinkUrl		string
homePageId		string
showNav		boolean
NavVersion		integer
thrumbNail		string
themeColor		string
lmenuEnabled		boolean
appUrl		string
extInfo		string
AppType		integer

响应示例:

{
    "response": {
        "requestId": "",
        "error": {
            "code": "",
            "message": ""
        },
        "data": {
            "Data": {
                "Apps": [
                    {
                        "Id": "",
                        "Name": "",
                        "DeployUrl": "",
                        "AppCustomNav": {
                            "navigationStyle": "",
                            "isMultiTerminal": true,
                            "menuData": [
                                {
                                    "Key": "",
                                    "title": "",
                                    "type": "",
                                    "path": "",
                                    "iconUrl": "",
                                    "children": [
                                        {
                                            "Key": "",
                                            "title": "",
                                            "type": "",
                                            "path": "",
                                            "iconUrl": "",
                                            "children": [
                                                {}
                                            ],
                                            "linkTargetBlank": true,
                                            "level": 0,
                                            "IconPath": "",
                                            "LinkUrl": ""
                                        }
                                    ],
                                    "linkTargetBlank": true,
                                    "level": 0,
                                    "IconPath": "",
                                    "LinkUrl": ""
                                }
                            ],
                            "mobileMenuData": [
                                {}
                            ],
                            "homePageId": "",
                            "showNav": true
                        },
                        "NavVersion": 0,
                        "thrumbNail": "",
                        "themeColor": "",
                        "lmenuEnabled": true,
                        "appUrl": "",
                        "extInfo": "",
                        "AppType": 0
                    }
                ],
                "ConfigInfo": [],
                "UserInfo": {
                    "accessibleService": [],
                    "avatar": "",
                    "uin": "",
                    "type": 0,
                    "email": "",
                    "name": "",
                    "envId": "",
                    "userId": "",
                    "uuid": "",
                    "phone": "",
                    "RelatedRoles": [
                        {
                            "name": "",
                            "roleIdentity": "",
                            "id": "",
                            "parentRoleId": "",
                            "childRoleId": "",
                            "envIdentity": "",
                            "isReleased": ""
                        }
                    ],
                    "UserExtend": "",
                    "PrimaryColumn": "",
                    "UserDesc": "",
                    "NickName": "",
                    "MainOrg": {
                        "orgId": "",
                        "orgName": "",
                        "orgIdentity": "",
                        "level": 0
                    },
                    "Orgs": [
                        {
                            "orgId": "",
                            "orgName": "",
                            "orgIdentity": "",
                            "level": 0
                        }
                    ],
                    "Corp": {
                        "id": "",
                        "name": ""
                    }
                },
                "ProdAppTotal": 0,
                "PreviewAppTotal": 0,
                "ThirdApps": [
                    {}
                ]
            }
        }
    }
}

获取环境套餐信息

接口地址:/enterprise/v1/{envType}/describeEnvInfo

请求方式:POST

请求数据类型:application/json,application/json

响应数据类型:*/*

接口描述:

获取环境套餐信息

请求示例:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID,用户管理取值 10001001"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType		path	true	string
describeEnvInfoRequest	DescribeEnvInfoRequest	body	true	DescribeEnvInfoRequest	DescribeEnvInfoRequest
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponse查询环境信息出参

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为查询环境信息出参	公共出参对象，data类型为查询环境信息出参
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		查询环境信息出参	查询环境信息出参
Data	环境数据	EnvInfo	EnvInfo
EnvId		string
PackageId		string
Status		integer
CreateTime		string
ExpireTime		string
IsolateTime		string
UserPackageId		string

响应示例:

{
    "response": {
        "requestId": "",
        "error": {
            "code": "",
            "message": ""
        },
        "data": {
            "Data": {
                "EnvId": "",
                "PackageId": "",
                "Status": 0,
                "CreateTime": "",
                "ExpireTime": "",
                "IsolateTime": "",
                "UserPackageId": ""
            }
        }
    }
}

获取用户导航内容

接口地址:/enterprise/v1/{envType}/describeAppHistoryByAppId

请求方式:POST

请求数据类型:application/json,application/json

响应数据类型:*/*

接口描述:

获取用户导航内容

请求示例:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID,用户管理取值 10001001",
  "WeAppId": "app-wesacp"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType		path	true	string
查询应用页面数据入参	查询应用页面数据入参	body	true	查询应用页面数据入参	查询应用页面数据入参
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
WeAppId	应用id		true	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponse查询应用页面数据出参

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为查询应用页面数据出参	公共出参对象，data类型为查询应用页面数据出参
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		查询应用页面数据出参	查询应用页面数据出参
Data	应用详情数据	应用详情数据	应用详情数据
AppId	应用id	string
Comment	应用说明	string
Content	应用页面信息	string
Version	应用历史版本	string
ExtraConfig	应用其他配置信息	string
ZipUrl	应用zip链接	string
FileName	应用文件名	integer
Operator	应用操作人	integer
AppVersionId	应用版本id	integer
ID	快照id	string
Pages	页面	string

响应示例:

{
    "response": {
        "requestId": "",
        "error": {
            "code": "",
            "message": ""
        },
        "data": {
            "Data": {
                "AppId": "app-wesacp",
                "Comment": "app-wesacp",
                "Content": "{\"title\":\"模型应用\"}",
                "Version": "1",
                "ExtraConfig": "{}",
                "ZipUrl": "http://cos.t.zip",
                "FileName": 0,
                "Operator": 100001,
                "AppVersionId": 1,
                "ID": "111101",
                "Pages": ""
            }
        }
    }
}

保存用户导航内容

接口地址:/enterprise/v1/{envType}/modifyAppCustomNav

请求方式:POST

请求数据类型:application/json,application/json

响应数据类型:*/*

接口描述:

保存用户导航内容

请求示例:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID,用户管理取值 10001001",
  "WeAppId": "app-wesacp",
  "AppHisId": 0,
  "PublishType": "prod",
  "Content": "{\"navigationStyle\":\"\",\"showNav\":true}",
  "NavVersion": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType		path	true	string
修改应用自定义导航数据入参	修改应用自定义导航数据入参	body	true	修改应用自定义导航数据入参	修改应用自定义导航数据入参
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
WeAppId	应用id		true	string
AppHisId	应用快照id		false	integer(int32)
PublishType	发布类型(pre/prod)		true	string
Content	自定义导航内容		true	string
NavVersion	自定义导航数据版本		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponse修改应用自定义导航数据出参

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为修改应用自定义导航数据出参	公共出参对象，data类型为修改应用自定义导航数据出参
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		修改应用自定义导航数据出参	修改应用自定义导航数据出参
Data	应用自定义导航数据	应用自定义导航数据	应用自定义导航数据
WeAppId	应用id	string
AppHisId	应用快照id	integer
Content	自定义导航内容	string
NavVersion	自定义导航数据版本	integer
CreatedAt	创建时间	string
UpdatedAt	修改时间	string

响应示例:

{
    "response": {
        "requestId": "",
        "error": {
            "code": "",
            "message": ""
        },
        "data": {
            "Data": {
                "WeAppId": "app-wesacp",
                "AppHisId": 0,
                "Content": "{\"navigationStyle\":\"\",\"showNav\":true}",
                "NavVersion": 0,
                "CreatedAt": "2023-10-16 10：00：00",
                "UpdatedAt": "2023-10-16 10：00：00"
            }
        }
    }
}

获取用户公开配置

接口地址:/enterprise/v1/{envType}/getSiteSetting

请求方式:POST

请求数据类型:application/json,application/json

响应数据类型:*/*

接口描述:

获取用户公开配置

请求示例:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID,用户管理取值 10001001"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType		path	true	string
查询企业工作台配置数据入参	查询企业工作台配置数据入参	body	true	查询企业工作台配置数据入参	查询企业工作台配置数据入参
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponse查询企业工作台配置数据出参

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为查询企业工作台配置数据出参	公共出参对象，data类型为查询企业工作台配置数据出参
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		查询企业工作台配置数据出参	查询企业工作台配置数据出参
Data	企业工作台配置数据	企业工作台配置数据	企业工作台配置数据
ConfigInfo	企业工作台配置数据数组	array	string

响应示例:

{
    "response": {
        "requestId": "",
        "error": {
            "code": "",
            "message": ""
        },
        "data": {
            "Data": {
                "ConfigInfo": []
            }
        }
    }
}

更新用户设置

接口地址:/enterprise/v1/{envType}/updateSiteSetting

请求方式:POST

请求数据类型:application/json,application/json

响应数据类型:*/*

接口描述:

更新用户设置

请求示例:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID,用户管理取值 10001001",
  "Data": "{\"_id\":{\"$oid\":\"65262c8e042b68f2a6642023\"},\"brandEnabled\":true\"title\":\"企业工作台\",\"todoEnabled\":false,\"topNavEnabled\":false,\"waterMarkEnabled\":false}"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType		path	true	string
修改企业工作台配置数据入参	修改企业工作台配置数据入参	body	true	修改企业工作台配置数据入参	修改企业工作台配置数据入参
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
Data	企业工作台配置数据		true	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponse修改企业工作台配置数据出参

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为修改企业工作台配置数据出参	公共出参对象，data类型为修改企业工作台配置数据出参
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		修改企业工作台配置数据出参	修改企业工作台配置数据出参
Data	修改企业工作台配置数据结果	修改企业工作台配置数据结果	修改企业工作台配置数据结果
Updated	修改企业工作台配置数据状态	integer

响应示例:

{
    "response": {
        "requestId": "",
        "error": {
            "code": "",
            "message": ""
        },
        "data": {
            "Data": {
                "Updated": 1
            }
        }
    }
}

查询用户设置超时时间

接口地址:/enterprise/v1/{envType}/describeIdaasAuthClient

请求方式:POST

请求数据类型:application/json,application/json

响应数据类型:*/*

接口描述:

查询用户设置超时时间

请求示例:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID,用户管理取值 10001001"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType		path	true	string
describeIdaasAuthClientRequest	DescribeIdaasAuthClientRequest	body	true	DescribeIdaasAuthClientRequest	DescribeIdaasAuthClientRequest
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponseDescribeIdaasAuthClientResponse

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为DescribeIdaasAuthClientResponse	公共出参对象，data类型为DescribeIdaasAuthClientResponse
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		DescribeIdaasAuthClientResponse	DescribeIdaasAuthClientResponse
Data		IdaasAuthClient	IdaasAuthClient
ClientId		string
RefreshTokenExpiresIn		integer

响应示例:

{
    "response": {
        "requestId": "",
        "error": {
            "code": "",
            "message": ""
        },
        "data": {
            "Data": {
                "ClientId": "",
                "RefreshTokenExpiresIn": 0
            }
        }
    }
}

修改用户设置超时时间

接口地址:/enterprise/v1/{envType}/modifyIdaasAuthClient

请求方式:POST

请求数据类型:application/json,application/json

响应数据类型:*/*

接口描述:

修改用户设置超时时间

请求示例:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID,用户管理取值 10001001",
  "RefreshTokenExpiresIn": 3
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType		path	true	string
修改用户设置超时时间入参	修改用户设置超时时间入参	body	true	修改用户设置超时时间入参	修改用户设置超时时间入参
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
RefreshTokenExpiresIn	过期时间		true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponseModifyIdaasAuthClientResponse

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为ModifyIdaasAuthClientResponse	公共出参对象，data类型为ModifyIdaasAuthClientResponse
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		ModifyIdaasAuthClientResponse	ModifyIdaasAuthClientResponse
Data		IdaasAuthClient	IdaasAuthClient
ClientId		string
RefreshTokenExpiresIn		integer

响应示例:

{
    "response": {
        "requestId": "",
        "error": {
            "code": "",
            "message": ""
        },
        "data": {
            "Data": {
                "ClientId": "",
                "RefreshTokenExpiresIn": 0
            }
        }
    }
}

获取素材上传地址

接口地址:/enterprise/v1/{envType}/describeMaterialUploadUrlData

请求方式:POST

请求数据类型:application/json,application/json

响应数据类型:*/*

接口描述:

获取素材上传地址

请求示例:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID,用户管理取值 10001001",
  "Name": "a.excel",
  "ExpireDay": 3,
  "IsPrivate": true
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType		path	true	string
describeMaterialUploadUrlDataRequest	DescribeMaterialUploadUrlDataRequest	body	true	DescribeMaterialUploadUrlDataRequest	DescribeMaterialUploadUrlDataRequest
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
Name	路径地址		true	string
ExpireDay	过期时间		true	integer(int32)
IsPrivate			false	boolean

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponseDescribeMaterialUploadUrlDataResponse

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为DescribeMaterialUploadUrlDataResponse	公共出参对象，data类型为DescribeMaterialUploadUrlDataResponse
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		DescribeMaterialUploadUrlDataResponse	DescribeMaterialUploadUrlDataResponse
Data		MaterialUploadUrlDataRsp	MaterialUploadUrlDataRsp
UploadUrl		string
DownloadUrl		string
ExpireDay		integer
Id		integer
Path		string

响应示例:

{
    "response": {
        "requestId": "",
        "error": {
            "code": "",
            "message": ""
        },
        "data": {
            "Data": {
                "UploadUrl": "",
                "DownloadUrl": "",
                "ExpireDay": 0,
                "Id": 0,
                "Path": ""
            }
        }
    }
}

绑定素材库

接口地址:/enterprise/v1/{envType}/updateMaterialInfoData

请求方式:POST

请求数据类型:application/json,application/json

响应数据类型:*/*

接口描述:

绑定素材库

请求示例:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID,用户管理取值 10001001",
  "Id": 1438500,
  "Name": "aa",
  "Tags": "aa",
  "IsPublic": true,
  "MediaType": "aa",
  "ExpireDay": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType		path	true	string
updateMaterialInfoDataRequest	UpdateMaterialInfoDataRequest	body	true	UpdateMaterialInfoDataRequest	UpdateMaterialInfoDataRequest
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
Id	素材id		true	integer(int32)
Name	素材名称		false	string
Tags	素材标签列表		false	array	string
IsPublic			false	boolean
MediaType	媒体类型		false	string
ExpireDay	过期天数		false	integer(int32)

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponseUpdateMaterialInfoDataResponse

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为UpdateMaterialInfoDataResponse	公共出参对象，data类型为UpdateMaterialInfoDataResponse
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		UpdateMaterialInfoDataResponse	UpdateMaterialInfoDataResponse

响应示例:

{
    "response": {
        "requestId": "",
        "error": {
            "code": "",
            "message": ""
        },
        "data": {}
    }
}

获取用户静态托管cdn域名

接口地址:/enterprise/v1/{envType}/getStaticResourceDomainByEnvId

请求方式:POST

请求数据类型:application/json,application/json

响应数据类型:*/*

接口描述:

获取用户静态托管cdn域名

请求示例:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID,用户管理取值 10001001"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType		path	true	string
获取用户静态托管cdn域名入参	获取用户静态托管cdn域名入参	body	true	获取用户静态托管cdn域名入参	获取用户静态托管cdn域名入参
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponseGetStaticResourceDomainByEnvIdResponse

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为GetStaticResourceDomainByEnvIdResponse	公共出参对象，data类型为GetStaticResourceDomainByEnvIdResponse
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		GetStaticResourceDomainByEnvIdResponse	GetStaticResourceDomainByEnvIdResponse
Data		CosDomainRsp	CosDomainRsp
StaticResourceDomain		string

响应示例:

{
    "response": {
        "requestId": "",
        "error": {
            "code": "",
            "message": ""
        },
        "data": {
            "Data": {
                "StaticResourceDomain": ""
            }
        }
    }
}

查询COS预签名地址

接口地址:/enterprise/v1/{envType}/describeStaticCosPreSignatureUrl

请求方式:POST

请求数据类型:application/json,application/json

响应数据类型:*/*

接口描述:

查询COS预签名地址

请求示例:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID,用户管理取值 10001001",
  "Path": "__auth/app.jpg",
  "ExpireDay": 0,
  "HostAddr": "https://abc.tcloudbaseapp.com",
  "BucketType": "桶类型，默认静态托管，CloudStorage为云存储",
  "Paths": [
    "__auth/app.jpg"
  ]
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
envType		path	true	string
查询预签名地址入参	查询预签名地址入参	body	true	查询预签名地址入参	查询预签名地址入参
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
Path			false	string
ExpireDay			false	integer(int32)
HostAddr			false	string
BucketType			false	string
Paths			false	array	string

响应状态:

状态码	说明	schema
200	OK	OpenApiServerResponse预签名返回参数

响应参数:

参数名称	参数说明	类型	schema
response		公共出参对象，data类型为预签名返回参数	公共出参对象，data类型为预签名返回参数
requestId	requestId	string
error	错误信息	错误信息	错误信息
code	错误码	string
message	错误消息提示	string
data		预签名返回参数	预签名返回参数
Data	预签名返回参数	DescribeStaticCosPreSignatureUrlInfo	DescribeStaticCosPreSignatureUrlInfo
DownloadUrl		string
DownloadUrlOrigin		string
PreSignatureDownloadUrl		string
PreSignatureDownloadUrlOrigin		string
StaticCosUploadUrlList		array	StaticCosUploadUrl
DownloadUrl		string
DownloadUrlOrigin		string
PreSignatureDownloadUrl		string
PreSignatureDownloadUrlOrigin		string
UploadUrlOrigin		string
UploadUrl		string
UploadUrlOrigin		string
UploadUrl		string

响应示例:

{
    "response": {
        "requestId": "",
        "error": {
            "code": "",
            "message": ""
        },
        "data": {
            "Data": {
                "DownloadUrl": "https://lowcode-aaa-111.tcloudbaseapp.com/__auth/app/a.json",
                "DownloadUrlOrigin": "/__auth/app/a.json",
                "PreSignatureDownloadUrl": "https://lowcode-aaa-111.tcloudbaseapp.com/__auth/app/a.json",
                "PreSignatureDownloadUrlOrigin": "/__auth/app/a.json",
                "StaticCosUploadUrlList": "[]",
                "UploadUrlOrigin": "/__auth/app/a.json",
                "UploadUrl": "https://lowcode-aaa-111.tcloudbaseapp.com/__auth/app/a.json"
            }
        }
    }
}