# Save the Parameter to Receivers from File
This API can be used to load the parameter from file and send or save it to a specified receiver.
# API Path
{CLTPlatform-ip}:8086/receiver/saveBasicParamFromFile
- Replace
{CLTPlatform-ip}with the corresponding IP address. - The request port is
8086.
# Protocol
HTTP
# Method
POST
# Request Parameters
- Set the
Content-Typeof the request body toapplication/json.
| Parameter Name | Description | Required | Type | Data Dictionary | Restriction | Example |
|---|---|---|---|---|---|---|
| command | Command type | Yes | [string] | receiver/saveBasicParamFromFile | ||
| data | Data | Yes | [object] | |||
| data>>senderIndex | Sender index (starting from 0, -1 for all senders) | Yes | [int] | |||
| data>>portIndex | Network port index (starts from 0, -1 for all network ports) | Yes | [int] | |||
| data>>receiverIndex | Receiver card index (starts from 0, -1 for all receivers) | Yes | [int] | |||
| data>>bSave | Whether to save (false means send only) | Yes | [boolean] | |||
| data>>filePathName | The path of the parameters file (UTF-8) | Yes | [string] | C:\Users\clt\Desktop\test.rcvbp |
# Request Example
{
"command": "receiver/saveBasicParamFromFile",
"data": {
"senderIndex": 0,
"portIndex": 0,
"receiverIndex": 0,
"bSave": false,
"filePathName": "C:\\Users\\clt\\Desktop\\test.rcvbp"
}
}
# Response
| Parameter Name | Description | Required | Type | Data Dictionary | Restriction | Example |
|---|---|---|---|---|---|---|
| command | Command type | Yes | [string] | receiver/saveBasicParamFromFile | ||
| code | Status code | Yes | [int] | 20000 | ||
| message | Message | Yes | [string] | Common_Success | ||
| data | Data | Yes | [object] |
# Response Example
{
"command": "receiver/saveBasicParamFromFile",
"code": 20000,
"message": "Common_Success",
"data": {}
}