weda API

Introduction:weda API

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

Contact:

Version:1.0

Endpoint Path:/v3/api-docs/EnterpriseAPI

[TOC]

Enterprise Workbench

Query Application List

Endpoint:/enterprise/v1/getAppListByAppName

Request method:GET

Request Data Type:application/json

Response Data Type:*/*

Interface Description:

Query Application List

Request Parameters:

Parameter Name	Description	Request Type	Required	Data Type	schema
envId	Environment id	query	true	string
envType	Environment type	query	true	string
uid	User id	query	true	string
appName	Application name	query	false	string
appStatus	Application status	query	false	string
includeCustomized	Whether the application is customized	query	false	integer(int32)

Response Status:

Status Code	Description	schema
200	OK	OpenApiServerResponseApplicationListResponse

Response Parameters:

Parameter Name	Description	Type	schema
response		Common Response Object (data type: Application List Response)	Common Response Object (data type: Application List Response)
requestId	requestId	string
error	Error Message	Error Message	Error Message
code	Error code	string
message	Error message prompt	string
data		Application List Response	Application List Response
appList		array	Application Data
appId	Application id	string
appName	Application name	string
appType	Application type	integer
appUrl	Application access URL	string
thumbNail	Thumbnail	string
themeColor	Theme color	string
lmenuEnabled	Whether menu navigation is enabled	boolean
extInfo	Extended information	string
categoryId	Category id	string
statusEnabled	Whether the status is enabled	boolean

Response Example:

{
    "response": {
        "requestId": "",
        "error": {
            "code": "",
            "message": ""
        },
        "data": {
            "appList": [
                {
                    "appId": "app-wesacp",
                    "appName": "Model Application",
                    "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
                }
            ]
        }
    }
}

Create Application Category

Endpoint:/enterprise/v1/{envType}/createAppCategory

Request Method:POST

Request Data Type:application/json,application/json

Response Data Type:*/*

Interface Description:

Create Application Category

Request Example:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID, value for user management is 10001001",
  "Uid": "100111",
  "Data": [
    {
      "CategoryId": "225",
      "CategoryName": "Education",
      "Order": 1,
      "Enabled": true,
      "AppIds": "[app-wesacp,app-wesdfsdf]"
    }
  ]
}

Request Parameters:

Parameter Name	Description	Request Type	Required	Data Type	schema
envType		path	true	string
Create Application Category Input	Create Application Category Input	body	true	Create Application Category Input	Create Application Category Input
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
Uid	User id		false	string
Data	Application Category Details		false	array	Application Category Details
CategoryId	Application Category id		false	string
CategoryName	Application Category Name		true	string
Order	Application Category Sort Order		false	integer
Enabled	Application Category Enabled Status		false	boolean
AppIds	List of Application IDs in Category		false	array	string

Response Status:

Status Code	Description	schema
200	OK	OpenApiServerResponseCreateApplicationCategoryResponse

Response Parameters:

Parameter Name	Description	Type	schema
response		Common Response Object (data type: Create Application Category Response)	Common Response Object (data type: Create Application Category Response)
requestId	requestId	string
error	Error Message	Error Message	Error Message
code	Error code	string
message	Error message prompt	string
data		Create Application Category Response	Create Application Category Response
Data	Application category creation result	array	CreateAppCategoryData
CategoryId	Application Category id	string
CategoryName	Application Category Name	string
Order	Application Category Sort Order	integer
Enabled	Application Category Enabled Status	boolean
AppIds	List of Application IDs in Category	array	string

Response Example:

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

Query Application Category

Endpoint:/enterprise/v1/{envType}/getAppCategory

Request Method:POST

Request Data Type:application/json,application/json

