JSON Edge API: input actions

FairCom Edge's JSON Edge API can be used to alter, create, delete, describe, and list inputs

Abstract

These actions are part of the JSON Edge API, which is available in FairCom Edge.

These actions are part of the JSON Edge API, which is available in FairCom Edge. This section provides several actions to alter, create, delete, describe, and list inputs. An input is a connection to an external device, equipment, or service that can input data into FairCom Edge. The input allows you to configure the connection, such as the frequency of data collection and the tags to be collected,

Note

A tag is a piece of named data with an associated value. For example, the tag temperature 70 includes both the named data temperature and the value 70. In JSON, a tag is a JSON property, such as "temperature": 70. In a SQL table, a tag is a data field, such as a field named temperature with a value of 70.

Action	Description
alterInput	alters, changes, modifies, updates, or configures an existing input connector in FairCom Edge. An input connector collects data automatically from a device or software system.
createInput	creates a new input.
deleteInput	removes a previously created input definition as long as no output definitions are using it.
describeInputs	returns all available information about each specified input.
listInputs	obtains a list of names of previously created inputs.