Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisMQTTPersistenceAlter

int ctMemphisMQTTPersistenceAlter( pRCESJson request, ppRCESJson result )

Description:

Alter a MQTT persistence topic. See "AlterPersistenceTopic" in the MQTT persistence documentation.

HTTP URL: <baseURL>/ctMemphisMQTTPersistenceAlter/

HTTP Verb: POST

Parameters:

  • request [IN] - Alter Persistence Topic request in JSON format. For example:

{

"mqttPersistence": {

"id": 1, // Unique MQTT persistence

identification

"persistenceTopicMessageFormat": "JSON", // MQTT payload message type

"persistenceTopicThreads": 10, // Number of threads used for

persistence

"dbEngine": 2, // DBEngine database where persistence

is executed

"database": 3, // Database database where persistence

is executed

"tableName": "table_name", // Table name where topic is persisted

"tableReplicationReady": TRUE, // Flag indicating if persistence table

is replication ready

"tableAutoTimeStamp": TRUE, // Flag indicating if persistence table

has auto timestamp field

"tableAutoTimeStampIndex": TRUE, // Flag indicating if persistence table

has auto timestamp index

"tableRetentionPeriod": 10, // Number of "tableRetentionUnit"

to be retained

"tableRetentionUnit": "day", // Retention period unit, see

"tableRetentionUnit" for values

"mapOfPropertiesToFields": [

{

"jsonPropertyPath": "prop1", // JSON property name to be mapped

"fieldName": "field1", // Field where property value is stored

"fieldType": "INTEGER" // See MQTT documentation for MQTT types

},

{

"jsonPropertyPath": "prop2", // JSON property name to be mapped

"fieldName": "field2", // Field where property value is stored

"fieldType": "DOUBLE", // See MQTT documentation for MQTT types

"fieldWidth": 8, // Field width

"fieldScale": 2 // Field scale

}

]

}

}

  • result [OUT] - Result in JSON format. For example:

{

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

},

"id": 3

}

Return: Error code

TOCIndex