Response Data Type:*/*

Interface Description:

Query Application Category

Request Example:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID, value for user management is 10001001",
  "Uid": "100111",
  "CategoryName": "Education"
}

Request Parameters:

Parameter Name	Description	Request Type	Required	Data Type	schema
envType		path	true	string
Query Application Category Input	Query Application Category Input	body	true	Query Application Category Input	Query Application Category Input
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
Uid	User id		false	string
CategoryName	Application Category Name		false	string

Response Status:

Status Code	Description	schema
200	OK	OpenApiServerResponseQueryApplicationCategoryResponse

Response Parameters:

Parameter Name	Description	Type	schema
response		Common Response Object (data type: Query Application Category Response Parameters)	Common Response Object (data type: Query Application Category Response Parameters)
requestId	requestId	string
error	Error Message	Error Message	Error Message
code	Error code	string
message	Error message prompt	string
data		Query Application Category Response Parameters	Query Application Category Response Parameters
data	Application category list	array	GetAppCategoryInfo
Id	Application Category id	string
CategoryName	Application Category Name	string
Order	Application Category Sort Order	integer
Enabled	Application Category Enabled Status	boolean
AppCount	Number of applications in category	integer
EnterpriseApps	Application Category - Application Details	array	Application Details
AppId	Application id	string
AppName	Application name	string
AppType	Application Type	boolean
AppUrl	Application access url	string
ThumbNail	Thumbnail	string
ThemeColor	Theme color	string
LmenuEnabled	Whether menu navigation is enabled	boolean
ExtInfo	Extended Information	string

Response Example:

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

Update Application Category

Endpoint:/enterprise/v1/{envType}/updateAppCategory

Request Method:POST

Request Data Type:application/json,application/json

Response Data Type:*/*

Interface Description:

Update Application Category

Request Example:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID, value for user management is 10001001",
  "Uid": "100111",
  "Data": [
    {
      "Id": "225",
      "CategoryName": "Education",
      "Order": 1,
      "Enabled": true,
      "AppIds": "[app-wesacp,app-wesdfsdf]"
    }
  ]
}

Request Parameters:

Parameter Name	Description	Request Type	Required	Data Type	schema
envType		path	true	string
Update Application Category Input	Update Application Category Input	body	true	Update Application Category Input	Update Application Category Input
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
Uid	User id		true	string
Data	Application Category Details		true	array	UpdateAppCategoryData
Id	Application Category id		false	string
CategoryName	Application Category Name		false	string
Order	Application Category Sort Order		false	integer
Enabled	Application Category Enabled Status		false	boolean
AppIds	List of Application IDs in Category		false	array	string

Response Status:

Status Code	Description	schema
200	OK	OpenApiServerResponseUpdateAppCategoryResponse

Response Parameters:

Parameter Name	Description	Type	schema
response		Common Response Object (data type: UpdateAppCategoryResponse)	Common Response Object (data type: UpdateAppCategoryResponse)
requestId	requestId	string
error	Error Message	Error Message	Error Message
code	Error code	string
message	Error message prompt	string
data		UpdateAppCategoryResponse	UpdateAppCategoryResponse

Response Example:

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

Delete Application Category

Endpoint:/enterprise/v1/{envType}/deleteAppCategory

Request Method:POST

Request Data Type:application/json,application/json

Response Data Type:*/*

Interface Description:

Delete Application Category

Request Example:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID, value for user management is 10001001",
  "Uid": "100111",
  "CategoryIds": [
    225,
    226
  ]
}

Request Parameters:

Parameter Name	Description	Request Type	Required	Data Type	schema
envType		path	true	string
Delete Application Category Request	Delete Application Category Request	body	true	Delete Application Category Request	Delete Application Category Request
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
Uid	User id		false	string
CategoryIds	List of Application Category IDs		true	array	string

Response Status:

Status Code	Description	schema
200	OK	OpenApiServerResponseDeleteAppCategoryResponse

Response Parameters:

Parameter Name	Description	Type	schema
response		Common Response Object (data type: DeleteAppCategoryResponse)	Common Response Object (data type: DeleteAppCategoryResponse)
requestId	requestId	string
error	Error Message	Error Message	Error Message
code	Error code	string
message	Error message prompt	string
data		DeleteAppCategoryResponse	DeleteAppCategoryResponse

Response Example:

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

Query Frequently Used Applications

Endpoint:/enterprise/v1/{envType}/getMyLruApp

Request Method:POST

Request Data Type:application/json,application/json

Response Data Type:*/*

