Saltar al contenido principal

Referencia GraphQL: device-management

Generada a partir del esquema que sirve este servicio, así que no puede quedarse atrás. El mismo esquema se publica como archivo para herramientas y agentes.

Endpointhttps://<your-host>/api/device-management/graphql
Plano de autenticacióntenant — The ordinary application plane. Obtain a tenant access token by calling login then selectTenant on user-management, and authorize each call with the capability it names (for example device:write).
Autorizacióntenant access token
Archivo del esquema/schema/device-management.graphql
Descritos1227 de 2232 elementos
nota

La referencia que sigue se genera a partir del esquema y está solo en inglés.

Queries​

activeAssetTypeVersion · activeProfileRules · alarmCountsByDeviceType · alarmCountsBySeverity · alarmDispositions · alarms · alarmsById · alarmsByToken · anchorDevices · areaTypes · areaTypesById · areaTypesByToken · areas · areasById · areasByToken · assetAncestors · assetChildren · assetParent · assetTypeVersions · assetTypes · assetTypesById · assetTypesByToken · assets · assetsById · assetsByToken · auditEvents · authenticateCommandChannel · calculatedBackfillRoster · calculatedMetricPlan · checkDeviceCredential · commandDefinitions · commandDefinitionsById · commandDefinitionsByToken · commandDispatchSchedule · commandPullDevices · currentFenceSetVersion · currentGeoFenceSet · currentGeoFenceSetManifest · customerDevices · customerTypes · customerTypesById · customerTypesByToken · customers · customersById · customersByToken · detectionRules · detectionRulesById · detectionRulesByToken · deviceClaim · deviceCommandVocabulary · deviceConfiguration · deviceConfigurationRevisions · deviceConstantsPage · deviceCredentials · deviceCredentialsById · deviceCredentialsByToken · deviceDecoder · deviceLocationDeclaration · deviceMetricVocabulary · deviceProfileVersions · deviceProfiles · deviceProfilesById · deviceProfilesByToken · deviceReplacements · deviceRevokedCertificates · deviceRosterPage · deviceScopeAnchors · deviceThresholdAttributePage · deviceTrustAnchors · deviceTrustAnchorsById · deviceTrustAnchorsByToken · deviceTypes · deviceTypesById · deviceTypesByToken · devices · devicesByExternalId · devicesById · devicesByToken · disabledDevicePage · entityAttributes · entityGroupVersions · entityGroups · entityGroupsById · entityGroupsByToken · entityRelationshipTypes · entityRelationshipTypesById · entityRelationshipTypesByToken · entityRelationships · entityRelationshipsById · entityRelationshipsByToken · existingEntityRefs · facetKeys · facetValues · geoFenceGeometry · geoFenceSetManifest · geoFenceSetSnapshot · geoFences · geoFencesById · geoFencesByToken · integration · integrationAuth · integrationDecoder · integrations · maintenanceWindowOpening · maintenanceWindows · maintenanceWindowsById · maintenanceWindowsByToken · metricDefinitions · metricDefinitionsById · metricDefinitionsByToken · payloadDecoderFunctions · payloadDecoderHealth · payloadDecoderSamples · previewSelector · provisioningProfiles · provisioningProfilesById · provisioningProfilesByToken · resolveDeviceGroupTargets · testMetricFormula · testPayloadDecoder · unregisteredIntegrationDevices · validateCommandEnqueue · validateCommandEnqueueBatch

activeAssetTypeVersion​

No description yet.

Returns AssetTypeVersion

ArgumentTypeDescription
tokenString!No description yet.

activeProfileRules​

No description yet.

Returns ActiveProfileRulesPage!

ArgumentTypeDescription
afterIdStringNo description yet.
limitInt!No description yet.

alarmCountsByDeviceType​

Counts the alarms matching the criteria per originating device type and severity, in one read, for a view that groups alarms by type. Only alarms on devices the caller can read are counted, so a type's count equals the total of alarms(criteria) filtered to that type. Requires alarm:read.

Returns [AlarmDeviceTypeCount!]!

ArgumentTypeDescription
criteriaAlarmCountCriteria!The facets the counted alarms must match.

alarmCountsBySeverity​

Counts the alarms matching the criteria per severity, in one read. With no deviceType every alarm alarms(criteria) would return is counted, whatever its originator (a device, an asset, an area, a customer or a group), so the counts sum to its total. With a deviceType only the alarms on devices of that type are counted, as alarms(criteria) filtered to that type returns them; an unknown type counts nothing. A severity with no alarm is absent. Requires alarm:read.

Returns [AlarmSeverityCount!]!

ArgumentTypeDescription
criteriaAlarmCountCriteria!The facets the counted alarms must match.
deviceTypeStringOnly alarms on devices of this type, by its token.

alarmDispositions​

Lists alarm disposition labels, newest labelled cycle first: every labelled cycle, including those before an alarm's current one. It is the read a backtest scores a rule against. Requires alarm:read; a member whose access is limited to some customers reads the labels of the cycles raised under its customers.

Returns AlarmDispositionSearchResults!

ArgumentTypeDescription
criteriaAlarmDispositionSearchCriteria!The facets the listed labels must match, and the page to return.

alarms​

No description yet.

Returns AlarmSearchResults!

ArgumentTypeDescription
criteriaAlarmSearchCriteria!No description yet.

alarmsById​

No description yet.

Returns [Alarm!]!

ArgumentTypeDescription
ids[ID!]!No description yet.

alarmsByToken​

No description yet.

Returns [Alarm!]!

ArgumentTypeDescription
tokens[String!]!No description yet.

anchorDevices​

Searches the devices on one anchor (a customer, an area or an asset), newest first, one page at a time: the members of a dashboard widget bound to that anchor, as the caller may read them. Every answer, and pagination.totalRecords, counts only the devices the caller can see, never the whole anchor. An anchor that does not exist matches nothing. For a member limited to part of the tenant, a customer anchor must be one that member's access names, or the request is refused with FORBIDDEN; an area or asset that none of the member's devices is on matches nothing; only ownership (tracked) relationships match, so naming a relationshipType is refused as unsupported for scoped access; and any other anchor kind is refused as unsupported for scoped access (FORBIDDEN, reason SCOPE_UNSUPPORTED). Requires device:read.

Returns DeviceSearchResults!

ArgumentTypeDescription
criteriaAnchorDeviceSearchCriteria!The anchor, an optional relationship type and the page to return.

areaTypes​

No description yet.

Returns AreaTypeSearchResults!

ArgumentTypeDescription
criteriaAreaTypeSearchCriteria!No description yet.

areaTypesById​

No description yet.

Returns [AreaType!]!

ArgumentTypeDescription
ids[ID!]!No description yet.

areaTypesByToken​

No description yet.

Returns [AreaType!]!

ArgumentTypeDescription
tokens[String!]!No description yet.

areas​

No description yet.

Returns AreaSearchResults!

ArgumentTypeDescription
criteriaAreaSearchCriteria!No description yet.

areasById​

No description yet.

Returns [Area!]!

ArgumentTypeDescription
ids[ID!]!No description yet.

areasByToken​

No description yet.

Returns [Area!]!

ArgumentTypeDescription
tokens[String!]!No description yet.

assetAncestors​

No description yet.

Returns [Asset!]!

ArgumentTypeDescription
tokenString!No description yet.

assetChildren​

No description yet.

Returns AssetSearchResults!

ArgumentTypeDescription
paginationPaginationInput!No description yet.
parentTokenStringNo description yet.

assetParent​

No description yet.

Returns Asset

ArgumentTypeDescription
tokenString!No description yet.

assetTypeVersions​

No description yet.

Returns [AssetTypeVersion!]!

ArgumentTypeDescription
limitIntNo description yet.
offsetIntNo description yet.
tokenString!No description yet.

assetTypes​

No description yet.

Returns AssetTypeSearchResults!

ArgumentTypeDescription
criteriaAssetTypeSearchCriteria!No description yet.

assetTypesById​

No description yet.

Returns [AssetType!]!

ArgumentTypeDescription
ids[ID!]!No description yet.

assetTypesByToken​

No description yet.

Returns [AssetType!]!

ArgumentTypeDescription
tokens[String!]!No description yet.

assets​

No description yet.

Returns AssetSearchResults!

ArgumentTypeDescription
criteriaAssetSearchCriteria!No description yet.

assetsById​

No description yet.

Returns [Asset!]!

ArgumentTypeDescription
ids[ID!]!No description yet.

assetsByToken​

No description yet.

Returns [Asset!]!

ArgumentTypeDescription
tokens[String!]!No description yet.

auditEvents​

No description yet.

Returns AuditEventSearchResults!

ArgumentTypeDescription
criteriaAuditEventSearchCriteria!No description yet.

authenticateCommandChannel​

Service plane. Proves a device's access token for the HTTP command endpoints and says which device it belongs to. Null when the token is unknown, revoked or expired, or the device is disabled: one answer for all of them. Reads the database on every call, so a revocation takes effect on the next request. Requires a service token with device:read.

Returns CommandChannelAccess

ArgumentTypeDescription
credentialIdString!The device's access token.

calculatedBackfillRoster​

One page of EVERY device whose type adopts the profile, in device order, each with when it was created and the numbers its metadata holds under the requested names (a device holding none is still listed). Pass the previous page's nextCursor as afterId and stop when it is null. deviceTokens narrows the walk to those devices, and a token that is not a device of the profile is refused with INVALID_VALUE, naming it. A limit outside 1..500, more than 32 constant names or more than 1000 device tokens is refused with INVALID_VALUE. Requires device:read; customer-scoped callers are refused.

Returns CalculatedBackfillRosterPage!

ArgumentTypeDescription
afterIdStringThe nextCursor of the previous page; omit for the first page.
constantKeys[String!]!The constant names to read, at most 32, each 1 to 64 bytes.
deviceTokens[String!]Only these devices, at most 1000; omit for every device of the profile.
limitInt!Page size, 1 to 500.
profileTokenString!The token of the profile whose devices are walked.

calculatedMetricPlan​

Describes the calculated metrics of one PUBLISHED version of a profile: the measured metrics its formulas may read, each calculated metric with its formula, type, bounds and unit in the order the live resolver evaluates them, and the device constants they read. It is read out of the same compiled plan the resolver runs, so a caller that compiles it gets that plan. A draft is not a version: an unknown profile, a profile never published and a version never published are NOT_FOUND. A plan that cannot be built is an error, never an empty answer. Requires device:read; customer-scoped callers are refused.

Returns CalculatedMetricPlan!

ArgumentTypeDescription
profileTokenString!The token of the profile.
versionIntThe published version number; omit for the active version.

checkDeviceCredential​

Service-only: callable with a service token that holds device:read, and refused for any user's access token. The ingest door's one question about an event's credential: would the credential its body carries authenticate under the device authentication policy the event resolver applies? True when it would (or when the policy asks for none); false only for an authentication failure, with no word on which: an unknown credential, an expired one, a wrong secret, another device's credential and a missing one the policy requires are one answer. A database failure is an error, never false. The caller MUST throttle failures per credential: unlike the resolver's, this verdict reaches the sender.

Returns Boolean!

ArgumentTypeDescription
credentialIdString!The credential id the event presents, or empty.
credentialTypeString!The credential type the event presents (for example MQTT_BASIC), or empty.
deviceString!The device token the event names, or empty.
secretStringThe credential secret the event presents, or null.

commandDefinitions​

Searches the tenant's command definitions, newest first, one page at a time. These are the draft definitions, not a published version. Requires device:read.

Returns CommandDefinitionSearchResults!

ArgumentTypeDescription
criteriaCommandDefinitionSearchCriteria!Filters and the page to return.

commandDefinitionsById​

Returns the command definitions with the given ids. Ids that match nothing are omitted, an id that is not a number fails the request, and more than 1000 ids are refused with LIMIT_EXCEEDED. Requires device:read.

Returns [CommandDefinition!]!

ArgumentTypeDescription
ids[ID!]!Ids of the command definitions to return.

commandDefinitionsByToken​

Returns the command definitions with the given tokens. Tokens that match nothing are omitted, and more than 1000 tokens are refused with LIMIT_EXCEEDED. Requires device:read.

Returns [CommandDefinition!]!

ArgumentTypeDescription
tokens[String!]!Tokens of the command definitions to return.

commandDispatchSchedule​

Decides, for a command about to be enqueued, which devices must wait for their device type's maintenance window and which are refused because the window opens after the command expires. Only commands whose definition has impact DISRUPTIVE or DESTRUCTIVE, on a type that has a window, are ever held. Devices that do not exist or are disabled are skipped; validateCommandEnqueue decides those. Requires device:read.

Returns CommandDispatchSchedule!

ArgumentTypeDescription
alreadyHeldBooleanTrue when asking about a command that is already waiting for a maintenance window. The answer then follows the device type's window alone: a profile version that now marks the command NORMAL does not make it ungated, so it keeps waiting. Defaults to false.
commandKeyString!Key of the command to send.
deviceTokens[String!]!Tokens of the target devices, at most 2000.
expiresAtStringWhen the command expires, as an RFC 3339 timestamp. Omit it for a command that never expires.

commandPullDevices​

Which of the named devices take their commands over HTTP_PULL: the ones that exist, are enabled, and whose device type has commandChannel HTTP_PULL. A device that does not exist or is disabled is simply absent from the answer. Requires device:read.

Returns [String!]!

ArgumentTypeDescription
deviceTokens[String!]!Tokens of the devices to ask about, at most 2000.

currentFenceSetVersion​

No description yet.

Returns Int!

currentGeoFenceSet​

No description yet.

Returns GeoFenceSetSnapshot!

currentGeoFenceSetManifest​

No description yet.

Returns GeoFenceSetManifest!

customerDevices​

Searches the devices linked to one customer by one relationship type, newest first, one page at a time: the members of a dashboard widget bound to that customer. A customer or relationship type that does not exist matches nothing. For a member limited to part of the tenant, the customer must be one that member's access names, or the request is refused with FORBIDDEN, and only an ownership relationship (a tracked type, such as the default "assigned") matches. Requires device:read.

Returns DeviceSearchResults!

ArgumentTypeDescription
criteriaCustomerDeviceSearchCriteria!The customer, the relationship type and the page to return.

customerTypes​

No description yet.

Returns CustomerTypeSearchResults!

ArgumentTypeDescription
criteriaCustomerTypeSearchCriteria!No description yet.

customerTypesById​

No description yet.

Returns [CustomerType!]!

ArgumentTypeDescription
ids[ID!]!No description yet.

customerTypesByToken​

No description yet.

Returns [CustomerType!]!

ArgumentTypeDescription
tokens[String!]!No description yet.

customers​

No description yet.

Returns CustomerSearchResults!

ArgumentTypeDescription
criteriaCustomerSearchCriteria!No description yet.

customersById​

No description yet.

Returns [Customer!]!

ArgumentTypeDescription
ids[ID!]!No description yet.

customersByToken​

No description yet.

Returns [Customer!]!

ArgumentTypeDescription
tokens[String!]!No description yet.

detectionRules​

No description yet.

Returns DetectionRuleSearchResults!

ArgumentTypeDescription
criteriaDetectionRuleSearchCriteria!No description yet.

detectionRulesById​

No description yet.

Returns [DetectionRule!]!

ArgumentTypeDescription
ids[ID!]!No description yet.

detectionRulesByToken​

No description yet.

Returns [DetectionRule!]!

ArgumentTypeDescription
tokens[String!]!No description yet.

deviceClaim​

No description yet.

Returns DeviceClaim

ArgumentTypeDescription
deviceTokenString!No description yet.

deviceCommandVocabulary​

Lists the commands a device currently accepts, from the active published version of its profile. It reads the same data validateCommandEnqueue checks against. Returns null when no device has the token. Requires device:read.

Returns DeviceCommandVocabulary

ArgumentTypeDescription
deviceTokenString!Token of the device.

deviceConfiguration​

A device's configuration: its latest revision, its last report and whether they agree. Null when no device has this token. Reading mints nothing.

Returns DeviceConfiguration

ArgumentTypeDescription
deviceTokenString!The token of the device to read.

deviceConfigurationRevisions​

A page of a device's configuration revisions, newest first. Empty when no device has this token.

Returns DeviceConfigurationRevisionSearchResults!

ArgumentTypeDescription
deviceTokenString!The token of the device whose revisions to list.
paginationPaginationInput!Which page of revisions to return, bounded by the platform page-size ceiling.

deviceConstantsPage​

One page of the numbers the devices of a profile (those whose type adopts it) hold in their metadata under the given names, which a draft calculated-metric formula reads as device.name. Only devices holding at least one of the names are listed. This is the rule preview's source for recalculating history with the devices' CURRENT constants. Pass the previous page's nextCursor as afterId and stop when it is null. A limit outside 1..500, or no key or more than 32, is refused with INVALID_VALUE. Requires device:read.

Returns DeviceConstantsPage!

ArgumentTypeDescription
afterIdStringThe nextCursor of the previous page; omit for the first page.
keys[String!]!The constant names to read, 1 to 32 of them, each 1 to 64 bytes.
limitInt!Page size, 1 to 500.
profileTokenString!The token of the profile whose devices are read.

deviceCredentials​

No description yet.

Returns DeviceCredentialSearchResults!

ArgumentTypeDescription
criteriaDeviceCredentialSearchCriteria!No description yet.

deviceCredentialsById​

No description yet.

Returns [DeviceCredential!]!

ArgumentTypeDescription
ids[ID!]!No description yet.

deviceCredentialsByToken​

No description yet.

Returns [DeviceCredential!]!

ArgumentTypeDescription
tokens[String!]!No description yet.

deviceDecoder​

Service-only: callable with a service token that holds device:read, and refused for any user's access token. What the ingest path needs to know about the payload decoder of the device with this token, for a device that publishes its own payload: whether the active published version of its type's profile declares one, which input it reads, and the figures the ingest charge is built from. The credential the device presented is authenticated first, and the answer is null for every failure to do so (nothing presented, an unknown, disabled or expired credential, a wrong secret, a credential that belongs to another device, a device that does not exist): those are indistinguishable from one another and say nothing about whether a decoder is attached. A device that authenticates and whose type has no decoder is present: false.

Returns DeviceDecoderPlan

ArgumentTypeDescription
credentialIdString!The credential id the device presented (for an access token, the token).
credentialSecretStringThe secret the device presented, for a credential type that carries one.
credentialTypeString!Type of the credential the device presented (ACCESS_TOKEN, MQTT_BASIC).
deviceTokenString!Token of the device the uplink is addressed to.

deviceLocationDeclaration​

Tells whether a device reports its own position, from the active published version of its profile rather than the draft. Returns null when no device has the token; a device that declares nothing answers with declared false. Requires device:read.

Returns DeviceLocationCapability

ArgumentTypeDescription
deviceTokenString!Token of the device.

deviceMetricVocabulary​

Lists the metrics a device's measurements are validated against, from the active published version of its profile: the same reading ingest validates and stores each measurement by. Returns null when no device has the token. Requires device:read.

Returns DeviceMetricVocabulary

ArgumentTypeDescription
deviceTokenString!Token of the device.

deviceProfileVersions​

Lists the published versions of a device profile, newest first, at most 1000 per call; use limit and offset to page. Empty when the profile has never been published or offset is past the last version. Fails if no profile has the token. Requires device:read.

Returns [DeviceProfileVersion!]!

ArgumentTypeDescription
limitIntMaximum number of versions to return, at least 1. Omitted, or above 1000, it is 1000; below 1 is refused.
offsetIntNumber of newest versions to skip before the first one returned. Omitted, it is 0; negative is refused.
tokenString!Token of the profile.

deviceProfiles​

Lists the tenant's device profiles, newest first, one page at a time. Requires device:read.

Returns DeviceProfileSearchResults!

ArgumentTypeDescription
criteriaDeviceProfileSearchCriteria!The page to return.

deviceProfilesById​

Returns the device profiles with the given ids. Ids that match no profile are omitted, an id that is not a number fails the request, and more than 1000 ids are refused with LIMIT_EXCEEDED. Requires device:read.

Returns [DeviceProfile!]!

ArgumentTypeDescription
ids[ID!]!Ids of the profiles to return.

deviceProfilesByToken​

Returns the device profiles with the given tokens. Tokens that match no profile are omitted, and more than 1000 tokens are refused with LIMIT_EXCEEDED. Requires device:read.

Returns [DeviceProfile!]!

ArgumentTypeDescription
tokens[String!]!Tokens of the profiles to return.

deviceReplacements​

No description yet.

Returns DeviceReplacementSearchResults!

ArgumentTypeDescription
criteriaDeviceReplacementSearchCriteria!No description yet.

deviceRevokedCertificates​

List the revoked certificates of a trust anchor, newest first.

Returns DeviceRevokedCertificateSearchResults!

ArgumentTypeDescription
anchorTokenString!Token of the anchor.
criteriaDeviceRevokedCertificateSearchCriteria!Paging and filters.

deviceRosterPage​

No description yet.

Returns DeviceRosterPage!

ArgumentTypeDescription
afterIdStringNo description yet.
limitInt!No description yet.

deviceScopeAnchors​

Returns the anchors of each named device: one type:token entry per tracked relationship from the device, such as customer:acme for a device assigned to that customer. Other services stamp a record about a device with these when they write it, which decides which members limited to part of the tenant can see the record. Devices that do not exist are omitted, and more than 1000 tokens are refused with LIMIT_EXCEEDED. Not available to a member limited to part of the tenant. Requires device:read.

Returns [DeviceScopeAnchors!]!

ArgumentTypeDescription
deviceTokens[String!]!Tokens of the devices, at most 1000.

deviceThresholdAttributePage​

No description yet.

Returns DeviceThresholdAttributePage!

ArgumentTypeDescription
afterIdStringNo description yet.
limitInt!No description yet.

deviceTrustAnchors​

List trust anchors that meet the criteria.

Returns DeviceTrustAnchorSearchResults!

ArgumentTypeDescription
criteriaDeviceTrustAnchorSearchCriteria!Paging and filters.

deviceTrustAnchorsById​

Find trust anchors by unique id.

Returns [DeviceTrustAnchor!]!

ArgumentTypeDescription
ids[ID!]!Ids of the anchors.

deviceTrustAnchorsByToken​

Find trust anchors by unique token.

Returns [DeviceTrustAnchor!]!

ArgumentTypeDescription
tokens[String!]!Tokens of the anchors.

deviceTypes​

Lists the tenant's device types, newest first, one page at a time. Requires device:read.

Returns DeviceTypeSearchResults!

ArgumentTypeDescription
criteriaDeviceTypeSearchCriteria!The page to return.

deviceTypesById​

Returns the device types with the given ids. Ids that match no device type are omitted, an id that is not a number fails the request, and more than 1000 ids are refused with LIMIT_EXCEEDED. Requires device:read.

Returns [DeviceType!]!

ArgumentTypeDescription
ids[ID!]!Ids of the device types to return.

deviceTypesByToken​

Returns the device types with the given tokens. Tokens that match no device type are omitted, and more than 1000 tokens are refused with LIMIT_EXCEEDED. Requires device:read.

Returns [DeviceType!]!

ArgumentTypeDescription
tokens[String!]!Tokens of the device types to return.

devices​

Searches the tenant's devices, newest first, one page at a time. Requires device:read.

Returns DeviceSearchResults!

ArgumentTypeDescription
criteriaDeviceSearchCriteria!Filters and the page to return.

devicesByExternalId​

Returns the devices whose business identifier is one of the given values. Values that match no device are omitted. Requires device:read.

Returns [Device!]!

ArgumentTypeDescription
externalIds[String!]!Business identifiers to look up, matched exactly.

devicesById​

Returns the devices with the given ids. Ids that match no device are omitted, an id that is not a number fails the request, and more than 1000 ids are refused with LIMIT_EXCEEDED. Requires device:read.

Returns [Device!]!

ArgumentTypeDescription
ids[ID!]!Ids of the devices to return.

devicesByToken​

Returns the devices with the given tokens. Tokens that match no device are omitted, and more than 1000 tokens are refused with LIMIT_EXCEEDED. Requires device:read.

Returns [Device!]!

ArgumentTypeDescription
tokens[String!]!Tokens of the devices to return.

disabledDevicePage​

One page of the tokens of the devices an operator has disabled, in device order. Pass the previous page's nextCursor as afterId and stop when it is null; a limit outside 1..1000 is refused. command-delivery walks it at startup and every few minutes to correct its record of which devices are disabled, because commands already queued for a disabled device are held rather than sent. Requires device:read.

Returns DisabledDevicePage!

ArgumentTypeDescription
afterIdStringThe nextCursor of the previous page; omit for the first page.
limitInt!Page size, 1 to 1000.

entityAttributes​

No description yet.

Returns EntityAttributeSearchResults!

ArgumentTypeDescription
criteriaEntityAttributeSearchCriteria!No description yet.

entityGroupVersions​

No description yet.

Returns [EntityGroupVersion!]!

ArgumentTypeDescription
limitIntNo description yet.
offsetIntNo description yet.
tokenString!No description yet.

entityGroups​

No description yet.

Returns EntityGroupSearchResults!

ArgumentTypeDescription
criteriaEntityGroupSearchCriteria!No description yet.

entityGroupsById​

No description yet.

Returns [EntityGroup!]!

ArgumentTypeDescription
ids[ID!]!No description yet.

entityGroupsByToken​

No description yet.

Returns [EntityGroup!]!

ArgumentTypeDescription
tokens[String!]!No description yet.

entityRelationshipTypes​

No description yet.

Returns EntityRelationshipTypeSearchResults!

ArgumentTypeDescription
criteriaEntityRelationshipTypeSearchCriteria!No description yet.

entityRelationshipTypesById​

No description yet.

Returns [EntityRelationshipType!]!

ArgumentTypeDescription
ids[String!]!No description yet.

entityRelationshipTypesByToken​

No description yet.

