# Save Mapping to Receivers from File
This API can be used to load the mapping from a file and send or save it to all the receivers connected to a specified network port.
# API Path
{CLTPlatform-ip}:8086/receiver/saveReceiverMappingFile
- Replace
{CLTPlatform-ip}
with the corresponding IP address. - The request port is
8086
.
# Protocol
HTTP
# Method
POST
# Request Parameters
- Set the
Content-Type
of the request body toapplication/json
.
Parameter Name | Description | Required | Type | Data Dictionary | Restriction | Example |
---|---|---|---|---|---|---|
command | Command type | Yes | [string] | receiver/saveReceiverMappingFile | ||
data | Data | Yes | [object] | |||
data>>bSave | Whether to save (false means send only) | Yes | [boolean] | |||
data>>bChangePortControlArea | Whether to modify the network ports' area | Yes | [boolean] | |||
data>>filePathName | The path of the mapping file (UTF-8) | Yes | [string] | C:\Users\clt\Desktop\test.mapping |
# Request Example
{
"command": "receiver/saveReceiverMappingFile",
"data": {
"bSave": false,
"bChangePortControlArea": false,
"filePathName": "C:\\Users\\clt\\Desktop\\test.mapping"
}
}
# Response
Parameter Name | Description | Required | Type | Data Dictionary | Restriction | Example |
---|---|---|---|---|---|---|
command | Command type | Yes | [string] | receiver/saveReceiverMappingFile | ||
code | Status code | Yes | [int] | 20000 | ||
message | Message | Yes | [string] | Common_Success | ||
data | Data | Yes | [object] |
# Response Example
{
"command": "receiver/saveReceiverMappingFile",
"code": 20000,
"message": "Common_Success",
"data": {}
}