ConneX_Help.pdf - 第47页

a da pter s Type: AdapterMod el Loo k up al l the kno wn ad a p ters c o nne c ted to this i nstanc e of C o nne X . Exa mple R e q ue st R e spo nse { "data": { "adapterM etrics": [ { "timeStamp…

100%1 / 86
Queries
ConneX exposes the following GraphQL queries:
Query Description
adapterMetrics
Get metrics for the specified adapter.
adapters
Look up all the known adapters connected to this instance of ConneX.
entities
Look up all the known entities connected to this instance of ConneX.
entityTypes
Look up all the known entity types that can be connected to this instance of ConneX.
handlerMetrics
Get metrics for the specified PSV system.
latestAdapterStatistics
Get the latest metric entries for the specified adapter.
latestHandlerStatistics
Get the latest metric entries for the specified PSV system.
license
Get the installed license information.
message
Get the last received MQTT message.
messages
Get all MQTT messages.
programmers
Look up all the known programmers connected to this instance of ConneX.
programmerTypes
Look up all the known programmer system types that can be connected to this instance of ConneX.
system
Look up a singular PSV system by its database ID.
systems
Look up all the known PSV systems connected to this instance of ConneX.
systemTypes
Look up all the known PSV system types that can be connected to this instance of ConneX.
adapterMetrics
Type:
[AdapterMetrics]
Get metrics for the specified adapter.
Arguments
Name Description
adapterIdentifier
(
String
)The adapter's unique identifier.
interval
(
Interval
) An
Interval
defining how far back to query.
timeBucket
(
Interval
) An
Interval
over which the metrics will be aggregated.
Example
Request Response
query{
adapterMetrics(adapterIdentifier: "222-032-205-139-137-224-207-100-238"
interval: "1 hour"
timeBucket: "15 minutes")
{
timeStamp
blankCheckDuration
eraseDuration
programmingDuration
verifyDuration
}
}
GraphQL
adapters
Type:
AdapterModel
Look up all the known adapters connected to this instance of ConneX.
Example
Request Response
{
"data": {
"adapterMetrics": [
{
"timeStamp": "2022-10-06T11:30:00.000-07:00",
"blankCheckDuration": 901358,
"eraseDuration": 896337,
"programmingDuration": 904021,
"verifyDuration": 895560
},
{
"timeStamp": "2022-10-06T11:15:00.000-07:00",
"blankCheckDuration": 895828,
"eraseDuration": 904213,
"programmingDuration": 898582,
"verifyDuration": 898548
},
{
"timeStamp": "2022-10-06T11:00:00.000-07:00",
"blankCheckDuration": 895486,
"eraseDuration": 895593,
"programmingDuration": 902716,
"verifyDuration": 896741
},
{
"timeStamp": "2022-10-06T10:45:00.000-07:00",
"blankCheckDuration": 900471,
"eraseDuration": 897392,
"programmingDuration": 898490,
"verifyDuration": 899448
}
]
}
}
JSON
query {
adapters {
adapterId
}
}
GraphQL
entities
Type:
[Entity]
Look up all the known entities connected to this instance of ConneX.
Example
Request Response
{
"data": {
"adapters": [
{
"adapterId": "110008"
},
{
"adapterId": "110008"
},
{
"adapterId": "110008"
},
{
"adapterId": "110008"
},
{
"adapterId": "310008"
},
{
"adapterId": "310008"
}
]
}
}
JSON
query {
entities {
entityIdentifier
entityType
entityName
}
}
GraphQL