Returns [EntityRelationshipType!]!

ArgumentTypeDescription
tokens[String!]!No description yet.

entityRelationships​

No description yet.

Returns EntityRelationshipSearchResults!

ArgumentTypeDescription
criteriaEntityRelationshipSearchCriteria!No description yet.

entityRelationshipsById​

No description yet.

Returns [EntityRelationship!]!

ArgumentTypeDescription
ids[String!]!No description yet.

entityRelationshipsByToken​

No description yet.

Returns [EntityRelationship!]!

ArgumentTypeDescription
tokens[String!]!No description yet.

existingEntityRefs​

No description yet.

Returns [EntityRef!]!

ArgumentTypeDescription
refs[EntityRefInput!]!No description yet.

facetKeys​

No description yet.

Returns FacetKeySearchResults!

ArgumentTypeDescription
criteriaFacetKeySearchCriteria!No description yet.

facetValues​

Lists the distinct values currently in use for a free-text classification field across the tenant's device types or profiles, sorted, without empty values. An authoring form can offer them as suggestions. Requires device:read.

Returns [String!]!

ArgumentTypeDescription
facetDeviceFacet!The field whose values to list.

geoFenceGeometry​

No description yet.

Returns [GeoFenceGeometry!]!

ArgumentTypeDescription
hashes[String!]!No description yet.

geoFenceSetManifest​

No description yet.

Returns GeoFenceSetManifest!

ArgumentTypeDescription
versionInt!No description yet.

geoFenceSetSnapshot​

No description yet.

Returns GeoFenceSetSnapshot!

ArgumentTypeDescription
versionInt!No description yet.

geoFences​

No description yet.

Returns GeoFenceSearchResults!

ArgumentTypeDescription
criteriaGeoFenceSearchCriteria!No description yet.

geoFencesById​

No description yet.

Returns [GeoFence!]!

ArgumentTypeDescription
ids[ID!]!No description yet.

geoFencesByToken​

No description yet.

Returns [GeoFence!]!

ArgumentTypeDescription
tokens[String!]!No description yet.

integration​

Find one integration by token, or null when there is none.

Returns Integration

ArgumentTypeDescription
tokenString!Token of the integration.

integrationAuth​

Service-only: callable with a service token that holds device:read, and refused for any user's access token. Proves a bearer token belongs to the integration with this token. Returns the integration when it does, and null for every failure: no such integration and a wrong token are indistinguishable. A switched-off integration whose token matches is returned with enabled false, so callers MUST check enabled before accepting traffic. Used by the ingest path to authenticate a sender.

Returns Integration

ArgumentTypeDescription
secretString!The bearer token the sender presented.
tokenString!Token of the integration, as it appears in the sender's URL.

integrationDecoder​

Service-only: callable with a service token that holds device:read, and refused for any user's access token. What the ingest path needs to know about the payload decoder of a device type, as seen by one integration: whether the active published version of the type's profile declares one, which input an uplink must carry for it, and the figures the ingest charge is built from. Returns null for every failure to authenticate (no such integration, a wrong token and a switched-off integration are indistinguishable), and present: false for a device type that does not exist or lies outside the integration's scope.

Returns IntegrationDecoderPlan

ArgumentTypeDescription
deviceTypeTokenString!Token of the device type the uplink's device belongs to.
integrationString!Token of the integration, as it appears in the sender's URL.
secretString!The bearer token the sender presented.

integrations​

List integrations that meet the criteria.

Returns IntegrationSearchResults!

ArgumentTypeDescription
criteriaIntegrationSearchCriteria!Paging and filters.

maintenanceWindowOpening​

When an operation under the maintenance window with this token may start at the given instant. The answer for a deleted window is found=false, not an error. Requires device:read.

Returns MaintenanceWindowOpening!

ArgumentTypeDescription
atStringThe instant to evaluate at, as an RFC 3339 timestamp. Omit it for now.
tokenString!Token of the window.

maintenanceWindows​

List the tenant's maintenance windows, one page at a time. Requires device:read.

Returns MaintenanceWindowSearchResults!

ArgumentTypeDescription
criteriaMaintenanceWindowSearchCriteria!Which page to return.

maintenanceWindowsById​

Find maintenance windows by unique id. Ids that match nothing are omitted. Requires device:read.

Returns [MaintenanceWindow!]!

ArgumentTypeDescription
ids[ID!]!Ids of the windows to find.

maintenanceWindowsByToken​

Find maintenance windows by unique token. Tokens that match nothing are omitted. Requires device:read.

Returns [MaintenanceWindow!]!

ArgumentTypeDescription
tokens[String!]!Tokens of the windows to find.

metricDefinitions​

Searches the tenant's metric definitions, newest first, one page at a time. These are the draft definitions, not a published version. Requires device:read.

Returns MetricDefinitionSearchResults!

ArgumentTypeDescription
criteriaMetricDefinitionSearchCriteria!Filters and the page to return.

metricDefinitionsById​

Returns the metric definitions with the given ids. Ids that match nothing are omitted, an id that is not a number fails the request, and more than 1000 ids are refused with LIMIT_EXCEEDED. Requires device:read.

Returns [MetricDefinition!]!

ArgumentTypeDescription
ids[ID!]!Ids of the metric definitions to return.

metricDefinitionsByToken​

Returns the metric definitions with the given tokens. Tokens that match nothing are omitted, and more than 1000 tokens are refused with LIMIT_EXCEEDED. Requires device:read.

Returns [MetricDefinition!]!

ArgumentTypeDescription
tokens[String!]!Tokens of the metric definitions to return.

payloadDecoderFunctions​

The decoder function library, in a stable order: every function a decoder expression may call, with its signature and limits. It drives the editor's help. Requires device:read.

Returns [PayloadDecoderFunction!]!

payloadDecoderHealth​

How the decoder of the profile has been doing over the last minutes (default 60, at most 10080, one week), summed over replicas. Rows are kept 7 days. Requires device:write.

Returns PayloadDecoderHealth!

ArgumentTypeDescription
minutesIntThe span in minutes.
profileTokenString!Token of the profile.

payloadDecoderSamples​

The failing uplinks kept for the profile, newest first: at most 20 are kept, and a new one is kept at most every 10 seconds per replica. Requires device:write.

Returns [PayloadDecoderSample!]!

ArgumentTypeDescription
limitIntHow many to list (default and at most 20 kept).
profileTokenString!Token of the profile.

previewSelector​

No description yet.

Returns SelectorPreview!

ArgumentTypeDescription
memberTypeString!No description yet.
paginationPaginationInput!No description yet.
selectorString!No description yet.

provisioningProfiles​

No description yet.

Returns ProvisioningProfileSearchResults!

ArgumentTypeDescription
criteriaProvisioningProfileSearchCriteria!No description yet.

provisioningProfilesById​

No description yet.

Returns [ProvisioningProfile!]!

ArgumentTypeDescription
ids[ID!]!No description yet.

provisioningProfilesByToken​

No description yet.

Returns [ProvisioningProfile!]!

ArgumentTypeDescription
tokens[String!]!No description yet.

resolveDeviceGroupTargets​

Returns one page of the devices an entity group contains, for use as the target of a command. Pass each page's nextCursor as afterId to get the next one. A device that stays in the group throughout a walk is visited exactly once. A dynamic group is resolved from a published version, never from its editable draft. A group that cannot be a target is answered with rejected set and a code, not with an error. Requires device:read.

Returns DeviceGroupTargetPage!

ArgumentTypeDescription
afterIdStringThe nextCursor of the previous page. Omit it to start from the beginning. A malformed cursor fails the request.
groupTokenString!Token of the entity group.
limitInt!Maximum number of devices on the page, from 1 to 1000.
versionIntPublished version of a dynamic group to resolve. Omit it for the active version. Must be omitted for a static group.

testMetricFormula​

Checks a calculated-metric formula against a profile's draft measured metrics and evaluates it for a sample you type, with the same evaluator that computes a published calculated metric from each reading. Nothing is stored. A sample of more than 256 values is refused with LIMIT_EXCEEDED, and naming a key twice with INVALID_VALUE. Requires device:read.

Returns MetricFormulaTest!

ArgumentTypeDescription
constants[MetricValueInput!]The values of the device constants the formula reads as device.name, as the device's metadata would hold them, at most 32. A constant the formula reads and this omits is absent, and the formula is skipped as missing_input, as it would be for a device without it. Omit this when the formula reads none.
dataTypeString!The result type: DOUBLE, INT or BOOLEAN.
expressionString!The formula.
maxValueFloatLargest value the metric accepts; a result above it is skipped.
metricKeyStringThe calculated metric's key, when the formula belongs to one.
minValueFloatSmallest value the metric accepts; a result below it is skipped.
profileTokenString!Token of the profile whose draft measured metrics the formula reads.
sample[MetricValueInput!]!The input values, at most 256.

testPayloadDecoder​

Runs a payload decoder over one input and reports the readings it would store, what it skipped, the error with its expression path and the cost, then runs the profile's saved vectors. The decoder is checked against the profile's DRAFT metrics with the same compiler and the same output validation that run at ingest, and a webhook body is parsed by the same code as ingest. Nothing is stored. A document that does not compile is reported in error, not as a request error. Limited to 10 requests per second per tenant (RATE_LIMITED). Requires device:read, except that sampleId requires device:write. A caller limited to part of the tenant is refused.

Returns PayloadDecoderTestResult!

ArgumentTypeDescription
inputPayloadDecoderTestInput!The decoder and the input.

unregisteredIntegrationDevices​

The sender-named devices an integration has seen that the tenant has no device in scope for, most recently seen first. Requires device:read.

Returns UnregisteredIntegrationDeviceSearchResults!

ArgumentTypeDescription
criteriaUnregisteredIntegrationDeviceSearchCriteria!The integration and the page.

validateCommandEnqueue​

Checks whether a command may be sent to a device, using the active published version of the device's profile. If that version declares commands, the key must be one of them and the payload must satisfy its parameters; if it declares none, or the device has no published profile, any command is allowed. Refusals are returned as a verdict, not as an error. Requires device:read.

Returns CommandEnqueueVerdict!

ArgumentTypeDescription
commandKeyString!Key of the command to send.
deviceTokenString!Token of the target device.
payloadStringThe command's arguments as a JSON object. Omit it or send null to check a command sent with no arguments, which passes only if no parameter is required.

validateCommandEnqueueBatch​

Checks one command against many devices at once, with the same rules as validateCommandEnqueue. Only refusals are returned: a device that may receive the command produces no entry, so an empty list means every listed device may receive it. Duplicate tokens are collapsed, and refusals come back in the order each device was first named. More than 2000 tokens fails the request. Requires device:read.

Returns [BatchEnqueueRefusal!]!

ArgumentTypeDescription
commandKeyString!Key of the command to send.
deviceTokens[String!]!Tokens of the target devices, at most 2000.
payloadStringThe command's arguments as a JSON object, applied to every device. Omit it to check a command with no arguments.

Mutations​

acknowledgeAlarm · acknowledgeAlarms · assignDeviceGateway · cancelDeviceClaim · claimDevice · clearAlarm · clearAssetParent · clearDeviceGateway · clearDeviceProfileDecoder · clearInstalledPosition · clearUnregisteredIntegrationDevices · copyDeviceConfiguration · createArea · createAreaType · createAsset · createAssetType · createCommandDefinition · createCustomer · createCustomerType · createDetectionRule · createDevice · createDeviceCredential · createDeviceProfile · createDeviceTrustAnchor · createDeviceType · createDevices · createEntityGroup · createEntityRelationship · createEntityRelationshipType · createEntityRelationships · createGeoFence · createIntegration · createMaintenanceWindow · createMetricDefinition · createProvisioningProfile · deleteArea · deleteAreaType · deleteAsset · deleteAssetType · deleteCommandDefinition · deleteCustomer · deleteCustomerType · deleteDetectionRule · deleteDevice · deleteDeviceCredential · deleteDeviceProfile · deleteDeviceRevocationList · deleteDeviceTrustAnchor · deleteDeviceType · deleteEntityAttribute · deleteEntityGroup · deleteEntityRelationshipType · deleteFacetKey · deleteGeoFence · deleteIntegration · deleteMaintenanceWindow · deleteMetricDefinition · deleteProvisioningProfile · importDevices · initiateDeviceClaim · publishAssetType · publishDeviceProfile · publishEntityGroup · putDeviceRevocationList · recordIntegrationAuthFailure · recordIntegrationUndecoded · removeEntityRelationship · removeEntityRelationships · renameDeviceProfile · replaceDevice · resetDeviceProvisioning · resolveIntegrationDevice · restoreDeviceConfiguration · revokeDeviceCertificate · revokeProvisionedDevices · rollbackAssetType · rollbackDeviceProfile · rollbackEntityGroup · rotateIntegrationToken · rotateProvisioningProfileSecret · setAlarmDisposition · setAssetParent · setDeviceProfileConfigurationDeclaration · setDeviceProfileDecoder · setEntityAttribute · setEntityGroupAccessScope · setFacetKey · setInstalledPosition · unrevokeDeviceCertificate · updateArea · updateAreaType · updateAsset · updateAssetType · updateCommandDefinition · updateCustomer · updateCustomerType · updateDetectionRule · updateDevice · updateDeviceCredential · updateDeviceProfile · updateDeviceTrustAnchor · updateDeviceType · updateEntityGroup · updateEntityRelationshipType · updateGeoFence · updateIntegration · updateMaintenanceWindow · updateMetricDefinition · updateProvisioningProfile

acknowledgeAlarm​

No description yet.

Returns Alarm!

ArgumentTypeDescription
tokenString!No description yet.

acknowledgeAlarms​

No description yet.

Returns BulkAcknowledgeAlarmsResult!

ArgumentTypeDescription
tokens[String!]!No description yet.

assignDeviceGateway​

Puts a device behind a gateway device, so that gateway's credential may publish the device's telemetry on the gateway's own topics, and returns the device. Assigning a device to the gateway it already has changes nothing; a device with another gateway is moved. Refused with INVALID_VALUE when the two are the same device, when the gateway is itself behind a gateway, or when the device is itself the gateway of other devices (gateways are one level deep). Fails if either token names no device. This grants the gateway the same standing over the device as issuing the device a credential, so it requires device:write and is refused for a member limited to part of the tenant.

Returns Device!

ArgumentTypeDescription
deviceTokenString!Token of the device to put behind the gateway.
gatewayTokenString!Token of the gateway device.

cancelDeviceClaim​

No description yet.

Returns Boolean!

ArgumentTypeDescription
deviceTokenString!No description yet.

claimDevice​

No description yet.

Returns EntityRelationship!

ArgumentTypeDescription
requestDeviceClaimRequest!No description yet.

clearAlarm​

No description yet.

Returns Alarm!

ArgumentTypeDescription
tokenString!No description yet.

clearAssetParent​

No description yet.

Returns Boolean!

ArgumentTypeDescription
childTokenString!No description yet.

clearDeviceGateway​

Takes a device out from behind its gateway and returns it: the gateway's next publish for the device is refused and recorded in failed events. Clearing a device that has no gateway changes nothing. Fails if no device has the token. Requires device:write.

Returns Device!

ArgumentTypeDescription
deviceTokenString!Token of the device.

clearDeviceProfileDecoder​

Withdraws a profile's DRAFT payload decoder. Published versions keep theirs. Returns the updated profile. Requires device:write.

Returns DeviceProfile!

ArgumentTypeDescription
profileTokenString!Token of the profile.

clearInstalledPosition​

Removes the installed position of a device or an asset. Needs device:write. Clearing an entity that has none succeeds.

Returns Boolean!

ArgumentTypeDescription
familyPositionFamily!Whether token names a device or an asset.
tokenString!The token of the device or asset.

clearUnregisteredIntegrationDevices​

Remove every unregistered device an integration has recorded, returning how many rows went. They are observations; ones the sender is still sending are recorded again. An unknown integration clears nothing.

Returns Int!

ArgumentTypeDescription
integrationString!Token of the integration.

copyDeviceConfiguration​

Makes one device's desired configuration equal to another device's latest revision (or the revision fromRevision names), by setting the target's shared attributes for its declared keys and minting a new revision on the target; the source is not changed. Both devices must be in the caller's tenant (another tenant's device is NOT_FOUND), and the target's profile must declare every key the source's document carries. Refused, writing nothing, with the same codes as restoreDeviceConfiguration; a source with no revision, or without fromRevision, is NOT_FOUND. Requires device:write.

Returns DeviceConfiguration!

ArgumentTypeDescription
fromDeviceTokenString!Token of the device whose configuration to copy.
fromRevisionIntThe source revision to copy; omitted or null copies the source's latest. Pass the revision you previewed, so a source that changes in between cannot make the copy apply something you were not shown.
toDeviceTokenString!Token of the device to copy it to.

createArea​

No description yet.

Returns Area!

ArgumentTypeDescription
requestAreaCreateRequestNo description yet.

createAreaType​

No description yet.

Returns AreaType!

ArgumentTypeDescription
requestAreaTypeCreateRequestNo description yet.

createAsset​

No description yet.

Returns Asset!

ArgumentTypeDescription
requestAssetCreateRequestNo description yet.

createAssetType​

No description yet.

Returns AssetType!

ArgumentTypeDescription
requestAssetTypeCreateRequestNo description yet.

createCommandDefinition​

Adds a command definition to a profile's draft and returns it. It reaches devices when the profile is next published. Requires device:write.

Returns CommandDefinition!

ArgumentTypeDescription
requestCommandDefinitionCreateRequestThe new command definition's fields. Although the schema lets it be omitted, a call without it fails.

createCustomer​

No description yet.

Returns Customer!

ArgumentTypeDescription
requestCustomerCreateRequestNo description yet.

createCustomerType​

No description yet.

Returns CustomerType!

ArgumentTypeDescription
requestCustomerTypeCreateRequestNo description yet.

createDetectionRule​

No description yet.

Returns DetectionRule!

ArgumentTypeDescription
requestDetectionRuleCreateRequest!No description yet.

createDevice​

Creates a device and returns it. Requires device:write.

Returns Device!

ArgumentTypeDescription
requestDeviceCreateRequestThe new device's fields. Although the schema lets it be omitted, a call without it fails.

createDeviceCredential​

No description yet.

Returns DeviceCredential!

ArgumentTypeDescription
requestDeviceCredentialCreateRequestNo description yet.

createDeviceProfile​

Creates a device profile, with no definitions and no published version, and returns it. Requires device:write.

Returns DeviceProfile!

ArgumentTypeDescription
requestDeviceProfileCreateRequestThe new profile's fields. Although the schema lets it be omitted, a call without it fails.

createDeviceTrustAnchor​

Create a trust anchor from a CA certificate. Refused when the tenant already holds 32.

Returns DeviceTrustAnchor!

ArgumentTypeDescription
requestDeviceTrustAnchorCreateRequest!The anchor to create.

createDeviceType​

Creates a device type and returns it. Requires device:write.

Returns DeviceType!

ArgumentTypeDescription
requestDeviceTypeCreateRequestThe new device type's fields. Although the schema lets it be omitted, a call without it fails.

createDevices​

Creates up to 1000 devices of one type from templates, in one transaction: every device is created, or none is (an invalid template, a rendered token that repeats or is already in use, or an unknown device type fails them all). Returns the created devices in index order. Requires device:write.

Returns [Device!]!

ArgumentTypeDescription
requestDeviceBulkCreateRequest!The type, count and templates of the devices to create.

createEntityGroup​

No description yet.

Returns EntityGroup!

ArgumentTypeDescription
requestEntityGroupCreateRequestNo description yet.

createEntityRelationship​

No description yet.

Returns EntityRelationship!

ArgumentTypeDescription
requestEntityRelationshipCreateRequest!No description yet.

createEntityRelationshipType​

No description yet.

Returns EntityRelationshipType!

ArgumentTypeDescription
requestEntityRelationshipTypeCreateRequest!No description yet.

createEntityRelationships​

No description yet.

Returns [EntityRelationship!]!

ArgumentTypeDescription
requests[EntityRelationshipCreateRequest!]!No description yet.

createGeoFence​

No description yet.

Returns GeoFence!

ArgumentTypeDescription
requestGeoFenceCreateRequest!No description yet.

createIntegration​

Create an inbound integration. The response carries the bearer token the server generated for it, once. Refused when the tenant already holds as many integrations as its tier allows.

Returns IntegrationSecretResult!

ArgumentTypeDescription
requestIntegrationCreateRequest!The integration to create.

createMaintenanceWindow​

Create a maintenance window. The time zone and slots are validated together, and the slots are stored in canonical form. Requires device:write.

Returns MaintenanceWindow!

ArgumentTypeDescription
requestMaintenanceWindowCreateRequest!The window to create.

createMetricDefinition​

Adds a metric definition to a profile's draft and returns it. It reaches devices when the profile is next published. Requires device:write.

Returns MetricDefinition!

ArgumentTypeDescription
requestMetricDefinitionCreateRequestThe new metric definition's fields. Although the schema lets it be omitted, a call without it fails.

createProvisioningProfile​

No description yet.

Returns ProvisioningProfileSecretResult!

ArgumentTypeDescription
requestProvisioningProfileCreateRequestNo description yet.

deleteArea​

No description yet.

Returns Boolean!

ArgumentTypeDescription
tokenString!No description yet.

deleteAreaType​

No description yet.

Returns Boolean!

ArgumentTypeDescription
tokenString!No description yet.

deleteAsset​

No description yet.

Returns Boolean!

ArgumentTypeDescription
tokenString!No description yet.

deleteAssetType​

No description yet.

Returns Boolean!

ArgumentTypeDescription
tokenString!No description yet.

deleteCommandDefinition​

Removes a command definition from a profile's draft. Published versions keep their copy. Returns true when it was deleted and false when nothing has the token. Requires device:write.

Returns Boolean!

ArgumentTypeDescription
tokenString!Token of the command definition to delete.

deleteCustomer​

No description yet.

Returns Boolean!

ArgumentTypeDescription
tokenString!No description yet.

deleteCustomerType​

No description yet.

Returns Boolean!

ArgumentTypeDescription
tokenString!No description yet.

deleteDetectionRule​

No description yet.

Returns Boolean!

ArgumentTypeDescription
tokenString!No description yet.

deleteDevice​

Deletes a device together with its credentials, replacement history, relationships, attributes, alarms and group memberships. Returns true when it was deleted and false when no device has the token. Requires device:write.

Returns Boolean!

ArgumentTypeDescription
tokenString!Token of the device to delete.

deleteDeviceCredential​

No description yet.

Returns Boolean!

ArgumentTypeDescription
tokenString!No description yet.

deleteDeviceProfile​

Deletes a device profile together with its metric, command and detection-rule definitions and all its published versions. Returns true when it was deleted and false when no profile has the token. Refused with REFERENCE_VIOLATION while any device type adopts it. Requires device:write.

Returns Boolean!

ArgumentTypeDescription
tokenString!Token of the profile to delete.

deleteDeviceRevocationList​

Delete the current list of an issuer and every entry it carried; those certificates are no longer refused for it. The issuer's highest CRL number is kept, so an older list still cannot be uploaded afterwards. True if there was a list. Under REQUIRE_CURRENT the anchor's certificates from that issuer are then refused until a new list is uploaded.

Returns Boolean!

ArgumentTypeDescription
anchorTokenString!Token of the trust anchor.
issuerKeyString!SHA-256 of the signer's public key, hex.
issuerNameString!SHA-256 of the signer's subject, hex.

deleteDeviceTrustAnchor​

Delete a trust anchor nothing relies on. Refused with extensions.code REFERENCE_VIOLATION while a credential or a provisioning profile still names it, and while it holds manual revocations (un-revoke them first). Revocation lists uploaded for it, their entries and the highest CRL number accepted for each issuer are discarded with it: an anchor re-created from the same CA starts again, and accepts a CRL whose number the deleted anchor had already passed.

Returns Boolean!

ArgumentTypeDescription
tokenString!Token of the anchor.

deleteDeviceType​

Deletes a device type. Returns true when it was deleted and false when no device type has the token. Refused with REFERENCE_VIOLATION while any device has this type. The profile it adopted is not affected. Requires device:write.

Returns Boolean!

ArgumentTypeDescription
tokenString!Token of the device type to delete.

deleteEntityAttribute​

No description yet.

Returns Boolean!

ArgumentTypeDescription
attrKeyString!No description yet.
entityString!No description yet.
entityTypeString!No description yet.
scopeString!No description yet.

deleteEntityGroup​

No description yet.

Returns Boolean!

ArgumentTypeDescription
tokenString!No description yet.

deleteEntityRelationshipType​

No description yet.

Returns Boolean!

ArgumentTypeDescription
tokenString!No description yet.

deleteFacetKey​

No description yet.

Returns Boolean!

ArgumentTypeDescription
keyString!No description yet.
memberTypeString!No description yet.

deleteGeoFence​

No description yet.

Returns Boolean!

ArgumentTypeDescription
tokenString!No description yet.

deleteIntegration​

Delete an integration. Returns false when there was none.

Returns Boolean!

ArgumentTypeDescription
tokenString!Token of the integration.

deleteMaintenanceWindow​

Delete a maintenance window. Refused while any device type uses it, because deleting it would stop holding those types' disruptive commands. Requires device:write.

Returns Boolean!

ArgumentTypeDescription
tokenString!Token of the window to delete.

deleteMetricDefinition​

Removes a metric definition from a profile's draft. Published versions keep their copy. Returns true when it was deleted and false when nothing has the token. Requires device:write.

Returns Boolean!

ArgumentTypeDescription
tokenString!Token of the metric definition to delete.

deleteProvisioningProfile​

No description yet.

Returns Boolean!

ArgumentTypeDescription
tokenString!No description yet.

importDevices​

Imports up to 1000 devices from rows, each in its own transaction, and reports what happened to every row; one bad row never affects another. Create-only and idempotent on the device token: a row whose device already exists exactly as described is EXISTS, one that exists differently is CONFLICT, and nothing is ever updated, so re-running a file is safe. A device's credential is created with it in the same transaction in FACTORY_CREDENTIALS mode; the same device and credential id re-run as EXISTS without the secret being compared. dryRun decides every row by the same code and writes nothing. More than 1000 rows fails the whole call. Requires device:write.

Returns DeviceImportResult!

ArgumentTypeDescription
dryRunBoolean!True to decide every row without writing anything.
modeDeviceImportMode!How credentials are treated.
rows[DeviceImportRow!]!The rows to import, at most 1000.

initiateDeviceClaim​

No description yet.

Returns DeviceClaim!

ArgumentTypeDescription
requestDeviceClaimInitiateRequest!No description yet.

publishAssetType​

No description yet.

Returns AssetTypeVersion!

ArgumentTypeDescription
descriptionStringNo description yet.
labelStringNo description yet.
tokenString!No description yet.

publishDeviceProfile​

Freezes the profile's current draft (its metric, command and detection-rule definitions, its position declaration and its configuration declaration) into a new version and makes that version the one devices use. The draft's enabled detection rules are checked first; a rejected rule, or a check that cannot be completed, fails the publish and nothing is stored. Fails if no profile has the token. Returns the new version. Requires device:write.

Returns DeviceProfileVersion!

ArgumentTypeDescription
descriptionStringOptional notes for the version, up to 1024 characters.
labelStringOptional label for the version, up to 128 characters, such as a release name.
tokenString!Token of the profile to publish.

publishEntityGroup​

Publishes a dynamic entity group's current draft selector as a new immutable version and makes it the active version a rule-scoped resolve reads. Rejected for a static group. Requires device:write.

Returns EntityGroupVersion!

ArgumentTypeDescription
descriptionStringOptional longer description of what the new version changes.
expectedActiveVersionIntThe active version the caller saw: 0 for a group never published. When the group's active version has since moved, because someone else published or rolled back, nothing is published and the request fails as modified by another writer. Omit to publish unconditionally.
labelStringOptional short label for the new version.
tokenString!Token of the group to publish.

putDeviceRevocationList​

Store a CRL as the current list of its issuer under a trust anchor, replacing the issuer's previous list. Its signature is verified against the anchor (or the issuer chain that links the signer to it) and it is refused unless its CRL number is above every number accepted before for that issuer, including after the list was deleted. The certificates it names are refused from the next connect on every replica. Uploading the very CRL already in force changes nothing. The text is limited (the instance's callout.revocation.maxGraphqlCrlBytes, 2 MiB of DER at most); larger lists go over the streaming REST upload, PUT /trust-anchors/{token}/crl on this service. The live sessions of the devices the list newly revokes are ended; sessionsEnded on the result says whether that was confirmed.