Interface Description:

Query Frequently Used Applications

Request Example:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID, value for user management is 10001001",
  "Uid": "100111",
  "UserId": "100111"
}

Request Parameters:

Parameter Name	Description	Request Type	Required	Data Type	schema
envType		path	true	string
Query Frequently Used Applications Input	Query Frequently Used Applications Input	body	true	Query Frequently Used Applications Input	Query Frequently Used Applications Input
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
Uid	User id, deprecated		false	string
UserId	User id		true	string

Response Status:

Status Code	Description	schema
200	OK	OpenApiServerResponseQueryFrequentlyUsedApplicationsResponse

Response Parameters:

Parameter Name	Description	Type	schema
response		Common Response Object (data type: Query Frequently Used Applications Response)	Common Response Object (data type: Query Frequently Used Applications Response)
requestId	requestId	string
error	Error Message	Error Message	Error Message
code	Error code	string
message	Error message prompt	string
data		Query Frequently Used Applications Response	Query Frequently Used Applications Response
AppLru		AppLru	AppLru
AppIds	List of frequently used application IDs	array	string

Response Example:

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

Set Frequently Used Applications

Endpoint:/enterprise/v1/{envType}/setCommonApp

Request Method:POST

Request Data Type:application/json,application/json

Response Data Type:*/*

Interface Description:

Set Frequently Used Applications

Request Example:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID, value for user management is 10001001",
  "UserId": "100111",
  "AppLru": {
    "AppIds": "[app-wesacp,app-wesdfsdf]"
  }
}

Request Parameters:

Parameter Name	Description	Request Type	Required	Data Type	schema
envType		path	true	string
Set Frequently Used Applications Input	Set Frequently Used Applications Input	body	true	Set Frequently Used Applications Input	Set Frequently Used Applications Input
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
UserId	User id		true	string
AppLru	Details of Frequently Used Applications		true	List of Frequently Used Application IDs	List of Frequently Used Application IDs
AppIds	List of frequently used application IDs		true	array	string

Response Status:

Status Code	Description	schema
200	OK	OpenApiServerResponseSetCommonAppResponse

Response Parameters:

Parameter Name	Description	Type	schema
response		Common Response Object (data type: SetCommonAppResponse)	Common Response Object (data type: SetCommonAppResponse)
requestId	requestId	string
error	Error Message	Error Message	Error Message
code	Error code	string
message	Error message prompt	string
data		SetCommonAppResponse	SetCommonAppResponse

Response Example:

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

Modify Third-party Application

Endpoint:/enterprise/v1/{envType}/updateEnterpriseApp

Request Method:POST

Request Data Type:application/json,application/json

Response Data Type:*/*

Interface Description:

Update Third-party Application

Request Example:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "app-wesacp",
  "Uid": "100111",
  "AppName": "Model Application-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
}

Request Parameters:

Parameter Name	Description	Request Type	Required	Data Type	schema
envType		path	true	string
Update Enterprise Workbench Application Input	Update Enterprise Workbench Application Input	body	true	Update Enterprise Workbench Application Input	Update Enterprise Workbench Application Input
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId	Application id		true	string
Uid	User id		false	string
AppName	Application name		false	string
CategoryId	Application Category id		true	string
AppType	Application type		false	integer(int32)
AppUrl	Application access URL		false	string
ThumbNail	Thumbnail		false	string
ThemeColor	Theme color		false	string
LmenuEnabled	Whether menu navigation is enabled		false	boolean
ExtInfo	Extended information		false	string
StatusEnabled	Whether enabled		false	boolean

Response Status:

Status Code	Description	schema
200	OK	OpenApiServerResponseUpdateEnterpriseAppResponse

Response Parameters:

Parameter Name	Description	Type	schema
response		Common Response Object (data type: UpdateEnterpriseAppResponse)	Common Response Object (data type: UpdateEnterpriseAppResponse)
requestId	requestId	string
error	Error Message	Error Message	Error Message
code	Error code	string
message	Error message prompt	string
data		UpdateEnterpriseAppResponse	UpdateEnterpriseAppResponse

Response Example:

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

Add Third-party Application

Endpoint:/enterprise/v1/{envType}/createEnterpriseApp

Request Method:POST

Request Data Type:application/json,application/json

Response Data Type:*/*

Interface Description:

Add Third-party Application

Request Example:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "app-wesacp",
  "Uid": "100111",
  "AppName": "Model Application-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}"
}

Request Parameters:

Parameter Name	Description	Request Type	Required	Data Type	schema
envType		path	true	string
Create Enterprise Workbench Application Input	Create Enterprise Workbench Application Input	body	true	Create Enterprise Workbench Application Input	Create Enterprise Workbench Application Input
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId	Application id		true	string
Uid	User id		false	string
AppName	Application name		false	string
CategoryId	Application Category id		true	string
AppType	Application type		false	integer(int32)
AppUrl	Application access URL		false	string
ThumbNail	Thumbnail		false	string
ThemeColor	Theme color		false	string
LmenuEnabled	Whether menu navigation is enabled		false	boolean
ExtInfo	Extended information		false	string

Response Status:

Status Code	Description	schema
200	OK	OpenApiServerResponseCreateEnterpriseAppResponse

Response Parameters:

Parameter Name	Description	Type	schema
response		Common Response Object (data type: CreateEnterpriseAppResponse)	Common Response Object (data type: CreateEnterpriseAppResponse)
requestId	requestId	string
error	Error Message	Error Message	Error Message
code	Error code	string
message	Error message prompt	string
data		CreateEnterpriseAppResponse	CreateEnterpriseAppResponse

Response Example:

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

Get All Users Initialization Information

Endpoint:/enterprise/v1/{envType}/getAdminAllInfo

Request Method:POST

Request Data Type:application/json,application/json

Response Data Type:*/*

Interface Description:

Get all users initialization information

Request Example:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID, value for user management is 10001001",
  "Uid": "100111",
  "Source": 1,
  "IncludeCustomized": 0
}

Request Parameters:

Parameter Name	Description	Request Type	Required	Data Type	schema
envType		path	true	string
getAdminAllInfoRequest	GetAdminAllInfoRequest	body	true	GetAdminAllInfoRequest	GetAdminAllInfoRequest
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
Uid	User id		true	string
Source	User source		true	integer(int32)
IncludeCustomized	Whether customized applications are included		false	integer(int32)

Response Status:

Status Code	Description	schema
200	OK	OpenApiServerResponseGetAdminAllInfoResponse

Response Parameters:

Parameter Name	Description	Type	schema
response		Common Response Object (data type: GetAdminAllInfoResponse)	Common Response Object (data type: GetAdminAllInfoResponse)
requestId	requestId	string
error	Error Message	Error Message	Error Message
code	Error code	string
message	Error message prompt	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 Example:

{
    "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": [
                    {}
                ]
            }
        }
    }
}

Getting Environment Plan Information

Endpoint:/enterprise/v1/{envType}/describeEnvInfo

Request Method:POST

Request Data Type:application/json,application/json

Response Data Type:*/*

Interface Description:

Get environment plan information

Request Example:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID, value for user management is 10001001"
}

Request Parameters:

Parameter Name	Description	Request Type	Required	Data Type	schema
envType		path	true	string
describeEnvInfoRequest	DescribeEnvInfoRequest	body	true	DescribeEnvInfoRequest	DescribeEnvInfoRequest
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string

Response Status:

Status Code	Description	schema
200	OK	OpenApiServerResponseQueryEnvironmentInformationResponse

Response Parameters:

Parameter Name	Description	Type	schema
response		Common Response Object (data type: Query Environment Information Response)	Common Response Object (data type: Query Environment Information Response)
requestId	requestId	string
error	Error Message	Error Message	Error Message
code	Error code	string
message	Error message prompt	string
data		Query Environment Information Response	Query Environment Information Response
Data	Environment Data	EnvInfo	EnvInfo
EnvId		string
PackageId		string
Status		integer
CreateTime		string
ExpireTime		string
IsolateTime		string
UserPackageId		string

Response Example:

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

Get User Navigation Content

Endpoint:/enterprise/v1/{envType}/describeAppHistoryByAppId

Request Method:POST

Request Data Type:application/json,application/json

Response Data Type:*/*

