Skip to main content
API docs by Redocly

APP Config

Download OpenAPI specification:Download

Provides functionality for configuring pages, including CRUD operations and batch data querying.

The request parameters for configuring pages have not been standardized. If there are any requirements in the future, relevant personnel can discuss it.

Authentication

Sign

Security Scheme Type: API Key
Header parameter name: Authorization

pages

Page instances

Query Page Tree List

  1. The response does not include layout blocks.
  2. The data structure of the response is not fixed, and the documentation cannot accurately describe the structure of the returned data.
Authorizations:
Sign
query Parameters
parentId
required
string

Parent ID

type
string

If type is "symbol", query the symbol tree list; if not provided or other value, query the page tree list.

Responses

Response samples

Content type
application/json
{
  • "id": "App_bac090d688004de9bf927b9ff66bfca7",
  • "name": "desktop",
  • "description": "",
  • "appName": "Desktop",
  • "appId": "App_bac090d688004de9bf927b9ff66bfca7",
  • "templateName": "App",
  • "appSecret": "cd5d7e2ac9f8d94658e0f6495cc043f1",
  • "appVersion": "1.0.0",
  • "hasChildren": true,
  • "allowEdit": 1,
  • "userAuthUrl": "",
  • "roleAuthUrl": "",
  • "coverUrl": "/api/app/manager/images/AppIconPreview?fileName=xxx",
  • "defaultDeskPageId": "Page_f0d175ba73b74e2a9a17a0150b3d8849",
  • "defaultShowId": "Page_f0d175ba73b74e2a9a17a0150b3d8849",
  • "icon": "",
  • "jarRunEnv": "openjdk:8-jdk-alpine",
  • "suposCpbVersion": "supOS-1.8.2",
  • "totalPage": 1,
  • "totalSymbol": 0,
  • "userId": "1",
  • "vendorName": "supos",
  • "order": 10000,
  • "children": [
    ]
}

Create a Page

Authorizations:
Sign
Request Body schema: application/json
name
required
string

Name

description
string

Description

layout
string

Page layout information in JSON format

type
integer

Page type is 1 for a blank page, 2 for an internal link, 3 for an external link

url
string

Page URL. It is empty if the type is 1

parentId
required
string

Parent ID

appId
required
string

APP ID

kind
string
Enum: "free" "new"

Layout mode is "free" for free layout, "new" for grid layout

platformType
string
Enum: "PC" "mobile"

Platform type is "PC" for PC Web, "mobile" for mobile devices

menuDisplay
boolean

Indicates whether it is displayed in the system menu bar

mobileShowType
string
Enum: "auto" "portrait" "landscape"

Display mode is "auto" for automatic portrait/landscape, "portrait" for portrait, "landscape" for landscape

navbarBgColor
string

Navigation bar background color

navbarFront
string

Navigation bar font color. Use "dark" when the background color is light, and "light" when the background color is dark

navbarStyle
string

Navigation bar style is "fixed" for fixed, "suspend" for floating

isWorkflow
boolean

Indicates whether the workflow is enabled

required
Array of objects (CreatePageLayout)

Layout block parameters. Required. A page must include at least one layout block

Responses

Request samples

Content type
application/json
{
  • "name": "page",
  • "description": "",
  • "layout": "",
  • "type": 1,
  • "url": "",
  • "parentId": "App_bac090d688004de9bf927b9ff66bfca7",
  • "appId": "App_bac090d688004de9bf927b9ff66bfca7",
  • "kind": "free",
  • "platformType": "PC",
  • "menuDisplay": true,
  • "mobileShowType": "auto",
  • "navbarBgColor": "#ffffff",
  • "navbarFront": "dark",
  • "navbarStyle": "fixed",
  • "isWorkflow": false,
  • "layouts": [
    ]
}

Response samples

Content type
application/json
{
  • "location": "string"
}

Get Page Details

Authorizations:
Sign
path Parameters
pageId
required
string

Page ID

query Parameters
kind
string

Data type to retrieve; "new" for draft data

Responses

Response samples

Content type
application/json
{
  • "layouts": [
    ],
  • "id": "Page_f0d175ba73b74e2a9a17a0150b3d8849",
  • "name": "page",
  • "description": "",
  • "layout": "{\"pageConfig\":{\"platformLayoutType\":\"PC\",\"singleLayout\":true,\"lwType\":\"1\",\"lwValue\":1638,\"lhValue\":912,\"linkage\":\"0\",\"background\":\"\",\"pageId\":\"Page_f0d175ba73b74e2a9a17a0150b3d8849\"},\"layoutNodes\":[{\"kind\":\"free\",\"col\":1,\"colW\":200,\"w\":240,\"h\":44.9,\"x\":0,\"y\":0,\"i\":\"3d8849-0\",\"moved\":false,\"static\":false,\"isResizable\":false,\"minW\":1,\"minH\":1,\"type\":\"2\",\"lw\":1638,\"lh\":912,\"opacity\":1,\"id\":\"Layout_9480068bb2bb40f0b0704ec7ae515ce0\"}]}",
  • "type": 1,
  • "url": "",
  • "parentId": "App_bac090d688004de9bf927b9ff66bfca7",
  • "appId": "App_bac090d688004de9bf927b9ff66bfca7",
  • "kind": "free",
  • "platformType": "PC",
  • "menuDisplay": true,
  • "mobileShowType": "auto",
  • "navbarBgColor": "#ffffff",
  • "navbarFront": "dark",
  • "navbarStyle": "fixed",
  • "extra": "{}",
  • "order": 20000,
  • "userId": "1",
  • "originalImage": "/resource/App_bac090d688004de9bf927b9ff66bfca7/screenshot/original/Page_f0d175ba73b74e2a9a17a0150b3d8849.png",
  • "thumbnail": "/resource/App_bac090d688004de9bf927b9ff66bfca7/screenshot/thumbnail/Page_f0d175ba73b74e2a9a17a0150b3d8849.png",
  • "isWorkflow": false
}