Returns DeviceRevocationListResult!

ArgumentTypeDescription
anchorTokenString!Token of the trust anchor.
crlPemString!The CRL, PEM (exactly one X509 CRL block).
issuerChainPemStringThe CRL signer's certificate first, then the CAs that link it to the anchor, PEM. Omit it when the anchor itself signed the CRL.

recordIntegrationAuthFailure​

Service-only: callable with a service token that holds device:read, and refused for any user's access token. Stamps the time a request for the integration last failed authentication, at most once a minute. A token that names no integration is not an error and writes nothing.

Returns Boolean!

ArgumentTypeDescription
integrationString!Token of the integration, as it appears in the sender's URL.

recordIntegrationUndecoded​

Service-only: callable with a service token that holds device:read, and refused for any user's access token. Adds count uplinks to the integration's undecoded tally and keeps the latest frame sample (hex, at most 1024 characters). It authenticates the integration with its bearer token, so a service token alone cannot write another sender's markers; a wrong token or a switched-off integration is refused and nothing is written. The ingest path batches these.

Returns Boolean!

ArgumentTypeDescription
countInt!How many uplinks to add; at least 1.
integrationString!Token of the integration, as it appears in the sender's URL.
sampleStringHex encoding of the latest frame, if the uplink carried one.
secretString!The bearer token the sender presented.

removeEntityRelationship​

No description yet.

Returns Boolean!

ArgumentTypeDescription
tokenString!No description yet.

removeEntityRelationships​

No description yet.

Returns Boolean!

ArgumentTypeDescription
tokens[String!]!No description yet.

renameDeviceProfile​

Changes a device profile's token and returns the profile. Allowed only while the profile has never been published and no device type currently adopts it; once it has been published, its token is permanent. Renaming to the current token succeeds without change. Fails if no profile has the token. Requires device:write.

Returns DeviceProfile!

ArgumentTypeDescription
newTokenString!The new token, in the usual token format. A blank value is refused, and a token another profile in the tenant holds is refused with CONFLICT.
tokenString!Current token of the profile.

replaceDevice​

No description yet.

Returns DeviceReplaceResult!

ArgumentTypeDescription
requestDeviceReplaceRequest!No description yet.

resetDeviceProvisioning​

Delete the credentials self-registration issued to the device and end its sessions. Returns how many it removed. The device keeps its earmark, so it can register again; this is the way back from a revoke.

Returns Int!

ArgumentTypeDescription
deviceTokenString!Token of the device.

resolveIntegrationDevice​

Service-only: callable with a service token that holds device:read, and refused for any user's access token. The ingest path's one call for turning a sender's identifier into a device: it authenticates the integration with its bearer token, finds the device the alias names, checks that device's type is in the integration's scope, and, when no device in scope carries the alias, records the sighting (see unregisteredIntegrationDevices). Every outcome a sender can cause is an answer, not an error; a scheme other than the one the integration resolves by, or a value the scheme refuses, is refused with INVALID_VALUE. A switched-off integration is reported as DISABLED and is not a failed credential.

Returns IntegrationDeviceResolution!

ArgumentTypeDescription
integrationString!Token of the integration, as it appears in the sender's URL.
schemeString!The alias scheme; it must be the one the integration's identity names.
secretString!The bearer token the sender presented.
valueString!The sender's identifier for the device.

restoreDeviceConfiguration​

Makes a device's desired configuration equal to the content of one of its own earlier revisions. The device's shared attributes for its declared keys are set to that revision's values (declared keys the revision does not carry are removed) and a NEW revision is minted and delivered; earlier revisions are never changed. Nothing is minted when the device already holds that content. The whole call is refused, writing nothing, with CONFIGURATION_KEY_UNDECLARED when the device's current profile version no longer declares a key the revision carries, CONFIGURATION_VALUE_TYPE_MISMATCH when a value cannot be carried as the type now declared, CONFIGURATION_TOO_LARGE over the document size limit, and CONFIGURATION_CONFLICT when another write to the device's configuration committed while this one ran (retrying is safe). An unknown device or revision is NOT_FOUND. Requires device:write.

Returns DeviceConfiguration!

ArgumentTypeDescription
deviceTokenString!Token of the device to restore.
revisionInt!The revision number whose content to restore.

revokeDeviceCertificate​

Revoke a certificate under a trust anchor, on the platform's own authority: the certificate is refused from the next connect on every replica, whether or not it is registered, and deleting its credential or its device does not let it register again. It applies to any certificate on a verified path, a leaf or an intermediate. Name it with exactly one of certificatePem and fingerprintSha256. Revoking one already revoked returns the existing entry. The anchor's own certificate is refused (disable the anchor instead). The live broker sessions of the devices the certificate affects are ended: those whose credential is this leaf, or every device under the anchor when the certificate is a CA that a registered credential's chain was seen to use. The result's sessionsEnded says whether that was confirmed.

Returns DeviceRevokedCertificate!

ArgumentTypeDescription
anchorTokenString!Token of the trust anchor.
certificatePemStringThe certificate, PEM. Exactly one of this and fingerprintSha256.
fingerprintSha256StringSHA-256 of the certificate, hex. Exactly one of this and certificatePem.
reasonCertificateRevocationReasonDefaults to UNSPECIFIED.

revokeProvisionedDevices​

Disable every credential the profile issued, and end those devices' live sessions. Returns how many credentials it disabled. The profile still accepts new registrations; pair it with rotateProvisioningProfileSecret after a leak. A revoked device stays refused until resetDeviceProvisioning.

Returns Int!

ArgumentTypeDescription
profileTokenString!Token of the profile.

rollbackAssetType​

No description yet.

Returns AssetType!

ArgumentTypeDescription
tokenString!No description yet.
versionInt!No description yet.

rollbackDeviceProfile​

Makes an existing published version the one devices use again. The draft and the version history are untouched, so a later version can be made active the same way. Fails if the profile or the version does not exist, and is refused with LIMIT_EXCEEDED when the version carries more calculated metrics than the tenant's tier allows (a version without any is never refused for this). Returns the updated profile. Requires device:write.

Returns DeviceProfile!

ArgumentTypeDescription
tokenString!Token of the profile.
versionInt!Number of the published version to make active.

rollbackEntityGroup​

No description yet.

Returns EntityGroup!

ArgumentTypeDescription
tokenString!No description yet.
versionInt!No description yet.

rotateIntegrationToken​

Replace an integration's bearer token with a new one, returned once. The old token stops working at once and there is no overlap.

Returns IntegrationSecretResult!

ArgumentTypeDescription
tokenString!Token of the integration.

rotateProvisioningProfileSecret​

Replace a profile's provision secret with a new one, returned once. The old secret stops working at once and there is no overlap (overlap is a second profile with its own key). Devices already registered are unaffected. This is also what brings a profile created before the server generated secrets into service.

Returns ProvisioningProfileSecretResult!

ArgumentTypeDescription
tokenString!Token of the profile.

setAlarmDisposition​

Labels the CURRENT cycle of an alarm with an operator's verdict (see AlarmDisposition) and returns the alarm. Only the current cycle can be labelled: once the alarm is raised again, the earlier cycle's disposition can be read but no longer written. Labelling changes nothing else about the alarm and emits no alarm event; labelling a cleared alarm is the ordinary case. Labelling a cycle again replaces its disposition. The labelling identity is the authenticated subject, recorded server-side. An alarm deleted while the label is being written answers NOT_FOUND, as an unknown token does.

Requires alarm:write. A member whose access is limited to some customers cannot label (FORBIDDEN): labels are ground truth for the tenant's rules.

Returns Alarm!

ArgumentTypeDescription
labelAlarmDispositionLabel!The verdict. A value that is not an AlarmDispositionLabel is refused when the request is validated.
noteStringWhy, at most 1000 characters. Empty or omitted is no note.
raisedTimeStringThe cycle being labelled, as the alarm's raisedTime was served. When given, the label is refused if the alarm has been raised again since ("alarm was modified by another writer; reload and try again"), so a verdict on one cycle never lands on the next. Omitted labels the alarm's current cycle.
tokenString!The alarm, by its token.

setAssetParent​

No description yet.

Returns EntityRelationship!

ArgumentTypeDescription
childTokenString!No description yet.
parentTokenString!No description yet.

setDeviceProfileConfigurationDeclaration​

Replaces a profile's draft device-visible configuration declaration with the given keys; an empty list withdraws it. At most 256 keys; each key must follow the attribute-key grammar, be unique, and carry a valid value type. The whole call is refused if any key is invalid. Published versions are immutable: this changes only what the next publish freezes. Returns the updated profile. Requires device:write.

Returns DeviceProfile!

ArgumentTypeDescription
keys[ConfigurationKeyInput!]!The complete new declaration, replacing the current one.
tokenString!Token of the profile.

setDeviceProfileDecoder​

Saves a profile's DRAFT payload decoder, replacing any earlier one. The document is parsed strictly (an unknown key is refused) and compiled in full against the profile's draft metrics: every scalar output key must be a declared, measured metric of the profile (a calculated metric cannot be one, and lorawan. keys are reserved for link metrics), a key may be written once per section, and every expression must type-check and fit its cost ceiling. The refusal is INVALID_DECODER and names the failing expression. A WASM document is refused with UNSUPPORTED_DECODER_KIND. Saved vectors need not pass here; they gate the publish. Published versions keep their decoder: this changes only what the next publish freezes. Returns the updated profile. Requires device:write.

Returns DeviceProfile!

ArgumentTypeDescription
documentString!The decoder document as JSON text, at most 32 KiB.
profileTokenString!Token of the profile.

setEntityAttribute​

No description yet.

Returns EntityAttribute!

ArgumentTypeDescription
requestEntityAttributeSetRequest!No description yet.

setEntityGroupAccessScope​

Make a group an access scope, or stop it being one, and return the group. A member whose access is limited to the group sees the devices in it at its active version, so publishing or rolling the group back changes what they see, and a device whose attributes move it into or out of the group appears or disappears for them without anyone editing the member. Records written about a device while it is in the group (events, alarms, commands, update assignments) stay visible to them afterwards. Only a published dynamic group of devices can be one (INVALID_VALUE otherwise), and a tenant may have at most 32 (LIMIT_EXCEEDED). Setting what is already set changes nothing. A deleted group's token is never reused, so a member limited to it is never handed a new group's devices. Requires device:write.

Returns EntityGroup!

ArgumentTypeDescription
enabledBoolean!True to make it an access scope, false to stop it being one.
tokenString!Token of the group.

setFacetKey​

No description yet.

Returns FacetKey!

ArgumentTypeDescription
requestFacetKeySetRequestNo description yet.

setInstalledPosition​

Records where a device or an asset was installed. Needs device:write. The position is refused, before anything is stored, when it is not a finite WGS84 coordinate. An entity outside the caller's scope is NOT_FOUND.

Returns InstalledPosition!

ArgumentTypeDescription
familyPositionFamily!Whether token names a device or an asset.
positionInstalledPositionInput!The position to record.
tokenString!The token of the device or asset.

unrevokeDeviceCertificate​

Remove a manual revocation. True if there was one. The certificate is admitted again from the next connect unless something else refuses it; nothing is kicked, and the device reconnects on its own.

Returns Boolean!

ArgumentTypeDescription
anchorTokenString!Token of the trust anchor.
fingerprintSha256String!SHA-256 of the certificate, hex.

updateArea​

No description yet.

Returns Area!

ArgumentTypeDescription
requestAreaUpdateRequest!No description yet.
tokenString!No description yet.

updateAreaType​

No description yet.

Returns AreaType!

ArgumentTypeDescription
requestAreaTypeUpdateRequest!No description yet.
tokenString!No description yet.

updateAsset​

No description yet.

Returns Asset!

ArgumentTypeDescription
requestAssetUpdateRequest!No description yet.
tokenString!No description yet.

updateAssetType​

No description yet.

Returns AssetType!

ArgumentTypeDescription
requestAssetTypeUpdateRequest!No description yet.
tokenString!No description yet.

updateCommandDefinition​

Partially updates a draft command definition and returns it. Fails if no command definition has the token. Requires device:write.

Returns CommandDefinition!

ArgumentTypeDescription
requestCommandDefinitionUpdateRequest!The fields to change.
tokenString!Token of the command definition to update.

updateCustomer​

No description yet.

Returns Customer!

ArgumentTypeDescription
requestCustomerUpdateRequest!No description yet.
tokenString!No description yet.

updateCustomerType​

No description yet.

Returns CustomerType!

ArgumentTypeDescription
requestCustomerTypeUpdateRequest!No description yet.
tokenString!No description yet.

updateDetectionRule​

No description yet.

Returns DetectionRule!

ArgumentTypeDescription
requestDetectionRuleUpdateRequest!No description yet.
tokenString!No description yet.

updateDevice​

Partially updates a device and returns it. Fails if no device has the token. Requires device:write.

Returns Device!

ArgumentTypeDescription
requestDeviceUpdateRequest!The fields to change.
tokenString!Token of the device to update.

updateDeviceCredential​

No description yet.

Returns DeviceCredential!

ArgumentTypeDescription
requestDeviceCredentialUpdateRequest!No description yet.
tokenString!No description yet.

updateDeviceProfile​

Partially updates a device profile's draft and returns it. Fails if no profile has the token. Requires device:write.

Returns DeviceProfile!

ArgumentTypeDescription
requestDeviceProfileUpdateRequest!The fields to change.
tokenString!Token of the profile to update.

updateDeviceTrustAnchor​

Update a trust anchor. Disabling one ends the live sessions of the devices that rely on it.

Returns DeviceTrustAnchor!

ArgumentTypeDescription
requestDeviceTrustAnchorUpdateRequest!The fields to change.
tokenString!Token of the anchor.

updateDeviceType​

Partially updates a device type and returns it. Fails if no device type has the token. Requires device:write.

Returns DeviceType!

ArgumentTypeDescription
requestDeviceTypeUpdateRequest!The fields to change.
tokenString!Token of the device type to update.

updateEntityGroup​

No description yet.

Returns EntityGroup!

ArgumentTypeDescription
requestEntityGroupUpdateRequest!No description yet.
tokenString!No description yet.

updateEntityRelationshipType​

No description yet.

Returns EntityRelationshipType!

ArgumentTypeDescription
requestEntityRelationshipTypeUpdateRequest!No description yet.
tokenString!No description yet.

updateGeoFence​

No description yet.

Returns GeoFence!

ArgumentTypeDescription
requestGeoFenceUpdateRequest!No description yet.
tokenString!No description yet.

updateIntegration​

Update an integration. Neither its token nor its type can be changed.

Returns Integration!

ArgumentTypeDescription
requestIntegrationUpdateRequest!The fields to change.
tokenString!Token of the integration.

updateMaintenanceWindow​

Update a maintenance window. A partial update: an omitted field is left alone. Commands already waiting on the window follow the new schedule within about a minute. Requires device:write.

Returns MaintenanceWindow!

ArgumentTypeDescription
requestMaintenanceWindowUpdateRequest!The fields to change.
tokenString!Token of the window to update.

updateMetricDefinition​

Partially updates a draft metric definition and returns it. Fails if no metric definition has the token. Requires device:write.

Returns MetricDefinition!

ArgumentTypeDescription
requestMetricDefinitionUpdateRequest!The fields to change.
tokenString!Token of the metric definition to update.

updateProvisioningProfile​

No description yet.

Returns ProvisioningProfile!

ArgumentTypeDescription
requestProvisioningProfileUpdateRequest!No description yet.
tokenString!No description yet.

Subscriptions​

alarmStream

alarmStream​

No description yet.

Returns AlarmEvent!

ArgumentTypeDescription
alarmKeyStringNo description yet.
anchorAlarmAnchorOnly events of alarms stamped with this anchor (see AlarmAnchor), judged on every pushed event, with the same limit to the subscriber's own devices as the queries. A customer outside the subscriber's access is refused when subscribing.
originatorTokenStringNo description yet.
originatorTypeStringNo description yet.
severityStringNo description yet.
stateStringNo description yet.

Objects​

ActiveProfileRules · ActiveProfileRulesPage · Alarm · AlarmAckRefusal · AlarmDeviceTypeCount · AlarmDisposition · AlarmDispositionSearchResults · AlarmEvent · AlarmSearchResults · AlarmSeverityCount · Area · AreaSearchResults · AreaType · AreaTypeSearchResults · Asset · AssetSearchResults · AssetType · AssetTypeSearchResults · AssetTypeVersion · AuditEvent · AuditEventSearchResults · BatchEnqueueRefusal · BulkAcknowledgeAlarmsResult · CalculatedBackfillRosterEntry · CalculatedBackfillRosterPage · CalculatedMetricPlan · CalculatedMetricPlanInput · CalculatedMetricPlanMetric · CommandChannelAccess · CommandDefinition · CommandDefinitionSearchResults · CommandDispatchHold · CommandDispatchImpact · CommandDispatchSchedule · CommandEnqueueVerdict · ConfigurationKey · Customer · CustomerSearchResults · CustomerType · CustomerTypeSearchResults · DetectionRule · DetectionRuleSearchResults · Device · DeviceAlias · DeviceClaim · DeviceCommandVocabulary · DeviceConfiguration · DeviceConfigurationReport · DeviceConfigurationRevision · DeviceConfigurationRevisionSearchResults · DeviceConstant · DeviceConstantsEntry · DeviceConstantsPage · DeviceCredential · DeviceCredentialSearchResults · DeviceDecoderPlan · DeviceGroupTargetPage · DeviceImportResult · DeviceImportRowResult · DeviceLocationCapability · DeviceLocationDeclaration · DeviceMetricVocabulary · DeviceProfile · DeviceProfileActivation · DeviceProfileActivationPage · DeviceProfileSearchResults · DeviceProfileVersion · DeviceReplaceResult · DeviceReplacement · DeviceReplacementSearchResults · DeviceRevocationList · DeviceRevocationListResult · DeviceRevokedCertificate · DeviceRevokedCertificateSearchResults · DeviceRosterEntry · DeviceRosterPage · DeviceScopeAnchors · DeviceSearchResults · DeviceThresholdAttribute · DeviceThresholdAttributePage · DeviceTrustAnchor · DeviceTrustAnchorSearchResults · DeviceType · DeviceTypeSearchResults · DisabledDevicePage · EntityAttribute · EntityAttributeSearchResults · EntityGroup · EntityGroupMember · EntityGroupMemberSearchResults · EntityGroupSearchResults · EntityGroupVersion · EntityRef · EntityRelationship · EntityRelationshipSearchResults · EntityRelationshipType · EntityRelationshipTypeSearchResults · FacetKey · FacetKeySearchResults · GeoFence · GeoFenceGeometry · GeoFenceManifestEntry · GeoFenceSearchResults · GeoFenceSetManifest · GeoFenceSetSnapshot · GeoFenceSnapshotEntry · GeoFenceSnapshotEntrySearchResults · InstalledPosition · Integration · IntegrationDecoderPlan · IntegrationDeviceResolution · IntegrationSearchResults · IntegrationSecretResult · MaintenanceWindow · MaintenanceWindowOpening · MaintenanceWindowSearchResults · MetricDefinition · MetricDefinitionSearchResults · MetricFormulaTest · PayloadDecoder · PayloadDecoderError · PayloadDecoderFunction · PayloadDecoderHealth · PayloadDecoderReading · PayloadDecoderSample · PayloadDecoderSkip · PayloadDecoderTestResult · PayloadDecoderVectorResult · ProvisioningProfile · ProvisioningProfileSearchResults · ProvisioningProfileSecretResult · PublishedCommand · PublishedMetric · PublishedProfileRule · SearchResultsPagination · SelectorPreview · UnregisteredIntegrationDevice · UnregisteredIntegrationDeviceSearchResults · X509Certificate

ActiveProfileRules​

object

No description yet.

FieldTypeDescription
activeSinceString!No description yet.
profileTokenString!No description yet.
rules[PublishedProfileRule!]!No description yet.
versionTokenString!No description yet.

ActiveProfileRulesPage​

object

No description yet.

FieldTypeDescription
entries[ActiveProfileRules!]!No description yet.
nextCursorStringNo description yet.

Alarm​

object

No description yet.

Implements Model, TokenReference, MetadataEntity

FieldTypeDescription
acknowledgedBoolean!No description yet.
acknowledgedByStringNo description yet.
acknowledgedTimeStringNo description yet.
alarmKeyString!No description yet.
clearedTimeStringNo description yet.
createdAtStringNo description yet.
deletedAtStringNo description yet.
dispositionAlarmDispositionThe disposition of this alarm's current cycle (see setAlarmDisposition), or null when nobody has labelled it. A disposition belongs to the cycle it was written on: when the alarm is raised again, the new cycle starts unlabelled and the earlier disposition stays with the earlier cycle, where alarmDispositions still finds it. A cycle is named by its raisedTime, so two cycles of one alarm raised at the same instant share one disposition.
idID!No description yet.
lastValueFloatNo description yet.
metadataStringNo description yet.
metricKeyString!No description yet.
originatorIdID!No description yet.
originatorTokenStringNo description yet.
originatorTypeString!No description yet.
raisedTimeStringNo description yet.
severityString!No description yet.
stateString!No description yet.
tokenString!No description yet.
updatedAtStringNo description yet.

AlarmAckRefusal​

object

No description yet.

FieldTypeDescription
codeString!No description yet.
reasonString!No description yet.
tokenString!No description yet.

AlarmDeviceTypeCount​

object

How many matching alarms are raised on devices of one type at one severity. A type with alarms at several severities has one entry per severity.

FieldTypeDescription
countInt!How many matching alarms have this device type and severity.
deviceTypeDeviceType!The device type the counted alarms' devices have.
severityString!The severity of the counted alarms.

AlarmDisposition​

object

An operator's verdict on one alarm cycle: was the condition real, and did it need anyone? It is ground truth for measuring a rule, not for operating one. A cycle is one raise of an alarm, named by the raisedTime the alarm had when it was labelled, so two cycles of one alarm raised at the same instant share one disposition.

FieldTypeDescription
alarmAlarmThe alarm itself, or null when the caller cannot read it any more (a member whose access is limited to some customers, after the alarm was raised again for another customer).
alarmIdID!The alarm the labelled cycle belongs to, by its id.
alarmTokenString!The alarm the labelled cycle belongs to, by its token. Always served, even when the caller can no longer read the alarm itself (see alarm).
labelAlarmDispositionLabel!The verdict. New values may be added in a later release; treat a value you do not know as unhandled.
noteStringWhy, in the labeller's words. Null when no note was given.
raisedTimeString!The labelled cycle: the alarm's raisedTime when the label was written.
recordedByStringThe authenticated subject that last wrote the label, recorded server-side.
recordedTimeString!When the label was last written.

AlarmDispositionSearchResults​

object

One page of alarm disposition labels, newest cycle first.

FieldTypeDescription
paginationSearchResultsPagination!Where this page sits in the full result set.
results[AlarmDisposition!]!The labels on this page.

AlarmEvent​

object

No description yet.

