listOutputs

JSON hub "listOutputs" action returns a list of the names of previously created FairCom Edge outputs

The "listOutputs" action obtains a list of the names of previously created outputs. Outputs deliver tags from the server to external systems.

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.
  • Use "describeOutputs" to get detailed information about specific outputs.

 

Request examples

Minimal

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

Maximal

{
  "api":        "hub",
  "apiVersion": "1.0",
  "action":     "listOutputs",
  "requestId":  "00000001",
  "params":     {
    "partialName": ""
  },
  "authToken": "replaceWithAuthTokenFromCreateSession"
}
 
 

 

Response examples

Minimal

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

Maximal

{
    "result": {
        "data": []
    },
    "requestId": "00000056",
    "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

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

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

 

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