ConneX_Help.pdf - 第63页

payload ( [Byte!] ) The me ssa ge p ayl oa d in raw bytes. payloadAs String ( String )T he me ssa ge p ayl oa d co nver ted t o a UTF8 string . Name D escrip t ion M ess a geM odelC oll ecti onS egm en t R e p rese nts a…

100%1 / 86
totalFail
(
Int!
) The total number of failed devices.
systemYield
(
String
) The system's yield.
programmerYield
(
String
) The system's programmer yield.
handlerYield
(
String
) The system's handler yield.
uPH
(
Int!
) The system's UPH (units per hour).
jobCompletionEstimate
(
String
)The system's job completion estimate.
Name Description
Interval
Represents a time interval as a
String
. Interval values can be written using the following syntax:
quantity unit
where
quantity
is an
Int!
and
unit
is one of the following:
Unit ISO 8601 AbbreviationExample
microsecond 1 microsecond(s)
millisecond 1 millisecond(s)
second S 1 second(s)
minute M
(in the time part)
1 minute(s)
hour H 1 hour(s)
day D 1 day(s)
week W 1 week(s)
month M
(in the date part)
1 month(s)
year Y 1 year(s)
decade 1 decade(s)
century 1 century(ies)
millenium 1 millenium(s)
LicenseModel
Represents the license information for the ConneX Service.
Fields
Name Description
availableConnections
(
Int!
) The number of connections still available for use.
conneXAnnualMaintenanceContract
(
DateTime!
)The expiration date for the ConneX Annual Maintenence Contract.
licenseType
(
String
) The type of license installed.
maxConnections
(
Int!
) The maximum number of connections available with the installed license.
timedLicenseExpiration
(
DateTime!
)
The expiration date of the license (if applicable).
The field
licenseType
has the following values:
Value Description
NoLicense
No ConneX license has been installed.
Perpetual
License is perpetual for the purchased version.
Timed
License is time bound based on purchase agreement.
MessageModel
Represents a message received over MQTT.
Fields
Name Description
topic
(
String
) The MQTT topic.
contentType
(
String
) The MQTT message type.
timestamp
(
DateTime!
) The message timestamp.
messageModelId
(
UUID!
) The unique UUID message identifier.
payload
(
[Byte!]
) The message payload in raw bytes.
payloadAsString
(
String
)The message payload converted to a
UTF8
string.
Name Description
MessageModelCollectionSegment
Represents a collection of MessageModel (used in pagination).
Fields
Name Description
items
(
[MessageModel]
) The items in the current page.
pageInfo
(
CollectionSegmentInfo!
)Information to aid in pagination.
totalCount
(
Int!
) The total message count for the query.
ProgrammerModel
Represents a programmer connected to ConneX.
Fields
Name Description
programmerId
(
Int!
) The database key for the programmer.
entity
(
Entity
) The associated entity for this programmer.
handler
(
Handler
) The associated handler for this programmer.
adapters
(
[AdapterModel]
) A collection of adapters associated with this programmer.
ipAddress
(
String
) The IP address of the programmer.
programmerType
(
ProgrammerType!
)The type of programmer.
Interfaces
ConneX exposes the following GraphQL interfaces:
None