Skip to main content

`"describeOutputs"`

JSON hub `"describeOutputs"` action returns all available information about each specified FairCom Edge output

The "describeOutputs" action returns all available information about each specified output. 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.

Request examples

Minimal request

{
  "api":        "hub",
  "apiVersion": "1.0",
  "requestId":  "optionalUniquerequestIdFromTheClient",
  "authToken":  "anAuthorizationTokenFromTheServer",
  "action":     "describeOutputs",
  "params":     {
    "outputNames": [ "AcmefactoryLine1Station1AcidbathTelemetryOutput" ]
  }
}

Response examples

Minimal response

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

Use the describeOutputs JSON API action to return all available information about each specified FairCom Edge output

JSON hub APIAPI actionsjsonActionoutput actionsdescribe outputdescribeOutputs

`"params"`

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

Properties summary

Table 1. "params" properties summary

Property	Description	Default	Type	Limits (inclusive)
outputNames	contains `"outputName"` strings	`[]`	array