"listOutputs"
listOutputs obtains a list of the names of previously created outputs.
The "listOutputs"
action obtains a list of the names of previously created outputs.
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.
Use
"describeOutputs"
to get detailed information about specific outputs.
Request examples
Minimal request example
{ "api": "hub", "apiVersion": "1.0", "action": "listOutputs", "requestId": "00000001", "authToken": "anAuthorizationTokenFromTheServer", "params": { } }
{ "api": "hub", "apiVersion": "1.0", "action": "listOutputs", "requestId": "00000001", "authToken": "anAuthorizationTokenFromTheServer", "params": { "partialName": "" } }
Response examples
Minimal response example
{ "result": { "data": [] }, "requestId": "00000055", "errorCode": 0, "errorMessage": "" }
{ "result": { "data": [] }, "requestId": "00000056", "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
"params"
property summariesProperty | Description | Default | Type | Limits (inclusive) | ||
---|---|---|---|---|---|---|
| filters the returned topics by applying partial matches to their names |
| string |
|
"result"
Property summary
"result"
property summariesProperty | Description | Type | Limits (inclusive) |
---|---|---|---|
| contains an array or object that the server returns, such as records returned by a query NoteIt is an empty array when there are no results available. | array | Its contents are determined by the action |