FairCom Edge API reference

The FairCom Edge API manages the actions that configure FairCom Edge. It is based on the jsonAction protocol, which sends JSON requests to a server and returns JSON responses. This section defines the JSON payloads that can be sent 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 Edge.

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.

Integration tables

These actions are part of the JSON Edge API. This section provides several actions to alter, create, delete, describe, and list integration tables.

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

Transforms

These actions are part of the JSON Edge API. This section provides several actions to alter, create, delete, describe, and list transforms.

Action	Description
`"alterTransform"`	`"alterTransform"` renames and/or edits the properties of an existing transform process.
`"createTransform"`	`"createTransform"` creates a transform and saves it by name for reuse in MQTT topics and inputs.
`"deleteTransform"`	`"deleteTransform"` deletes one or more transforms and returns a full description of each deleted transform so that the transform can be recreated easily.
`"describeTransforms"`	`"describeTransforms"` returns all available information about each specified transform.
`"listTransforms"`	`"listTransforms"` obtains a list of the names of existing transforms.
`"runTransform"`	`"runTransform"` runs a transform and returns the transformed data.

Topics

These actions are part of the JSON MQ API. This section provides several actions the configure, delete, describe, and list topics.

Action	Description
`"configureTopic"`	`"configureTopic"` configures an existing MQTT topic or creates a new one.
`"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

These 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.

Inputs

These actions are part of the JSON Edge API. This section provides several actions to alter, create, delete, describe, and list inputs.

Action	Description
`"alterInput"`	`"alterInput"` modifies the configuration of an existing input.
`"createInput"`	`"createInput"` creates a new input.
`"deleteInput"`	`"deleteInput"` removes a previously created input definition as long as no output definitions are using it.
`"describeInputs"`	`"describeInputs"` returns all available information about each specified input.
`"listInputs"`	`"listInputs"` obtains a list of names of previously created inputs.

Databases

Action	Description
`"createDatabase"`	`"createDatabase"` creates a database.
`"deleteDatabase"`	`"deleteDatabase"` deletes a database unless archived, deleting a database and its containing folder and all its files . It removes all data and metadata in the database.
`"listDatabases"`	`"listDatabses"` lists databases the logged-in user is allowed to see.

Tables

Action	Description
`"alterTable"`	`"alterTable"` modifies a table.
`"createTable"`	`"createTable"` creates a table in a database.
`"deleteTables"`	`"deleteTables"` deletes one or more tables in a single transaction.
`"describeTables"`	`"describeTables"` returns a complete set of metadata about one or more specified tables.
`"listTables"`	`"listTables"` lists tables in the specified database that the logged-in user is allowed to see.
`"rebuildTables"`	`"rebuildTables"` rebuilds specified tables.

Indexes

Action	Description
`"createIndex"`	`"createIndex"` creates an index on one or more fields in a table.
`"deleteIndexes"`	`"deleteIndexes"` deletes an index.
`"listIndexes"`	`"listIndexes"` lists indexes in the specified database table that the logged-in user is allowed to see.
`"rebuildIndexes"`	`"rebuildIndexes"` rebuilds all indexes or specified indexes.

Modify data

Action	Description
`"deleteRecords"`	`"deleteRecords"` deletes one or more records from a database table using one or more IDs.
`"insertRecords"`	`"insertRecords"` inserts one or more records into a database table - one record for each item in the `"data"` array.
`"truncateRecords"`	`"truncateRecords"` deletes all records from a database table very quickly by deleting and recreating the data file.
`"updateRecords"`	`"updateRecords"` updates one or more records in database table.

Get data

Action	Description
`"closeCursor"`	`"closeCursor"` closes a previously opened cursor.
`"getRecordsByIds"`	`"getRecordsByIds"` retrieves one or more records from a database using their IDs.
`"getRecordsByIndex"`	`"getRecordsByIndex"` can return a cursor to retrieve a large number of records efficiently or to navigate and retrieve records in any desired way.
`"getRecordsByPartialKeyRange"`	`"getRecordsByPartialKeyRange"` retrieves zero or more records from a database table using the specified index.
`"getRecordsByTable"`	`"getRecordsByTable"` retrieves zero or more records from a database table in table order and performs a full scan of all records in a table.
`"getRecordsFromCursor"`	`"getRecordsFromCursor"` retrieves zero or more records from the recordset of a previously opened cursor.
`"getRecordsInKeyRange"`	`"getRecordsInKeyRange"` retrieves zero or more records from a database table using the specified index. This method is the fastest possible way to retrieve a bounded set of records in index order, and includes records by matching index keys against a range of partial or complete key values supplied by you.
`"getRecordsStartingAtKey"`	`"getRecordsStartingAtKey"` retrieves zero or more records from a database table using the specified index. It is the fastest way to walk records in index order starting at a specific key and is typically used to retrieve one or more records that match a key value. It can also be used to retrieve a span of records before and after a key value.
`"getRecordsUsingSQL"`	`"getRecordsUsingSQL"` uses SQL to retrieve a set of records.

JSON requestsJSON responsesQuality of Service