Modify window grouping
Request method and path
html
POST http://localhost:[Port]/openapi/window/group/update?ticket=[OpenApiTicket]
Interface Function Description
Used to modify information for grouping window browsers.
Request parameter
Parameter Name | Required | type | Explanation |
---|---|---|---|
index | Y | number | The unique identifier for window grouping is obtained in Get Window Grouping. |
windowGroupBasicInfo | Y | object | window Group Objectview 。 |
Request parameter example
json
{
"index": 123,
"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
json
{
"code": "00000",
"message": "Success",
"data": {
"status": "success",
"errorCode": "",
"errorMsg": "",
"result": {}
}
}
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.
json
{
"code": "00001",
"message": "Unknown error occurred, please provide feedback to official customer service!",
"data": {}
}
This modification operation failed
json
{
"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 parameter windowGroupBasicInfo.(xxx)。 |
E04 | There are multiple parameters in windowGroupBasicInfo |
E05 | Index must be a positive integer between 1 and 200 |
E06 | Window group unique identifier index does not have a corresponding window group list! |
E07 | Window group unique identifier index does not have a corresponding window group list! |