Save Mapping to Receivers

This API can be used to save the mapping to the receivers, through which you can adjust the port control areas, the primary-backup relationship of the ports, and the receiver control areas.

Request Path

{CLTPlatform-ip}:8086/receiver/saveReceiverMapping

• 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 to application/json.

Parameter Name	Description	Required	Type	Data Dictionary	Restriction	Example
command	Command type	Yes	[string]			receiver/saveReceiverMapping
data	Data	Yes	[object]
data>>bSave	Whether to save the mapping to receiver	Yes	[boolean]
data>>bChangePortControlArea	Whether to modify network port area	Yes	[boolean]
data>>receiverMapping	Receiver mapping	Yes	[object]
data>>receiverMapping>>senderArray	Sender array	Yes	[array]
data>>receiverMapping>>senderArray>>senderIndex	Sender index	Yes	[int]
data>>receiverMapping>>senderArray>>portArray	Network port array	Yes	[array]
data>>receiverMapping>>senderArray>>portArray>>portIndex	Network port index	Yes	[int]
data>>receiverMapping>>senderArray>>portArray>>isBackupPort	Whe	Yes	[boolean]
data>>receiverMapping>>senderArray>>portArray>>srcPort	The main network port, it is valid when isBackupPort is true	Yes	[object]
data>>receiverMapping>>senderArray>>portArray>>srcPort>>senderIndex	Sender index	Yes	[int]
data>>receiverMapping>>senderArray>>portArray>>srcPort>>portIndex	Network port index	Yes	[int]
data>>receiverMapping>>senderArray>>portArray>>area	Network port control area	Yes	[object]
data>>receiverMapping>>senderArray>>portArray>>area>>x	x	Yes	[int]			0
data>>receiverMapping>>senderArray>>portArray>>area>>y	y	Yes	[int]			0
data>>receiverMapping>>senderArray>>portArray>>area>>width	Width	Yes	[int]			128
data>>receiverMapping>>senderArray>>portArray>>area>>height	Height	Yes	[int]			128
data>>receiverMapping>>senderArray>>portArray>>receiverArray	Receiver array，this array's size can set to be 0 when isBackupPort is true	Yes	[array]
data>>receiverMapping>>senderArray>>portArray>>receiverArray>>receiverIndex	Receiver index	Yes	[int]
data>>receiverMapping>>senderArray>>portArray>>receiverArray>>area		Yes	[object]
data>>receiverMapping>>senderArray>>portArray>>receiverArray>>area>>x	x	Yes	[int]			0
data>>receiverMapping>>senderArray>>portArray>>receiverArray>>area>>y	y	Yes	[int]			0
data>>receiverMapping>>senderArray>>portArray>>receiverArray>>area>>width	Width	Yes	[int]			128
data>>receiverMapping>>senderArray>>portArray>>receiverArray>>area>>height	Height	Yes	[int]			128

Request Example

{
    "command": "receiver/saveReceiverMapping",
    "data": {
        "bSave": false,
        "bChangePortControlArea": false,
        "receiverMapping": {
            "senderArray": [{
                "senderIndex": 0,
                "portArray": [{
                    "portIndex": 0,
                    "isBackupPort": false,
                    "srcPort": {
                        "senderIndex": 0,
                        "portIndex": 0
                    },
                    "area": {
                        "x": 0,
                        "y": 0,
                        "width": 128,
                        "height": 128
                    },
                    "receiverArray": [{
                        "receiverIndex": 0,
                        "area": {
                            "x": 0,
                            "y": 0,
                            "width": 128,
                            "height": 128
                        }
                    }]
                }]
            }]
        }
    }
}

Response

Parameter Name	Description	Required	Type	Data Dictionary	Restriction	Example
command	Command type	Yes	[string]			receiver/saveReceiverMapping
code	Status code	Yes	[int]			20000
message	Message	Yes	[string]			Common_Success
data	Data	Yes	[object]

Response Example

{
    "command": "receiver/saveReceiverMapping",
    "code": 20000,
    "message": "Common_Success",
    "data": {}
}

Detailed Description