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

These actions are part of the Admin API and are used by all FairCom APIs. They are used to log in and log out of the server.

Action	Description
alterSession	Modifies the settings of a session, such as changing the default database and owner.
createSession	Allows an account to log into a FairCom server.
deleteSession	Allows an account to logout and close a session.
describeSessions	Describes the settings for one or more sessions.
listSessions	Lists sessions that the current account is authorized to see.
pingSession	Keeps a session alive and returns failure when a session is inactive.

Services

These actions are part of the Admin API and are used by all FairCom's APIs. They are used to manage services.

Action	Description
listServices	Returns information about each specified service.
manageService	Configures the general settings of a FairCom server service.

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
configureTopic	`"configureTopic"` configures a topic and its many settings. You can change a topic to use a different integration table and control how MQTT data is transformed before inserting it into the integration table. You can also forward MQTT messages to other MQTT topics.
deleteTopic	`"deleteTopic"` deletes an MQTT topic.
describeTopics	`"describeTopics"` returns all available information about specified MQTT topics.
listTopics	`"listTopics"` lists the names of MQTT topics that the server is tracking.

Broker connections

The broker connection actions are part of the JSON MQ API. This section provides actions to configure, delete, describe, and list broker connections.

Action	Description
configureBrokerConnection	`"configureBrokerConnection"` creates or updates a reusable connection to an external broker, which may be another instance of FairCom MQ, FairCom Edge, or an MQTT broker from another vendor.
deleteBrokerConnection	`"deleteBrokerConnection"` deletes a previously created broker connection.
describeBrokerConnections	`"describeBrokerConnections"` returns information about specified broker connections.
listBrokerConnections	`"listBrokerConnections"` lists all available broker connections that have been created.

Integration tables

Action	Description
alterIntegrationTable	alters table settings that are safe to modify, such as adding new fields
createIntegrationTable	creates an integration table
deleteIntegrationTables	deletes an integration table as long as there are no dependencies on it
describeIntegrationTables	returns all available information about each specified integration table
listIntegrationTables	lists only the integration tables in a given database

Outputs

Action	Description
alterOutput	`"alterOutput"` configures an existing integration.
createOutput	`"createOutput"` creates and new integration.
deleteOutput	`"deleteOutput"` removes a previously created integration.
describeOutputs	`"describeOutputs"` returns all available information about each specified output.
listOutputs	`"listOutputs"` obtains a list of the names of previously created outputs.

JSON MQ message

Action	Description
alterMqttSession	alters session settings without disrupting the client
createMqttSession	creates a new MQTT session
deleteMqttSession	disconnects a client's MQTT session
describeMqttSession	returns information about a client's MQTT session
getMessagesFromMqttSession	returns undelivered messages from a client-subscribed MQTT topic
getMessagesFromMqttTopic	returns messages published on a specific topic
listMqttSessions	returns a list of sessions that match the `"partialClientName"`
publishMessagesToMqtt	publishes messages to an MQTT topic from the specified client
subscribeToMqtt	adds or removes a client's subscriptions

FairCom MQ APIs

FairCom MQ's API documentation for software developers, equipment manufacturers, and automation engineers

Important

Sessions

Services

Topics

Broker connections

Integration tables

Outputs

JSON MQ message

Use the FairCom MQ API reference to configure MQ

MQ API

JSON MQ API

API reference

configure MQ

MQ topic

broker connections

topics