Interface Description:

Get user navigation content

Request Example:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID, value for user management is 10001001",
  "WeAppId": "app-wesacp"
}

Request Parameters:

Parameter Name	Description	Request Type	Required	Data Type	schema
envType		path	true	string
Query Application Page Data Input	Query Application Page Data Input	body	true	Query Application Page Data Input	Query Application Page Data Input
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
WeAppId	Application id		true	string

Response Status:

Status Code	Description	schema
200	OK	OpenApiServerResponseQueryApplicationPageDataResponse

Response Parameters:

Parameter Name	Description	Type	schema
response		Common Response Object (data type: Query Application Page Data Response)	Common Response Object (data type: Query Application Page Data Response)
requestId	requestId	string
error	Error Message	Error Message	Error Message
code	Error code	string
message	Error message prompt	string
data		Query Application Page Data Response	Query Application Page Data Response
Data	Application detail data	Application detail data	Application detail data
AppId	Application id	string
Comment	Application description	string
Content	Application page information	string
Version	Application historical version	string
ExtraConfig	Additional application configuration information	string
ZipUrl	Application zip link	string
FileName	Application file name	integer
Operator	Application operator	integer
AppVersionId	Application version id	integer
ID	Snapshot id	string
Pages	Page	string

Response Example:

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

Save User Navigation Content

Endpoint:/enterprise/v1/{envType}/modifyAppCustomNav

Request Method:POST

Request Data Type:application/json,application/json

Response Data Type:*/*

Interface Description:

Save user navigation content

Request Example:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID, value for user management is 10001001",
  "WeAppId": "app-wesacp",
  "AppHisId": 0,
  "PublishType": "prod",
  "Content": "{\"navigationStyle\":\"\",\"showNav\":true}",
  "NavVersion": 0
}

Request Parameters:

Parameter Name	Description	Request Type	Required	Data Type	schema
envType		path	true	string
Modify Application Custom Navigation Data Input	Modify Application Custom Navigation Data Input	body	true	Modify Application Custom Navigation Data Input	Modify Application Custom Navigation Data Input
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
WeAppId	Application id		true	string
AppHisId	Application snapshot id		false	integer(int32)
PublishType	Release type (pre/prod)		true	string
Content	Custom navigation content		true	string
NavVersion	Custom navigation data version		false	integer(int32)

Response Status:

Status Code	Description	schema
200	OK	OpenApiServerResponseModifyApplicationCustomNavigationDataResponse

Response Parameters:

Parameter Name	Description	Type	schema
response		Common Response Object (data type: Modify Application Custom Navigation Data Response)	Common Response Object (data type: Modify Application Custom Navigation Data Response)
requestId	requestId	string
error	Error Message	Error Message	Error Message
code	Error code	string
message	Error message prompt	string
data		Modify Application Custom Navigation Data Output	Modify Application Custom Navigation Data Output
Data	Application custom navigation data	Application custom navigation data	Application custom navigation data
WeAppId	Application id	string
AppHisId	Application Snapshot id	integer
Content	Custom navigation content	string
NavVersion	Custom navigation data version	integer
CreatedAt	Creation Time	string
UpdatedAt	Update Time	string

Response Example:

{
    "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"
            }
        }
    }
}

Get User Public Configuration

Endpoint:/enterprise/v1/{envType}/getSiteSetting

Request Method:POST

Request Data Type:application/json,application/json

Response Data Type:*/*

Interface Description:

Get User Public Configuration

Request Example:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID, value for user management is 10001001"
}

Request Parameters:

Parameter Name	Description	Request Type	Required	Data Type	schema
envType		path	true	string
Query Enterprise Workbench Configuration Data Input	Query Enterprise Workbench Configuration Data Input	body	true	Query Enterprise Workbench Configuration Data Input	Query Enterprise Workbench Configuration Data Input
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string

Response Status:

Status Code	Description	schema
200	OK	OpenApiServerResponseQueryEnterpriseWorkbenchConfigurationDataResponse

Response Parameters:

Parameter Name	Description	Type	schema
response		Common Response Object (data type: QueryEnterpriseWorkbenchConfigurationDataResponse)	Common Response Object (data type: QueryEnterpriseWorkbenchConfigurationDataResponse)
requestId	requestId	string
error	Error Message	Error Message	Error Message
code	Error code	string
message	Error message prompt	string
data		QueryEnterpriseWorkbenchConfigurationDataResponse	QueryEnterpriseWorkbenchConfigurationDataResponse
Data	Enterprise Workbench Configuration Data	Enterprise Workbench Configuration Data	Enterprise Workbench Configuration Data
ConfigInfo	Enterprise Workbench Configuration Data Array	array	string

Response Example:

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

Update User Settings

Endpoint:/enterprise/v1/{envType}/updateSiteSetting

Request Method:POST

Request Data Type:application/json,application/json

Response Data Type:*/*

Interface Description:

Update User Settings

Request Example:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID, value for user management is 10001001",
  "Data": "{\"_id\":{\"$oid\":\"65262c8e042b68f2a6642023\"},\"brandEnabled\":true,\"title\":\"Enterprise Workbench\",\"todoEnabled\":false,\"topNavEnabled\":false,\"waterMarkEnabled\":false}"
}

Request Parameters:

Parameter Name	Description	Request Type	Required	Data Type	schema
envType		path	true	string
Update Enterprise Workbench Configuration Data Input	Update Enterprise Workbench Configuration Data Input	body	true	Update Enterprise Workbench Configuration Data Input	Update Enterprise Workbench Configuration Data Input
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
Data	Enterprise Workbench Configuration Data		true	string

Response Status:

Status Code	Description	schema
200	OK	OpenApiServerResponseModifyEnterpriseWorkbenchConfigurationDataResponse

Response Parameters:

Parameter Name	Description	Type	schema
response		Common Response Object (data type: UpdateEnterpriseWorkbenchConfigurationDataResponse)	Common Response Object (data type: UpdateEnterpriseWorkbenchConfigurationDataResponse)
requestId	requestId	string
error	Error Message	Error Message	Error Message
code	Error code	string
message	Error message prompt	string
data		UpdateEnterpriseWorkbenchConfigurationDataResponse	UpdateEnterpriseWorkbenchConfigurationDataResponse
Data	UpdateEnterpriseWorkbenchConfigurationDataResult	UpdateEnterpriseWorkbenchConfigurationDataResult	UpdateEnterpriseWorkbenchConfigurationDataResult
Updated	Update Status	integer

Response Example:

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

Query User-Configured Timeout

Endpoint:/enterprise/v1/{envType}/describeIdaasAuthClient

Request Method:POST

Request Data Type:application/json,application/json

Response Data Type:*/*

Interface Description:

Query User-Configured Timeout

Request Example:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID, value for user management is 10001001"
}

Request Parameters:

Parameter Name	Description	Request Type	Required	Data Type	schema
envType		path	true	string
describeIdaasAuthClientRequest	DescribeIdaasAuthClientRequest	body	true	DescribeIdaasAuthClientRequest	DescribeIdaasAuthClientRequest
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string

Response Status:

Status Code	Description	schema
200	OK	OpenApiServerResponseDescribeIdaasAuthClientResponse

Response Parameters:

Parameter Name	Description	Type	schema
response		Common Response Object (data type: DescribeIdaasAuthClientResponse)	Common Response Object (data type: DescribeIdaasAuthClientResponse)
requestId	requestId	string
error	Error Message	Error Message	Error Message
code	Error code	string
message	Error message prompt	string
data		DescribeIdaasAuthClientResponse	DescribeIdaasAuthClientResponse
Data		IdaasAuthClient	IdaasAuthClient
ClientId		string
RefreshTokenExpiresIn		integer

Response Example:

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

Update User-Configured Timeout

Endpoint:/enterprise/v1/{envType}/modifyIdaasAuthClient

Request Method:POST

Request Data Type:application/json,application/json

Response Data Type:*/*

Interface Description:

Update User-Configured Timeout

Request Example:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID, value for user management is 10001001",
  "RefreshTokenExpiresIn": 3
}

Request Parameters:

Parameter Name	Description	Request Type	Required	Data Type	schema
envType		path	true	string
UpdateUserConfiguredTimeoutInput	UpdateUserConfiguredTimeoutInput	body	true	UpdateUserConfiguredTimeoutInput	UpdateUserConfiguredTimeoutInput
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
RefreshTokenExpiresIn	Expiration Time		true	integer(int32)

Response Status:

Status Code	Description	schema
200	OK	OpenApiServerResponseModifyIdaasAuthClientResponse

Response Parameters:

Parameter Name	Description	Type	schema
response		Common Response Object (data type: ModifyIdaasAuthClientResponse)	Common Response Object (data type: ModifyIdaasAuthClientResponse)
requestId	requestId	string
error	Error Message	Error Message	Error Message
code	Error code	string
message	Error message prompt	string
data		ModifyIdaasAuthClientResponse	ModifyIdaasAuthClientResponse
Data		IdaasAuthClient	IdaasAuthClient
ClientId		string
RefreshTokenExpiresIn		integer

Response Example:

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

Get material upload URL

Endpoint:/enterprise/v1/{envType}/describeMaterialUploadUrlData

Request Method:POST

Request Data Type:application/json,application/json

Response Data Type:*/*

Interface Description:

Get material upload URL

Request Example:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID, value for user management is 10001001",
  "Name": "a.excel",
  "ExpireDay": 3,
  "IsPrivate": true
}

Request Parameters:

Parameter Name	Description	Request Type	Required	Data Type	schema
envType		path	true	string
describeMaterialUploadUrlDataRequest	DescribeMaterialUploadUrlDataRequest	body	true	DescribeMaterialUploadUrlDataRequest	DescribeMaterialUploadUrlDataRequest
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
Name	Path address		true	string
ExpireDay	Expiration Time		true	integer(int32)
IsPrivate			false	boolean

Response Status:

Status Code	Description	schema
200	OK	OpenApiServerResponseDescribeMaterialUploadUrlDataResponse

Response Parameters:

Parameter Name	Description	Type	schema
response		Common Response Object (data type: DescribeMaterialUploadUrlDataResponse)	Common Response Object (data type: DescribeMaterialUploadUrlDataResponse)
requestId	requestId	string
error	Error Message	Error Message	Error Message
code	Error code	string
message	Error message prompt	string
data		DescribeMaterialUploadUrlDataResponse	DescribeMaterialUploadUrlDataResponse
Data		MaterialUploadUrlDataRsp	MaterialUploadUrlDataRsp
UploadUrl		string
DownloadUrl		string
ExpireDay		integer
Id		integer
Path		string

Response Example:

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

Bind Asset Library

Endpoint:/enterprise/v1/{envType}/updateMaterialInfoData

Request Method:POST

Request Data Type:application/json,application/json

