Important: You do not have the latest version of Historian! You are missing out on the newest capabilities and enhanced security. For information on all the latest features, see the Historian product page. For more information on upgrades, contact your GE Digital sales agent or e-mail GE Digital Sales Support. For the most up-to-date documentation, go here.

The Message Compression API

Using the Message Compression API, you can enable or disable message compression.


METHOD	PUT
URI	`https://<historianservername>/historian-rest-api/v1/collector/messagecompression`
SAMPLE REQUEST	`{ "interfaceName":"<source server>_<type of the collector>_<destination server>", "messageCompression":1 }`
SAMPLE RESPONSE	`{ "ErrorCode":0, "ErrorMessage":null, }`
SAMPLE cURL COMMAND	`curl -i -H "Accept: application/json" -i -H "Content-Type: application/json" -H "Authorization: Bearer <TOKEN>” -d “{\"interfaceName\":\"<source server>_<type of the collector>_<destination server>\", \"messageCompression\":1}” -X PUT https://<historianservername>/historian-rest-api/v1/collector/messagecompression`

Query Parameters


Parameter	Description	Required?	Values
`interface name`	The interface name of the collector whose message compression you want to enable or disable.	Yes	String
`messagecompression`	Identifies whether you want to enable or disable message compression. The valid values are 0 and 1.	Yes

Response Parameters


Parameter	Data Type	Required?	Description
`ErrorCode`	Integer	Yes	For example, ErrorCode = 0 implies the operation was successful.
`ErrorMessage`	String	Yes	For example, NULL.