FairCom MQ APIs
FairCom MQ's API documentation for software developers, equipment manufacturers, and automation engineers
You configure FairCom MQ using FairCom's JSON MQ API.
This API is based on the jsonAction protocol, which POSTs the JSON request to one endpoint on a server and returns the JSON response. This section defines the JSON payloads that can be POSTed to the FairCom server over HTTP, HTTPS, WS, and WSS using the endpoint /api
, such as https://localhost:8443/api
.
The following sections are a listing of all available actions for configuring FairCom MQ.
Important
When using the Property summary tables, if there is additional information that the Property summary tables do not provide the property has a link to the property topic that contains the comprehensive explanation.
Sessions
Services
Topics
This section provides several actions to configure, delete, describe, and list MQTT topics. These actions are part of the JSON MQ API and are available in FairCom Edge and FairCom MQ.
Action | Description |
---|---|
| |
| |
| |
|
Broker connections
The JSON Hub API: broker connection actions are part of the JSON MQ API. This section provides actions to configure, delete, describe, and list broker connections.
Action | Description |
---|---|
| |
| |
| |
|
Integration tables
Action | Description |
---|---|
alters table settings that are safe to modify, such as adding new fields | |
creates an integration table | |
deletes an integration table as long as there are no dependencies on it | |
returns all available information about each specified integration table | |
lists only the integration tables in a given database |
Outputs
Action | Description |
---|---|
| |
| |
| |
| |
|