search

Request URL

{{adminHost:8181}}/group/search

Request Method

get

Header

Field Name
Sample
Required
Type
Note


adminKey
603284317954637824
Yes
string
This parameter is for backend management access credentials, which can be viewed in LarkXR3.3 backend access management

timestamp
8641706679604867
Yes
string
The timestamp when sending a request, in milliseconds

signature
9A02B47AE67664D80A2ED13FC2B1691512613790
Yes
string
This parameter is a key signature. Sort the adminKey (viewed in LarkXR3.2 backend access management), adminSecret (viewed in LarkXR3.3 backend access management), and current timestamp (long value) in alphabetical order, and then perform SHA-1 summary signature. Please refer to the example of [Obtaining Voucher Signature]

Request Query Parameters

Field Name
Sample
Required
Type
Note


groupId
 
Yes
string
Group ID

groupName
 
Yes
string
None

wsId
 
Yes
string
None

page
 
Yes
string
None

pageSize
 
Yes
string
None

Success Response Example

{
  "code": 1000,
  "message": "Success",
  "result": {
    "records": [
      {
        "groupId": "601477834145267712",
        "groupName": "Default",
        "clientRunMode": 0,
        "noOperationTimeout": "0",
        "createDate": "20190722132708",
        "updateDate": "1687939292630"
      },
      {
        "groupId": "1194226279482654720",
        "groupName": "test",
        "clientRunMode": 1,
        "noOperationTimeout": "0",
        "wsId": "6mLkDgqf",
        "createDate": "1704767332681",
        "updateDate": "1704767332682",
        "clientRunModeName": "自主切换",
        "wsName": "pxydev-overseas-xuzhibin123"
      }
    ],
    "total": "2",
    "size": "15",
    "current": "1",
    "orders": [],
    "optimizeCountSql": true,
    "searchCount": true,
    "pages": "1"
  }
}

Parameter Note for Success Response Example

Field Name
Type
Note


code
string
None

message
string
None

result
object
None

records
array
None

records. groupId
string
Group Id

records. groupName
string
Group name

records. clientRunMode
string
VR client running mode: 1: autonomous switching, 2: centralized control, 3: demonstration mode

records. noOperationTimeout
string
No operation timeout time, 0 indicates no timeout.

primaryClientId
string
VR main control glasses, used for demonstration mode, select one as the main control glasses for operation, and watch the other glasses

records. createDate
string
Creation time

records. updateDate
string
Update time

total
string
How many pieces of data in total

size
string
How many pieces of data per page

current
string
Current page number

pages
string
How many pages are there in total

Field Name	Sample	Required	Type	Note
adminKey	603284317954637824	Yes	string	This parameter is for backend management access credentials, which can be viewed in LarkXR3.3 backend access management
timestamp	8641706679604867	Yes	string	The timestamp when sending a request, in milliseconds
signature	9A02B47AE67664D80A2ED13FC2B1691512613790	Yes	string	This parameter is a key signature. Sort the adminKey (viewed in LarkXR3.2 backend access management), adminSecret (viewed in LarkXR3.3 backend access management), and current timestamp (long value) in alphabetical order, and then perform SHA-1 summary signature. Please refer to the example of [Obtaining Voucher Signature]

Field Name	Required	Type	Note
groupId	Yes	string	Group ID
groupName	Yes	string	None
wsId	Yes	string	None
page	Yes	string	None
pageSize	Yes	string	None

Field Name	Type	Note
code	string	None
message	string	None
result	object	None
records	array	None
records. groupId	string	Group Id
records. groupName	string	Group name
records. clientRunMode	string	VR client running mode: 1: autonomous switching, 2: centralized control, 3: demonstration mode
records. noOperationTimeout	string	No operation timeout time, 0 indicates no timeout.
primaryClientId	string	VR main control glasses, used for demonstration mode, select one as the main control glasses for operation, and watch the other glasses
records. createDate	string	Creation time
records. updateDate	string	Update time
total	string	How many pieces of data in total
size	string	How many pieces of data per page
current	string	Current page number
pages	string	How many pages are there in total