Create window grouping

Request method and path

POST http://localhost:[Port]/openapi/window/group/create?ticket=[OpenApiTicket]

Interface Function Description

Used to create window groups.

Request parameter

Parameter Name	Required	type	Explanation
windowGroupBasicInfo	Y	object	window Group Object view

Request parameter example

{
  "windowGroupBasicInfo": {
    "windowGroupName": "124",
    "isDefault": true,
    "enable": true
  }
}

Detailed explanation of parameters

windowGroupBasicInfo Parameter Description

Parameter Name	Required	type	Explanation
windowGroupName	Y	string	Group Name
isDefault	Y	bool	Is it set as the default group for the system
enable	Y	bool	Group Enable

Example of Interface Response Result

Successful Response Example

Return parameters

newWindowGroupKey: The unique identifier of the newly created group.

{
  "code": "00000",
  "message": "Success",
  "data": {
    "status": "success",
    "errorCode": "",
    "errorMsg": "",
    "result": {
      "newWindowGroupKey": 123
    }
  }
}

Example of failed response

Failed to call interface

When the interface response status code is not '00000', the interface call fails.
The specific reasons for interface call errors can be found in the Interface Response Status Code Information Comparison Table for querying.

{
  "code": "00001",
  "message": "Unknown error occurred, please provide feedback to official customer service!",
  "data": {}
}

This modification operation failed

{
  "code": "00000",
  "message": "Success",
  "data": {
    "status": "failed",
    "errorCode": "E01",
    "errorMsg": "Missing parameter (xxx).",
    "result": {}
  }
}

Operation failure errorCode error code information comparison table

Error code	Reason for error
E00	The format of parameter (xxx) is incorrect!
E01	Missing parameter (xxx).
E02	The parameters are redundant.
E03	Missing parameters windowGroupBasicInfo.(xxx)。
E04	The parameters in windowGroupBasicInfo are redundant.
E05	We are about to exceed the maximum capacity of 50 groups. Please delete some of the group lists (i.e. template lists) and try again!
E06	The value of the unique number index for window grouping has exceeded the maximum allowable value of 200. Please delete some of the later grouping lists (i.e. template lists) and try again!