`"describeOutputs"`

Abstract

describeOutputs returns all available information about each specified output.

The "describeOutputs" action returns all available information about each specified output..

Request examples

Minimal request example

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

Response examples

Minimal response example

{
    "result": {
        "data": []
    },
    "requestId": "00000006",
    "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)
`"outputNames"`	contains `"outputName"` strings	`[]`	array