FieldTypeDescription
acknowledgedBoolean!No description yet.
acknowledgedByStringNo description yet.
alarmKeyString!No description yet.
alarmTokenString!No description yet.
eventTypeString!No description yet.
lastValueFloatNo description yet.
metricKeyString!No description yet.
occurredTimeString!No description yet.
originatorIdID!No description yet.
originatorTokenStringNo description yet.
originatorTypeString!No description yet.
previousSeverityStringNo description yet.
raisedTimeStringNo description yet.
severityString!No description yet.
stateString!No description yet.

AlarmSearchResults​

object

No description yet.

FieldTypeDescription
paginationSearchResultsPagination!No description yet.
results[Alarm!]!No description yet.

AlarmSeverityCount​

object

How many matching alarms are at one severity.

FieldTypeDescription
countInt!How many matching alarms have this severity.
severityString!The severity of the counted alarms.

Area​

object

No description yet.

Implements Model, TokenReference, NamedEntity, MetadataEntity, Entity

FieldTypeDescription
areaTypeAreaType!No description yet.
boundaryFenceGeoFenceThe geofence that bounds the area, or null when none does. Null for a caller limited to part of the tenant. Answers an error, not null, when the linked fence has been deleted.
createdAtStringNo description yet.
deletedAtStringNo description yet.
descriptionStringNo description yet.
idID!No description yet.
metadataStringNo description yet.
nameStringNo description yet.
tokenString!No description yet.
updatedAtStringNo description yet.

AreaSearchResults​

object

No description yet.

FieldTypeDescription
paginationSearchResultsPagination!No description yet.
results[Area!]!No description yet.

AreaType​

object

No description yet.

Implements Model, TokenReference, NamedEntity, BrandedEntity, MetadataEntity

FieldTypeDescription
backgroundColorStringNo description yet.
borderColorStringNo description yet.
createdAtStringNo description yet.
deletedAtStringNo description yet.
descriptionStringNo description yet.
foregroundColorStringNo description yet.
iconStringNo description yet.
idID!No description yet.
imageUrlStringNo description yet.
metadataStringNo description yet.
nameStringNo description yet.
tokenString!No description yet.
updatedAtStringNo description yet.

AreaTypeSearchResults​

object

No description yet.

FieldTypeDescription
paginationSearchResultsPagination!No description yet.
results[AreaType!]!No description yet.

Asset​

object

No description yet.

Implements Model, TokenReference, NamedEntity, MetadataEntity, Entity

FieldTypeDescription
assetTypeAssetType!No description yet.
createdAtStringNo description yet.
deletedAtStringNo description yet.
descriptionStringNo description yet.
idID!No description yet.
installedPositionInstalledPositionWhere the asset was installed. Needs location:installed:read (location:read includes it). Null for a caller without it, and null when no position was recorded.
metadataStringNo description yet.
nameStringNo description yet.
positionWithheldBoolean!Whether installedPosition is withheld from this caller; it concerns the installed position only. True for every asset a caller without location:installed:read (or location:read) reads, whether or not the asset has an installed position. It depends on the caller alone.
propertiesStringNo description yet.
tokenString!No description yet.
updatedAtStringNo description yet.

AssetSearchResults​

object

No description yet.

FieldTypeDescription
paginationSearchResultsPagination!No description yet.
results[Asset!]!No description yet.

AssetType​

object

No description yet.

Implements Model, TokenReference, NamedEntity, BrandedEntity, MetadataEntity

FieldTypeDescription
activeVersionIntNo description yet.
backgroundColorStringNo description yet.
borderColorStringNo description yet.
createdAtStringNo description yet.
deletedAtStringNo description yet.
descriptionStringNo description yet.
foregroundColorStringNo description yet.
iconStringNo description yet.
idID!No description yet.
imageUrlStringNo description yet.
metadataStringNo description yet.
nameStringNo description yet.
propertySchemaStringNo description yet.
tokenString!No description yet.
updatedAtStringNo description yet.

AssetTypeSearchResults​

object

No description yet.

FieldTypeDescription
paginationSearchResultsPagination!No description yet.
results[AssetType!]!No description yet.

AssetTypeVersion​

object

No description yet.

FieldTypeDescription
descriptionStringNo description yet.
labelStringNo description yet.
propertySchemaString!No description yet.
publishedAtString!No description yet.
publishedByStringNo description yet.
versionInt!No description yet.

AuditEvent​

object

No description yet.

FieldTypeDescription
actorString!No description yet.
categoryString!No description yet.
entityLabelStringNo description yet.
entityPkStringNo description yet.
idID!No description yet.
occurredTimeString!No description yet.
operationString!No description yet.
rowsAffectedInt!No description yet.
tableNameStringNo description yet.

AuditEventSearchResults​

object

No description yet.

FieldTypeDescription
paginationSearchResultsPagination!No description yet.
results[AuditEvent!]!No description yet.

BatchEnqueueRefusal​

object

One device a batch command check refused, and why.

