Concise description
Request URL
{{adminHost:8181}}/appli/addPackage
Request Method
| 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 Body Parameters
| Field Name |
Sample |
Required |
Type |
Note |
| pkgName |
undefined |
Yes |
undefined |
Application name |
| pkgId |
|
Yes |
string |
Application types, divided into 1: SR exclusive, 2: 3D sharing, 3: SteamVR, 5: VR (SteamVR: dependent on Steam), 7: OpenXR, 9: PXY-AR, 11: NV-AR, 13: Pixel streaming, 14:2D sharing |
| version |
|
No |
string |
Publicity: 1: Public application (default) 0: Private application |
| wsId |
|
No |
string |
workspace |
| zipFile |
|
No |
string |
Application package path. If using the upload package method, the zipFile parameter must be passed. If using an application installed on the server, the package can be omitted (corresponding to the application upload interface returning the value zipFilePath). |
| appliPath |
|
No |
string |
The subdirectory where the application package is saved (corresponding to the return value appliPath from the application upload interface) |
| fileSize |
|
No |
string |
Application package size (corresponding to the return value of the application upload interface fileSize) |
| exeFileName |
1. exe |
No |
string |
The startup file path of the application, the relative path within the compressed package (corresponding to the application upload interface return value exeFileName) |
| exeFileNameList |
|
No |
string |
Execution file optional list (corresponding to the application upload interface return value exeFileNameList) |
| param |
|
No |
string |
Command line parameter for application startup, default to empty |
| initiativeSyncFlag |
|
No |
string |
Active synchronization identifier, default to 1; 0: No active synchronization, 1: Active synchronization, 2: Semi active synchronization |
| syncRegions |
|
No |
string |
The synchronization area during semi-active synchronization (initiativeSyncFlag passing 2), when empty, represents all areas. Area IDs are separated by commas. |
| syncCoefficent |
|
No |
string |
The synchronization coefficient during semi-active synchronization, which defaults to 1, indicates that only one node is selected in an area to synchronize one application. |
Success Response Example
{
"code": 1000,
"message": "保存成功",
"result": {
"pgmId": "1224416183051091968",
"wsId": "Jx3wQMD1",
"initiativeSyncFlag": 1,
"pkgId": "100225",
"version": "1.0.0",
"pkgName": "testPackage",
"appliPath": "",
"zipFile": "",
"exeFileName": "1.exe",
"exeFileNameList": "",
"param": "",
"createDate": "1711965166592",
"updateDate": "1711965166593"
}
}
Parameter Note for Success Response Example
| Field Name |
Type |
Note |
| code |
string |
Response code |
| message |
string |
Response message |
| result |
object |
Response result |
| pgmId |
string |
Project Id |
| wsId |
string |
Workplace Id |
| initiativeSyncFlag |
int |
Active synchronization identifier, 0: Non active synchronization, 1: Active synchronization, 2: Semi active synchronization |
| pkgId |
string |
Package Id |
| version |
string |
Package version number |
| pkgname |
string |
Package name |
| appliPath |
string |
The path to save the application |
| zipFile |
string |
Zip package storage path |
| exeFilename |
string |
Application’s execution file path |
| exeFilenameList |
array |
List of exe applications |
| param |
string |
Command line parameters for application startup |
| createDate |
long |
Creation time |
| updateDate |
long |
Update time |
Failure Response Example
{
"code": 500,
"message": "exeFileName can not be null or empty"
}
Parameter Note for Failure Response Example
| Field Name |
Type |
Note |
| code |
string |
None |
| message |
string |
None |
Note