Modify Page Information

Authorizations:
Sign
path Parameters
pageId
required
string

Page ID

Request Body schema: application/json
name
string

Name

description
string

Description

layout
string

Page layout information in JSON format

type
integer

Page type is 1 for a blank page, 2 for an internal link, 3 for an external link

url
string

Page URL. It is empty if the type is 1

platformType
string

Platform type is "PC" for PC Web, "mobile" for mobile devices

menuDisplay
boolean

Indicates whether it is displayed in the system menu bar

mobileShowType
string
Enum: "auto" "portrait" "landscape"

Display mode is "auto" for automatic portrait/landscape, "portrait" for portrait, "landscape" for landscape

navbarBgColor
string

Navigation bar background color

navbarFront
string

Navigation bar font color. Use "dark" when the background color is light, and "light" when the background color is dark

navbarStyle
string

Navigation bar style is "fixed" for fixed, "suspend" for floating

isWorkflow
boolean

Indicates whether the workflow is enabled

Responses

Request samples

Content type
application/json
{
  • "name": "page",
  • "description": "",
  • "layout": "{\"pageConfig\":{\"platformLayoutType\":\"PC\",\"singleLayout\":true,\"lwType\":\"1\",\"lwValue\":1638,\"lhValue\":912,\"linkage\":\"0\",\"background\":\"\",\"pageId\":\"Page_f0d175ba73b74e2a9a17a0150b3d8849\"},\"layoutNodes\":[{\"kind\":\"free\",\"col\":1,\"colW\":200,\"w\":240,\"h\":44.9,\"x\":0,\"y\":0,\"i\":\"3d8849-0\",\"moved\":false,\"static\":false,\"isResizable\":false,\"minW\":1,\"minH\":1,\"type\":\"2\",\"lw\":1638,\"lh\":912,\"opacity\":1,\"id\":\"Layout_9480068bb2bb40f0b0704ec7ae515ce0\"}]}",
  • "type": 1,
  • "url": "",
  • "platformType": "PC",
  • "menuDisplay": false,
  • "mobileShowType": "auto",
  • "navbarBgColor": "#ffffff",
  • "navbarFront": "dark",
  • "navbarStyle": "fixed",
  • "isWorkflow": false
}

Response samples

Content type
application/json
400

Delete Page

Authorizations:
Sign
path Parameters
pageId
required
string

Page ID

Responses

Response samples

Content type
application/json
400

layouts

Layout instances

Create Layout

Authorizations:
Sign
path Parameters
pageId
required
string

Page ID

Request Body schema: application/json
name
required
string

Name

description
string

Description

context
string

Context in JSON format

kind
string
Enum: "free" "new"

Layout mode is "free" for free layout, "new" for grid layout

appId
string

APP ID

Responses

Request samples

Content type
application/json
{
  • "name": "3d8849-0",
  • "description": "",
  • "context": "{}",
  • "kind": "free",
  • "appId": "App_bac090d688004de9bf927b9ff66bfca7"
}

Response samples

Content type
application/json
{
  • "location": "api/layouts/Car001"
}

Modify Layout Information

Authorizations:
Sign
path Parameters
layoutId
required
string

Layout ID

Request Body schema: application/json
description
string

Remark

context
string

Context in JSON format

Responses

Request samples

Content type
application/json
{
  • "description": "layout",
  • "context": "{}"
}

Response samples

Content type
application/json
400

objectdata

Object data

Batch Query Object instance data

Authorizations:
Sign
Request Body schema: application/json
Array of objects (ObjectQueryItem)
Array
dataSource
string

The requested data source, different parameters are passed based on the different types: For type "network", pass {networkEnName}. For type "instance.property", pass {templateNamespace.templateEnName.instanceEnName.attriubteNamespace.attributeEnName}. For type "instance.service", pass {templateNamespace.templateEnName.instanceEnName.serviceNamespace.serviceEnName}. For type "template.service", pass {templateNamespace.templateEnName.serviceNamespace.serviceEnName}. For type "template.data", pass {templateNamespace.templateEnName}. Note: When calling the API, replace the values within {} with specific query data sources.

type
string
Enum: "network" "instance.property" "instance.service" "template.service" "template.data"

Request type: network：Query factory model tree. instance.property：Query property historical data. instance.service：Execute service on entity instance. template.service：Execute service on form template. template.data：Query template instance data.

object (ObjectQueryItem_filters)

Query parameters. Required when type is "instance.property". Must provide parameters according to the following requirements.

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
{
  • "list": [
    ]
}