FieldTypeDescription
codeString!Why the command was refused, as a stable code: DEVICE_NOT_FOUND, DEVICE_DISABLED, COMMAND_NOT_IN_VOCABULARY, PAYLOAD_SCHEMA_VIOLATION or COMMAND_DESTRUCTIVE_REFUSED, with the same meanings as in validateCommandEnqueue; commandDispatchSchedule adds WINDOW_AFTER_EXPIRY (the device type's maintenance window next opens after the command expires). Branch on this, not on reason.
deviceTokenString!The refused device's token, exactly as it appeared in the request.
reasonString!Why the command was refused, in words a person can act on. The wording may change.

BulkAcknowledgeAlarmsResult​

object

No description yet.

FieldTypeDescription
acknowledged[Alarm!]!No description yet.
refusals[AlarmAckRefusal!]!No description yet.

CalculatedBackfillRosterEntry​

object

One device of the profile a backfill walks.

FieldTypeDescription
constants[DeviceConstant!]!The requested constant names the device's metadata holds; empty when it holds none.
createdAtString!When the device was created, RFC 3339 in UTC.
deviceIdString!The device's id, the cursor's unit.
deviceTokenString!The device's token.

CalculatedBackfillRosterPage​

object

One page of the devices a calculated-metric backfill walks.

FieldTypeDescription
entries[CalculatedBackfillRosterEntry!]!The devices on this page, in device order.
nextCursorStringThe cursor to pass as afterId for the next page; null when the walk is complete.
totalFloatHow many devices the whole walk covers; set on the first page only, null after.

CalculatedMetricPlan​

object

The calculated metrics of one published profile version, as the live resolver runs them.

FieldTypeDescription
activeSinceStringWhen the version became active; null unless it is the profile's active version.
calculated[CalculatedMetricPlanMetric!]!The calculated metrics in the order the resolver evaluates them: a formula follows the ones it reads, and by key otherwise. A metric whose data type no formula can produce comes last, by key.
constantKeys[String!]!The device constants the formulas read together, sorted and distinct.
measured[CalculatedMetricPlanInput!]!The measured metrics the formulas may read, in declaration order.
versionInt!The version number.
versionTokenString!The version's token, profileToken@version.

CalculatedMetricPlanInput​

object

One measured metric a calculated metric's formula may read.

FieldTypeDescription
dataTypeString!The metric's data type: DOUBLE, INT or BOOLEAN.
keyString!The metric's key.

CalculatedMetricPlanMetric​

object

One calculated metric of a published profile version.

FieldTypeDescription
changedSinceEarlierBoolean!True when an earlier published version calculated this key under a different expression, data type or bounds, so values computed then differ from what this version's formula gives.
classifierFloat!The metric definition's id, stamped on every value of it as its classifier.
constants[String!]The device constants the formula reads, including through the calculated metrics it reads, sorted and distinct. Null exactly when inputs is.
dataTypeString!The declared result type: DOUBLE, INT or BOOLEAN.
expressionString!The formula source, a CEL expression over the version's other metrics.
inputs[String!]The metric keys the formula reads directly, measured or calculated, as this version compiles it. Null when the metric cannot run in this version (its formula does not compile here, or no formula can produce its data type), so it computes from nothing.
keyString!The metric's key.
maxValueFloatThe inclusive upper bound a computed value must meet, if the definition has one.
measuredInputs[String!]The measured metrics the formula's value is computed from, including those read through the calculated metrics it reads, in the order of measured. Null exactly when inputs is.
minValueFloatThe inclusive lower bound a computed value must meet, if the definition has one.
nameSharedWithOtherProfilesBoolean!True when another device profile of the tenant declares a metric (measured or calculated) with this key in its active version. Tenant-wide readings counted by metric name then include that profile's readings, so a count under this name cannot show this formula is working. Also true when the check could not be completed: more candidate versions than its bound, or another profile's version that could not be read.
newInVersionBoolean!True when the previous published version did not calculate this key (a first calculation, or one reinstated after a version without it).
unitStringThe unit stamped on computed values, if the definition has one.

CommandChannelAccess​

object

What the HTTP command endpoints learn about a device that proved its access token.

FieldTypeDescription
commandChannelStringThe type's command channel: PUBLISH, HTTP_PULL, or null for the default (PUBLISH).
deviceTokenString!Token of the device the access token belongs to.
deviceTypeTokenString!Token of the device's type.

CommandDefinition​

object

A command the devices of a profile accept, with the parameters its payload must satisfy. Once the profile is published, a command sent to such a device must use one of the published keys, and its payload is checked against the parameters.

Implements Model, TokenReference, NamedEntity, MetadataEntity

FieldTypeDescription
commandKeyString!The key used to send this command, unique within the profile. Letters, digits, hyphens and underscores, starting with a letter or digit; at most 128 characters. Dots may separate namespaced segments (for example sparkplug.write): each segment follows the same rule, and a leading, trailing or doubled dot is refused.
createdAtStringWhen the command definition was created, as an RFC 3339 timestamp.
deletedAtStringAlways null: deleted command definitions are not returned.
descriptionStringFree-text description, up to 1024 characters. Null when none is set.
deviceProfileDeviceProfile!The profile this command is declared on.
idID!Server-assigned numeric identifier, as a string. Address a command definition by its token instead where you can.
impactString!How disruptive the command is to the device's work: NORMAL (a read or a benign write), DISRUPTIVE (interrupts it, such as a reboot) or DESTRUCTIVE (erases state, such as a wipe). DISRUPTIVE and DESTRUCTIVE commands wait for the device type's maintenance window when it has one; NORMAL commands never do.
metadataStringCaller-defined metadata as a JSON document, or null when none is set.
nameStringHuman-readable name, up to 128 characters. Null when none is set.
parameterSchemaStringThe command's parameters as a JSON array of parameter descriptors, or null when the command takes no structured arguments, in which case payloads are not checked.
tokenString!Identifier of the command definition, unique within the tenant.
updatedAtStringWhen the command definition was last written, as an RFC 3339 timestamp.

CommandDefinitionSearchResults​

object

One page of command definitions matching a search.

FieldTypeDescription
paginationSearchResultsPagination!Where this page sits in the full result set.
results[CommandDefinition!]!The command definitions on this page.

CommandDispatchHold​

object

A command bound to one opening of its device type's maintenance window: it may be sent only between dispatchAfter and dispatchUntil. When the window is open now, dispatchAfter is already past and the command may be sent at once, but only until the window closes.

FieldTypeDescription
deviceTokenString!Token of the device the command is for.
dispatchAfterString!The earliest instant the command may be sent, as an RFC 3339 timestamp.
dispatchUntilString!When the opening closes, as an RFC 3339 timestamp. The command may not be sent at or after it.
windowTokenString!Token of the maintenance window that gates the command.

CommandDispatchImpact​

object

One device's command impact, decided together with its dispatch schedule.

FieldTypeDescription
deviceTokenString!Token of the device.
impactString!NORMAL, DISRUPTIVE or DESTRUCTIVE.

CommandDispatchSchedule​

object

The maintenance-window part of an enqueue decision for one or many devices: which commands must wait, and which are refused because the window opens only after they expire.

FieldTypeDescription
holds[CommandDispatchHold!]!Commands gated by a window, whether it is open now or not. A device not listed here and not refused may be sent to at any time.
impacts[CommandDispatchImpact!]!For every device that exists, is enabled and whose device type's current profile version defines the command, the impact (NORMAL, DISRUPTIVE or DESTRUCTIVE) it carries. It is the classification the maintenance-window gate decided on, so a transport that gates on impact reads the same answer. A device that does not exist, is disabled, or whose type does not define the command has no entry.
refusals[BatchEnqueueRefusal!]!Devices refused with the stable code WINDOW_AFTER_EXPIRY: the window next opens after the command expires, so it could only lapse unsent. Branch on code, not reason.
undefined[String!]!Devices that exist and are enabled, but whose device type's current profile version does not define this command at all.
ungated[String!]!Devices that exist, are enabled, and whose device type does not gate this command: no maintenance window, or a command that is not DISRUPTIVE or DESTRUCTIVE. Asked with alreadyHeld, only a device type with no maintenance window makes a device ungated. A device in none of the four lists does not exist or is disabled, and nothing is decided about it.

CommandEnqueueVerdict​

object

Whether a command may be sent to a device. A refusal is reported here rather than as a GraphQL error; an error means the check itself could not be made.

FieldTypeDescription
allowedBoolean!True when the command may be sent.
codeStringWhy the command was refused, as a stable code; null when allowed. One of DEVICE_NOT_FOUND (no device has the token), DEVICE_DISABLED (the device is disabled and accepts no commands), COMMAND_NOT_IN_VOCABULARY (the device's published profile declares commands and this key is not one of them) PAYLOAD_SCHEMA_VIOLATION (the payload does not satisfy the command's parameters) or COMMAND_DESTRUCTIVE_REFUSED (a raw execute of an operation that wipes the device, such as LwM2M Factory Reset). Branch on this, not on reason.
reasonStringWhy the command was refused, in words a person can act on; null when allowed. The wording may change; use code to decide what to do.

ConfigurationKey​

object

One shared attribute key declared as device-visible configuration on a device profile.

FieldTypeDescription
descriptionStringAn optional human-readable note.
keyString!The shared attribute key.
valueTypeString!How the key's value is typed: STRING, LONG, DOUBLE, BOOLEAN or JSON.

Customer​

object

No description yet.

Implements Model, TokenReference, NamedEntity, MetadataEntity, Entity

FieldTypeDescription
createdAtStringNo description yet.
customerTypeCustomerType!No description yet.
deletedAtStringNo description yet.
descriptionStringNo description yet.
idID!No description yet.
metadataStringNo description yet.
nameStringNo description yet.
tokenString!No description yet.
updatedAtStringNo description yet.

CustomerSearchResults​

object

No description yet.

FieldTypeDescription
paginationSearchResultsPagination!No description yet.
results[Customer!]!No description yet.

CustomerType​

object

No description yet.

Implements Model, TokenReference, NamedEntity, BrandedEntity, MetadataEntity

FieldTypeDescription
backgroundColorStringNo description yet.
borderColorStringNo description yet.
createdAtStringNo description yet.
deletedAtStringNo description yet.
descriptionStringNo description yet.
foregroundColorStringNo description yet.
iconStringNo description yet.
idID!No description yet.
imageUrlStringNo description yet.
metadataStringNo description yet.
nameStringNo description yet.
tokenString!No description yet.
updatedAtStringNo description yet.

CustomerTypeSearchResults​

object

No description yet.

FieldTypeDescription
paginationSearchResultsPagination!No description yet.
results[CustomerType!]!No description yet.

DetectionRule​

object

No description yet.

Implements Model, TokenReference, NamedEntity, MetadataEntity

FieldTypeDescription
authoringGraphStringNo description yet.
createdAtStringNo description yet.
definitionString!No description yet.
deletedAtStringNo description yet.
descriptionStringNo description yet.
deviceProfileDeviceProfile!No description yet.
enabledBoolean!No description yet.
entityGroupTokenStringNo description yet.
entityGroupVersionIntNo description yet.
idID!No description yet.
metadataStringNo description yet.
nameStringNo description yet.
tokenString!No description yet.
updatedAtStringNo description yet.

DetectionRuleSearchResults​

object

No description yet.

FieldTypeDescription
paginationSearchResultsPagination!No description yet.
results[DetectionRule!]!No description yet.

Device​

object

A device: one connected thing the platform receives events from and sends commands to. What it measures and accepts comes from its device type's profile.

Implements Model, TokenReference, NamedEntity, MetadataEntity, Entity

FieldTypeDescription
aliases[DeviceAlias!]The names a sender other than the platform knows this device by, such as a LoRaWAN DevEUI, ordered by scheme. An inbound integration finds the device by one of these. Empty when the device has none. Null, and never an empty list, for a caller limited to part of the tenant: aliases are not shown to it.
childrenDeviceSearchResults!The devices behind this device, one page at a time. Empty unless the device is a gateway. Requires device:read.

Arguments:
pagination: PaginationInput! — Which page to return.
createdAtStringWhen the device was created, as an RFC 3339 timestamp.
deletedAtStringAlways null: deleted devices are not returned.
descriptionStringFree-text description, up to 1024 characters. Null when none is set.
deviceTypeDeviceType!The device's type.
disabledAtStringWhen the device was disabled, as an RFC 3339 timestamp; null while it is enabled.
enabledBoolean!False when the device has been disabled. A disabled device's events are discarded rather than stored, it cannot open a new broker connection, and commands sent to it are refused with DEVICE_DISABLED. Its data, credentials and configuration are kept.
expectedProvisioningProfileProvisioningProfileThe provisioning profile this device is earmarked for, or null when it is earmarked for none (or the profile was deleted). Only that profile may adopt it when it registers itself. Requires device:read, unscoped.
externalIdStringOptional business identifier you assign, such as a serial number or VIN, up to 256 characters. Unique within the tenant when set. It is only a lookup key: devices are not addressed or authenticated by it.
gatewayDeviceThe gateway this device is behind, or null when it is behind none. Only that gateway's credential may publish this device's telemetry on the gateway's own topics; the device's own credential still works as before.
idID!Server-assigned numeric identifier, as a string. Address a device by its token instead where you can.
installedPositionInstalledPositionWhere the device was installed, for a device that is fixed in place. Needs location:installed:read (location:read includes it). Null for a caller without it, and null when no position was recorded. This is installation data only: it never falls back to a position the device reported, even when the device also reports GPS.
metadataStringCaller-defined metadata as a JSON document, or null when none is set.
nameStringHuman-readable name, up to 128 characters. Null when none is set.
positionWithheldBoolean!Whether installedPosition is withheld from this caller. It concerns the INSTALLED position only, not any position the device reports. True for every device a caller without location:installed:read (or location:read) reads, whether or not the device has an installed position, and false for every device a caller with it reads. It depends on the caller alone, so it does not reveal whether a position exists.
tokenString!Identifier of the device, unique within the tenant. It cannot be changed after the device is created.
updatedAtStringWhen the device was last written, as an RFC 3339 timestamp.

DeviceAlias​

object

One name a sender other than the platform knows a device by. The pair is unique within the tenant, and a device has at most one value per scheme.

FieldTypeDescription
schemeString!Whose vocabulary the value is in: lorawan.deveui, tts.device-id, or custom.<name> for a name you chose.
valueString!The value in its stored spelling. A lorawan.deveui value is 16 upper-case hexadecimal digits whatever case it was written in, and a tts.device-id value is lower case.

DeviceClaim​

object

No description yet.

Implements Model

FieldTypeDescription
claimedByCustomerCustomerNo description yet.
claimedTimeStringNo description yet.
createdAtStringNo description yet.
deletedAtStringNo description yet.
deviceDevice!No description yet.
expiresAtStringNo description yet.
idID!No description yet.
statusString!No description yet.
updatedAtStringNo description yet.

DeviceCommandVocabulary​

object

The commands a device currently accepts, from its profile's active published version.

FieldTypeDescription
commands[PublishedCommand!]!The accepted commands; empty when not constrained.
constrainedBoolean!True when the device accepts only the listed commands. False when its published profile declares no commands, or it has no published profile: any command key is then accepted, and commands is empty.

DeviceConfiguration​

object

A device's configuration: the latest revision it should hold, what it last reported, and whether the two agree.

FieldTypeDescription
desiredDeviceConfigurationRevisionThe latest minted revision, or null when none has been minted for this device.
invalid[String!]!Declared keys whose stored value cannot be carried as the declared value type (written with another type, or unparseable). They are left out of the document.
pendingBoolean!True when a revision exists and the device has not reported APPLIED for that same revision with that same digest. Equal values under a different revision or digest do not count as applied.
reportedDeviceConfigurationReportThe device's last report, or null when it has never reported.
staleBoolean!True when the document the device's current profile declaration and shared attributes would build differs from the latest revision - for example after a profile publish declared new keys. A newer revision is minted when a declared key is next written or the device next synchronizes.
undeclared[String!]!The device's shared attribute keys that its declaration does not name. They are never part of the document.

DeviceConfigurationReport​

object

The configuration state a device last reported. Written only from the device's own reports; no mutation sets it.

FieldTypeDescription
digestStringThe digest the device reported for that revision.
errors[String!]!The device's reasons for a REJECTED report; empty otherwise.
lastSyncAtStringWhen the device last asked for its configuration.
reportedAtStringWhen the device made the report.
revisionIntThe revision the device reported, or null when it has not reported one.
statusStringRECEIVED, APPLIED or REJECTED.

DeviceConfigurationRevision​

object

One immutable revision of a device's configuration document: the values of the shared attribute keys its profile's active published version declares as device-visible. Revisions are append-only; a new one is minted only when the document changes.

FieldTypeDescription
actorString!The authenticated subject whose attribute change minted the revision; empty when none was recorded.
createdAtStringWhen the revision was minted.
digestString!"sha256:" followed by the lowercase hex SHA-256 of the document bytes. A device converges on a revision by reporting this revision number and this digest. A device hashes the bytes it receives and never re-serializes them to check the digest.
documentString!The document as canonical JSON text: an object of declared key to typed value with keys sorted. These are exactly the bytes the digest covers.
revisionInt!The revision number: 1 for the device's first document and one higher for each later one. A number is never reused for the same device.

DeviceConfigurationRevisionSearchResults​

object

A page of a device's configuration revisions, newest first.

FieldTypeDescription
paginationSearchResultsPagination!Where this page sits in the device's whole revision history.
results[DeviceConfigurationRevision!]!The revisions on this page, highest revision number first.

DeviceConstant​

object

One constant a device holds under a requested name.

FieldTypeDescription
keyString!The name.
numberFloatThe value, or null when the device's metadata holds the name but not a finite number (a string, a boolean, null, an object): present and unusable, which is not absent.

DeviceConstantsEntry​

object

The requested constants one device holds.

FieldTypeDescription
constants[DeviceConstant!]!The requested names the device's metadata holds.
deviceTokenString!The device's token.

DeviceConstantsPage​

object

One page of device constants.

FieldTypeDescription
entries[DeviceConstantsEntry!]!The devices on this page that hold at least one requested name.
nextCursorStringThe cursor to pass as afterId for the next page; null when the walk is complete.

DeviceCredential​

object

No description yet.

Implements Model, TokenReference, MetadataEntity

FieldTypeDescription
certificateX509CertificateThe certificate an X509_CERTIFICATE credential pins, or null for any other type. Requires device:read, unscoped.
createdAtStringNo description yet.
credentialIdString!What the device presents. For MQTT_BASIC, the username. For ACCESS_TOKEN, the access token itself ONLY in the response to the create, update or replacement that set it, which is the one time it can be read: the platform stores an access token as a keyed digest and cannot return it afterwards. Every later read returns a fingerprint that identifies the credential and cannot be presented as the token. If the token is lost, set a new one with updateDeviceCredential. For X509_CERTIFICATE it is the SHA-256 of the device certificate (hex), computed by the server; it is public and is not something a device presents.
credentialTypeString!No description yet.
credentialValueStringNo description yet.
deletedAtStringNo description yet.
deviceDevice!No description yet.
enabledBoolean!No description yet.
expiresAtStringNo description yet.
idID!No description yet.
metadataStringNo description yet.
provisioningProfileProvisioningProfileThe provisioning profile whose registration issued this credential, or null for a credential an operator created. Requires device:read, unscoped.
tokenString!No description yet.
updatedAtStringNo description yet.

DeviceCredentialSearchResults​

object

No description yet.

FieldTypeDescription
paginationSearchResultsPagination!No description yet.
results[DeviceCredential!]!No description yet.

DeviceDecoderPlan​

object

What the ingest path needs to know about the payload decoder of a device's type.

FieldTypeDescription
composedCostInt!The part of the static worst-case cost that does not depend on the size of the uplink.
inputPayloadDecoderInputThe input an uplink must carry for the decoder to run; null when there is no decoder.
maxReadingsInt!The most readings one decode produces; 0 when there is no decoder this build can run.
parsesJsonBoolean!Whether the decoder reads the JSON body, parsed and priced by size.
presentBoolean!Whether the active published version declares a decoder, usable or not.
profileVersionTokenString!The profile version the answer is for, as "{profile}@{version}"; empty when there is no decoder.

DeviceGroupTargetPage​

object

One page of the devices an entity group contains, for use as the target of a command.

FieldTypeDescription
codeStringWhy the group was refused, as a stable code; null when not rejected. One of GROUP_NOT_FOUND, GROUP_NOT_A_DEVICE_GROUP (it contains something other than devices), GROUP_NOT_PUBLISHED (a dynamic group that was never published), GROUP_VERSION_NOT_FOUND (the requested version does not exist) or GROUP_NOT_VERSIONED (a version was requested for a static group).
deviceTokens[String!]!The device tokens on this page, in ascending order of the devices' ids.
nextCursorStringOpaque cursor to pass as afterId for the next page. Null when this page holds fewer tokens than the limit; a full page always carries a cursor, so a walk can end with an empty page.
reasonStringWhy the group was refused, in words a person can act on; null when not rejected.
rejectedBoolean!True when the group cannot be a command target. code and reason then explain why, and the empty deviceTokens list does not mean the group has no members.
resolvedVersionIntThe dynamic group's published version this page was resolved from; null for a static group.

DeviceImportResult​

object

The per-row outcomes of an importDevices call, with their totals.

FieldTypeDescription
conflictInt!Rows that clash with an existing device or one of its unique values; nothing was written for them.
createdInt!Rows whose device was created (on a dry run: would be created).
dryRunBoolean!True when nothing was written.
existsInt!Rows whose device already exists exactly as described, so nothing was written.
invalidInt!Rows refused because a value is malformed, missing or duplicated within the file.
refusedInt!Rows refused because what they ask for is not supported, such as an unsupported credential type.
rows[DeviceImportRowResult!]!One outcome per request row, in request order.

DeviceImportRowResult​

object

The outcome of one row of an import.

FieldTypeDescription
codeStringA machine-readable reason for every outcome but CREATED and EXISTS: CONFLICT, INVALID_VALUE, NOT_FOUND, LIMIT_EXCEEDED, DUPLICATE_IN_FILE or UNSUPPORTED.
messageStringWhat is wrong. It never contains a credential secret, but may repeat a token the row supplied, such as a device type token.
outcomeDeviceImportOutcome!What happened to this row: created, already present unchanged, in conflict with an existing device, invalid, or refused.
rowInt!The row's position in the request, starting at 1.
tokenString!The row's device token.

DeviceLocationCapability​

object

Whether a device reports its own position, according to the active published version of its profile (not the draft). Location data is accepted whether or not it is declared, so an undeclared device may still have stored positions.

FieldTypeDescription
declarationDeviceLocationDeclarationThe declaration, or null when declared is false. An empty object is a real answer: the device reports position and no expectations are stated.
declaredBoolean!True when the published version declares that the device reports position. False when the device's type has no profile, the profile was never published, or the published version declares nothing.

DeviceLocationDeclaration​

object

A statement that devices report their own position, with what to expect of it. The object being present is the statement; both fields are optional, so an empty object still means the devices report position. It is descriptive only: location data is accepted and stored whether or not a declaration exists.

FieldTypeDescription
expectedAccuracyMetersFloatHorizontal accuracy to expect from these devices, in metres, or null when not stated. Descriptive only: a less accurate fix is still stored unchanged.
expectedUpdateIntervalSecondsIntHow often a position fix is expected, in seconds, or null when not stated. Descriptive only: nothing is raised when fixes arrive less often.

DeviceMetricVocabulary​

object

The metrics a device's measurements are validated against, from the active published version of its profile (not the draft).

FieldTypeDescription
metrics[PublishedMetric!]!The published metrics. Empty when the device's type has no profile, the profile was never published, or the published version declares no metric. Empty does not mean the device may send nothing: a measurement whose key is not declared is accepted without validation, provided its value is a number.

DeviceProfile​

object

The capability contract a device type adopts: the metrics its devices report, the commands they accept, the detection rules evaluated against them and whether they report their own position. What you edit is a draft; publishDeviceProfile freezes the draft into a numbered version, and devices use only the active published version. Many device types may share one profile.

Implements Model, TokenReference, NamedEntity, MetadataEntity

FieldTypeDescription
activationsDeviceProfileActivationPage!The profile's activation log, newest first: every time a version became the one devices resolve, by publish or by rollback. Use it to find which version was active at a given time: it is the entry with the latest activatedAt not after that time. The log begins when the platform release that introduced it was installed, so a profile last activated before that has no entry for that activation; treat the absence as unknown, not as inactive. Page with first and after. Requires device:read.

Arguments:
after: String — The nextCursor of the previous page. Omit it to start at the newest entry. A malformed cursor fails the request.
first: Int — Maximum number of entries to return, at least 1. Omitted, or above 1000, it is 1000; below 1 is refused.
activeProfileVersionDeviceProfileVersionThe published version a device currently resolves through this profile, with the content frozen into it, or null until the profile is first published. Read the declaration devices actually see from here, not from the draft fields above.
activeVersionIntThe published version devices currently use, or null if the profile has never been published. Until then devices of this profile have no declared metrics or commands.
categoryStringFunctional class of the devices, such as thermostat or meter: free text, up to 64 characters. facetValues lists the values already in use.
commandDefinitions[CommandDefinition!]!The command definitions in the draft. Devices use the active published version, so a change here takes effect only when the profile is published.
configurationDeclaration[ConfigurationKey!]!The profile's DRAFT device-visible configuration declaration: the shared attribute keys a device of this profile may see. Empty when nothing is declared, in which case a device sees an empty document. Like every draft field, it reaches devices only when the profile is published; the declaration frozen into each published version never changes.
createdAtStringWhen the profile was created, as an RFC 3339 timestamp.
decoderPayloadDecoderThe profile's DRAFT payload decoder: the rules that turn a binary frame or a webhook's JSON into measurements, or null when none is saved. Like every draft field, it reaches devices only when the profile is published; the decoder frozen into each published version never changes.
deletedAtStringAlways null: deleted profiles are not returned.
descriptionStringFree-text description, up to 1024 characters. Null when none is set.
detectionRules[DetectionRule!]!The detection rules in the draft. Devices use the active published version, so a change here takes effect only when the profile is published.
deviceTypeCountInt!Number of device types that currently adopt this profile.
idID!Server-assigned numeric identifier, as a string. Address a profile by its token instead where you can.
locationDeviceLocationDeclarationThe draft position declaration: present when devices of this profile report their own position, null when they do not. Like the other draft content, it reaches devices only when the profile is published.
metadataStringCaller-defined metadata as a JSON document, or null when none is set.
metricDefinitions[MetricDefinition!]!The metric definitions in the draft. Devices use the active published version, so a change here takes effect only when the profile is published.
nameStringHuman-readable name, up to 128 characters. Null when none is set.
tokenString!Identifier of the profile, unique within the tenant. It can be changed with renameDeviceProfile only while the profile has never been published and no device type currently adopts it.
updatedAtStringWhen the profile was last written, as an RFC 3339 timestamp.

DeviceProfileActivation​

object

One moment a profile version became the version devices resolve.

FieldTypeDescription
activatedAtString!When it became active, as an RFC 3339 timestamp in UTC. For a rollback this is when the rollback happened, not when the version was published.
activatedByStringWho did it: their username, or their email when there is no username. Null when not recorded.
kindString!Why it became active: PUBLISH when the version was just published, ROLLBACK when an earlier version was made active again.
versionInt!The version that became active.

DeviceProfileActivationPage​

object

One page of a profile's activation log.

FieldTypeDescription
entries[DeviceProfileActivation!]!The entries on this page, newest first.
nextCursorStringThe cursor to pass as after for the next page; null when this is the last page.

DeviceProfileSearchResults​

object

One page of device profiles matching a search.

FieldTypeDescription
paginationSearchResultsPagination!Where this page sits in the full result set.
results[DeviceProfile!]!The device profiles on this page.

DeviceProfileVersion​

object

An immutable, published snapshot of a profile's metric, command and detection-rule definitions and its position declaration. Versions are never deleted while the profile exists; rollbackDeviceProfile makes an earlier one active again.

FieldTypeDescription
commands[PublishedCommand!]!The commands frozen into this version, each with the impact it was published with. Empty when the version declares none, in which case a device accepts any command key. It never changes after publication.
configurationDeclaration[ConfigurationKey!]!The device-visible configuration declaration frozen into this version: the shared attribute keys a device of the profile may see. Empty when the version declared nothing, including every version published before declarations existed. It never changes after publication.
decoderPayloadDecoderThe payload decoder frozen into this version, or null when it declared none, including every version published before decoders existed. It never changes after publication.
descriptionStringOptional notes given at publish time.
labelStringOptional label given at publish time, such as a release name. Not interpreted.
metrics[PublishedMetric!]!The metrics frozen into this version, in declaration order: what a device's measurements are validated against while this version is active. Calculated metrics are included and marked. It never changes after publication.
publishedAtString!When the version was published, as an RFC 3339 timestamp.
publishedByStringWho published it: their username, or their email when there is no username.
thingModelString!This version as a W3C Web of Things Thing Model (TD 1.1), as JSON-LD text. Each metric is a read-only, observable property typed from its data type, with its unit, bounds, allowed values and descriptor (as the property's @type); each command is an action whose input is its typed parameters. A Thing Model describes every device of the profile, so it carries no device address, protocol binding or security. Detection rules, the location and configuration declarations, and metadata are not part of it. The title and description are the profile's current ones, so the text changes only when those do. A version holding a constraint a Thing Model cannot express exactly (allowed values that are not text, or that repeat once typed; bounds on a non-numeric metric) is refused with an error rather than exported without it. A descriptor is emitted as written, so it should be an absolute IRI or a prefixed term the consumer knows.
versionInt!Version number: 1 for the first publish of the profile, increasing by one with each publish.

DeviceReplaceResult​

object

No description yet.

FieldTypeDescription
deviceDevice!No description yet.
newCredentialDeviceCredential!No description yet.
replacementDeviceReplacement!No description yet.
retiredCredentialTokens[String!]!No description yet.

DeviceReplacement​

object

No description yet.

FieldTypeDescription
actorString!No description yet.
createdAtStringNo description yet.
deviceDevice!No description yet.
idID!No description yet.
newCredentialTokenString!No description yet.
newCredentialTypeString!No description yet.
occurredTimeString!No description yet.
reasonStringNo description yet.
retiredCredentialTokens[String!]!No description yet.
unitIdentifierStringNo description yet.

DeviceReplacementSearchResults​

object

No description yet.

FieldTypeDescription
paginationSearchResultsPagination!No description yet.
results[DeviceReplacement!]!No description yet.

DeviceRevocationList​

object

The current CRL of one issuer under a trust anchor. Its entries are listed through deviceRevokedCertificates.

FieldTypeDescription
crlNumberString!The CRL number, as a decimal string (up to 20 octets).
crlSha256String!SHA-256 of the CRL's DER, hex.
entryCountInt!How many certificates the list revokes.
issuerKeyString!SHA-256 of the signer's public key, hex. With issuerName, identifies the issuer.
issuerNameString!SHA-256 of the signer's subject, hex.
issuerSubjectString!The CRL signer's subject, for display.
nextUpdateString!The CRL's nextUpdate, as an RFC 3339 timestamp.
sourceString!UPLOAD.
statusRevocationStatus!The list's freshness now.
thisUpdateString!The CRL's thisUpdate, as an RFC 3339 timestamp.

DeviceRevocationListResult​

object

The outcome of storing a revocation list.

FieldTypeDescription
listDeviceRevocationList!The list now in force for the issuer.
newlyRevokedInt!How many certificates the list revokes that the issuer's previous list did not.
sessionsEndedBoolean!True when the live broker sessions of the devices the list newly revokes were confirmed ended. False when the list is stored and new connects are refused, but a session already open could not be confirmed ended: the retry (automatic, and on repeating the upload, which is idempotent) ends it, or its token expires.
unchangedBoolean!True when this very CRL was already the current list and nothing was written.

DeviceRevokedCertificate​

object

One revoked certificate in a trust anchor's revocation store. A MANUAL entry names a certificate by fingerprint and refuses it wherever it appears on a verified path (a leaf or an intermediate), registered or not, whatever later becomes of its credential or its device.

FieldTypeDescription
fingerprintSha256StringSHA-256 of the certificate, hex. Set on a MANUAL entry.
issuerKeyStringSHA-256 of the issuing CA's public key, hex. Set on a CRL entry.
kindString!MANUAL (revoked here, by fingerprint) or CRL (from a stored CA revocation list).
reasonCertificateRevocationReason!Why it was revoked.
revokedAtString!When it was revoked, as an RFC 3339 timestamp.
serialStringThe certificate's serial number, hex. Set on a CRL entry.
sessionsEndedBooleanSet only on the result of revokeDeviceCertificate, null everywhere else. True when the live broker sessions of the devices the revocation affects were confirmed ended. False when the revocation is saved and new connects are refused, but a session already open could not be confirmed ended: it may still be publishing until the retry (automatic, and on repeating the mutation, which is idempotent) ends it, or its token expires.

DeviceRevokedCertificateSearchResults​

object

A page of revoked certificates.

FieldTypeDescription
paginationSearchResultsPagination!Where this page sits in the whole result.
results[DeviceRevokedCertificate!]!The entries on this page.

DeviceRosterEntry​

object

No description yet.

FieldTypeDescription
deviceTokenString!No description yet.
expectedSinceString!No description yet.
profileTokenString!No description yet.

DeviceRosterPage​

object

No description yet.

FieldTypeDescription
entries[DeviceRosterEntry!]!No description yet.
nextCursorStringNo description yet.

DeviceScopeAnchors​

object

The anchors of one device: what decides which members limited to part of the tenant can see records about it.

FieldTypeDescription
anchors[String!]!One entry per tracked relationship from the device, written as type:token (for example customer:acme). Empty when the device has no tracked relationship.
deviceTokenString!The device's token, as it was named in the request.

DeviceSearchResults​

object

One page of devices matching a search.

FieldTypeDescription
paginationSearchResultsPagination!Where this page sits in the full result set.
results[Device!]!The devices on this page.

DeviceThresholdAttribute​

object

No description yet.

FieldTypeDescription
deviceTokenString!No description yet.
keyString!No description yet.
scopeString!No description yet.
updatedAtString!No description yet.
valueFloat!No description yet.

DeviceThresholdAttributePage​

object

No description yet.

FieldTypeDescription
entries[DeviceThresholdAttribute!]!No description yet.
nextCursorStringNo description yet.

DeviceTrustAnchor​

object

A CA certificate a tenant trusts to vouch for its devices' client certificates. It is public material. An X509_CERTIFICATE credential, and a certificate provisioning profile, name the anchor their chain must reach, and it is checked at EVERY connect: disabling the anchor withdraws the CA at once and ends the live sessions of the devices that rely on it. A root or an intermediate may be an anchor; anchor at the narrowest intermediate to trust one sub-CA of a manufacturer's PKI. Name constraints on an anchor or on any CA below it are not supported and are refused: identity is the certificate's subject common name, which name constraints do not cover.

Implements Model, TokenReference, NamedEntity, MetadataEntity

FieldTypeDescription
certificatePemString!The CA certificate, PEM.
createdAtStringWhen the anchor was created, as an RFC 3339 timestamp.
credentialCountInt!How many credentials rely on the anchor, soft-deleted ones included (they hold the delete refusal too).
deletedAtStringAlways null: deleted anchors are not returned by this API.
descriptionStringFree-text description. Null when none is set.
enabledBoolean!False withdraws the CA: no chain to it authenticates, and the devices relying on it are disconnected.
fingerprintSha256String!SHA-256 of the certificate, hex. Unique within the tenant.
idID!Server-assigned numeric identifier, as a string.
issuerString!The certificate's issuer distinguished name; equal to the subject for a root.
metadataStringFree-form JSON the platform stores and does not interpret. Null when none is set.
nameStringHuman-readable name. Null when none is set.
notAfterString!When the certificate expires, as an RFC 3339 timestamp. Chains to it stop authenticating then.
notBeforeString!When the certificate becomes valid, as an RFC 3339 timestamp.
ocspModeCertificateOcspMode!Whether, and how strictly, a certificate's status is also asked of its issuer's online OCSP responder when a device connects. OFF (the default) asks nothing and sends no request.
ocspResponderUrlStringThe responder every OCSP request for this anchor goes to, in place of each certificate's own Authority Information Access entry. Null when the certificates' own entries are used.
profileCountInt!How many provisioning profiles authenticate against the anchor.
revocationLists[DeviceRevocationList!]!The current CRL of each issuer the anchor holds one for.
revocationModeCertificateRevocationMode!How the anchor treats the completeness of its revocation lists. ENTRIES (the default) refuses every certificate a stored list or manual entry names and admits the rest, however old the lists are; REQUIRE_CURRENT also refuses a certificate whose issuer has no current list.
revocationStaleGraceString!How long past a list's nextUpdate it still counts as current under REQUIRE_CURRENT, as a Go duration (for example "24h0m0s"). The instance default when the anchor sets none.
revocationStatusRevocationStatus!The worst freshness over the anchor's lists: NONE when it holds no list, otherwise the most stale of them.
subjectString!The certificate's subject distinguished name.
tokenString!Identifier of the anchor, unique within the tenant.
updatedAtStringWhen the anchor was last written, as an RFC 3339 timestamp.

DeviceTrustAnchorSearchResults​

object

A page of trust anchors.

FieldTypeDescription
paginationSearchResultsPagination!Where this page sits in the whole result.
results[DeviceTrustAnchor!]!The anchors on this page.

DeviceType​

object

A kind of device: what it is (manufacturer and model), how it is displayed, and the device profile that defines what its devices measure and accept. Every device has exactly one device type, and many types may share one profile.

Implements Model, TokenReference, NamedEntity, BrandedEntity, MetadataEntity

FieldTypeDescription
backgroundColorStringBackground colour to display the device type with, up to 32 characters. Not validated.
borderColorStringBorder colour to display the device type with, up to 32 characters. Not validated.
commandChannelStringHow the devices of this type receive their commands. PUBLISH, or null, is the default: the command is published to the device's subject and delivered by the transport the device is connected on. HTTP_PULL holds the type's commands until the device asks for them with an authenticated GET to its commands endpoint.
createdAtStringWhen the device type was created, as an RFC 3339 timestamp.
deletedAtStringAlways null: deleted device types are not returned.
descriptionStringFree-text description, up to 1024 characters. Null when none is set.
foregroundColorStringForeground (text) colour to display the device type with, up to 32 characters. Not validated.
iconStringName of an icon representing the device type, up to 128 characters. Not checked against any icon set.
idID!Server-assigned numeric identifier, as a string. Address a device type by its token instead where you can.
imageUrlStringURL of an image representing the device type, up to 512 characters.
maintenanceWindowMaintenanceWindowThe maintenance window that holds this type's disruptive commands until it opens, or null when the type has none. Commands whose definition has impact DISRUPTIVE or DESTRUCTIVE wait for the window; every other command is sent whenever the device is reachable.
manufacturerStringManufacturer of the devices of this type: free text, up to 128 characters. facetValues lists the values already in use.
metadataStringCaller-defined metadata as a JSON document, or null when none is set.
modelStringModel of the devices of this type: free text, up to 128 characters. facetValues lists the values already in use.
nameStringHuman-readable name, up to 128 characters. Null when none is set.
profileDeviceProfileThe device profile this type adopts, or null when it adopts none. Devices of a type with no profile have no declared metrics or commands.
tokenString!Identifier of the device type, unique within the tenant.
updatedAtStringWhen the device type was last written, as an RFC 3339 timestamp.

DeviceTypeSearchResults​

object

One page of device types matching a search.

FieldTypeDescription
paginationSearchResultsPagination!Where this page sits in the full result set.
results[DeviceType!]!The device types on this page.

DisabledDevicePage​

object

One page of the tokens of the tenant's disabled devices.

FieldTypeDescription
deviceTokens[String!]!The tokens of the disabled devices on this page.
nextCursorStringThe cursor to pass as afterId for the next page; null when the walk is complete.

EntityAttribute​

object

No description yet.

Implements Model

FieldTypeDescription
attrKeyString!No description yet.
createdAtStringNo description yet.
deletedAtStringNo description yet.
entityEntity!No description yet.
entityTypeString!No description yet.
idID!No description yet.
lastUpdatedStringNo description yet.
scopeString!No description yet.
updatedAtStringNo description yet.
valueStringNo description yet.
valueTypeString!No description yet.

EntityAttributeSearchResults​

object

No description yet.

FieldTypeDescription
paginationSearchResultsPagination!No description yet.
results[EntityAttribute!]!No description yet.

EntityGroup​

object

No description yet.

Implements Model, TokenReference, NamedEntity, BrandedEntity, MetadataEntity, Entity

FieldTypeDescription
accessScopeBoolean!Whether the group is an access scope: a group a member's access can be limited to. A member limited to it sees the devices in the group at its active version — and only while they are in it — and the history recorded while they were. Set with setEntityGroupAccessScope.
activeVersionIntNo description yet.
backgroundColorStringNo description yet.
borderColorStringNo description yet.
createdAtStringNo description yet.
deletedAtStringNo description yet.
descriptionStringNo description yet.
foregroundColorStringNo description yet.
iconStringNo description yet.
idID!No description yet.
imageUrlStringNo description yet.
memberTypeString!No description yet.
membersEntityGroupMemberSearchResults!No description yet.

Arguments:
pagination: PaginationInput! — No description yet.
membershipModeString!No description yet.
metadataStringNo description yet.
nameStringNo description yet.
selectorStringNo description yet.
tokenString!No description yet.
updatedAtStringNo description yet.
versions[EntityGroupVersion!]!No description yet.

EntityGroupMember​

object

No description yet.

FieldTypeDescription
idID!No description yet.
tokenString!No description yet.

EntityGroupMemberSearchResults​

object

No description yet.

FieldTypeDescription
paginationSearchResultsPagination!No description yet.
results[EntityGroupMember!]!No description yet.

EntityGroupSearchResults​

object

No description yet.

FieldTypeDescription
paginationSearchResultsPagination!No description yet.
results[EntityGroup!]!No description yet.

EntityGroupVersion​

object

No description yet.

FieldTypeDescription
descriptionStringNo description yet.
labelStringNo description yet.
memberTypeString!No description yet.
publishedAtString!No description yet.
publishedByStringNo description yet.
selectorString!No description yet.
versionInt!No description yet.

EntityRef​

object

No description yet.

FieldTypeDescription
tokenString!No description yet.
typeString!No description yet.

EntityRelationship​

object

No description yet.

Implements Model, TokenReference, MetadataEntity

FieldTypeDescription
createdAtStringNo description yet.
deletedAtStringNo description yet.
idID!No description yet.
metadataStringNo description yet.
relationshipTypeEntityRelationshipType!No description yet.
sourceEntity!No description yet.
sourceTypeString!No description yet.
targetEntity!No description yet.
targetTypeString!No description yet.
tokenString!No description yet.
updatedAtStringNo description yet.

EntityRelationshipSearchResults​

object

No description yet.

FieldTypeDescription
paginationSearchResultsPagination!No description yet.
results[EntityRelationship!]!No description yet.

EntityRelationshipType​

object

No description yet.

Implements Model, TokenReference, NamedEntity, MetadataEntity

FieldTypeDescription
createdAtStringNo description yet.
deletedAtStringNo description yet.
descriptionStringNo description yet.
idID!No description yet.
metadataStringNo description yet.
nameStringNo description yet.
tokenString!No description yet.
trackedBoolean!No description yet.
updatedAtStringNo description yet.

EntityRelationshipTypeSearchResults​

object

No description yet.

FieldTypeDescription
paginationSearchResultsPagination!No description yet.
results[EntityRelationshipType!]!No description yet.

FacetKey​

object

No description yet.

Implements Model

FieldTypeDescription
createdAtStringNo description yet.
deletedAtStringNo description yet.
idID!No description yet.
keyString!No description yet.
labelStringNo description yet.
memberTypeString!No description yet.
sourceString!No description yet.
updatedAtStringNo description yet.
valueTypeString!No description yet.
values[String!]No description yet.

FacetKeySearchResults​

object

No description yet.

FieldTypeDescription
paginationSearchResultsPagination!No description yet.
results[FacetKey!]!No description yet.

GeoFence​

object

No description yet.

Implements Model, TokenReference, NamedEntity, MetadataEntity

FieldTypeDescription
createdAtStringNo description yet.
deletedAtStringNo description yet.
descriptionStringNo description yet.
geometryString!No description yet.
idID!No description yet.
kindString!No description yet.
metadataStringNo description yet.
nameStringNo description yet.
tokenString!No description yet.
updatedAtStringNo description yet.

GeoFenceGeometry​

object

No description yet.

FieldTypeDescription
geometryString!No description yet.
hashString!No description yet.

GeoFenceManifestEntry​

object

No description yet.

FieldTypeDescription
hashString!No description yet.
tokenString!No description yet.

GeoFenceSearchResults​

object

No description yet.

FieldTypeDescription
paginationSearchResultsPagination!No description yet.
results[GeoFence!]!No description yet.

GeoFenceSetManifest​

object

No description yet.

FieldTypeDescription
fences[GeoFenceManifestEntry!]!No description yet.
mintedAtStringNo description yet.
versionInt!No description yet.

GeoFenceSetSnapshot​

object

No description yet.

FieldTypeDescription
fencesGeoFenceSnapshotEntrySearchResults!No description yet.

Arguments:
pagination: PaginationInput! — No description yet.
versionInt!No description yet.

GeoFenceSnapshotEntry​

object

No description yet.

FieldTypeDescription
geometryString!No description yet.
tokenString!No description yet.

GeoFenceSnapshotEntrySearchResults​

object

No description yet.

FieldTypeDescription
paginationSearchResultsPagination!No description yet.
results[GeoFenceSnapshotEntry!]!No description yet.

InstalledPosition​

object

Where a fixed asset was installed: WGS84 decimal degrees, elevation and accuracy in metres.

FieldTypeDescription
accuracyFloatHorizontal accuracy in metres, or null when not recorded.
elevationFloatMetres above the WGS84 ellipsoid, or null when not recorded.
latitudeFloat!Degrees north, -90 to 90.
longitudeFloat!Degrees east, -180 to 180.
sourceInstalledPositionSourceHow the position was obtained.
updatedAtStringWhen the position was recorded, as an RFC 3339 timestamp.

Integration​

object

An inbound integration: a tenant's authenticated sender of device data over HTTP, such as a LoRaWAN network server or a webhook. It holds the bearer token the sender presents, the kind of body it sends, and the device types it may resolve devices of. The token is generated by the server, returned once by createIntegration and rotateIntegrationToken, and never exposed on this type: only a keyed digest of it is stored.

Implements Model, TokenReference, NamedEntity, MetadataEntity

FieldTypeDescription
createdAtStringWhen the integration was created, as an RFC 3339 timestamp.
deletedAtStringAlways null: deleted integrations are not returned by this API.
descriptionStringFree-text description. Null when none is set.
deviceTypes[DeviceType!]!The device types the integration may resolve devices of. A device of any other type is refused, whatever the sender claims.
enabledBoolean!False while an operator has switched the integration off: its token authenticates, and nothing resolves through it.
genericStringA generic sender's settings as a JSON object: where the device identifier is (idFrom), and optionally an array of items (itemsPointer), the sender's own time (timePointer) and an encoded raw frame (framePointer, frameEncoding). Null for the other types.
idID!Server-assigned numeric identifier, as a string.
identityString!How the sender names a device: DEV_EUI, DEVICE_ID, or ALIAS:custom.name for a generic sender.
lastAuthFailureAtStringWhen a request for this integration last failed authentication.
lastUndecodedAtStringWhen the last such uplink arrived.
lastUndecodedSampleStringUp to 512 bytes of the last such frame, hex encoded.
linkMetricsBoolean!Whether the receive-link readings (signal strength, signal-to-noise ratio, gateway count) are stored beside the decoded values.
metadataStringFree-form JSON the platform stores and does not interpret. Null when none is set.
nameStringHuman-readable name. Null when none is set.
tokenString!Identifier of the integration, unique within the tenant. It is part of the URL the sender posts to.
tokenIssuedAtString!When the bearer token was last generated: at creation and at every rotation.
typeString!The kind of sender, which fixes the body format its route parses: CHIRPSTACK_V4, TTS_V3, GENERIC_JSON or GENERIC_BINARY. It cannot be changed after creation.
undecodedCountInt!How many uplinks arrived with nothing to read readings from.
updatedAtStringWhen the integration was last written, as an RFC 3339 timestamp.

IntegrationDecoderPlan​

object

What the ingest path needs to know about the payload decoder of a device type.

FieldTypeDescription
composedCostInt!The part of estimatedCost that does not depend on the size of the uplink: the decoder's expressions alone. The ingest charge adds the parse of the inputs the decoder reads at their actual sizes. 0 when there is no decoder this build can run.
estimatedCostInt!The decoder's static worst-case cost; 0 when there is no decoder this build can run.
inputPayloadDecoderInputThe input an uplink must carry for the decoder to run; null when there is no decoder.
maxReadingsInt!The most readings one decode produces; 0 when there is no decoder this build can run.
parsesDecodedBoolean!Whether the decoder reads the network server's decoded object, parsed and priced by size.
parsesJsonBoolean!Whether the decoder reads the generic item's JSON, which is parsed and priced by size.
presentBoolean!Whether the active published version declares a decoder. True also when this build cannot run it: such an uplink must still reach the resolver, which records the failure.
profileVersionTokenString!The profile version the answer is for, as "{profile}@{version}"; empty when there is no decoder.

IntegrationDeviceResolution​

object

The answer to resolveIntegrationDevice.

FieldTypeDescription
deviceTokenStringToken of the device the alias names. Set only when the outcome is RESOLVED.
deviceTypeTokenStringToken of that device's type. Set only when the outcome is RESOLVED.
outcomeIntegrationDeviceOutcome!What happened.
overflowBoolean!True when the outcome is UNREGISTERED and the sighting was not stored because the integration already records 1000 distinct unregistered devices.

IntegrationSearchResults​

object

A page of integrations.

FieldTypeDescription
paginationSearchResultsPagination!Where this page sits in the whole result.
results[Integration!]!The integrations on this page.

IntegrationSecretResult​

object

An integration together with the bearer token the server just generated for it. The token is in the response to the write that issued it and nowhere else: the platform stores only a digest, so it cannot be read again. Rotate it if it is lost.

FieldTypeDescription
integrationIntegration!The integration the token belongs to.
issuedTokenString!43 characters, 256 bits. Show it to the operator once; the sender presents it as Authorization: Bearer.

MaintenanceWindow​

object

A recurring weekly schedule, in an IANA time zone, during which disruptive commands may start. Assign it to a device type; commands whose definition has impact DISRUPTIVE or DESTRUCTIVE then wait for it to open.

Implements Model, TokenReference, NamedEntity, MetadataEntity

FieldTypeDescription
createdAtStringWhen the window was created, as an RFC 3339 timestamp.
deletedAtStringAlways null: deleted windows are not returned.
descriptionStringFree-text description, up to 1024 characters. Null when none is set.
idID!Server-assigned numeric identifier, as a string. Address a window by its token instead where you can.
metadataStringCaller-defined metadata as a JSON document, or null when none is set.
nameStringHuman-readable name, up to 128 characters. Null when none is set.
slotsString!The weekly openings as a JSON array of objects with day (MONDAY to SUNDAY), start (a 24-hour HH:MM wall-clock time in the zone) and durationMinutes (1 to 10080, elapsed time). A slot may run past midnight and past the end of the week.
timezoneString!The IANA time zone the slots are read in, for example Europe/Berlin.
tokenString!Identifier of the window, unique within the tenant.
updatedAtStringWhen the window was last written, as an RFC 3339 timestamp.

MaintenanceWindowOpening​

object

When an operation under a maintenance window may start.

FieldTypeDescription
closesString!When the opening dispatchAfter belongs to ends, as an RFC 3339 timestamp.
dispatchAfterString!The earliest instant an operation may start, as an RFC 3339 timestamp: the instant asked about when the window is open, otherwise the next opening.
foundBoolean!False when no window has the token (it was deleted or never existed); the other fields are then meaningless.
openNowBoolean!True when the window is open at the instant asked about.

MaintenanceWindowSearchResults​

object

One page of maintenance windows matching a search.

FieldTypeDescription
paginationSearchResultsPagination!Where this page sits in the full result set.
results[MaintenanceWindow!]!The windows on this page.

MetricDefinition​

object

A measurement the devices of a profile report: its key, numeric type, unit and allowed values. Inbound measurements whose key matches are validated against it; a measurement whose key is not declared is not validated.

Implements Model, TokenReference, NamedEntity, MetadataEntity

FieldTypeDescription
calculatedBoolean!True when the metric is calculated from its formula rather than reported by devices. Fixed when the metric is created.
createdAtStringWhen the metric definition was created, as an RFC 3339 timestamp.
dataTypeString!The value type: DOUBLE, INT or BOOLEAN. A BOOLEAN value is stored as 0 or 1.
deletedAtStringAlways null: deleted metric definitions are not returned.
descriptionStringFree-text description, up to 1024 characters. Null when none is set.
descriptorStringOptional semantic tag for the metric, such as a Web of Things type. Not interpreted on ingest; a published version's thingModel carries it as the property's @type.
deviceProfileDeviceProfile!The profile this metric is declared on.
enumStringThe allowed values as a JSON array of strings, or null when any value is allowed. A measurement must equal one of them exactly. A value that is not a non-empty array of strings restricts nothing.
expressionStringThe formula a calculated metric is computed from, written over the profile's measured metrics (for example voltage * current / 1000), and optionally over numbers a device carries in its metadata, as device.name (for example voltage * device.calibration). Null for a measured metric, which devices report.
idID!Server-assigned numeric identifier, as a string. Address a metric definition by its token instead where you can.
maxValueFloatLargest value accepted for a DOUBLE or INT metric, or null for no upper bound. A measurement above it is rejected.
metadataStringCaller-defined metadata as a JSON document, or null when none is set.
metricKeyString!The key a measurement uses to report this metric, unique within the profile and at most 128 characters.
minValueFloatSmallest value accepted for a DOUBLE or INT metric, or null for no lower bound. A measurement below it is rejected.
nameStringHuman-readable name, up to 128 characters. Null when none is set.
tokenString!Identifier of the metric definition, unique within the tenant.
unitStringUnit of measure, such as a UCUM code (Cel, kW). It is carried with each measurement of this metric; values are not converted.
updatedAtStringWhen the metric definition was last written, as an RFC 3339 timestamp.

MetricDefinitionSearchResults​

object

One page of metric definitions matching a search.

FieldTypeDescription
paginationSearchResultsPagination!Where this page sits in the full result set.
results[MetricDefinition!]!The metric definitions on this page.

MetricFormulaTest​

object

What a calculated-metric formula gives for a sample. A formula that does not compile has compileError and no value; one that compiles has exactly one of value or skippedReason.

FieldTypeDescription
chain[String!]!The calculated metrics the formula depends on, directly or through others, in the order they are evaluated, each computed from the sample through its own formula. Empty for a formula over measured metrics only.
compileErrorStringWhy the formula was refused, or null when it compiles.
constants[String!]!The device constants the formula reads as device.name, sorted. Each comes from a device's metadata when a reading is resolved; empty when the formula reads none.
estimatedCostIntThe formula's estimated worst-case cost; a formula above 100 is refused.
inputs[String!]!The metrics the formula reads directly: measured metrics and, since a formula may read another calculated metric, calculated ones.
measuredInputs[String!]!Every measured metric the evaluation reads: the formula's own and those read through the calculated metrics in the chain. These are the values a sample supplies; equal to inputs when the chain is empty.
skippedReasonStringWhy the formula produces no value for the sample: missing_input, invalid_input, non_finite, div_zero, overflow, range, unstorable (a magnitude of 1e12 or more, which measurements cannot be stored with) or eval_error. No value is ever substituted.
valueStringThe value the formula produces for the sample, formatted as it would be stored.
warnings[String!]!Advisory findings that do not stop a publish, such as a sample value no formula can read, or a result range wider than measurements can be stored with.

PayloadDecoder​

object

A payload decoder: the rules that turn a binary frame, a generic webhook's JSON or a network server's decoded object into measurements.

FieldTypeDescription
documentString!The whole decoder document as JSON text, exactly as saved.
envVersionInt!The version of the function library the decoder was written against. It never changes meaning.
estimatedCostInt!The decoder's worst-case static cost, in the units the function reference gives.
inputPayloadDecoderInput!Which input of an uplink the decoder reads.
kindPayloadDecoderKind!The engine the decoder runs on.
maxReadingsInt!The most readings one uplink can produce: the largest section's scalar rows plus its map rows' maxKeys. Ingest is charged this many readings per uplink.

PayloadDecoderError​

object

Why a test produced no readings.

FieldTypeDescription
messageString!What went wrong. It names the function and offset, never platform internals.
offsetIntThe byte offset a reader refused, or null.
pathString!The expression that failed, such as sections[1].outputs[2].expr, or empty when it is not one.
reasonString!The reason: compile_failed, env_unsupported, eval_error, cost_exceeded, invalid_output, no_section, no_outputs, missing_input, map_overflow, input_too_large, input_malformed, unsupported_encoding or ignored_message.

PayloadDecoderFunction​

object

One function of the decoder library.

FieldTypeDescription
descriptionString!What it does, including its limits.
nameString!The function's name, such as i16be.
signatureString!Its signature.

PayloadDecoderHealth​

object

How a profile's decoder has been doing over a span. Every uplink the decoder saw lands in exactly one of decoded, ignored, failed or suppressed. Counts are at least what happened: they are kept in memory and written about once a minute, so a crash loses up to a minute of them. The counts are Float, not Int: a busy decoder passes a 32-bit Int in a week. They are whole numbers, exact up to 2^53, so read them as integers.

FieldTypeDescription
chargeSkewFloat!Readings stored beyond what the route charged for, because a newer decoder produces more. A whole number, exact up to 2^53.
decodedFloat!Uplinks decoded to readings. A whole number, exact up to 2^53 (Float so it cannot overflow).
failedFloat!Failed uplinks that have a failed-events record (filter DECODE_FAILED). A whole number, exact up to 2^53.
ignoredFloat!Uplinks an ignore section matched: accepted, nothing stored. A whole number, exact up to 2^53.
lastErrorString!The text of the most recent failure, or empty when there was none.
lastFailureAtStringWhen the most recent failure happened, as an RFC 3339 time, or null when there was none.
sinceString!The start of the span, as an RFC 3339 time.
suppressedFloat!Failed uplinks that were NOT given a record because the device type's record budget was spent (a burst of 20, refilled 10 a minute, on each replica). They are counted here and nowhere else. A whole number, exact up to 2^53.
windowsInt!How many replica-minutes of tallies the sums cover.

PayloadDecoderReading​

object

One value a decoder produced, as it would be stored.

FieldTypeDescription
keyString!The measurement key.
valueString!The value, formatted by the target metric's type.

PayloadDecoderSample​

object

One failing uplink kept for replay. Its bytes are not listed: load it into the test panel with testPayloadDecoder sampleId.

FieldTypeDescription
createdAtString!When it was kept, as an RFC 3339 time.
deviceTokenString!Token of the device the uplink was for.
errorString!The failure text.
idID!Pass this as testPayloadDecoder sampleId.
profileVersionInt!The profile version whose decoder failed on it.
reasonString!The failure's sub-reason, such as missing_input.

PayloadDecoderSkip​

object

A value the decode did not store, and why.

FieldTypeDescription
keyString!The key that was skipped.
reasonString!Why: undeclared (no such metric), collision (a scalar row writes the key), reserved, or invalid.

PayloadDecoderTestResult​

object

What a decoder made of one input, through the code that runs at ingest. Nothing is stored.

FieldTypeDescription
costInt!The cost the decode spent.
errorPayloadDecoderErrorWhy the test failed, or null. A document that does not compile is reported here.
ignoredBoolean!True when an ignore section matched: the uplink would be accepted and store nothing.
okBoolean!True when the decoder compiled and the input decoded (an ignore section counts).
readings[PayloadDecoderReading!]!The readings that would be stored, with link metrics appended when the integration asks for them.
sectionStringThe name of the section that matched, or null.
skipped[PayloadDecoderSkip!]!Values the decode produced or the envelope carried that were not stored.
uplinksInt!How many uplinks a webhook body held; the first one was tested. Zero when the input was not a webhook body.
vectors[PayloadDecoderVectorResult!]!The saved vectors, each run through the decoder.

PayloadDecoderVectorResult​

object

One saved vector's outcome.

FieldTypeDescription
costInt!The cost the run spent.
errorStringWhy it failed, or null.
nameString!The vector's name.
okBoolean!Whether the decoder produced exactly the readings the vector expects.

ProvisioningProfile​

object

No description yet.

Implements Model, TokenReference, NamedEntity, MetadataEntity

FieldTypeDescription
createdAtStringNo description yet.
credentialTypeString!No description yet.
deletedAtStringNo description yet.
descriptionStringNo description yet.
deviceTypeDeviceType!No description yet.
enabledBoolean!No description yet.
expiresAtStringNo description yet.
idID!No description yet.
maxDevicesIntThe most devices the profile may register, or null for no cap. Devices holding a credential the profile issued count, revoked ones included, until their provisioning is reset or they are deleted.
metadataStringNo description yet.
nameStringNo description yet.
provisionKeyString!No description yet.
provisionedDeviceCountInt!How many devices hold a credential the profile issued, counted against maxDevices.
secretIssuedBoolean!False for a profile whose secret was chosen by an operator (every profile created before the server generated secrets). The registration endpoint refuses such a profile with PROVISIONING_FAILED until rotateProvisioningProfileSecret issues it a secret. Always false for a certificate profile, which has no secret.
strategyString!No description yet.
tokenString!No description yet.
trustAnchorDeviceTrustAnchorThe trust anchor a certificate profile authenticates its devices against, or null for a profile that authenticates by secret. A certificate profile has no provision secret.
updatedAtStringNo description yet.

ProvisioningProfileSearchResults​

object

No description yet.

FieldTypeDescription
paginationSearchResultsPagination!No description yet.
results[ProvisioningProfile!]!No description yet.

ProvisioningProfileSecretResult​

object

A provisioning profile together with the provision secret the server just generated for it. The secret is in the response to the write that issued it and nowhere else: the platform stores only a digest, so it cannot be read again. Rotate it if it is lost.

FieldTypeDescription
issuedSecretString43 characters, 256 bits. Show it to the operator once; devices present it, with the profile's provisionKey, to the registration endpoint. Null for a certificate profile, which has no secret.
profileProvisioningProfile!The profile the secret belongs to.

PublishedCommand​

object

One command a device accepts, as frozen in its profile's active published version. To edit commands, use the profile's command definitions and publish the profile.

FieldTypeDescription
commandKeyString!The key used to send this command.
descriptionStringFree-text description, or null when none was set.
impactString!NORMAL, DISRUPTIVE or DESTRUCTIVE. The last two wait for the device type's maintenance window.
nameStringHuman-readable name, or null when none was set.
parameterSchemaStringThe command's parameters as a JSON array of parameter descriptors, or null when it takes no structured arguments.

PublishedMetric​

object

A metric in a device's published profile version, as inbound measurements are checked against it.

FieldTypeDescription
allowedValues[String!]The only values accepted, or null when any value of the type is accepted.
calculatedBoolean!True when the platform computes this metric from a formula over the device's other readings, so a device never reports it. A dashboard offers it like any other metric.
dataTypeString!DOUBLE, INT or BOOLEAN; a measurement's value must parse as this type.
maxValueFloatThe largest value accepted, or null when there is no upper bound.
metricKeyString!The key a measurement uses to report this metric.
minValueFloatThe smallest value accepted, or null when there is no lower bound.
unitStringThe unit, or null when none is declared.

PublishedProfileRule​

object

No description yet.

FieldTypeDescription
definitionString!No description yet.
entityGroupTokenString!No description yet.
entityGroupVersionInt!No description yet.
tokenString!No description yet.

SearchResultsPagination​

object

Where a page of search results sits in the full result set. Positions are 1-based and inclusive.

FieldTypeDescription
pageEndIntPosition of the last result on this page within the full result set (1-based, inclusive). Lower than pageStart when the page is past the end of the results.
pageStartIntPosition of the first result on this page within the full result set (1-based).
totalRecordsIntNumber of records matching the criteria across all pages.

SelectorPreview​

object

No description yet.

FieldTypeDescription
errorStringNo description yet.
membersEntityGroupMemberSearchResultsNo description yet.
validBoolean!No description yet.

UnregisteredIntegrationDevice​

object

A device a sender named that no device of the tenant carries an alias for, as an integration saw it. Create a device of a type in the integration's scope with this alias to start resolving it; the sighting then disappears. Values some device already holds are never listed, and clearUnregisteredIntegrationDevices empties the list.

FieldTypeDescription
countInt!How many times it has been seen.
firstSeenString!When it was first seen, as an RFC 3339 timestamp.
idID!Server-assigned numeric identifier, as a string.
integrationString!Token of the integration that saw it.
lastSeenString!When it was last seen, as an RFC 3339 timestamp.
schemeString!The alias scheme the sender's identifier is in.
valueString!The sender's identifier in its stored spelling.

UnregisteredIntegrationDeviceSearchResults​

object

A page of unregistered devices.

FieldTypeDescription
paginationSearchResultsPagination!Where this page sits in the whole result.
results[UnregisteredIntegrationDevice!]!The unregistered devices on this page.

X509Certificate​

object

The pinned device certificate of an X509_CERTIFICATE credential, read back from what is stored.

FieldTypeDescription
fingerprintSha256String!SHA-256 of the certificate, hex. The credential's id.
notAfterString!When the certificate itself expires. The credential's expiresAt is the earliest expiry over its whole chain.
serialHexString!The certificate's serial number, hex.
subjectCnString!The certificate's subject common name: the device's external id when it registers itself.
trustAnchorDeviceTrustAnchorThe trust anchor the certificate's chain must reach at every connect.

Interfaces​

BrandedEntity · Entity · MetadataEntity · Model · NamedEntity · TokenReference

BrandedEntity​

interface

Presentation hints a user interface can use when showing the record. The server stores them as text and does not interpret them.

FieldTypeDescription
backgroundColorStringBackground colour to display the record with, such as a CSS colour. Not validated.
borderColorStringBorder colour to display the record with, such as a CSS colour. Not validated.
foregroundColorStringForeground (text) colour to display the record with, such as a CSS colour. Not validated.
iconStringName of an icon representing the record. Not checked against any icon set.
imageUrlStringURL of an image representing the record.

Entity​

interface

No description yet.

FieldTypeDescription
idID!No description yet.
tokenString!No description yet.

MetadataEntity​

interface

A record that carries caller-defined metadata.

FieldTypeDescription
metadataStringCaller-defined metadata as a JSON document, or null when none is set.

Model​

interface

Fields every stored record carries: a server-assigned id and its timestamps.

FieldTypeDescription
createdAtStringWhen the record was created, as an RFC 3339 timestamp.
deletedAtStringAlways null: deleted records are not returned by this API.
idID!Server-assigned numeric identifier, as a string. Records are normally addressed by token; the ById lookups take this value.
updatedAtStringWhen the record was last written, as an RFC 3339 timestamp.

NamedEntity​

interface

A record with a human-readable name and description.

FieldTypeDescription
descriptionStringFree-text description. Null when none is set.
nameStringHuman-readable name. Null when none is set.

TokenReference​

interface

A record addressed by a token, an identifier unique within the tenant among records of its kind.

FieldTypeDescription
tokenString!Identifier of the record, unique within the tenant among records of its kind. Letters, digits, hyphens and underscores, starting with a letter or digit; at most 128 characters.

Input types​

AlarmAnchor · AlarmCountCriteria · AlarmDispositionSearchCriteria · AlarmSearchCriteria · AnchorDeviceSearchCriteria · AreaCreateRequest · AreaSearchCriteria · AreaTypeCreateRequest · AreaTypeSearchCriteria · AreaTypeUpdateRequest · AreaUpdateRequest · AssetCreateRequest · AssetSearchCriteria · AssetTypeCreateRequest · AssetTypeSearchCriteria · AssetTypeUpdateRequest · AssetUpdateRequest · AuditEventSearchCriteria · CommandDefinitionCreateRequest · CommandDefinitionSearchCriteria · CommandDefinitionUpdateRequest · ConfigurationKeyInput · CustomerCreateRequest · CustomerDeviceSearchCriteria · CustomerSearchCriteria · CustomerTypeCreateRequest · CustomerTypeSearchCriteria · CustomerTypeUpdateRequest · CustomerUpdateRequest · DetectionRuleCreateRequest · DetectionRuleSearchCriteria · DetectionRuleUpdateRequest · DeviceAliasInput · DeviceBulkCreateRequest · DeviceClaimInitiateRequest · DeviceClaimRequest · DeviceCreateRequest · DeviceCredentialCreateRequest · DeviceCredentialSearchCriteria · DeviceCredentialUpdateRequest · DeviceImportRow · DeviceLocationDeclarationInput · DeviceProfileCreateRequest · DeviceProfileSearchCriteria · DeviceProfileUpdateRequest · DeviceReplaceRequest · DeviceReplacementSearchCriteria · DeviceRevokedCertificateSearchCriteria · DeviceSearchCriteria · DeviceTrustAnchorCreateRequest · DeviceTrustAnchorSearchCriteria · DeviceTrustAnchorUpdateRequest · DeviceTypeCreateRequest · DeviceTypeSearchCriteria · DeviceTypeUpdateRequest · DeviceUpdateRequest · EntityAttributeSearchCriteria · EntityAttributeSetRequest · EntityGroupCreateRequest · EntityGroupSearchCriteria · EntityGroupUpdateRequest · EntityRefInput · EntityRelationshipCreateRequest · EntityRelationshipSearchCriteria · EntityRelationshipTypeCreateRequest · EntityRelationshipTypeSearchCriteria · EntityRelationshipTypeUpdateRequest · FacetKeySearchCriteria · FacetKeySetRequest · GeoFenceCreateRequest · GeoFenceSearchCriteria · GeoFenceUpdateRequest · HeaderInput · InstalledPositionInput · IntegrationCreateRequest · IntegrationSearchCriteria · IntegrationUpdateRequest · MaintenanceWindowCreateRequest · MaintenanceWindowSearchCriteria · MaintenanceWindowUpdateRequest · MetricDefinitionCreateRequest · MetricDefinitionSearchCriteria · MetricDefinitionUpdateRequest · MetricValueInput · PaginationInput · PayloadDecoderTestInput · ProvisioningProfileCreateRequest · ProvisioningProfileSearchCriteria · ProvisioningProfileUpdateRequest · QueryParamInput · UnregisteredIntegrationDeviceSearchCriteria

AlarmAnchor​

input

An anchor to filter alarms by: the alarms of one customer, area or asset, as stamped when each alarm cycle began. An alarm stays under the area its device was in when the alarm was raised, even after the device moves; a device sold or moved raises its NEXT alarm under the new anchors. For a member whose access is limited to some customers the answer is also limited to the alarms of that member's own devices, so a shared area counts only the member's own. A customer outside that member's access is refused (FORBIDDEN); an area or asset none of its devices raised in answers nothing.

Input fieldTypeDescription
tokenString!Token of the entity, unique within the tenant.
typeString!Entity class: customer, area or asset. Any other value is an error.

AlarmCountCriteria​

input

Criteria for counting alarms by device type or by severity. The facets are those of AlarmSearchCriteria, without paging and without deviceType (the per-type count's grouping; the per-severity count takes it as an argument of its own), and they AND together.

Input fieldTypeDescription
acknowledgedBooleanOnly acknowledged (true) or unacknowledged (false) alarms.
alarmKeyStringOnly alarms with this alarm key.
anchorAlarmAnchorOnly alarms stamped with this anchor (see AlarmAnchor).
originatorTokenStringOnly alarms of this originator, by its token. An unknown token counts nothing.
originatorTypeStringEntity type of the originator, e.g. "device". Required when originatorToken is set.
severityStringOnly alarms at this severity.
stateStringOnly alarms in this state: ACTIVE or CLEARED.

AlarmDispositionSearchCriteria​

input

Criteria for listing alarm disposition labels. Every facet is optional and they AND together.

Input fieldTypeDescription
alarmTokenStringOnly the labelled cycles of this alarm, by its token. An unknown token finds nothing.
endTimeStringOnly cycles raised at or before this instant (inclusive), as an RFC 3339 timestamp.
labelAlarmDispositionLabelOnly cycles with this label. A value that is not an AlarmDispositionLabel is refused when the request is validated, so a misspelt filter never reads as an empty answer.
pageNumberInt!The page to return, starting at 1.
pageSizeInt!How many labels a page holds.
startTimeStringOnly cycles raised at or after this instant (inclusive), as an RFC 3339 timestamp.

AlarmSearchCriteria​

input

No description yet.

Input fieldTypeDescription
acknowledgedBooleanNo description yet.
alarmKeyStringNo description yet.
anchorAlarmAnchorOnly alarms stamped with this anchor (see AlarmAnchor).
deviceTypeStringOnly alarms raised on a device of this type, by the type's token. An unknown token finds nothing. A member whose access is limited to some customers matches only the devices its scope owns, so an alarm it can see on a device it no longer owns is under no type.
endTimeStringOnly alarms raised at or before this instant (inclusive), as an RFC 3339 timestamp. With startTime, this keeps the alarms whose span overlaps the range. An alarm row holds its latest raise only, so an earlier raise of the same alarm is not found by any range. Omit for no upper bound. A value that is not RFC 3339 is an error.
originatorTokenStringNo description yet.
originatorTypeStringNo description yet.
pageNumberInt!No description yet.
pageSizeInt!No description yet.
severityStringNo description yet.
startTimeStringOnly alarms active at some point at or after this instant (inclusive), as an RFC 3339 timestamp: still active, or cleared at or after it. An alarm raised earlier that was still active then is included. Omit for no lower bound. A value that is not RFC 3339 is an error.
stateStringNo description yet.

AnchorDeviceSearchCriteria​

input

Criteria for the devices on one anchor: a customer, an area or an asset.

Input fieldTypeDescription
pageNumberInt!Page to return, starting at 1. Values below 1 are read as 1.
pageSizeInt!Results per page. Below 1 means the default of 100; above 1000 is capped at 1000.
relationshipTypeStringToken of the relationship type linking each device to the anchor, such as "assigned". Omit it for a device linked by any type. Refused for a member limited to part of the tenant.
targetString!Token of the anchor.
targetTypeString!The anchor's kind: "customer", "area" or "asset".

AreaCreateRequest​

input

No description yet.

Input fieldTypeDescription
areaTypeTokenString!No description yet.
boundaryFenceTokenStringThe token of the geofence that bounds the area. It must name an existing fence.
descriptionStringNo description yet.
metadataStringNo description yet.
nameStringNo description yet.
tokenString!No description yet.

AreaSearchCriteria​

input

No description yet.

Input fieldTypeDescription
areaTypeTokenStringNo description yet.
pageNumberInt!No description yet.
pageSizeInt!No description yet.

AreaTypeCreateRequest​

input

No description yet.

Input fieldTypeDescription
backgroundColorStringNo description yet.
borderColorStringNo description yet.
descriptionStringNo description yet.
foregroundColorStringNo description yet.
iconStringNo description yet.
imageUrlStringNo description yet.
metadataStringNo description yet.
nameStringNo description yet.
tokenString!No description yet.

AreaTypeSearchCriteria​

input

No description yet.

Input fieldTypeDescription
pageNumberInt!No description yet.
pageSizeInt!No description yet.

AreaTypeUpdateRequest​

input

No description yet.

Input fieldTypeDescription
backgroundColorStringNo description yet.
borderColorStringNo description yet.
descriptionStringNo description yet.
foregroundColorStringNo description yet.
iconStringNo description yet.
imageUrlStringNo description yet.
metadataStringNo description yet.
nameStringNo description yet.

AreaUpdateRequest​

input

No description yet.

Input fieldTypeDescription
areaTypeTokenStringNo description yet.
boundaryFenceTokenStringLinks the area to the geofence that bounds it: omit to keep the link, send null to remove it, send a token to set it. The token must name an existing fence.
descriptionStringNo description yet.
metadataStringNo description yet.
nameStringNo description yet.

AssetCreateRequest​

input

No description yet.

Input fieldTypeDescription
assetTypeTokenString!No description yet.
descriptionStringNo description yet.
metadataStringNo description yet.
nameStringNo description yet.
propertiesStringNo description yet.
tokenString!No description yet.

AssetSearchCriteria​

input

No description yet.

Input fieldTypeDescription
assetTypeTokenStringNo description yet.
pageNumberInt!No description yet.
pageSizeInt!No description yet.

AssetTypeCreateRequest​

input

No description yet.

Input fieldTypeDescription
backgroundColorStringNo description yet.
borderColorStringNo description yet.
descriptionStringNo description yet.
foregroundColorStringNo description yet.
iconStringNo description yet.
imageUrlStringNo description yet.
metadataStringNo description yet.
nameStringNo description yet.
propertySchemaStringNo description yet.
tokenString!No description yet.

AssetTypeSearchCriteria​

input

No description yet.

Input fieldTypeDescription
pageNumberInt!No description yet.
pageSizeInt!No description yet.

AssetTypeUpdateRequest​

input

No description yet.

Input fieldTypeDescription
backgroundColorStringNo description yet.
borderColorStringNo description yet.
descriptionStringNo description yet.
foregroundColorStringNo description yet.
iconStringNo description yet.
imageUrlStringNo description yet.
metadataStringNo description yet.
nameStringNo description yet.
propertySchemaStringNo description yet.

AssetUpdateRequest​

input

No description yet.

Input fieldTypeDescription
assetTypeTokenStringNo description yet.
descriptionStringNo description yet.
metadataStringNo description yet.
nameStringNo description yet.
propertiesStringNo description yet.

AuditEventSearchCriteria​

input

No description yet.

Input fieldTypeDescription
actorStringNo description yet.
categoryStringNo description yet.
endTimeStringNo description yet.
entityPkStringNo description yet.
operationStringNo description yet.
pageNumberInt!No description yet.
pageSizeInt!No description yet.
startTimeStringNo description yet.
tableNameStringNo description yet.

CommandDefinitionCreateRequest​

input

Fields for a new command definition.

Input fieldTypeDescription
commandKeyString!The key used to send the command. Letters, digits, hyphens and underscores, starting with a letter or digit; at most 128 characters. Dots may separate namespaced segments (for example sparkplug.write): each segment follows the same rule, and a leading, trailing or doubled dot is refused. A key the profile already declares is refused with CONFLICT.
descriptionStringFree-text description, up to 1024 characters.
deviceProfileTokenString!Token of the profile to declare the command on. An unknown token fails the request.
impactStringHow disruptive the command is: NORMAL (the default), DISRUPTIVE or DESTRUCTIVE. DISRUPTIVE and DESTRUCTIVE commands wait for the device type's maintenance window. An unknown value fails the request.
metadataStringCaller-defined metadata. Must be valid JSON; an empty string means none.
nameStringHuman-readable name, up to 128 characters.
parameterSchemaStringThe command's parameters: a JSON array of descriptors, each with a name and optional description, kind (SCALAR, the default, or OBJECT with nested parameters), dataType (DOUBLE, INT, BOOLEAN or STRING), unit, required, default, minValue, maxValue and enum. Unknown keys and inconsistent constraints are refused. Omit it for a command without structured arguments.
tokenString!Identifier for the new command definition. A token already in use in the tenant is refused with CONFLICT.

CommandDefinitionSearchCriteria​

input

Criteria for searching command definitions. Results are newest first.

Input fieldTypeDescription
commandKeyStringReturn only definitions with exactly this command key.
deviceProfileStringReturn only definitions on the profile with this token. An unknown token matches nothing.
pageNumberInt!Page to return, starting at 1. Values below 1 are read as 1.
pageSizeInt!Results per page. Below 1 means the default of 100; above 1000 is capped at 1000.

CommandDefinitionUpdateRequest​

input

A partial update to a command definition. Omit a field to leave the stored value alone, send a value to set it, or send an explicit null to clear it; the fields that cannot be cleared say so. The definition is named by the mutation's token argument, so there is no token here. Any refusal leaves the definition unchanged.

Input fieldTypeDescription
commandKeyStringNew command key, in the same format as on create. An explicit null or a blank value is refused, and a key already declared on the profile is refused with CONFLICT.
descriptionStringNew description, or null to clear it.
deviceProfileTokenStringToken of another profile to move the definition to. An explicit null or a blank value is refused, and an unknown token fails the whole update. The command key must be unique in the profile the definition ends up in.
impactStringNew impact (NORMAL, DISRUPTIVE or DESTRUCTIVE). An explicit null or an unknown value is refused. The change reaches devices when the profile is published.
metadataStringNew metadata (valid JSON, replacing the stored document), or null to clear it.
nameStringNew name, or null to clear it.
parameterSchemaStringNew parameters (validated as on create), or null to make the command one without structured arguments.

ConfigurationKeyInput​

input

One key of a configuration declaration. The key must follow the attribute-key grammar (letters, digits, hyphens and underscores, starting with a letter or digit), be unique within the declaration, and carry a valid value type.

Input fieldTypeDescription
descriptionStringAn optional human-readable note.
keyString!The shared attribute key.
valueTypeString!How the key's value is typed: STRING, LONG, DOUBLE, BOOLEAN or JSON.

CustomerCreateRequest​

input

No description yet.

Input fieldTypeDescription
customerTypeTokenString!No description yet.
descriptionStringNo description yet.
metadataStringNo description yet.
nameStringNo description yet.
tokenString!No description yet.

CustomerDeviceSearchCriteria​

input

Which customer's devices to return, and the page.

Input fieldTypeDescription
customerString!Token of the customer.
pageNumberInt!Page to return, starting at 1. Values below 1 are read as 1.
pageSizeInt!Results per page. Below 1 means the default of 100; above 1000 is capped at 1000.
relationshipTypeString!Token of the relationship type linking each device to the customer, such as "assigned".

CustomerSearchCriteria​

input

No description yet.

Input fieldTypeDescription
customerTypeTokenStringNo description yet.
pageNumberInt!No description yet.
pageSizeInt!No description yet.

CustomerTypeCreateRequest​

input

No description yet.

Input fieldTypeDescription
backgroundColorStringNo description yet.
borderColorStringNo description yet.
descriptionStringNo description yet.
foregroundColorStringNo description yet.
iconStringNo description yet.
imageUrlStringNo description yet.
metadataStringNo description yet.
nameStringNo description yet.
tokenString!No description yet.

CustomerTypeSearchCriteria​

input

No description yet.

Input fieldTypeDescription
pageNumberInt!No description yet.
pageSizeInt!No description yet.

CustomerTypeUpdateRequest​

input

No description yet.

Input fieldTypeDescription
backgroundColorStringNo description yet.
borderColorStringNo description yet.
descriptionStringNo description yet.
foregroundColorStringNo description yet.
iconStringNo description yet.
imageUrlStringNo description yet.
metadataStringNo description yet.
nameStringNo description yet.

CustomerUpdateRequest​

input

No description yet.

Input fieldTypeDescription
customerTypeTokenStringNo description yet.
descriptionStringNo description yet.
metadataStringNo description yet.
nameStringNo description yet.

DetectionRuleCreateRequest​

input

No description yet.

Input fieldTypeDescription
authoringGraphStringNo description yet.
definitionString!No description yet.
descriptionStringNo description yet.
deviceProfileTokenString!No description yet.
enabledBoolean!No description yet.
entityGroupTokenStringNo description yet.
entityGroupVersionIntNo description yet.
metadataStringNo description yet.
nameStringNo description yet.
tokenString!No description yet.

DetectionRuleSearchCriteria​

input

No description yet.

Input fieldTypeDescription
deviceProfileStringNo description yet.
pageNumberInt!No description yet.
pageSizeInt!No description yet.

DetectionRuleUpdateRequest​

input

No description yet.

Input fieldTypeDescription
authoringGraphStringNo description yet.
definitionStringNo description yet.
descriptionStringNo description yet.
deviceProfileTokenStringNo description yet.
enabledBooleanNo description yet.
entityGroupTokenStringNo description yet.
entityGroupVersionIntNo description yet.
metadataStringNo description yet.
nameStringNo description yet.

DeviceAliasInput​

input

A name for a device in a sender's vocabulary. The value is checked against the scheme and stored in one canonical spelling, so the same DevEUI written in either case is one alias.

Input fieldTypeDescription
schemeString!lorawan.deveui, tts.device-id, or custom.<name> (lower-case letters, digits, hyphen and underscore, up to 63 characters).
valueString!lorawan.deveui: exactly 16 hexadecimal digits. tts.device-id: 1 to 36 letters, digits and hyphens. custom.<name>: 1 to 128 characters with no control characters, case kept.

DeviceBulkCreateRequest​

input

Creates many devices of one type from templates. Device n of the batch (n running from startIndex to startIndex + count - 1) is rendered by replacing {n} with n, or {n:0Wd} with n zero-padded to width W. Each template may be at most 256 characters, with a pad width of at most 128. The whole batch is created or none of it is.

Input fieldTypeDescription
countInt!Number of devices to create, from 1 to 1000.
deviceTypeTokenString!Token of the device type for every device. An unknown token fails the request.
externalIdTemplateStringTemplate for the external ids. Optional. {random} renders a fresh random value per device. When creating more than one device the template must contain {n}, {n:0Wd} or {random}, since external ids are unique within the tenant. A rendered value may be at most 256 characters.
metadataStringMetadata given to every device. Must be valid JSON; an empty string means none.
nameTemplateStringTemplate for the device names. Optional; {random} is not allowed. A rendered name may be at most 128 characters.
startIndexIntIndex of the first device. Defaults to 1; values below 1 are refused.
tokenTemplateString!Template for the device tokens. It must contain {n} or {n:0Wd} so each token is distinct, must not contain {random}, and every rendered token must be a valid token not already in use.

DeviceClaimInitiateRequest​

input

No description yet.

Input fieldTypeDescription
claimSecretString!No description yet.
deviceTokenString!No description yet.
expiresAtStringNo description yet.

DeviceClaimRequest​

input

No description yet.

Input fieldTypeDescription
claimSecretString!No description yet.
customerTokenString!No description yet.
deviceTokenString!No description yet.
relationshipTypeStringThe relationship type of the edge the claim writes. Omit it to use the built-in tracked "assigned" type, which is what makes the device belong to the customer: only a tracked relationship counts as ownership, so a device claimed with an untracked type is not visible to members limited to that customer.

DeviceCreateRequest​

input

Fields for a new device.

Input fieldTypeDescription
aliases[DeviceAliasInput!]Names a sender other than the platform knows the device by, such as its LoRaWAN DevEUI. At most 8, one per scheme. A value another device in the tenant already holds under the scheme is refused with CONFLICT. Omitted or null creates the device with none.
descriptionStringFree-text description, up to 1024 characters.
deviceTypeTokenString!Token of the device's type. An unknown token fails the request.
enabledBooleanFalse to create the device already disabled. Omitted or null creates it enabled.
externalIdStringOptional business identifier, up to 256 characters. A value another device in the tenant already has is refused with CONFLICT.
gatewayTokenStringToken of the gateway device to create this device behind. The same rules as assignDeviceGateway apply, and a refusal fails the create. Omitted or null creates the device behind no gateway.
metadataStringCaller-defined metadata. Must be valid JSON; an empty string means none.
nameStringHuman-readable name, up to 128 characters.
provisioningProfileTokenStringToken of a provisioning profile to EARMARK the device for. Only that profile may later adopt this device when it registers itself; the profile must exist in the tenant and be of this device's type, otherwise the request is refused with INVALID_VALUE. Omitted or null earmarks nothing, and no profile will take the device over.
tokenString!Identifier for the new device. A token already in use in the tenant is refused with CONFLICT.

DeviceCredentialCreateRequest​

input

No description yet.

Input fieldTypeDescription
certificatePemStringX509_CERTIFICATE only: the device certificate in PEM, optionally followed by the intermediates that link it to the trust anchor. The chain is verified when the credential is created, so one that could not authenticate is refused with INVALID_VALUE. Only the device certificate is stored. Requires trustAnchorToken. Refused for any other type.
credentialIdString!The MQTT username, or the access token for ACCESS_TOKEN (at most 256 bytes). The token is stored only as a keyed digest and is returned once, in this mutation's response.
credentialTypeString!No description yet.
credentialValueStringThe password for an MQTT_BASIC credential: at least 16 bytes, counted as sent, and at most 4096. A shorter one is refused with extensions.code INVALID_VALUE. Write-only; it is stored only as a keyed digest. A password set before the 16-byte minimum keeps working until it is next changed.
deviceTokenString!No description yet.
enabledBoolean!No description yet.
expiresAtStringNo description yet.
metadataStringNo description yet.
tokenString!No description yet.
trustAnchorTokenStringX509_CERTIFICATE only: the trust anchor the certificate's chain must reach, at creation and at every connect.

DeviceCredentialSearchCriteria​

input

No description yet.

Input fieldTypeDescription
credentialIdStringAn MQTT username, or for ACCESS_TOKEN either the access token or the fingerprint a read returns. The token is matched through its digest; it is never stored or compared as sent.
credentialTypeStringNo description yet.
deviceStringNo description yet.
enabledBooleanNo description yet.
pageNumberInt!No description yet.
pageSizeInt!No description yet.

DeviceCredentialUpdateRequest​

input

No description yet.

Input fieldTypeDescription
credentialIdStringThe MQTT username, or the new access token for ACCESS_TOKEN. Setting it on an ACCESS_TOKEN credential rotates the token: the old one stops working at once and the new one is returned once, in this mutation's response. Required when this request changes the credential's type to or from ACCESS_TOKEN, and refused otherwise with extensions.code INVALID_VALUE.
credentialTypeStringNo description yet.
credentialValueStringThe new password for an MQTT_BASIC credential: at least 16 bytes, counted as sent, and at most 4096. A shorter one is refused with extensions.code INVALID_VALUE. Required when this request changes the credential's type to MQTT_BASIC. Ignored for a type that has no password. Write-only; it is stored only as a keyed digest. A password set before the 16-byte minimum keeps working until it is next changed.
deviceTokenStringNo description yet.
enabledBooleanNo description yet.
expiresAtStringNo description yet.
metadataStringNo description yet.

DeviceImportRow​

input

One device of an import file.

Input fieldTypeDescription
aliases[DeviceAliasInput!]Names a sender other than the platform knows the device by, as on a single create. A value another device holds makes the row a CONFLICT and a malformed one makes it INVALID. A device that already exists with a different alias set makes the row a CONFLICT.
credentialIdStringThe id the device presents (the access token itself, or the MQTT username). FACTORY_CREDENTIALS mode only.
credentialTypeStringACCESS_TOKEN or MQTT_BASIC. FACTORY_CREDENTIALS mode only.
credentialValueStringThe MQTT_BASIC password, at least 16 bytes. Write-only: stored as a keyed digest, never returned, logged or compared on a re-run. FACTORY_CREDENTIALS mode only.
descriptionStringFree-text description, up to 1024 characters.
deviceTypeTokenString!Token of the device's type. An unknown token makes the row INVALID.
externalIdStringOptional business identifier, up to 256 characters. Checked for conflicts; never the key.
installedAccuracyFloatHorizontal accuracy in metres, not negative. Needs installedLatitude and installedLongitude. Like installedElevation, an omitted accuracy compares as none against a device that exists.
installedElevationFloatMetres above the WGS84 ellipsoid. Needs installedLatitude and installedLongitude. When a device that already exists is compared, an omitted elevation compares as NONE: a row that leaves it out, against a device whose stored position has one, is a CONFLICT.
installedLatitudeFloatDegrees north where the device was installed, for a device that is fixed in place. Given together with installedLongitude or not at all. A value outside -90 to 90 makes the row INVALID. The position is stored with source IMPORT. A device that already exists makes the row a CONFLICT when its stored position differs, and always for a caller without location:installed:read, which is never told whether the position matches.
installedLongitudeFloatDegrees east where the device was installed, -180 to 180. See installedLatitude.
metadataStringCaller-defined metadata. Must be valid JSON; an empty string means none.
nameStringHuman-readable name, up to 128 characters.
provisioningProfileTokenStringToken of a provisioning profile to earmark the device for. An unknown profile, or one of a different device type, makes the row INVALID. A device that already exists with a different earmark makes the row a CONFLICT.
tokenString!Identifier of the device, and the key a re-run matches on. Required.

DeviceLocationDeclarationInput​

input

Sets a profile's position declaration. Supplying it states that the devices report their own position; an empty object makes that statement with no expectations.

Input fieldTypeDescription
expectedAccuracyMetersFloatHorizontal accuracy to expect, in metres. Must be a positive finite number when sent; omit it or send null to state no expectation.
expectedUpdateIntervalSecondsIntHow often a position fix is expected, in seconds. Must be positive when sent; omit it or send null to state no expectation.

DeviceProfileCreateRequest​

input

Fields for a new device profile. Its definitions are added afterwards, and take effect when the profile is published.

Input fieldTypeDescription
categoryStringFunctional class of the devices, such as thermostat or meter, up to 64 characters.
descriptionStringFree-text description, up to 1024 characters.
locationDeviceLocationDeclarationInputWhether the devices report their own position, and what to expect of it. Omit it when they do not.
metadataStringCaller-defined metadata. Must be valid JSON; an empty string means none.
nameStringHuman-readable name, up to 128 characters.
tokenString!Identifier for the new profile. A token already in use in the tenant is refused with CONFLICT.

DeviceProfileSearchCriteria​

input

Criteria for searching device profiles. Results are newest first.

Input fieldTypeDescription
pageNumberInt!Page to return, starting at 1. Values below 1 are read as 1.
pageSizeInt!Results per page. Below 1 means the default of 100; above 1000 is capped at 1000.

DeviceProfileUpdateRequest​

input

A partial update to a device profile's own fields. Omit a field to leave the stored value alone, send a value to set it, or send an explicit null to clear it. The profile is named by the mutation's token argument; use renameDeviceProfile to change its token. Changes here are part of the draft.

Input fieldTypeDescription
categoryStringNew category, or null to clear it.
descriptionStringNew description, or null to clear it.
locationDeviceLocationDeclarationInputNew position declaration, replacing the stored one; null states that the devices do not report their own position. An empty object states that they do, with no expectations.
metadataStringNew metadata (valid JSON, replacing the stored document), or null to clear it.
nameStringNew name, or null to clear it.

DeviceReplaceRequest​

input

No description yet.

Input fieldTypeDescription
credentialIdStringNo description yet.
credentialTokenStringNo description yet.
credentialTypeStringNo description yet.
credentialValueStringThe password for an MQTT_BASIC credential: at least 16 bytes, counted as sent, and at most 4096. A shorter one is refused with extensions.code INVALID_VALUE. Write-only; it is stored only as a keyed digest. A password set before the 16-byte minimum keeps working until it is next changed.
deviceTokenString!No description yet.
expiresAtStringNo description yet.
reasonStringNo description yet.
unitIdentifierStringNo description yet.

DeviceReplacementSearchCriteria​

input

No description yet.

Input fieldTypeDescription
deviceStringNo description yet.
pageNumberInt!No description yet.
pageSizeInt!No description yet.

DeviceRevokedCertificateSearchCriteria​

input

Criteria used when listing the revoked certificates of a trust anchor.

Input fieldTypeDescription
kindStringOnly MANUAL or only CRL entries.
pageNumberInt!1-based page number.
pageSizeInt!Entries per page.

DeviceSearchCriteria​

input

Criteria for searching devices. Results are newest first.

Input fieldTypeDescription
aliasDeviceAliasInputReturn only the device this alias names. The value is matched in its stored spelling, so a DevEUI in either case finds the same device. A malformed alias is refused with INVALID_VALUE, and a caller limited to part of the tenant is refused.
deviceTypeStringReturn only devices of the device type with this token. An unknown token matches nothing.
expectedProvisioningProfileStringReturn only devices earmarked for the provisioning profile with this token. An unknown token matches nothing.
nameContainsStringReturn only devices whose name or token contains this text, ignoring case (a name is optional, so an unnamed device is found by its token). Blank matches all.
pageNumberInt!Page to return, starting at 1. Values below 1 are read as 1.
pageSizeInt!Results per page. Below 1 means the default of 100; above 1000 is capped at 1000.
provisioningProfileStringReturn only devices that hold a credential issued by the provisioning profile with this token, revoked ones included. An unknown token matches nothing.

DeviceTrustAnchorCreateRequest​

input

Data required to create a trust anchor.

Input fieldTypeDescription
certificatePemString!Exactly one CA certificate in PEM: it must be a CA that may sign certificates, unexpired, use an RSA (2048 to 8192 bits), P-256, P-384 or Ed25519 key, be signed with a modern hash, and carry no name constraints. A private key anywhere in the text is refused. A tenant may hold 32 anchors.
descriptionStringFree-text description.
enabledBooleanDefaults to true.
metadataStringFree-form JSON the platform stores and does not interpret.
nameStringHuman-readable name.
tokenString!Identifier of the anchor, unique within the tenant.

DeviceTrustAnchorSearchCriteria​

input

Criteria used when searching for trust anchors.

Input fieldTypeDescription
enabledBooleanOnly anchors that are (or are not) enabled.
pageNumberInt!1-based page number.
pageSizeInt!Anchors per page.

DeviceTrustAnchorUpdateRequest​

input

A PARTIAL update: omit a field to leave it, send null to clear a nullable one. The certificate cannot be changed (another CA is another anchor).

Input fieldTypeDescription
descriptionStringFree-text description. Null clears it.
enabledBooleanRequired and unclearable. Setting it false ends the live sessions of the devices that rely on the anchor; if that cannot be confirmed the change is saved and the call answers that the sessions were not confirmed ended, and repeating it asks again.
metadataStringFree-form JSON the platform stores and does not interpret. Null clears it.
nameStringHuman-readable name. Null clears it.
ocspModeCertificateOcspModeRequired and unclearable. OFF asks no responder. ENFORCE_KNOWN and REQUIRE_CURRENT are refused while the instance's OCSP switch is off; REQUIRE_CURRENT is refused unless the instance allows it, and needs ocspResponderUrl.
ocspResponderUrlStringAn http or https URL, without credentials, that replaces each certificate's own responder. Null clears it. The address it resolves to must be one the instance's egress policy allows.
revocationModeCertificateRevocationModeRequired and unclearable. Switching to REQUIRE_CURRENT is refused while the anchor holds no current revocation list, or a registered certificate under it was issued by a CA that has none: the switch would refuse every such device.
revocationStaleGraceStringA Go duration of whole seconds, 0s to 168h. Null restores the instance default. While the anchor is in REQUIRE_CURRENT, a change is refused if it would leave an issuer without a current list.

DeviceTypeCreateRequest​

input

Fields for a new device type.

Input fieldTypeDescription
backgroundColorStringBackground colour, up to 32 characters.
borderColorStringBorder colour, up to 32 characters.
commandChannelStringCommand channel of the type: PUBLISH or HTTP_PULL, or omit it (or send an empty value) for the default channel, which behaves as PUBLISH. Any other value fails the request with INVALID_VALUE.
descriptionStringFree-text description, up to 1024 characters.
foregroundColorStringForeground (text) colour, up to 32 characters.
iconStringName of an icon representing the device type, up to 128 characters.
imageUrlStringURL of an image representing the device type, up to 512 characters.
maintenanceWindowTokenStringToken of the maintenance window that holds the type's disruptive commands until it opens. Omit it, or send an empty value, for a type with no window. An unknown token fails the request.
manufacturerStringManufacturer of the devices of this type, up to 128 characters.
metadataStringCaller-defined metadata. Must be valid JSON; an empty string means none.
modelStringModel of the devices of this type, up to 128 characters.
nameStringHuman-readable name, up to 128 characters.
profileTokenStringToken of the device profile the type adopts. Omit it, or send an empty value, for a type with no profile. An unknown token fails the request.
tokenString!Identifier for the new device type. A token already in use in the tenant is refused with CONFLICT.

DeviceTypeSearchCriteria​

input

Criteria for searching device types. Results are newest first.

Input fieldTypeDescription
nameContainsStringReturn only device types whose name or token contains this text, ignoring case (a name is optional, so an unnamed type is found by its token). Blank matches all.
pageNumberInt!Page to return, starting at 1. Values below 1 are read as 1.
pageSizeInt!Results per page. Below 1 means the default of 100; above 1000 is capped at 1000.

DeviceTypeUpdateRequest​

input

A partial update to a device type. Omit a field to leave the stored value alone, send a value to set it, or send an explicit null to clear it; sending only name renames the type and changes nothing else. The type is named by the mutation's token argument, so there is no token here and a type's token cannot be changed.

Input fieldTypeDescription
backgroundColorStringNew background colour, or null to clear it.
borderColorStringNew border colour, or null to clear it.
commandChannelStringNew command channel: PUBLISH or HTTP_PULL, or null (or an empty value) to return the type to the default channel, which behaves as PUBLISH. Any other value fails the whole update with INVALID_VALUE.
descriptionStringNew description, or null to clear it.
foregroundColorStringNew foreground colour, or null to clear it.
iconStringNew icon name, or null to clear it.
imageUrlStringNew image URL, or null to clear it.
maintenanceWindowTokenStringToken of the maintenance window the type should use; null or an empty value removes the current one, after which its disruptive commands are sent whenever the device is reachable. An unknown token fails the whole update. Commands already waiting for the old window are moved to the new schedule within about a minute.
manufacturerStringNew manufacturer, or null to clear it.
metadataStringNew metadata (valid JSON, replacing the stored document), or null to clear it.
modelStringNew model, or null to clear it.
nameStringNew name, or null to clear it.
profileTokenStringToken of the profile the type should adopt; null or an empty value detaches the current profile. An unknown token fails the whole update. Changing the profile changes what every device of the type measures and accepts.

DeviceUpdateRequest​

input

A partial update to a device. Omit a field to leave the stored value alone, send a value to set it, or send an explicit null to clear it; the fields that cannot be cleared say so. The device is named by the mutation's token argument, so there is no token here. An empty object changes nothing.

Input fieldTypeDescription
aliases[DeviceAliasInput!]Replaces the device's aliases with exactly this list. Null or an empty list removes them all; omit the field to leave them alone. A value another device already holds under a scheme refuses the whole update with CONFLICT.
descriptionStringNew description, or null to clear it.
deviceTypeTokenStringToken of a different device type to move the device to. An explicit null or an empty value is refused, because every device must have a type; an unknown token fails the whole update.
enabledBooleanFalse to disable the device, true to enable it again. An explicit null is refused. Disabling a device that is already disabled keeps the time it was first disabled.
externalIdStringNew business identifier, or null to clear it. A value another device already has is refused with CONFLICT.
metadataStringNew metadata (valid JSON, replacing the stored document), or null to clear it.
nameStringNew name, or null to clear it.

EntityAttributeSearchCriteria​

input

No description yet.

Input fieldTypeDescription
attrKeys[String!]No description yet.
entityStringNo description yet.
entityTypeStringNo description yet.
pageNumberInt!No description yet.
pageSizeInt!No description yet.
scopeStringNo description yet.

EntityAttributeSetRequest​

input

No description yet.

Input fieldTypeDescription
attrKeyString!No description yet.
entityString!No description yet.
entityTypeString!No description yet.
scopeString!No description yet.
valueStringNo description yet.
valueTypeString!No description yet.

EntityGroupCreateRequest​

input

No description yet.

Input fieldTypeDescription
backgroundColorStringNo description yet.
borderColorStringNo description yet.
descriptionStringNo description yet.
foregroundColorStringNo description yet.
iconStringNo description yet.
imageUrlStringNo description yet.
memberTypeString!No description yet.
membershipModeStringNo description yet.
metadataStringNo description yet.
nameStringNo description yet.
selectorStringNo description yet.
tokenString!No description yet.

EntityGroupSearchCriteria​

input

No description yet.

Input fieldTypeDescription
accessScopeBooleanKeep only the groups that are (true) or are not (false) access scopes. Omit it for both.
memberTypeStringNo description yet.
membershipModeStringNo description yet.
pageNumberInt!No description yet.
pageSizeInt!No description yet.

EntityGroupUpdateRequest​

input

No description yet.

Input fieldTypeDescription
backgroundColorStringNo description yet.
borderColorStringNo description yet.
descriptionStringNo description yet.
foregroundColorStringNo description yet.
iconStringNo description yet.
imageUrlStringNo description yet.
metadataStringNo description yet.
nameStringNo description yet.
selectorStringNo description yet.

EntityRefInput​

input

No description yet.

Input fieldTypeDescription
tokenString!No description yet.
typeString!No description yet.

EntityRelationshipCreateRequest​

input

No description yet.

Input fieldTypeDescription
metadataStringNo description yet.
relationshipTypeString!No description yet.
sourceString!No description yet.
sourceTypeString!No description yet.
targetString!No description yet.
targetTypeString!No description yet.
tokenString!No description yet.

EntityRelationshipSearchCriteria​

input

No description yet.

Input fieldTypeDescription
pageNumberInt!No description yet.
pageSizeInt!No description yet.
relationshipTypeStringNo description yet.
sourceStringNo description yet.
sourceTypeStringNo description yet.
targetStringNo description yet.
targetTypeStringNo description yet.
trackedBooleanNo description yet.

EntityRelationshipTypeCreateRequest​

input

No description yet.

Input fieldTypeDescription
descriptionStringNo description yet.
metadataStringNo description yet.
nameStringNo description yet.
tokenString!No description yet.
trackedBoolean!No description yet.

EntityRelationshipTypeSearchCriteria​

input

No description yet.

Input fieldTypeDescription
pageNumberInt!No description yet.
pageSizeInt!No description yet.

EntityRelationshipTypeUpdateRequest​

input

No description yet.

Input fieldTypeDescription
descriptionStringNo description yet.
metadataStringNo description yet.
nameStringNo description yet.
trackedBooleanNo description yet.

FacetKeySearchCriteria​

input

No description yet.

Input fieldTypeDescription
memberTypeStringNo description yet.
pageNumberInt!No description yet.
pageSizeInt!No description yet.

FacetKeySetRequest​

input

No description yet.

Input fieldTypeDescription
keyString!No description yet.
labelStringNo description yet.
memberTypeString!No description yet.
valueTypeString!No description yet.
values[String!]No description yet.

GeoFenceCreateRequest​

input

No description yet.

Input fieldTypeDescription
descriptionStringNo description yet.
geometryString!No description yet.
metadataStringNo description yet.
nameStringNo description yet.
tokenString!No description yet.

GeoFenceSearchCriteria​

input

No description yet.

Input fieldTypeDescription
pageNumberInt!No description yet.
pageSizeInt!No description yet.

GeoFenceUpdateRequest​

input

No description yet.

Input fieldTypeDescription
descriptionStringNo description yet.
geometryStringNo description yet.
metadataStringNo description yet.
nameStringNo description yet.

HeaderInput​

input

One header of a pasted webhook request.

Input fieldTypeDescription
nameString!The header name.
valueString!The header value.

InstalledPositionInput​

input

The position an operator, an import or a survey tool records.

Input fieldTypeDescription
accuracyFloatHorizontal accuracy in metres. Not negative.
elevationFloatMetres above the WGS84 ellipsoid.
latitudeFloat!Degrees north. Values outside -90 to 90, and values that are not numbers, are refused.
longitudeFloat!Degrees east. Values outside -180 to 180, and values that are not numbers, are refused.
sourceInstalledPositionSourceHow the position was obtained. MANUAL when omitted.

IntegrationCreateRequest​

input

Data required to create an integration.

Input fieldTypeDescription
descriptionStringFree-text description.
deviceTypeTokens[String!]!Tokens of the device types the integration may resolve devices of; at least one, at most 50.
enabledBoolean!Whether the integration accepts traffic. A disabled integration can be enabled later.
genericStringThe generic settings as a JSON object. Required for the generic types and refused for the others. idFrom is pointer:/path, header:Name or query:name; a binary body can only name a header or a query value.
identityStringDEV_EUI (the default) for CHIRPSTACK_V4; DEV_EUI (the default) or DEVICE_ID for TTS_V3; required, as ALIAS:custom.name, for the generic types.
linkMetricsBooleanStore the receive-link readings beside the decoded values. Defaults to false.
metadataStringFree-form JSON the platform stores and does not interpret.
nameStringHuman-readable name.
tokenString!Identifier of the integration, unique within the tenant. It is part of the sender's URL.
typeString!CHIRPSTACK_V4, TTS_V3, GENERIC_JSON or GENERIC_BINARY.

IntegrationSearchCriteria​

input

Criteria used when searching for integrations.

Input fieldTypeDescription
deviceTypeStringReturn only integrations whose scope includes the device type with this token.
enabledBooleanReturn only integrations that are enabled (true) or disabled (false).
pageNumberInt!1-based page number.
pageSizeInt!Rows per page.
typeStringReturn only integrations of this type.

IntegrationUpdateRequest​

input

A partial update of an integration. Omitted fields keep their stored value.

Input fieldTypeDescription
descriptionStringFree-text description. Null clears it.
deviceTypeTokens[String!]Replaces the scope. At least one device type; null is refused.
enabledBooleanRequired and unclearable.
genericStringReplaces the generic settings; refused for the network-server types, and null is refused for the generic ones.
identityStringRequired and unclearable; validated against the integration's type.
linkMetricsBooleanRequired and unclearable.
metadataStringFree-form JSON the platform stores and does not interpret. Null clears it.
nameStringHuman-readable name. Null clears it.

MaintenanceWindowCreateRequest​

input

Fields for a new maintenance window.

Input fieldTypeDescription
descriptionStringFree-text description, up to 1024 characters.
metadataStringCaller-defined metadata. Must be valid JSON; an empty string means none.
nameStringHuman-readable name, up to 128 characters.
slotsString!The weekly openings as a JSON array of {day, start, durationMinutes}, at least one and at most 56. Unknown keys and out-of-range values are refused.
timezoneString!An IANA time zone name such as Europe/Berlin. Local and unknown names are refused.
tokenString!Identifier for the new window. A token already in use in the tenant is refused with CONFLICT.

MaintenanceWindowSearchCriteria​

input

Criteria for searching maintenance windows. Results are newest first.

Input fieldTypeDescription
pageNumberInt!Page to return, starting at 1. Values below 1 are read as 1.
pageSizeInt!Results per page. Below 1 means the default of 100; above 1000 is capped at 1000.

MaintenanceWindowUpdateRequest​

input

A partial update to a maintenance window: omit a field to leave it alone.

Input fieldTypeDescription
descriptionStringNew description, or null to clear it.
metadataStringNew metadata (valid JSON, replacing the stored document), or null to clear it.
nameStringNew name, or null to clear it.
slotsStringNew weekly openings (validated as on create). An explicit null is refused.
timezoneStringNew time zone. An explicit null or an unknown zone is refused.

MetricDefinitionCreateRequest​

input

Fields for a new metric definition.

Input fieldTypeDescription
dataTypeString!The value type: DOUBLE, INT or BOOLEAN. STRING is refused, because a metric must be numeric; report string values as attributes instead.
descriptionStringFree-text description, up to 1024 characters.
descriptorStringOptional semantic tag, such as a Web of Things type.
deviceProfileTokenString!Token of the profile to declare the metric on. An unknown token fails the request.
enumStringAllowed values as a JSON array of strings. Must be valid JSON.
expressionStringA formula, which makes the new metric calculated: its value is computed from the profile's measured metrics instead of reported by devices. Omit it for a measured metric. Which of the two a metric is cannot be changed later. At most 1024 bytes and not blank. The formula is checked when the profile is published, not here; use testMetricFormula to check it sooner. It may read up to 8 numbers from the device's metadata as device.name; naming one is declaring it, and a device whose metadata lacks it gets no value for the reading.
maxValueFloatLargest value accepted for a DOUBLE or INT metric.
metadataStringCaller-defined metadata. Must be valid JSON; an empty string means none.
metricKeyString!The key measurements will use for this metric, at most 128 characters. A key the profile already declares is refused with CONFLICT.
minValueFloatSmallest value accepted for a DOUBLE or INT metric.
nameStringHuman-readable name, up to 128 characters.
tokenString!Identifier for the new metric definition. A token already in use in the tenant is refused with CONFLICT.
unitStringUnit of measure, such as a UCUM code (Cel, kW).

MetricDefinitionSearchCriteria​

input

Criteria for searching metric definitions. Results are newest first.

Input fieldTypeDescription
deviceProfileStringReturn only definitions on the profile with this token. An unknown token matches nothing.
metricKeyStringReturn only definitions with exactly this metric key.
pageNumberInt!Page to return, starting at 1. Values below 1 are read as 1.
pageSizeInt!Results per page. Below 1 means the default of 100; above 1000 is capped at 1000.

MetricDefinitionUpdateRequest​

input

A partial update to a metric definition. Omit a field to leave the stored value alone, send a value to set it, or send an explicit null to clear it; the fields that cannot be cleared say so. The definition is named by the mutation's token argument, so there is no token here. Any refusal leaves the definition unchanged.

Input fieldTypeDescription
dataTypeStringNew value type: DOUBLE, INT or BOOLEAN. An explicit null is refused.
descriptionStringNew description, or null to clear it.
descriptorStringNew semantic tag, or null to clear it.
deviceProfileTokenStringToken of another profile to move the definition to. An explicit null or a blank value is refused, and an unknown token fails the whole update.
enumStringNew allowed values as a JSON array of strings, or null to allow any value.
expressionStringNew formula for a calculated metric. Refused on a measured metric, which cannot become calculated. A null or blank value is refused on a calculated metric, which cannot become measured; delete it and create a new metric instead.
maxValueFloatNew upper bound, or null to remove it.
metadataStringNew metadata (valid JSON, replacing the stored document), or null to clear it.
metricKeyStringNew key for the metric, unique within the profile the definition ends up in. An explicit null or a blank value is refused.
minValueFloatNew lower bound, or null to remove it.
nameStringNew name, or null to clear it.
unitStringNew unit, or null to clear it.

MetricValueInput​

input

One typed value for testMetricFormula: a measured input of the sample, or a device constant.

Input fieldTypeDescription
keyString!The measured metric's key, or the device constant's name.
valueString!The value as a device would send it, such as 230.5, 12 or true; for a device constant, a number such as 1.02.

PaginationInput​

input

Which page of results to return.

Input fieldTypeDescription
pageNumberInt!Page to return, starting at 1. Values below 1 are read as 1.
pageSizeInt!Results per page. Below 1 means the default of 100; above 1000 is capped at 1000.

PayloadDecoderTestInput​

input

A decoder and one input to run it over. Name at most one of frameHex, frameBase64, json, webhookBody and sampleId; naming none runs only the saved vectors.

Input fieldTypeDescription
contentTypeStringWith webhookBody: the request's content type. A network server integration refuses a non-JSON one.
documentStringThe decoder document as JSON text. Omit to test the profile's saved draft decoder.
fCntIntThe LoRaWAN uplink frame counter, for a frame given as hex or base64.
fPortIntThe LoRaWAN application port, for a frame given as hex or base64.
frameBase64StringThe frame as base64. At most 4096 bytes once decoded.
frameHexStringThe frame as hex; whitespace is ignored. At most 4096 bytes once decoded.
headers[HeaderInput!]With webhookBody: the request headers, which a generic integration may read its device id from.
integrationTokenStringToken of the stored integration whose type and settings parse webhookBody.
jsonStringA JSON object, given to the decoder's JSON or DECODED input, whichever it declares.
messageTypeStringWith webhookBody: the message-type path segment some network servers post each message type to.
profileTokenString!Token of the profile whose draft metrics the decoder is checked against.
query[QueryParamInput!]With webhookBody: the query parameters, such as the event type of a network server.
sampleIdIDLoad the input from a stored failure sample of this profile instead. Running a decoder over a sample reveals its bytes, so this needs device:write, not device:read. A sample of another tenant or profile is NOT_FOUND.
webhookBodyStringA whole network-server or generic webhook body, up to 256 KiB, parsed by the same code that parses it at ingest. Needs integrationToken.

ProvisioningProfileCreateRequest​

input

No description yet.

Input fieldTypeDescription
credentialTypeStringNo description yet.
descriptionStringNo description yet.
deviceTypeTokenString!No description yet.
enabledBoolean!No description yet.
expiresAtStringNo description yet.
maxDevicesIntThe most devices the profile may register; at least 1. Omit or send null for no cap.
metadataStringNo description yet.
nameStringNo description yet.
provisionKeyString!No description yet.
strategyString!No description yet.
tokenString!No description yet.
trustAnchorTokenStringMakes this a certificate profile: its devices authenticate by a client certificate whose chain reaches this trust anchor, and it has no provision secret. credentialType, when sent, must be X509_CERTIFICATE. A tenant may hold eight certificate profiles. A device earmarked for one must have the token derived from its externalId, and takes it when the token is left empty.

ProvisioningProfileSearchCriteria​

input

No description yet.

Input fieldTypeDescription
deviceTypeStringNo description yet.
enabledBooleanNo description yet.
pageNumberInt!No description yet.
pageSizeInt!No description yet.
strategyStringNo description yet.

ProvisioningProfileUpdateRequest​

input

No description yet.

Input fieldTypeDescription
descriptionStringNo description yet.
deviceTypeTokenStringNo description yet.
enabledBooleanNo description yet.
expiresAtStringNo description yet.
maxDevicesIntThe most devices the profile may register; at least 1. Null removes the cap. Lowering it below the number already registered only refuses further registrations.
metadataStringNo description yet.
nameStringNo description yet.
provisionKeyStringNo description yet.
strategyStringNo description yet.
trustAnchorTokenStringRe-points a certificate profile at another trust anchor. Null is refused, and so is naming an anchor on a profile that authenticates by secret.

QueryParamInput​

input

One query parameter of a pasted webhook request.

Input fieldTypeDescription
nameString!The parameter name.
valueString!The parameter value.

UnregisteredIntegrationDeviceSearchCriteria​

input

Which integration's unregistered devices to return, and the page. Most recently seen first.

Input fieldTypeDescription
integrationString!Token of the integration. An unknown token matches nothing.
pageNumberInt!Page to return, starting at 1. Values below 1 are read as 1.
pageSizeInt!Results per page. Below 1 means the default of 100; above 1000 is capped at 1000.

Enums​

AlarmDispositionLabel · CertificateOcspMode · CertificateRevocationMode · CertificateRevocationReason · DeviceFacet · DeviceImportMode · DeviceImportOutcome · InstalledPositionSource · IntegrationDeviceOutcome · PayloadDecoderInput · PayloadDecoderKind · PositionFamily · RevocationStatus

AlarmDispositionLabel​

enum

An operator's verdict on one alarm cycle. New values may be added in a later release; a client should treat a value it does not know as unhandled rather than as any of these.

ValueDescription
TRUE_POSITIVEThe condition was real and needed attention.
FALSE_POSITIVEThe condition was not real, for example a bad reading, a fouled sensor or a threshold set wrong. A different rule should not have raised it.
EXPECTEDThe condition was real but expected and needed no action, such as planned maintenance or a commissioning test.

CertificateOcspMode​

enum

How an anchor uses its issuers' OCSP responders at connect. A certificate a responder says is revoked is always refused (a verified revoked answer for any certificate on any verified path wins); the modes differ in what an answer that could not be had means.

ValueDescription
OFFNo responder is asked. The default for every anchor.
ENFORCE_KNOWNA revoked answer refuses; a status that could not be learned (a timeout, an unreachable or refused responder, an unusable answer) is ADMITTED and counted. Availability over completeness.
REQUIRE_CURRENTA revoked answer refuses, and so does a certificate whose status could not be confirmed current. A responder outage refuses new connects once cached answers expire.

CertificateRevocationMode​

enum

How an anchor treats the completeness of its revocation lists.

ValueDescription
ENTRIESA listed certificate is refused; an issuer with no list, or a stale one, is allowed.
REQUIRE_CURRENTA listed certificate is refused, and so is one whose issuer has no current list.

CertificateRevocationReason​

enum

Why a certificate was revoked (RFC 5280 section 5.3.1). A manual revocation that names none is UNSPECIFIED.

ValueDescription
UNSPECIFIEDNo reason given.
KEY_COMPROMISEThe certificate's private key is known or suspected to be compromised.
CA_COMPROMISEThe key of the CA that issued the certificate is known or suspected to be compromised.
AFFILIATION_CHANGEDThe subject changed affiliation; the certificate no longer applies, and its key is not compromised.
SUPERSEDEDThe certificate was replaced by another.
CESSATION_OF_OPERATIONThe certificate is no longer needed because its subject ceased operating.
CERTIFICATE_HOLDThe certificate is suspended, not permanently revoked.
PRIVILEGE_WITHDRAWNA privilege the certificate granted was withdrawn.
AA_COMPROMISEThe key of an attribute authority is known or suspected to be compromised.

DeviceFacet​

enum

A free-text classification field whose values in use facetValues can list.

ValueDescription
MANUFACTURERThe manufacturer field of device types.
MODELThe model field of device types.
CATEGORYThe category field of device profiles.

DeviceImportMode​

enum

How an import treats credentials. No mode generates a secret.

ValueDescription
NONECreate devices only. Credential columns are refused.
FACTORY_CREDENTIALSCreate each device together with the credential a factory supplied for it, in one transaction. credentialType and credentialId are required on every row.

DeviceImportOutcome​

enum

What happened to one row of an import.

ValueDescription
CREATEDThe device (and its credential, in FACTORY_CREDENTIALS mode) was created; on a dry run, would be.
EXISTSThe device already exists exactly as the row describes it. A success; nothing was written.
CONFLICTThe device, external id or credential id is taken by something different. Nothing was written.
INVALIDThe row is malformed or names something that does not exist.
REFUSEDThe row is well-formed and was refused by a rule of the platform.

InstalledPositionSource​

enum

Where an installed position came from.

ValueDescription
SURVEYMeasured on site by a survey.
IMPORTRead from a fleet import file.
MANUALEntered by an operator.
INFERREDDerived from other data rather than measured.

IntegrationDeviceOutcome​

enum

What resolveIntegrationDevice concluded.

ValueDescription
RESOLVEDThe alias names a device whose type is in the integration's scope.
UNREGISTEREDNo device in scope carries the alias. The sighting was recorded, unless a device outside the integration's scope holds the alias, in which case it reads the same but nothing is recorded: that value is not an unregistered device, and creating a device with it would be refused.
DISABLEDThe token matched an integration that an operator has switched off. This is not a failed credential: nothing is resolved or recorded.
UNAUTHENTICATEDNo such integration, or the token did not match. One answer to both.

PayloadDecoderInput​

enum

Which input of an uplink a decoder reads. An uplink without it fails to decode with missing_input.

ValueDescription
FRAMEThe raw frame: a LoRaWAN payload, or a binary webhook body.
JSONA JSON item from a generic webhook.
DECODEDThe object a network server already decoded.

PayloadDecoderKind​

enum

The engine a payload decoder runs on. Only CEL is executable; a WASM document is refused with UNSUPPORTED_DECODER_KIND.

ValueDescription
CELExpressions in a bounded, loop-free expression language over a library of byte and bit readers.
WASMReserved. Refused wherever a decoder is saved or published.

PositionFamily​

enum

The entity kinds a position can be installed on.

ValueDescription
DEVICEA device, named by its token.
ASSETAn asset, named by its token.

RevocationStatus​

enum

How fresh a stored revocation list is.

ValueDescription
NONENo list is stored.
FRESHLess than three quarters of the list's validity has passed.
EXPIRINGThree quarters of its validity have passed, or nextUpdate has passed within the grace: push the next list.
STALEnextUpdate and the grace have both passed: REQUIRE_CURRENT no longer counts the list as current.