Response Data Type:*/*

Interface Description:

Bind Asset Library

Request Example:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID, value for user management is 10001001",
  "Id": 1438500,
  "Name": "aa",
  "Tags": "aa",
  "IsPublic": true,
  "MediaType": "aa",
  "ExpireDay": 0
}

Request Parameters:

Parameter Name	Description	Request Type	Required	Data Type	schema
envType		path	true	string
updateMaterialInfoDataRequest	UpdateMaterialInfoDataRequest	body	true	UpdateMaterialInfoDataRequest	UpdateMaterialInfoDataRequest
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string
Id	Asset ID		true	integer(int32)
Name	Asset Name		false	string
Tags	Asset Tag List		false	array	string
IsPublic			false	boolean
MediaType	Media Type		false	string
ExpireDay	Expiration Days		false	integer(int32)

Response Status:

Status Code	Description	schema
200	OK	OpenApiServerResponseUpdateMaterialInfoDataResponse

Response Parameters:

Parameter Name	Description	Type	schema
response		Common Response Object (data type: UpdateMaterialInfoDataResponse)	Common Response Object (data type: UpdateMaterialInfoDataResponse)
requestId	requestId	string
error	Error Message	Error Message	Error Message
code	Error code	string
message	Error message prompt	string
data		UpdateMaterialInfoDataResponse	UpdateMaterialInfoDataResponse

Response Example:

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

Get User Static Hosting cdn Domain

Endpoint:/enterprise/v1/{envType}/getStaticResourceDomainByEnvId

Request Method:POST

Request Data Type:application/json,application/json

Response Data Type:*/*

Interface Description:

Get User Static Hosting cdn Domain

Request Example:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID, value for user management is 10001001"
}

Request Parameters:

Parameter Name	Description	Request Type	Required	Data Type	schema
envType		path	true	string
Get User Static Hosting cdn Domain Input Parameters	Get User Static Hosting cdn Domain Input Parameters	body	true	Get User Static Hosting cdn Domain Input Parameters	Get User Static Hosting cdn Domain Input Parameters
Uin			true	string
EnvId			true	string
EnvType			true	string
AppId			true	string

Response Status:

Status Code	Description	schema
200	OK	OpenApiServerResponseGetStaticResourceDomainByEnvIdResponse

Response Parameters:

Parameter Name	Description	Type	schema
response		Common Response Object (data type: GetStaticResourceDomainByEnvIdResponse)	Common Response Object (data type: GetStaticResourceDomainByEnvIdResponse)
requestId	requestId	string
error	Error Message	Error Message	Error Message
code	Error code	string
message	Error message prompt	string
data		GetStaticResourceDomainByEnvIdResponse	GetStaticResourceDomainByEnvIdResponse
Data		CosDomainRsp	CosDomainRsp
StaticResourceDomain		string

Response Example:

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

Query COS Presigned URL

Endpoint:/enterprise/v1/{envType}/describeStaticCosPreSignatureUrl

Request Method:POST

Request Data Type:application/json,application/json

Response Data Type:*/*

Interface Description:

Query COS presigned URL

Request Example:

{
  "Uin": "1001178931",
  "EnvId": "lowcode-8gr4tbore6df",
  "EnvType": "preview/prod",
  "AppId": "APPID, value for user management is 10001001",
  "Path": "__auth/app.jpg",
  "ExpireDay": 0,
  "HostAddr": "https://abc.tcloudbaseapp.com",
  "BucketType": "Bucket type, default static hosting, CloudStorage is cloud storage",
  "Paths": [
    "__auth/app.jpg"
  ]
}

Request Parameters:

Parameter Name	Description	Request Type	Required	Data Type	schema
envType		path	true	string
Query Presigned URL Input Parameters	Query Presigned URL Input Parameters	body	true	Query Presigned URL Input Parameters	Query Presigned URL Input Parameters
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

Response Status:

Status Code	Description	schema
200	OK	OpenApiServerResponsePresignedResponseParameters

Response Parameters:

Parameter Name	Description	Type	schema
response		Common Response Object (data type: Presigned Response Parameters)	Common Response Object (data type: Presigned Response Parameters)
requestId	requestId	string
error	Error Message	Error Message	Error Message
code	Error code	string
message	Error message prompt	string
data		Presigned Response Parameters	Presigned Response Parameters
Data	Presigned Response Parameters	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 Example:

{
    "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"
            }
        }
    }
}