listInputs

JSON hub "listInputs" action obtains a list of names of previously created FairCom Edge inputs

The "listInputs" action obtains a list of names of previously created inputs. Inputs collect tags from a data source and insert them into an integration table.

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.

  • You can return a filtered list by specifying a partial name in the "partialName" property.
  • You can include additional items in the list by searching for words contained in the item's metadata.
  • To get detailed information about specific inputs, use "describeInputs".

 

Request examples

Minimal

{
  "apiVersion": "1.0",
  "action": "listInputs",
  "requestId": "00000001",
  "params": {
  },
  "authToken": "replaceWithAuthTokenFromCreateSession"
}
 
 

Maximal

{
  "api": "hub",
  "apiVersion": "1.0",
  "action": "listInputs",
  "requestId": "00000001",
  "params": {
    "partialName": "",
    "statusFilter": ["active", "paused", "inactive", "connectorError", "deviceError", "userError"],
    "purposeFilter": [ "myPur", "Track Celsius Temperatures from devices" ],
    "labelsFilter": ["temperature", "celsius"]
  },
  "authToken": "replaceWithAuthTokenFromCreateSession"
}
 
 

Return input connectors that are delivering data

The following example returns all input connectors that are currently collecting data.

Tips 

  • Set to false to return input connectors that are not delivering data.
  • Set to null or omit to return all input connectors.
{
  "action": "listInputs",
  "params": {
    "runningFilter": true
  },
  "authToken": "replaceWithAuthTokenFromCreateSession"
}
 
 

 

Response examples

Minimal

{
    "result": {
        "data": [
            "modbusTCP"
        ]
    },
    "requestId": "00000046",
    "errorCode": 0,
    "errorMessage": ""
}
 
 

Maximal

{
    "result": {
       "data": [
            "modbusTCP"
        ]
    },
    "requestId": "00000047",
    "errorCode": 0,
    "errorMessage": ""
}
 
 

Return input connectors that are delivering data

{
 "result": {
    "data": [
     "INPUT: PLC 74 & Modbus"
   ]
 },
 "requestId": "00000047",
 "errorCode": 0,
 "errorMessage": ""
 }
 
 

 

Properties

Request properties ("params")

Property Description Default Type Limits (inclusive)

enabledFilter

 The "enabledFilter" property returns input connections that are enabled or not. Omit or set to null to match all connections. Optional with default of null Boolean

true

false

integrationTableIdFilter

 The "integrationTableIdFilter" property specifies the integration table ID to include connectors that use the table. null array of integers Integer from 1 to 9223372036854770000, or a string containing an integer.

partialName

The "partialName" property returns code packages with code names that match the value of "partialName". The match starts at the name's beginning, making it a "starts with" match instead of a "substring" match. If the partial name is empty, null, or omitted, it matches all names.

 Optional with default of "" string 1 to 64 bytes

purposeFilter

 The "purposeFilter" property specifies the the partial or complete purpose of the thing you are looking up or filtering. such as, "purposeFilter": [ "myPur", "Manage an Acid Bath" ]. The  purpose string is stored in the label group "faircom/edge/purpose". The action returns connectors that match at least one item in the array, provided it also satisfies all other specified filter properties. If "purposeFilter" is omitted or set to null, the default value is [], which prevents the action from using purpose strings to filter the results. Optional with default of [] Array of strings

Each string in the array is 1 to 64 bytes and is a partial or complete purpose stored in the label group "faircom/edge/purpose". 
If omitted, or set to null, the default value is [], which prevents the action from using the "purposeFilter" property to filter the results.  


Values are managed in the Label API.
 

runningFilter

 The "runningFilter" property returns input connections that are running or not. Omit or set to null to match all connections. Optional with default of null Boolean

true

false

statusFilter

 The "statusFilter" property filters connectors based on their active or inactive status. An inactive status is like a soft delete. Omitting the property or setting it to null matches all connections. ["active"] array of status string enums "active"
"inactive"
"paused"
"connectorError"
"deviceError"
"userError"

tagIdFilter

 The "tagIdFilter" property associates a tag with a value being collected by a connector. It is mutually exclusive with the "tagNameFilter" and "propertyPath" properties. Conditional - No default value


array of integers

 


If present, it must contain the ID of an existing tag, which is an integer from 0 to 9223372036854770000.

 

tagNameFilter

 The "tagNameFilter" property associates a tag with a value being collected by a connector. It is mutually exclusive with the "tagIdFilter" and "propertyPath" properties. Conditional - No default value Array of strings

If present, it must contain the name of an existing tag.

Each string in the array is 1 to 256 bytes and must be an existing tag managed by the "createTag" and "alterTag" actions.
 

thingIdFilter

 The "thingIdFilter" property lists all connectors that match the specified ID of the device or software thing. For example, you can use it to list all inputs connected to the thing identified by an ID of 37. It is mutually exclusive with the "thingNameFilter" property. null integer


If present, it must contain the ID of an existing thing, which is an integer from 0 to 9223372036854770000.

 

thingNameFilter

 The "thingNameFilter" property lists all connectors that match the specified name of the device or software thing. For example, you can use it to list all outputs connected to the thing named "PLC 437". It is mutually exclusive with the "thingIdFilter" property. null string


If present, it must contain the name of an existing thing.

 

 

Response properties ("result")

Property Description Type Limits (inclusive)

data

The "data" property contains a response message. Its contents are defined by the action. It is an empty array when no results are available. The following is an example of the data property from a code package action.

  "result": {
    "data": [
      {
        "codeId": 6,
        "databaseName": "faircom",
        "ownerName": "admin",
        "codeName": "convertAndCategorizeTemperature",
        "codeVersion": 1,
        "clonedCodeId": 1,
        "codeStatus": "active",
        "codeLanguage": "javascript",
        "serviceName": "javascript",
        "codeType": "module",
        "description": "optional new description",
        "metadata": {},
        "createdBy": "ADMIN",
        "createdOn": "2025-08-25T21:48:38.109",
        "updatedBy": "ADMIN",
        "updatedOn": "2025-08-25T21:48:38.109",
        "comment": "Cloned from convertTemperature",
        "codeFormat": "utf8"
      },
    ]
 array of objects The action determines its contents.

 

Was this article helpful?

Give feedback about this article

Related Articles