Skip to main content

"listInputs"

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

Abstract

The "listInputs" action obtains a list of names of previously created 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.

Things to know

  • 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 request example

{
  "api": "hub",
  "apiVersion": "1.0",
  "action": "listInputs",
  "requestId": "00000001",
  "authToken": "anAuthorizationTokenFromTheServer",
  "params": {
  }
}

Maximal request example

{
  "api": "hub",
  "apiVersion": "1.0",
  "action": "listInputs",
  "requestId": "00000001",
  "authToken": "anAuthorizationTokenFromTheServer",
  "params": {
    "partialName": ""
  }
}

Response examples

Minimal response example

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

Maximal response example

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

"params"

The "params" property is an object that contains an action's parameters. Each action defines its own required and optional properties.

Property summary

Table 1. "params" property summaries

Property

Description

Default

Type

Limits (inclusive)

partialName

filters the returned topics by applying partial matches to their names

""

string

0 to 64 bytes



"partialName"

The "partialName" property is an optional string that causes the server to include items in the result when the beginning of their names match the "partialName" value. It defaults to an empty string.

Things to know:

  • A zero-length string matches all names.

  • The "partialName" property is used to filter results in several actions used to return lists.

"result"

Properties summary

Table 2. "result" properties summary

Property

Description

Type

Limits (inclusive)

data

specifies an array or object that the server returns, such as records returned by a query

Note

It is an empty array when there are no results available.

array

Its contents are determined by the action