Skip to main content

"listOutputs" (JSON Action)

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.

Essential information

  • 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

{
  "api":        "hub",
  "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": ""
}

Use the listOutputs JSON API action to return a list of the names of previously created FairCom Edge outputs

JSON hub APIAPI actionsJSON Actionoutput actionslist outputlistOutputs

"params"

The "params" property is an object that contains an action's request parameters as defined by a set of properties. Each action defines its own required and optional properties. See System limits for a comprehensive overview of property requirements and limitations.

Table 1. listOutputs "params" property summaries

Property

Description

Default

Type

Limits (inclusive)

partialName

(optional) filters the returned topics by applying partial matches to their names.

""

string

0 to 64 bytes



"result"

Table 2. "result" property summaries

Property

Description

Type

Limits (inclusive)

data

is an array of objects or arrays. Each item in the array describes a record. The array is empty if no results are available.

array

The action determines its contents.