GraphQL reference: device-management

Generated from the schema this service serves, so it cannot fall behind it. The same schema is published as a file for tools and agents.

Endpoint	https://<your-host>/api/device-management/graphql
Auth plane	tenant — 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).
Authorize with	tenant access token
Schema file	/schema/device-management.graphql
Described	419 of 1435 elements

Queries

activeAssetTypeVersion · activeProfileRules · alarms · alarmsById · alarmsByToken · areaTypes · areaTypesById · areaTypesByToken · areas · areasById · areasByToken · assetAncestors · assetChildren · assetParent · assetTypeVersions · assetTypes · assetTypesById · assetTypesByToken · assets · assetsById · assetsByToken · auditEvents · commandDefinitions · commandDefinitionsById · commandDefinitionsByToken · currentFenceSetVersion · currentGeoFenceSet · currentGeoFenceSetManifest · customerTypes · customerTypesById · customerTypesByToken · customers · customersById · customersByToken · detectionRules · detectionRulesById · detectionRulesByToken · deviceClaim · deviceCommandVocabulary · deviceConfiguration · deviceConfigurationRevisions · deviceCredentials · deviceCredentialsById · deviceCredentialsByToken · deviceLocationDeclaration · deviceProfileVersions · deviceProfiles · deviceProfilesById · deviceProfilesByToken · deviceReplacements · deviceRosterPage · deviceThresholdAttributePage · deviceTypes · deviceTypesById · deviceTypesByToken · devices · devicesByExternalId · devicesById · devicesByToken · entityAttributes · entityGroupVersions · entityGroups · entityGroupsById · entityGroupsByToken · entityRelationshipTypes · entityRelationshipTypesById · entityRelationshipTypesByToken · entityRelationships · entityRelationshipsById · entityRelationshipsByToken · existingEntityRefs · facetKeys · facetValues · geoFenceGeometry · geoFenceSetManifest · geoFenceSetSnapshot · geoFences · geoFencesById · geoFencesByToken · metricDefinitions · metricDefinitionsById · metricDefinitionsByToken · previewSelector · provisioningProfiles · provisioningProfilesById · provisioningProfilesByToken · resolveDeviceGroupTargets · validateCommandEnqueue · validateCommandEnqueueBatch

activeAssetTypeVersion

No description yet.

Returns AssetTypeVersion

Argument	Type	Description
token	String!	No description yet.

activeProfileRules

No description yet.

Returns ActiveProfileRulesPage!

Argument	Type	Description
afterId	String	No description yet.
limit	Int!	No description yet.

alarms

No description yet.

Returns AlarmSearchResults!

Argument	Type	Description
criteria	AlarmSearchCriteria!	No description yet.

alarmsById

No description yet.

Returns [Alarm!]!

Argument	Type	Description
ids	[ID!]!	No description yet.

alarmsByToken

No description yet.

Returns [Alarm!]!

Argument	Type	Description
tokens	[String!]!	No description yet.

areaTypes

No description yet.

Returns AreaTypeSearchResults!

Argument	Type	Description
criteria	AreaTypeSearchCriteria!	No description yet.

areaTypesById

No description yet.

Returns [AreaType!]!

Argument	Type	Description
ids	[ID!]!	No description yet.

areaTypesByToken

No description yet.

Returns [AreaType!]!

Argument	Type	Description
tokens	[String!]!	No description yet.

areas

No description yet.

Returns AreaSearchResults!

Argument	Type	Description
criteria	AreaSearchCriteria!	No description yet.

areasById

No description yet.

Returns [Area!]!

Argument	Type	Description
ids	[ID!]!	No description yet.

areasByToken

No description yet.

Returns [Area!]!

Argument	Type	Description
tokens	[String!]!	No description yet.

assetAncestors

No description yet.

Returns [Asset!]!

Argument	Type	Description
token	String!	No description yet.

assetChildren

No description yet.

Returns AssetSearchResults!

Argument	Type	Description
pagination	PaginationInput!	No description yet.
parentToken	String	No description yet.

assetParent

No description yet.

Returns Asset

Argument	Type	Description
token	String!	No description yet.

assetTypeVersions

No description yet.

Returns [AssetTypeVersion!]!

Argument	Type	Description
limit	Int	No description yet.
offset	Int	No description yet.
token	String!	No description yet.

assetTypes

No description yet.

Returns AssetTypeSearchResults!

Argument	Type	Description
criteria	AssetTypeSearchCriteria!	No description yet.

assetTypesById

No description yet.

Returns [AssetType!]!

Argument	Type	Description
ids	[ID!]!	No description yet.

assetTypesByToken

No description yet.

Returns [AssetType!]!

Argument	Type	Description
tokens	[String!]!	No description yet.

assets

No description yet.

Returns AssetSearchResults!

Argument	Type	Description
criteria	AssetSearchCriteria!	No description yet.

assetsById

No description yet.

Returns [Asset!]!

Argument	Type	Description
ids	[ID!]!	No description yet.

assetsByToken

No description yet.

Returns [Asset!]!

Argument	Type	Description
tokens	[String!]!	No description yet.

auditEvents

No description yet.

Returns AuditEventSearchResults!

Argument	Type	Description
criteria	AuditEventSearchCriteria!	No description yet.

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!

Argument	Type	Description
criteria	CommandDefinitionSearchCriteria!	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!]!

Argument	Type	Description
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!]!

Argument	Type	Description
tokens	[String!]!	Tokens of the command definitions to return.

currentFenceSetVersion

No description yet.

Returns Int!

currentGeoFenceSet

No description yet.

Returns GeoFenceSetSnapshot!

currentGeoFenceSetManifest

No description yet.

Returns GeoFenceSetManifest!

customerTypes

No description yet.

Returns CustomerTypeSearchResults!

Argument	Type	Description
criteria	CustomerTypeSearchCriteria!	No description yet.

customerTypesById

No description yet.

Returns [CustomerType!]!

Argument	Type	Description
ids	[ID!]!	No description yet.

customerTypesByToken

No description yet.

Returns [CustomerType!]!

Argument	Type	Description
tokens	[String!]!	No description yet.

customers

No description yet.

Returns CustomerSearchResults!

Argument	Type	Description
criteria	CustomerSearchCriteria!	No description yet.

customersById

No description yet.

Returns [Customer!]!

Argument	Type	Description
ids	[ID!]!	No description yet.

customersByToken

No description yet.

Returns [Customer!]!

Argument	Type	Description
tokens	[String!]!	No description yet.

detectionRules

No description yet.

Returns DetectionRuleSearchResults!

Argument	Type	Description
criteria	DetectionRuleSearchCriteria!	No description yet.

detectionRulesById

No description yet.

Returns [DetectionRule!]!

Argument	Type	Description
ids	[ID!]!	No description yet.

detectionRulesByToken

No description yet.

Returns [DetectionRule!]!

Argument	Type	Description
tokens	[String!]!	No description yet.

deviceClaim

No description yet.

Returns DeviceClaim

Argument	Type	Description
deviceToken	String!	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

Argument	Type	Description
deviceToken	String!	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

Argument	Type	Description
deviceToken	String!	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!

Argument	Type	Description
deviceToken	String!	The token of the device whose revisions to list.
pagination	PaginationInput!	Which page of revisions to return, bounded by the platform page-size ceiling.

deviceCredentials

No description yet.

Returns DeviceCredentialSearchResults!

Argument	Type	Description
criteria	DeviceCredentialSearchCriteria!	No description yet.

deviceCredentialsById

No description yet.

Returns [DeviceCredential!]!

Argument	Type	Description
ids	[ID!]!	No description yet.

deviceCredentialsByToken

No description yet.

Returns [DeviceCredential!]!

Argument	Type	Description
tokens	[String!]!	No description yet.

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

Argument	Type	Description
deviceToken	String!	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!]!

Argument	Type	Description
limit	Int	Maximum number of versions to return, at least 1. Omitted, or above 1000, it is 1000; below 1 is refused.
offset	Int	Number of newest versions to skip before the first one returned. Omitted, it is 0; negative is refused.
token	String!	Token of the profile.

deviceProfiles

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

Returns DeviceProfileSearchResults!

Argument	Type	Description
criteria	DeviceProfileSearchCriteria!	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!]!

Argument	Type	Description
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!]!

Argument	Type	Description
tokens	[String!]!	Tokens of the profiles to return.

deviceReplacements

No description yet.

Returns DeviceReplacementSearchResults!

Argument	Type	Description
criteria	DeviceReplacementSearchCriteria!	No description yet.

deviceRosterPage

No description yet.

Returns DeviceRosterPage!

Argument	Type	Description
afterId	String	No description yet.
limit	Int!	No description yet.

deviceThresholdAttributePage

No description yet.

Returns DeviceThresholdAttributePage!

Argument	Type	Description
afterId	String	No description yet.
limit	Int!	No description yet.

deviceTypes

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

Returns DeviceTypeSearchResults!

Argument	Type	Description
criteria	DeviceTypeSearchCriteria!	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!]!

Argument	Type	Description
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!]!

Argument	Type	Description
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!

Argument	Type	Description
criteria	DeviceSearchCriteria!	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!]!

Argument	Type	Description
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!]!

Argument	Type	Description
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!]!

Argument	Type	Description
tokens	[String!]!	Tokens of the devices to return.

entityAttributes

No description yet.

Returns EntityAttributeSearchResults!

Argument	Type	Description
criteria	EntityAttributeSearchCriteria!	No description yet.

entityGroupVersions

No description yet.

Returns [EntityGroupVersion!]!

Argument	Type	Description
limit	Int	No description yet.
offset	Int	No description yet.
token	String!	No description yet.

entityGroups

No description yet.

Returns EntityGroupSearchResults!

Argument	Type	Description
criteria	EntityGroupSearchCriteria!	No description yet.

entityGroupsById

No description yet.

Returns [EntityGroup!]!

Argument	Type	Description
ids	[ID!]!	No description yet.

entityGroupsByToken

No description yet.

Returns [EntityGroup!]!

Argument	Type	Description
tokens	[String!]!	No description yet.

entityRelationshipTypes

No description yet.

Returns EntityRelationshipTypeSearchResults!

Argument	Type	Description
criteria	EntityRelationshipTypeSearchCriteria!	No description yet.

entityRelationshipTypesById

No description yet.

Returns [EntityRelationshipType!]!

Argument	Type	Description
ids	[String!]!	No description yet.

entityRelationshipTypesByToken

No description yet.

Returns [EntityRelationshipType!]!

Argument	Type	Description
tokens	[String!]!	No description yet.

entityRelationships

No description yet.

Returns EntityRelationshipSearchResults!

Argument	Type	Description
criteria	EntityRelationshipSearchCriteria!	No description yet.

entityRelationshipsById

No description yet.

Returns [EntityRelationship!]!

Argument	Type	Description
ids	[String!]!	No description yet.

entityRelationshipsByToken

No description yet.

Returns [EntityRelationship!]!

Argument	Type	Description
tokens	[String!]!	No description yet.

existingEntityRefs

No description yet.

Returns [EntityRef!]!

Argument	Type	Description
refs	[EntityRefInput!]!	No description yet.

facetKeys

No description yet.

Returns FacetKeySearchResults!

Argument	Type	Description
criteria	FacetKeySearchCriteria!	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!]!

Argument	Type	Description
facet	DeviceFacet!	The field whose values to list.

geoFenceGeometry

No description yet.

Returns [GeoFenceGeometry!]!

Argument	Type	Description
hashes	[String!]!	No description yet.

geoFenceSetManifest

No description yet.

Returns GeoFenceSetManifest!

Argument	Type	Description
version	Int!	No description yet.

geoFenceSetSnapshot

No description yet.

Returns GeoFenceSetSnapshot!

Argument	Type	Description
version	Int!	No description yet.

geoFences

No description yet.

Returns GeoFenceSearchResults!

Argument	Type	Description
criteria	GeoFenceSearchCriteria!	No description yet.

geoFencesById

No description yet.

Returns [GeoFence!]!

Argument	Type	Description
ids	[ID!]!	No description yet.

geoFencesByToken

No description yet.

Returns [GeoFence!]!

Argument	Type	Description
tokens	[String!]!	No description yet.

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!

Argument	Type	Description
criteria	MetricDefinitionSearchCriteria!	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!]!

Argument	Type	Description
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!]!

Argument	Type	Description
tokens	[String!]!	Tokens of the metric definitions to return.

previewSelector

No description yet.

Returns SelectorPreview!

Argument	Type	Description
memberType	String!	No description yet.
pagination	PaginationInput!	No description yet.
selector	String!	No description yet.

provisioningProfiles

No description yet.

Returns ProvisioningProfileSearchResults!

Argument	Type	Description
criteria	ProvisioningProfileSearchCriteria!	No description yet.

provisioningProfilesById

No description yet.

Returns [ProvisioningProfile!]!

Argument	Type	Description
ids	[ID!]!	No description yet.

provisioningProfilesByToken

No description yet.

Returns [ProvisioningProfile!]!

Argument	Type	Description
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!

Argument	Type	Description
afterId	String	The nextCursor of the previous page. Omit it to start from the beginning. A malformed cursor fails the request.
groupToken	String!	Token of the entity group.
limit	Int!	Maximum number of devices on the page, from 1 to 1000.
version	Int	Published version of a dynamic group to resolve. Omit it for the active version. Must be omitted for a static group.

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!

Argument	Type	Description
commandKey	String!	Key of the command to send.
deviceToken	String!	Token of the target device.
payload	String	The 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!]!

Argument	Type	Description
commandKey	String!	Key of the command to send.
deviceTokens	[String!]!	Tokens of the target devices, at most 2000.
payload	String	The command's arguments as a JSON object, applied to every device. Omit it to check a command with no arguments.

Mutations

acknowledgeAlarm · acknowledgeAlarms · cancelDeviceClaim · claimDevice · clearAlarm · clearAssetParent · createArea · createAreaType · createAsset · createAssetType · createCommandDefinition · createCustomer · createCustomerType · createDetectionRule · createDevice · createDeviceCredential · createDeviceProfile · createDeviceType · createDevices · createEntityGroup · createEntityRelationship · createEntityRelationshipType · createEntityRelationships · createGeoFence · createMetricDefinition · createProvisioningProfile · deleteArea · deleteAreaType · deleteAsset · deleteAssetType · deleteCommandDefinition · deleteCustomer · deleteCustomerType · deleteDetectionRule · deleteDevice · deleteDeviceCredential · deleteDeviceProfile · deleteDeviceType · deleteEntityAttribute · deleteEntityGroup · deleteEntityRelationshipType · deleteFacetKey · deleteGeoFence · deleteMetricDefinition · deleteProvisioningProfile · initiateDeviceClaim · publishAssetType · publishDeviceProfile · publishEntityGroup · removeEntityRelationship · removeEntityRelationships · renameDeviceProfile · replaceDevice · rollbackAssetType · rollbackDeviceProfile · rollbackEntityGroup · setAssetParent · setDeviceProfileConfigurationDeclaration · setEntityAttribute · setFacetKey · updateArea · updateAreaType · updateAsset · updateAssetType · updateCommandDefinition · updateCustomer · updateCustomerType · updateDetectionRule · updateDevice · updateDeviceCredential · updateDeviceProfile · updateDeviceType · updateEntityGroup · updateEntityRelationshipType · updateGeoFence · updateMetricDefinition · updateProvisioningProfile

acknowledgeAlarm

No description yet.

Returns Alarm!

Argument	Type	Description
token	String!	No description yet.

acknowledgeAlarms

No description yet.

Returns BulkAcknowledgeAlarmsResult!

Argument	Type	Description
tokens	[String!]!	No description yet.

cancelDeviceClaim

No description yet.

Returns Boolean!

Argument	Type	Description
deviceToken	String!	No description yet.

claimDevice

No description yet.

Returns EntityRelationship!

Argument	Type	Description
request	DeviceClaimRequest!	No description yet.

clearAlarm

No description yet.

Returns Alarm!

Argument	Type	Description
token	String!	No description yet.

clearAssetParent

No description yet.

Returns Boolean!

Argument	Type	Description
childToken	String!	No description yet.

createArea

No description yet.

Returns Area!

Argument	Type	Description
request	AreaCreateRequest	No description yet.

createAreaType

No description yet.

Returns AreaType!

Argument	Type	Description
request	AreaTypeCreateRequest	No description yet.

createAsset

No description yet.

Returns Asset!

Argument	Type	Description
request	AssetCreateRequest	No description yet.

createAssetType

No description yet.

Returns AssetType!

Argument	Type	Description
request	AssetTypeCreateRequest	No 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!

Argument	Type	Description
request	CommandDefinitionCreateRequest	The new command definition's fields. Although the schema lets it be omitted, a call without it fails.

createCustomer

No description yet.

Returns Customer!

Argument	Type	Description
request	CustomerCreateRequest	No description yet.

createCustomerType

No description yet.

Returns CustomerType!

Argument	Type	Description
request	CustomerTypeCreateRequest	No description yet.

createDetectionRule

No description yet.

Returns DetectionRule!

Argument	Type	Description
request	DetectionRuleCreateRequest!	No description yet.

createDevice

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

Returns Device!

Argument	Type	Description
request	DeviceCreateRequest	The new device's fields. Although the schema lets it be omitted, a call without it fails.

createDeviceCredential

No description yet.

Returns DeviceCredential!

Argument	Type	Description
request	DeviceCredentialCreateRequest	No description yet.

createDeviceProfile

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

Returns DeviceProfile!

Argument	Type	Description
request	DeviceProfileCreateRequest	The new profile's fields. Although the schema lets it be omitted, a call without it fails.

createDeviceType

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

Returns DeviceType!

Argument	Type	Description
request	DeviceTypeCreateRequest	The 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!]!

Argument	Type	Description
request	DeviceBulkCreateRequest!	The type, count and templates of the devices to create.

createEntityGroup

No description yet.

Returns EntityGroup!

Argument	Type	Description
request	EntityGroupCreateRequest	No description yet.

createEntityRelationship

No description yet.

Returns EntityRelationship!

Argument	Type	Description
request	EntityRelationshipCreateRequest!	No description yet.

createEntityRelationshipType

No description yet.

Returns EntityRelationshipType!

Argument	Type	Description
request	EntityRelationshipTypeCreateRequest!	No description yet.

createEntityRelationships

No description yet.

Returns [EntityRelationship!]!

Argument	Type	Description
requests	[EntityRelationshipCreateRequest!]!	No description yet.

createGeoFence

No description yet.

Returns GeoFence!

Argument	Type	Description
request	GeoFenceCreateRequest!	No description yet.

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!

Argument	Type	Description
request	MetricDefinitionCreateRequest	The new metric definition's fields. Although the schema lets it be omitted, a call without it fails.

createProvisioningProfile

No description yet.

Returns ProvisioningProfile!

Argument	Type	Description
request	ProvisioningProfileCreateRequest	No description yet.

deleteArea

No description yet.

Returns Boolean!

Argument	Type	Description
token	String!	No description yet.

deleteAreaType

No description yet.

Returns Boolean!

Argument	Type	Description
token	String!	No description yet.

deleteAsset

No description yet.

Returns Boolean!

Argument	Type	Description
token	String!	No description yet.

deleteAssetType

No description yet.

Returns Boolean!

Argument	Type	Description
token	String!	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!

Argument	Type	Description
token	String!	Token of the command definition to delete.

deleteCustomer

No description yet.

Returns Boolean!

Argument	Type	Description
token	String!	No description yet.

deleteCustomerType

No description yet.

Returns Boolean!

Argument	Type	Description
token	String!	No description yet.

deleteDetectionRule

No description yet.

Returns Boolean!

Argument	Type	Description
token	String!	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!

Argument	Type	Description
token	String!	Token of the device to delete.

deleteDeviceCredential

No description yet.

Returns Boolean!

Argument	Type	Description
token	String!	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!

Argument	Type	Description
token	String!	Token of the profile to delete.

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!

Argument	Type	Description
token	String!	Token of the device type to delete.

deleteEntityAttribute

No description yet.

Returns Boolean!

Argument	Type	Description
attrKey	String!	No description yet.
entity	String!	No description yet.
entityType	String!	No description yet.
scope	String!	No description yet.

deleteEntityGroup

No description yet.

Returns Boolean!

Argument	Type	Description
token	String!	No description yet.

deleteEntityRelationshipType

No description yet.

Returns Boolean!

Argument	Type	Description
token	String!	No description yet.

deleteFacetKey

No description yet.

Returns Boolean!

Argument	Type	Description
key	String!	No description yet.
memberType	String!	No description yet.

deleteGeoFence

No description yet.

Returns Boolean!

Argument	Type	Description
token	String!	No description yet.

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!

Argument	Type	Description
token	String!	Token of the metric definition to delete.

deleteProvisioningProfile

No description yet.

Returns Boolean!

Argument	Type	Description
token	String!	No description yet.

initiateDeviceClaim

No description yet.

Returns DeviceClaim!

Argument	Type	Description
request	DeviceClaimInitiateRequest!	No description yet.

publishAssetType

No description yet.

Returns AssetTypeVersion!

Argument	Type	Description
description	String	No description yet.
label	String	No description yet.
token	String!	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!

Argument	Type	Description
description	String	Optional notes for the version, up to 1024 characters.
label	String	Optional label for the version, up to 128 characters, such as a release name.
token	String!	Token of the profile to publish.

publishEntityGroup

No description yet.

Returns EntityGroupVersion!

Argument	Type	Description
description	String	No description yet.
label	String	No description yet.
token	String!	No description yet.

removeEntityRelationship

No description yet.

Returns Boolean!

Argument	Type	Description
token	String!	No description yet.

removeEntityRelationships

No description yet.

Returns Boolean!

Argument	Type	Description
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!

Argument	Type	Description
newToken	String!	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.
token	String!	Current token of the profile.

replaceDevice

No description yet.

Returns DeviceReplaceResult!

Argument	Type	Description
request	DeviceReplaceRequest!	No description yet.

rollbackAssetType

No description yet.

Returns AssetType!

Argument	Type	Description
token	String!	No description yet.
version	Int!	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. Returns the updated profile. Requires device:write.

Returns DeviceProfile!

Argument	Type	Description
token	String!	Token of the profile.
version	Int!	Number of the published version to make active.

rollbackEntityGroup

No description yet.

Returns EntityGroup!

Argument	Type	Description
token	String!	No description yet.
version	Int!	No description yet.

setAssetParent

No description yet.

Returns EntityRelationship!

Argument	Type	Description
childToken	String!	No description yet.
parentToken	String!	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!

Argument	Type	Description
keys	[ConfigurationKeyInput!]!	The complete new declaration, replacing the current one.
token	String!	Token of the profile.

setEntityAttribute

No description yet.

Returns EntityAttribute!

Argument	Type	Description
request	EntityAttributeSetRequest!	No description yet.

setFacetKey

No description yet.

Returns FacetKey!

Argument	Type	Description
request	FacetKeySetRequest	No description yet.

updateArea

No description yet.

Returns Area!

Argument	Type	Description
request	AreaUpdateRequest!	No description yet.
token	String!	No description yet.

updateAreaType

No description yet.

Returns AreaType!

Argument	Type	Description
request	AreaTypeUpdateRequest!	No description yet.
token	String!	No description yet.

updateAsset

No description yet.

Returns Asset!

Argument	Type	Description
request	AssetUpdateRequest!	No description yet.
token	String!	No description yet.

updateAssetType

No description yet.

Returns AssetType!

Argument	Type	Description
request	AssetTypeUpdateRequest!	No description yet.
token	String!	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!

Argument	Type	Description
request	CommandDefinitionUpdateRequest!	The fields to change.
token	String!	Token of the command definition to update.

updateCustomer

No description yet.

Returns Customer!

Argument	Type	Description
request	CustomerUpdateRequest!	No description yet.
token	String!	No description yet.

updateCustomerType

No description yet.

Returns CustomerType!

Argument	Type	Description
request	CustomerTypeUpdateRequest!	No description yet.
token	String!	No description yet.

updateDetectionRule

No description yet.

Returns DetectionRule!

Argument	Type	Description
request	DetectionRuleUpdateRequest!	No description yet.
token	String!	No description yet.

updateDevice

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

Returns Device!

Argument	Type	Description
request	DeviceUpdateRequest!	The fields to change.
token	String!	Token of the device to update.

updateDeviceCredential

No description yet.

Returns DeviceCredential!

Argument	Type	Description
request	DeviceCredentialUpdateRequest!	No description yet.
token	String!	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!

Argument	Type	Description
request	DeviceProfileUpdateRequest!	The fields to change.
token	String!	Token of the profile to update.

updateDeviceType

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

Returns DeviceType!

Argument	Type	Description
request	DeviceTypeUpdateRequest!	The fields to change.
token	String!	Token of the device type to update.

updateEntityGroup

No description yet.

Returns EntityGroup!

Argument	Type	Description
request	EntityGroupUpdateRequest!	No description yet.
token	String!	No description yet.

updateEntityRelationshipType

No description yet.

Returns EntityRelationshipType!

Argument	Type	Description
request	EntityRelationshipTypeUpdateRequest!	No description yet.
token	String!	No description yet.

updateGeoFence

No description yet.

Returns GeoFence!

Argument	Type	Description
request	GeoFenceUpdateRequest!	No description yet.
token	String!	No description yet.

updateMetricDefinition

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

Returns MetricDefinition!

Argument	Type	Description
request	MetricDefinitionUpdateRequest!	The fields to change.
token	String!	Token of the metric definition to update.

updateProvisioningProfile

No description yet.

Returns ProvisioningProfile!

Argument	Type	Description
request	ProvisioningProfileUpdateRequest!	No description yet.
token	String!	No description yet.

Subscriptions

alarmStream

alarmStream

No description yet.

Returns AlarmEvent!

Argument	Type	Description
alarmKey	String	No description yet.
originator	String	No description yet.
originatorType	String	No description yet.
severity	String	No description yet.
state	String	No description yet.

Objects

ActiveProfileRules · ActiveProfileRulesPage · Alarm · AlarmAckRefusal · AlarmEvent · AlarmSearchResults · Area · AreaSearchResults · AreaType · AreaTypeSearchResults · Asset · AssetSearchResults · AssetType · AssetTypeSearchResults · AssetTypeVersion · AuditEvent · AuditEventSearchResults · BatchEnqueueRefusal · BulkAcknowledgeAlarmsResult · CommandDefinition · CommandDefinitionSearchResults · CommandEnqueueVerdict · ConfigurationKey · Customer · CustomerSearchResults · CustomerType · CustomerTypeSearchResults · DetectionRule · DetectionRuleSearchResults · Device · DeviceClaim · DeviceCommandVocabulary · DeviceConfiguration · DeviceConfigurationReport · DeviceConfigurationRevision · DeviceConfigurationRevisionSearchResults · DeviceCredential · DeviceCredentialSearchResults · DeviceGroupTargetPage · DeviceLocationCapability · DeviceLocationDeclaration · DeviceProfile · DeviceProfileSearchResults · DeviceProfileVersion · DeviceReplaceResult · DeviceReplacement · DeviceReplacementSearchResults · DeviceRosterEntry · DeviceRosterPage · DeviceSearchResults · DeviceThresholdAttribute · DeviceThresholdAttributePage · DeviceType · DeviceTypeSearchResults · EntityAttribute · EntityAttributeSearchResults · EntityGroup · EntityGroupMember · EntityGroupMemberSearchResults · EntityGroupSearchResults · EntityGroupVersion · EntityRef · EntityRelationship · EntityRelationshipSearchResults · EntityRelationshipType · EntityRelationshipTypeSearchResults · FacetKey · FacetKeySearchResults · GeoFence · GeoFenceGeometry · GeoFenceManifestEntry · GeoFenceSearchResults · GeoFenceSetManifest · GeoFenceSetSnapshot · GeoFenceSnapshotEntry · GeoFenceSnapshotEntrySearchResults · MetricDefinition · MetricDefinitionSearchResults · ProvisioningProfile · ProvisioningProfileSearchResults · PublishedCommand · PublishedProfileRule · SearchResultsPagination · SelectorPreview

ActiveProfileRules

object

No description yet.

Field	Type	Description
activeSince	String!	No description yet.
profileToken	String!	No description yet.
rules	[PublishedProfileRule!]!	No description yet.
versionToken	String!	No description yet.

ActiveProfileRulesPage

object

No description yet.

Field	Type	Description
entries	[ActiveProfileRules!]!	No description yet.
nextCursor	String	No description yet.

Alarm

object

No description yet.

Implements Model, TokenReference, MetadataEntity

Field	Type	Description
acknowledged	Boolean!	No description yet.
acknowledgedBy	String	No description yet.
acknowledgedTime	String	No description yet.
alarmKey	String!	No description yet.
clearedTime	String	No description yet.
createdAt	String	No description yet.
deletedAt	String	No description yet.
id	ID!	No description yet.
lastValue	Float	No description yet.
metadata	String	No description yet.
metricKey	String!	No description yet.
originatorId	ID!	No description yet.
originatorToken	String	No description yet.
originatorType	String!	No description yet.
raisedTime	String	No description yet.
severity	String!	No description yet.
state	String!	No description yet.
token	String!	No description yet.
updatedAt	String	No description yet.

AlarmAckRefusal

object

No description yet.

Field	Type	Description
code	String!	No description yet.
reason	String!	No description yet.
token	String!	No description yet.

AlarmEvent

object

No description yet.

Field	Type	Description
acknowledged	Boolean!	No description yet.
acknowledgedBy	String	No description yet.
alarmKey	String!	No description yet.
alarmToken	String!	No description yet.
eventType	String!	No description yet.
lastValue	Float	No description yet.
metricKey	String!	No description yet.
occurredTime	String!	No description yet.
originatorId	ID!	No description yet.
originatorToken	String	No description yet.
originatorType	String!	No description yet.
previousSeverity	String	No description yet.
raisedTime	String	No description yet.
severity	String!	No description yet.
state	String!	No description yet.

AlarmSearchResults

object

No description yet.

Field	Type	Description
pagination	SearchResultsPagination!	No description yet.
results	[Alarm!]!	No description yet.

Area

object

No description yet.

Implements Model, TokenReference, NamedEntity, MetadataEntity, Entity

Field	Type	Description
areaType	AreaType!	No description yet.
createdAt	String	No description yet.
deletedAt	String	No description yet.
description	String	No description yet.
id	ID!	No description yet.
metadata	String	No description yet.
name	String	No description yet.
token	String!	No description yet.
updatedAt	String	No description yet.

AreaSearchResults

object

No description yet.

Field	Type	Description
pagination	SearchResultsPagination!	No description yet.
results	[Area!]!	No description yet.

AreaType

object

No description yet.

Implements Model, TokenReference, NamedEntity, BrandedEntity, MetadataEntity

Field	Type	Description
backgroundColor	String	No description yet.
borderColor	String	No description yet.
createdAt	String	No description yet.
deletedAt	String	No description yet.
description	String	No description yet.
foregroundColor	String	No description yet.
icon	String	No description yet.
id	ID!	No description yet.
imageUrl	String	No description yet.
metadata	String	No description yet.
name	String	No description yet.
token	String!	No description yet.
updatedAt	String	No description yet.

AreaTypeSearchResults

object

No description yet.

Field	Type	Description
pagination	SearchResultsPagination!	No description yet.
results	[AreaType!]!	No description yet.

Asset

object

No description yet.

Implements Model, TokenReference, NamedEntity, MetadataEntity, Entity

Field	Type	Description
assetType	AssetType!	No description yet.
createdAt	String	No description yet.
deletedAt	String	No description yet.
description	String	No description yet.
id	ID!	No description yet.
metadata	String	No description yet.
name	String	No description yet.
properties	String	No description yet.
token	String!	No description yet.
updatedAt	String	No description yet.

AssetSearchResults

object

No description yet.

Field	Type	Description
pagination	SearchResultsPagination!	No description yet.
results	[Asset!]!	No description yet.

AssetType

object

No description yet.

Implements Model, TokenReference, NamedEntity, BrandedEntity, MetadataEntity

Field	Type	Description
activeVersion	Int	No description yet.
backgroundColor	String	No description yet.
borderColor	String	No description yet.
createdAt	String	No description yet.
deletedAt	String	No description yet.
description	String	No description yet.
foregroundColor	String	No description yet.
icon	String	No description yet.
id	ID!	No description yet.
imageUrl	String	No description yet.
metadata	String	No description yet.
name	String	No description yet.
propertySchema	String	No description yet.
token	String!	No description yet.
updatedAt	String	No description yet.

AssetTypeSearchResults

object

No description yet.

Field	Type	Description
pagination	SearchResultsPagination!	No description yet.
results	[AssetType!]!	No description yet.

AssetTypeVersion

object

No description yet.

Field	Type	Description
description	String	No description yet.
label	String	No description yet.
propertySchema	String!	No description yet.
publishedAt	String!	No description yet.
publishedBy	String	No description yet.
version	Int!	No description yet.

AuditEvent

object

No description yet.

Field	Type	Description
actor	String!	No description yet.
category	String!	No description yet.
entityLabel	String	No description yet.
entityPk	String	No description yet.
id	ID!	No description yet.
occurredTime	String!	No description yet.
operation	String!	No description yet.
rowsAffected	Int!	No description yet.
tableName	String	No description yet.

AuditEventSearchResults

object

No description yet.

Field	Type	Description
pagination	SearchResultsPagination!	No description yet.
results	[AuditEvent!]!	No description yet.

BatchEnqueueRefusal

object

One device a batch command check refused, and why.

Field	Type	Description
code	String!	Why the command was refused, as a stable code: DEVICE_NOT_FOUND, COMMAND_NOT_IN_VOCABULARY or PAYLOAD_SCHEMA_VIOLATION, with the same meanings as in validateCommandEnqueue. Branch on this, not on reason.
deviceToken	String!	The refused device's token, exactly as it appeared in the request.
reason	String!	Why the command was refused, in words a person can act on. The wording may change.

BulkAcknowledgeAlarmsResult

object

No description yet.

Field	Type	Description
acknowledged	[Alarm!]!	No description yet.
refusals	[AlarmAckRefusal!]!	No description yet.

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

Field	Type	Description
commandKey	String!	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.
createdAt	String	When the command definition was created, as an RFC 3339 timestamp.
deletedAt	String	Always null: deleted command definitions are not returned.
description	String	Free-text description, up to 1024 characters. Null when none is set.
deviceProfile	DeviceProfile!	The profile this command is declared on.
id	ID!	Server-assigned numeric identifier, as a string. Address a command definition by its token instead where you can.
metadata	String	Caller-defined metadata as a JSON document, or null when none is set.
name	String	Human-readable name, up to 128 characters. Null when none is set.
parameterSchema	String	The 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.
token	String!	Identifier of the command definition, unique within the tenant.
updatedAt	String	When the command definition was last written, as an RFC 3339 timestamp.

CommandDefinitionSearchResults

object

One page of command definitions matching a search.

Field	Type	Description
pagination	SearchResultsPagination!	Where this page sits in the full result set.
results	[CommandDefinition!]!	The command definitions on this page.

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.

Field	Type	Description
allowed	Boolean!	True when the command may be sent.
code	String	Why the command was refused, as a stable code; null when allowed. One of DEVICE_NOT_FOUND (no device has the token), COMMAND_NOT_IN_VOCABULARY (the device's published profile declares commands and this key is not one of them) or PAYLOAD_SCHEMA_VIOLATION (the payload does not satisfy the command's parameters). Branch on this, not on reason.
reason	String	Why 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.

Field	Type	Description
description	String	An optional human-readable note.
key	String!	The shared attribute key.
valueType	String!	How the key's value is typed: STRING, LONG, DOUBLE, BOOLEAN or JSON.

Customer

object

No description yet.

Implements Model, TokenReference, NamedEntity, MetadataEntity, Entity

Field	Type	Description
createdAt	String	No description yet.
customerType	CustomerType!	No description yet.
deletedAt	String	No description yet.
description	String	No description yet.
id	ID!	No description yet.
metadata	String	No description yet.
name	String	No description yet.
token	String!	No description yet.
updatedAt	String	No description yet.

CustomerSearchResults

object

No description yet.

Field	Type	Description
pagination	SearchResultsPagination!	No description yet.
results	[Customer!]!	No description yet.

CustomerType

object

No description yet.

Implements Model, TokenReference, NamedEntity, BrandedEntity, MetadataEntity

Field	Type	Description
backgroundColor	String	No description yet.
borderColor	String	No description yet.
createdAt	String	No description yet.
deletedAt	String	No description yet.
description	String	No description yet.
foregroundColor	String	No description yet.
icon	String	No description yet.
id	ID!	No description yet.
imageUrl	String	No description yet.
metadata	String	No description yet.
name	String	No description yet.
token	String!	No description yet.
updatedAt	String	No description yet.

CustomerTypeSearchResults

object

No description yet.

Field	Type	Description
pagination	SearchResultsPagination!	No description yet.
results	[CustomerType!]!	No description yet.

DetectionRule

object

No description yet.

Implements Model, TokenReference, NamedEntity, MetadataEntity

Field	Type	Description
authoringGraph	String	No description yet.
createdAt	String	No description yet.
definition	String!	No description yet.
deletedAt	String	No description yet.
description	String	No description yet.
deviceProfile	DeviceProfile!	No description yet.
enabled	Boolean!	No description yet.
entityGroupToken	String	No description yet.
entityGroupVersion	Int	No description yet.
id	ID!	No description yet.
metadata	String	No description yet.
name	String	No description yet.
token	String!	No description yet.
updatedAt	String	No description yet.

DetectionRuleSearchResults

object

No description yet.

Field	Type	Description
pagination	SearchResultsPagination!	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

Field	Type	Description
createdAt	String	When the device was created, as an RFC 3339 timestamp.
deletedAt	String	Always null: deleted devices are not returned.
description	String	Free-text description, up to 1024 characters. Null when none is set.
deviceType	DeviceType!	The device's type.
externalId	String	Optional 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.
id	ID!	Server-assigned numeric identifier, as a string. Address a device by its token instead where you can.
metadata	String	Caller-defined metadata as a JSON document, or null when none is set.
name	String	Human-readable name, up to 128 characters. Null when none is set.
token	String!	Identifier of the device, unique within the tenant. It cannot be changed after the device is created.
updatedAt	String	When the device was last written, as an RFC 3339 timestamp.

DeviceClaim

object

No description yet.

Implements Model

Field	Type	Description
claimedByCustomer	Customer	No description yet.
claimedTime	String	No description yet.
createdAt	String	No description yet.
deletedAt	String	No description yet.
device	Device!	No description yet.
expiresAt	String	No description yet.
id	ID!	No description yet.
status	String!	No description yet.
updatedAt	String	No description yet.

DeviceCommandVocabulary

object

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

Field	Type	Description
commands	[PublishedCommand!]!	The accepted commands; empty when not constrained.
constrained	Boolean!	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.

Field	Type	Description
desired	DeviceConfigurationRevision	The 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.
pending	Boolean!	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.
reported	DeviceConfigurationReport	The device's last report, or null when it has never reported.
stale	Boolean!	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.

Field	Type	Description
digest	String	The digest the device reported for that revision.
errors	[String!]!	The device's reasons for a REJECTED report; empty otherwise.
lastSyncAt	String	When the device last asked for its configuration.
reportedAt	String	When the device made the report.
revision	Int	The revision the device reported, or null when it has not reported one.
status	String	RECEIVED, 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.

Field	Type	Description
actor	String!	The authenticated subject whose attribute change minted the revision; empty when none was recorded.
createdAt	String	When the revision was minted.
digest	String!	"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.
document	String!	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.
revision	Int!	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.

Field	Type	Description
pagination	SearchResultsPagination!	Where this page sits in the device's whole revision history.
results	[DeviceConfigurationRevision!]!	The revisions on this page, highest revision number first.

DeviceCredential

object

No description yet.

Implements Model, TokenReference, MetadataEntity

Field	Type	Description
createdAt	String	No description yet.
credentialId	String!	No description yet.
credentialType	String!	No description yet.
credentialValue	String	No description yet.
deletedAt	String	No description yet.
device	Device!	No description yet.
enabled	Boolean!	No description yet.
expiresAt	String	No description yet.
id	ID!	No description yet.
metadata	String	No description yet.
token	String!	No description yet.
updatedAt	String	No description yet.

DeviceCredentialSearchResults

object

No description yet.

Field	Type	Description
pagination	SearchResultsPagination!	No description yet.
results	[DeviceCredential!]!	No description yet.

DeviceGroupTargetPage

object

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

Field	Type	Description
code	String	Why 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.
nextCursor	String	Opaque 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.
reason	String	Why the group was refused, in words a person can act on; null when not rejected.
rejected	Boolean!	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.
resolvedVersion	Int	The dynamic group's published version this page was resolved from; null for a static group.

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.

Field	Type	Description
declaration	DeviceLocationDeclaration	The declaration, or null when declared is false. An empty object is a real answer: the device reports position and no expectations are stated.
declared	Boolean!	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.

Field	Type	Description
expectedAccuracyMeters	Float	Horizontal accuracy to expect from these devices, in metres, or null when not stated. Descriptive only: a less accurate fix is still stored unchanged.
expectedUpdateIntervalSeconds	Int	How often a position fix is expected, in seconds, or null when not stated. Descriptive only: nothing is raised when fixes arrive less often.

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

Field	Type	Description
activeVersion	Int	The 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.
category	String	Functional 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.
createdAt	String	When the profile was created, as an RFC 3339 timestamp.
deletedAt	String	Always null: deleted profiles are not returned.
description	String	Free-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.
deviceTypeCount	Int!	Number of device types that currently adopt this profile.
id	ID!	Server-assigned numeric identifier, as a string. Address a profile by its token instead where you can.
location	DeviceLocationDeclaration	The 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.
metadata	String	Caller-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.
name	String	Human-readable name, up to 128 characters. Null when none is set.
token	String!	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.
updatedAt	String	When the profile was last written, as an RFC 3339 timestamp.

DeviceProfileSearchResults

object

One page of device profiles matching a search.

Field	Type	Description
pagination	SearchResultsPagination!	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.

Field	Type	Description
description	String	Optional notes given at publish time.
label	String	Optional label given at publish time, such as a release name. Not interpreted.
publishedAt	String!	When the version was published, as an RFC 3339 timestamp.
publishedBy	String	Who published it: their username, or their email when there is no username.
version	Int!	Version number: 1 for the first publish of the profile, increasing by one with each publish.

DeviceReplaceResult

object

No description yet.

Field	Type	Description
device	Device!	No description yet.
newCredential	DeviceCredential!	No description yet.
replacement	DeviceReplacement!	No description yet.
retiredCredentialTokens	[String!]!	No description yet.

DeviceReplacement

object

No description yet.

Field	Type	Description
actor	String!	No description yet.
createdAt	String	No description yet.
device	Device!	No description yet.
id	ID!	No description yet.
newCredentialToken	String!	No description yet.
newCredentialType	String!	No description yet.
occurredTime	String!	No description yet.
reason	String	No description yet.
retiredCredentialTokens	[String!]!	No description yet.
unitIdentifier	String	No description yet.

DeviceReplacementSearchResults

object

No description yet.

Field	Type	Description
pagination	SearchResultsPagination!	No description yet.
results	[DeviceReplacement!]!	No description yet.

DeviceRosterEntry

object

No description yet.

Field	Type	Description
deviceToken	String!	No description yet.
expectedSince	String!	No description yet.
profileToken	String!	No description yet.

DeviceRosterPage

object

No description yet.

Field	Type	Description
entries	[DeviceRosterEntry!]!	No description yet.
nextCursor	String	No description yet.

DeviceSearchResults

object

One page of devices matching a search.

Field	Type	Description
pagination	SearchResultsPagination!	Where this page sits in the full result set.
results	[Device!]!	The devices on this page.

DeviceThresholdAttribute

object

No description yet.

Field	Type	Description
deviceToken	String!	No description yet.
key	String!	No description yet.
scope	String!	No description yet.
updatedAt	String!	No description yet.
value	Float!	No description yet.

DeviceThresholdAttributePage

object

No description yet.

Field	Type	Description
entries	[DeviceThresholdAttribute!]!	No description yet.
nextCursor	String	No description yet.

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

Field	Type	Description
backgroundColor	String	Background colour to display the device type with, up to 32 characters. Not validated.
borderColor	String	Border colour to display the device type with, up to 32 characters. Not validated.
createdAt	String	When the device type was created, as an RFC 3339 timestamp.
deletedAt	String	Always null: deleted device types are not returned.
description	String	Free-text description, up to 1024 characters. Null when none is set.
foregroundColor	String	Foreground (text) colour to display the device type with, up to 32 characters. Not validated.
icon	String	Name of an icon representing the device type, up to 128 characters. Not checked against any icon set.
id	ID!	Server-assigned numeric identifier, as a string. Address a device type by its token instead where you can.
imageUrl	String	URL of an image representing the device type, up to 512 characters.
manufacturer	String	Manufacturer of the devices of this type: free text, up to 128 characters. facetValues lists the values already in use.
metadata	String	Caller-defined metadata as a JSON document, or null when none is set.
model	String	Model of the devices of this type: free text, up to 128 characters. facetValues lists the values already in use.
name	String	Human-readable name, up to 128 characters. Null when none is set.
profile	DeviceProfile	The device profile this type adopts, or null when it adopts none. Devices of a type with no profile have no declared metrics or commands.
token	String!	Identifier of the device type, unique within the tenant.
updatedAt	String	When the device type was last written, as an RFC 3339 timestamp.

DeviceTypeSearchResults

object

One page of device types matching a search.

Field	Type	Description
pagination	SearchResultsPagination!	Where this page sits in the full result set.
results	[DeviceType!]!	The device types on this page.

EntityAttribute

object

No description yet.

Implements Model

Field	Type	Description
attrKey	String!	No description yet.
createdAt	String	No description yet.
deletedAt	String	No description yet.
entity	Entity!	No description yet.
entityType	String!	No description yet.
id	ID!	No description yet.
lastUpdated	String	No description yet.
scope	String!	No description yet.
updatedAt	String	No description yet.
value	String	No description yet.
valueType	String!	No description yet.

EntityAttributeSearchResults

object

No description yet.

Field	Type	Description
pagination	SearchResultsPagination!	No description yet.
results	[EntityAttribute!]!	No description yet.

EntityGroup

object

No description yet.

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

Field	Type	Description
activeVersion	Int	No description yet.
backgroundColor	String	No description yet.
borderColor	String	No description yet.
createdAt	String	No description yet.
deletedAt	String	No description yet.
description	String	No description yet.
foregroundColor	String	No description yet.
icon	String	No description yet.
id	ID!	No description yet.
imageUrl	String	No description yet.
memberType	String!	No description yet.
members	EntityGroupMemberSearchResults!	No description yet. Arguments: pagination: PaginationInput! — No description yet.
membershipMode	String!	No description yet.
metadata	String	No description yet.
name	String	No description yet.
selector	String	No description yet.
token	String!	No description yet.
updatedAt	String	No description yet.
versions	[EntityGroupVersion!]!	No description yet.

EntityGroupMember

object

No description yet.

Field	Type	Description
id	ID!	No description yet.
token	String!	No description yet.

EntityGroupMemberSearchResults

object

No description yet.

Field	Type	Description
pagination	SearchResultsPagination!	No description yet.
results	[EntityGroupMember!]!	No description yet.

EntityGroupSearchResults

object

No description yet.

Field	Type	Description
pagination	SearchResultsPagination!	No description yet.
results	[EntityGroup!]!	No description yet.

EntityGroupVersion

object

No description yet.

Field	Type	Description
description	String	No description yet.
label	String	No description yet.
memberType	String!	No description yet.
publishedAt	String!	No description yet.
publishedBy	String	No description yet.
selector	String!	No description yet.
version	Int!	No description yet.

EntityRef

object

No description yet.

Field	Type	Description
token	String!	No description yet.
type	String!	No description yet.

EntityRelationship

object

No description yet.

Implements Model, TokenReference, MetadataEntity

Field	Type	Description
createdAt	String	No description yet.
deletedAt	String	No description yet.
id	ID!	No description yet.
metadata	String	No description yet.
relationshipType	EntityRelationshipType!	No description yet.
source	Entity!	No description yet.
sourceType	String!	No description yet.
target	Entity!	No description yet.
targetType	String!	No description yet.
token	String!	No description yet.
updatedAt	String	No description yet.

EntityRelationshipSearchResults

object

No description yet.

Field	Type	Description
pagination	SearchResultsPagination!	No description yet.
results	[EntityRelationship!]!	No description yet.

EntityRelationshipType

object

No description yet.

Implements Model, TokenReference, NamedEntity, MetadataEntity

Field	Type	Description
createdAt	String	No description yet.
deletedAt	String	No description yet.
description	String	No description yet.
id	ID!	No description yet.
metadata	String	No description yet.
name	String	No description yet.
token	String!	No description yet.
tracked	Boolean!	No description yet.
updatedAt	String	No description yet.

EntityRelationshipTypeSearchResults

object

No description yet.

Field	Type	Description
pagination	SearchResultsPagination!	No description yet.
results	[EntityRelationshipType!]!	No description yet.

FacetKey

object

No description yet.

Implements Model

Field	Type	Description
createdAt	String	No description yet.
deletedAt	String	No description yet.
id	ID!	No description yet.
key	String!	No description yet.
label	String	No description yet.
memberType	String!	No description yet.
source	String!	No description yet.
updatedAt	String	No description yet.
valueType	String!	No description yet.
values	[String!]	No description yet.

FacetKeySearchResults

object

No description yet.

Field	Type	Description
pagination	SearchResultsPagination!	No description yet.
results	[FacetKey!]!	No description yet.

GeoFence

object

No description yet.

Implements Model, TokenReference, NamedEntity, MetadataEntity

Field	Type	Description
createdAt	String	No description yet.
deletedAt	String	No description yet.
description	String	No description yet.
geometry	String!	No description yet.
id	ID!	No description yet.
kind	String!	No description yet.
metadata	String	No description yet.
name	String	No description yet.
token	String!	No description yet.
updatedAt	String	No description yet.

GeoFenceGeometry

object

No description yet.

Field	Type	Description
geometry	String!	No description yet.
hash	String!	No description yet.

GeoFenceManifestEntry

object

No description yet.

Field	Type	Description
hash	String!	No description yet.
token	String!	No description yet.

GeoFenceSearchResults

object

No description yet.

Field	Type	Description
pagination	SearchResultsPagination!	No description yet.
results	[GeoFence!]!	No description yet.

GeoFenceSetManifest

object

No description yet.

Field	Type	Description
fences	[GeoFenceManifestEntry!]!	No description yet.
mintedAt	String	No description yet.
version	Int!	No description yet.

GeoFenceSetSnapshot

object

No description yet.

Field	Type	Description
fences	GeoFenceSnapshotEntrySearchResults!	No description yet. Arguments: pagination: PaginationInput! — No description yet.
version	Int!	No description yet.

GeoFenceSnapshotEntry

object

No description yet.

Field	Type	Description
geometry	String!	No description yet.
token	String!	No description yet.

GeoFenceSnapshotEntrySearchResults

object

No description yet.

Field	Type	Description
pagination	SearchResultsPagination!	No description yet.
results	[GeoFenceSnapshotEntry!]!	No description yet.

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

Field	Type	Description
createdAt	String	When the metric definition was created, as an RFC 3339 timestamp.
dataType	String!	The value type: DOUBLE, INT or BOOLEAN. A BOOLEAN value is stored as 0 or 1.
deletedAt	String	Always null: deleted metric definitions are not returned.
description	String	Free-text description, up to 1024 characters. Null when none is set.
descriptor	String	Optional semantic tag for the metric, such as a Web of Things type. Stored and returned; not interpreted.
deviceProfile	DeviceProfile!	The profile this metric is declared on.
enum	String	The 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.
id	ID!	Server-assigned numeric identifier, as a string. Address a metric definition by its token instead where you can.
maxValue	Float	Largest value accepted for a DOUBLE or INT metric, or null for no upper bound. A measurement above it is rejected.
metadata	String	Caller-defined metadata as a JSON document, or null when none is set.
metricKey	String!	The key a measurement uses to report this metric, unique within the profile and at most 128 characters.
minValue	Float	Smallest value accepted for a DOUBLE or INT metric, or null for no lower bound. A measurement below it is rejected.
name	String	Human-readable name, up to 128 characters. Null when none is set.
token	String!	Identifier of the metric definition, unique within the tenant.
unit	String	Unit of measure, such as a UCUM code (Cel, kW). It is carried with each measurement of this metric; values are not converted.
updatedAt	String	When the metric definition was last written, as an RFC 3339 timestamp.

MetricDefinitionSearchResults

object

One page of metric definitions matching a search.

Field	Type	Description
pagination	SearchResultsPagination!	Where this page sits in the full result set.
results	[MetricDefinition!]!	The metric definitions on this page.

ProvisioningProfile

object

No description yet.

Implements Model, TokenReference, NamedEntity, MetadataEntity

Field	Type	Description
createdAt	String	No description yet.
credentialType	String!	No description yet.
deletedAt	String	No description yet.
description	String	No description yet.
deviceType	DeviceType!	No description yet.
enabled	Boolean!	No description yet.
expiresAt	String	No description yet.
id	ID!	No description yet.
metadata	String	No description yet.
name	String	No description yet.
provisionKey	String!	No description yet.
strategy	String!	No description yet.
token	String!	No description yet.
updatedAt	String	No description yet.

ProvisioningProfileSearchResults

object

No description yet.

Field	Type	Description
pagination	SearchResultsPagination!	No description yet.
results	[ProvisioningProfile!]!	No description yet.

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.

Field	Type	Description
commandKey	String!	The key used to send this command.
description	String	Free-text description, or null when none was set.
name	String	Human-readable name, or null when none was set.
parameterSchema	String	The command's parameters as a JSON array of parameter descriptors, or null when it takes no structured arguments.

PublishedProfileRule

object

No description yet.

Field	Type	Description
definition	String!	No description yet.
entityGroupToken	String!	No description yet.
entityGroupVersion	Int!	No description yet.
token	String!	No description yet.

SearchResultsPagination

object

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

Field	Type	Description
pageEnd	Int	Position 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.
pageStart	Int	Position of the first result on this page within the full result set (1-based).
totalRecords	Int	Number of records matching the criteria across all pages.

SelectorPreview

object

No description yet.

Field	Type	Description
error	String	No description yet.
members	EntityGroupMemberSearchResults	No description yet.
valid	Boolean!	No description yet.

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.

Field	Type	Description
backgroundColor	String	Background colour to display the record with, such as a CSS colour. Not validated.
borderColor	String	Border colour to display the record with, such as a CSS colour. Not validated.
foregroundColor	String	Foreground (text) colour to display the record with, such as a CSS colour. Not validated.
icon	String	Name of an icon representing the record. Not checked against any icon set.
imageUrl	String	URL of an image representing the record.

Entity

interface

No description yet.

Field	Type	Description
id	ID!	No description yet.
token	String!	No description yet.

MetadataEntity

interface

A record that carries caller-defined metadata.

Field	Type	Description
metadata	String	Caller-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.

Field	Type	Description
createdAt	String	When the record was created, as an RFC 3339 timestamp.
deletedAt	String	Always null: deleted records are not returned by this API.
id	ID!	Server-assigned numeric identifier, as a string. Records are normally addressed by token; the ById lookups take this value.
updatedAt	String	When the record was last written, as an RFC 3339 timestamp.

NamedEntity

interface

A record with a human-readable name and description.

Field	Type	Description
description	String	Free-text description. Null when none is set.
name	String	Human-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.

Field	Type	Description
token	String!	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

AlarmSearchCriteria · AreaCreateRequest · AreaSearchCriteria · AreaTypeCreateRequest · AreaTypeSearchCriteria · AreaTypeUpdateRequest · AreaUpdateRequest · AssetCreateRequest · AssetSearchCriteria · AssetTypeCreateRequest · AssetTypeSearchCriteria · AssetTypeUpdateRequest · AssetUpdateRequest · AuditEventSearchCriteria · CommandDefinitionCreateRequest · CommandDefinitionSearchCriteria · CommandDefinitionUpdateRequest · ConfigurationKeyInput · CustomerCreateRequest · CustomerSearchCriteria · CustomerTypeCreateRequest · CustomerTypeSearchCriteria · CustomerTypeUpdateRequest · CustomerUpdateRequest · DetectionRuleCreateRequest · DetectionRuleSearchCriteria · DetectionRuleUpdateRequest · DeviceBulkCreateRequest · DeviceClaimInitiateRequest · DeviceClaimRequest · DeviceCreateRequest · DeviceCredentialCreateRequest · DeviceCredentialSearchCriteria · DeviceCredentialUpdateRequest · DeviceLocationDeclarationInput · DeviceProfileCreateRequest · DeviceProfileSearchCriteria · DeviceProfileUpdateRequest · DeviceReplaceRequest · DeviceReplacementSearchCriteria · DeviceSearchCriteria · DeviceTypeCreateRequest · DeviceTypeSearchCriteria · DeviceTypeUpdateRequest · DeviceUpdateRequest · EntityAttributeSearchCriteria · EntityAttributeSetRequest · EntityGroupCreateRequest · EntityGroupSearchCriteria · EntityGroupUpdateRequest · EntityRefInput · EntityRelationshipCreateRequest · EntityRelationshipSearchCriteria · EntityRelationshipTypeCreateRequest · EntityRelationshipTypeSearchCriteria · EntityRelationshipTypeUpdateRequest · FacetKeySearchCriteria · FacetKeySetRequest · GeoFenceCreateRequest · GeoFenceSearchCriteria · GeoFenceUpdateRequest · MetricDefinitionCreateRequest · MetricDefinitionSearchCriteria · MetricDefinitionUpdateRequest · PaginationInput · ProvisioningProfileCreateRequest · ProvisioningProfileSearchCriteria · ProvisioningProfileUpdateRequest

AlarmSearchCriteria

input

No description yet.

Input field	Type	Description
acknowledged	Boolean	No description yet.
alarmKey	String	No description yet.
originator	String	No description yet.
originatorType	String	No description yet.
pageNumber	Int!	No description yet.
pageSize	Int!	No description yet.
severity	String	No description yet.
state	String	No description yet.

AreaCreateRequest

input

No description yet.

Input field	Type	Description
areaTypeToken	String!	No description yet.
description	String	No description yet.
metadata	String	No description yet.
name	String	No description yet.
token	String!	No description yet.

AreaSearchCriteria

input

No description yet.

Input field	Type	Description
areaTypeToken	String	No description yet.
pageNumber	Int!	No description yet.
pageSize	Int!	No description yet.

AreaTypeCreateRequest

input

No description yet.

Input field	Type	Description
backgroundColor	String	No description yet.
borderColor	String	No description yet.
description	String	No description yet.
foregroundColor	String	No description yet.
icon	String	No description yet.
imageUrl	String	No description yet.
metadata	String	No description yet.
name	String	No description yet.
token	String!	No description yet.

AreaTypeSearchCriteria

input

No description yet.

Input field	Type	Description
pageNumber	Int!	No description yet.
pageSize	Int!	No description yet.

AreaTypeUpdateRequest

input

No description yet.

Input field	Type	Description
backgroundColor	String	No description yet.
borderColor	String	No description yet.
description	String	No description yet.
foregroundColor	String	No description yet.
icon	String	No description yet.
imageUrl	String	No description yet.
metadata	String	No description yet.
name	String	No description yet.

AreaUpdateRequest

input

No description yet.

Input field	Type	Description
areaTypeToken	String	No description yet.
description	String	No description yet.
metadata	String	No description yet.
name	String	No description yet.

AssetCreateRequest

input

No description yet.

Input field	Type	Description
assetTypeToken	String!	No description yet.
description	String	No description yet.
metadata	String	No description yet.
name	String	No description yet.
properties	String	No description yet.
token	String!	No description yet.

AssetSearchCriteria

input

No description yet.

Input field	Type	Description
assetTypeToken	String	No description yet.
pageNumber	Int!	No description yet.
pageSize	Int!	No description yet.

AssetTypeCreateRequest

input

No description yet.

Input field	Type	Description
backgroundColor	String	No description yet.
borderColor	String	No description yet.
description	String	No description yet.
foregroundColor	String	No description yet.
icon	String	No description yet.
imageUrl	String	No description yet.
metadata	String	No description yet.
name	String	No description yet.
propertySchema	String	No description yet.
token	String!	No description yet.

AssetTypeSearchCriteria

input

No description yet.

Input field	Type	Description
pageNumber	Int!	No description yet.
pageSize	Int!	No description yet.

AssetTypeUpdateRequest

input

No description yet.

Input field	Type	Description
backgroundColor	String	No description yet.
borderColor	String	No description yet.
description	String	No description yet.
foregroundColor	String	No description yet.
icon	String	No description yet.
imageUrl	String	No description yet.
metadata	String	No description yet.
name	String	No description yet.
propertySchema	String	No description yet.

AssetUpdateRequest

input

No description yet.

Input field	Type	Description
assetTypeToken	String	No description yet.
description	String	No description yet.
metadata	String	No description yet.
name	String	No description yet.
properties	String	No description yet.

AuditEventSearchCriteria

input

No description yet.

Input field	Type	Description
actor	String	No description yet.
category	String	No description yet.
endTime	String	No description yet.
entityPk	String	No description yet.
operation	String	No description yet.
pageNumber	Int!	No description yet.
pageSize	Int!	No description yet.
startTime	String	No description yet.
tableName	String	No description yet.

CommandDefinitionCreateRequest

input

Fields for a new command definition.

Input field	Type	Description
commandKey	String!	The key used to send the command. Letters, digits, hyphens and underscores, starting with a letter or digit; at most 128 characters. A key the profile already declares is refused with CONFLICT.
description	String	Free-text description, up to 1024 characters.
deviceProfileToken	String!	Token of the profile to declare the command on. An unknown token fails the request.
metadata	String	Caller-defined metadata. Must be valid JSON; an empty string means none.
name	String	Human-readable name, up to 128 characters.
parameterSchema	String	The 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.
token	String!	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 field	Type	Description
commandKey	String	Return only definitions with exactly this command key.
deviceProfile	String	Return only definitions on the profile with this token. An unknown token matches nothing.
pageNumber	Int!	Page to return, starting at 1. Values below 1 are read as 1.
pageSize	Int!	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 field	Type	Description
commandKey	String	New 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.
description	String	New description, or null to clear it.
deviceProfileToken	String	Token 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.
metadata	String	New metadata (valid JSON, replacing the stored document), or null to clear it.
name	String	New name, or null to clear it.
parameterSchema	String	New 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 field	Type	Description
description	String	An optional human-readable note.
key	String!	The shared attribute key.
valueType	String!	How the key's value is typed: STRING, LONG, DOUBLE, BOOLEAN or JSON.

CustomerCreateRequest

input

No description yet.

Input field	Type	Description
customerTypeToken	String!	No description yet.
description	String	No description yet.
metadata	String	No description yet.
name	String	No description yet.
token	String!	No description yet.

CustomerSearchCriteria

input

No description yet.

Input field	Type	Description
customerTypeToken	String	No description yet.
pageNumber	Int!	No description yet.
pageSize	Int!	No description yet.

CustomerTypeCreateRequest

input

No description yet.

Input field	Type	Description
backgroundColor	String	No description yet.
borderColor	String	No description yet.
description	String	No description yet.
foregroundColor	String	No description yet.
icon	String	No description yet.
imageUrl	String	No description yet.
metadata	String	No description yet.
name	String	No description yet.
token	String!	No description yet.

CustomerTypeSearchCriteria

input

No description yet.

Input field	Type	Description
pageNumber	Int!	No description yet.
pageSize	Int!	No description yet.

CustomerTypeUpdateRequest

input

No description yet.

Input field	Type	Description
backgroundColor	String	No description yet.
borderColor	String	No description yet.
description	String	No description yet.
foregroundColor	String	No description yet.
icon	String	No description yet.
imageUrl	String	No description yet.
metadata	String	No description yet.
name	String	No description yet.

CustomerUpdateRequest

input

No description yet.

Input field	Type	Description
customerTypeToken	String	No description yet.
description	String	No description yet.
metadata	String	No description yet.
name	String	No description yet.

DetectionRuleCreateRequest

input

No description yet.

Input field	Type	Description
authoringGraph	String	No description yet.
definition	String!	No description yet.
description	String	No description yet.
deviceProfileToken	String!	No description yet.
enabled	Boolean!	No description yet.
entityGroupToken	String	No description yet.
entityGroupVersion	Int	No description yet.
metadata	String	No description yet.
name	String	No description yet.
token	String!	No description yet.

DetectionRuleSearchCriteria

input

No description yet.

Input field	Type	Description
deviceProfile	String	No description yet.
pageNumber	Int!	No description yet.
pageSize	Int!	No description yet.

DetectionRuleUpdateRequest

input

No description yet.

Input field	Type	Description
authoringGraph	String	No description yet.
definition	String	No description yet.
description	String	No description yet.
deviceProfileToken	String	No description yet.
enabled	Boolean	No description yet.
entityGroupToken	String	No description yet.
entityGroupVersion	Int	No description yet.
metadata	String	No description yet.
name	String	No description yet.

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 field	Type	Description
count	Int!	Number of devices to create, from 1 to 1000.
deviceTypeToken	String!	Token of the device type for every device. An unknown token fails the request.
externalIdTemplate	String	Template 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.
metadata	String	Metadata given to every device. Must be valid JSON; an empty string means none.
nameTemplate	String	Template for the device names. Optional; {random} is not allowed. A rendered name may be at most 128 characters.
startIndex	Int	Index of the first device. Defaults to 1; values below 1 are refused.
tokenTemplate	String!	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 field	Type	Description
claimSecret	String!	No description yet.
deviceToken	String!	No description yet.
expiresAt	String	No description yet.

DeviceClaimRequest

input

No description yet.

Input field	Type	Description
claimSecret	String!	No description yet.
customerToken	String!	No description yet.
deviceToken	String!	No description yet.
relationshipType	String!	No description yet.

DeviceCreateRequest

input

Fields for a new device.

Input field	Type	Description
description	String	Free-text description, up to 1024 characters.
deviceTypeToken	String!	Token of the device's type. An unknown token fails the request.
externalId	String	Optional business identifier, up to 256 characters. A value another device in the tenant already has is refused with CONFLICT.
metadata	String	Caller-defined metadata. Must be valid JSON; an empty string means none.
name	String	Human-readable name, up to 128 characters.
token	String!	Identifier for the new device. A token already in use in the tenant is refused with CONFLICT.

DeviceCredentialCreateRequest

input

No description yet.

Input field	Type	Description
credentialId	String!	No description yet.
credentialType	String!	No description yet.
credentialValue	String	The 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.
deviceToken	String!	No description yet.
enabled	Boolean!	No description yet.
expiresAt	String	No description yet.
metadata	String	No description yet.
token	String!	No description yet.

DeviceCredentialSearchCriteria

input

No description yet.

Input field	Type	Description
credentialId	String	No description yet.
credentialType	String	No description yet.
device	String	No description yet.
enabled	Boolean	No description yet.
pageNumber	Int!	No description yet.
pageSize	Int!	No description yet.

DeviceCredentialUpdateRequest

input

No description yet.

Input field	Type	Description
credentialId	String	No description yet.
credentialType	String	No description yet.
credentialValue	String	The 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.
deviceToken	String	No description yet.
enabled	Boolean	No description yet.
expiresAt	String	No description yet.
metadata	String	No description yet.

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 field	Type	Description
expectedAccuracyMeters	Float	Horizontal accuracy to expect, in metres. Must be a positive finite number when sent; omit it or send null to state no expectation.
expectedUpdateIntervalSeconds	Int	How 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 field	Type	Description
category	String	Functional class of the devices, such as thermostat or meter, up to 64 characters.
description	String	Free-text description, up to 1024 characters.
location	DeviceLocationDeclarationInput	Whether the devices report their own position, and what to expect of it. Omit it when they do not.
metadata	String	Caller-defined metadata. Must be valid JSON; an empty string means none.
name	String	Human-readable name, up to 128 characters.
token	String!	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 field	Type	Description
pageNumber	Int!	Page to return, starting at 1. Values below 1 are read as 1.
pageSize	Int!	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 field	Type	Description
category	String	New category, or null to clear it.
description	String	New description, or null to clear it.
location	DeviceLocationDeclarationInput	New 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.
metadata	String	New metadata (valid JSON, replacing the stored document), or null to clear it.
name	String	New name, or null to clear it.

DeviceReplaceRequest

input

No description yet.

Input field	Type	Description
credentialId	String	No description yet.
credentialToken	String	No description yet.
credentialType	String	No description yet.
credentialValue	String	The 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.
deviceToken	String!	No description yet.
expiresAt	String	No description yet.
reason	String	No description yet.
unitIdentifier	String	No description yet.

DeviceReplacementSearchCriteria

input

No description yet.

Input field	Type	Description
device	String	No description yet.
pageNumber	Int!	No description yet.
pageSize	Int!	No description yet.

DeviceSearchCriteria

input

Criteria for searching devices. Results are newest first.

Input field	Type	Description
deviceType	String	Return only devices of the device type with this token. An unknown token matches nothing.
pageNumber	Int!	Page to return, starting at 1. Values below 1 are read as 1.
pageSize	Int!	Results per page. Below 1 means the default of 100; above 1000 is capped at 1000.

DeviceTypeCreateRequest

input

Fields for a new device type.

Input field	Type	Description
backgroundColor	String	Background colour, up to 32 characters.
borderColor	String	Border colour, up to 32 characters.
description	String	Free-text description, up to 1024 characters.
foregroundColor	String	Foreground (text) colour, up to 32 characters.
icon	String	Name of an icon representing the device type, up to 128 characters.
imageUrl	String	URL of an image representing the device type, up to 512 characters.
manufacturer	String	Manufacturer of the devices of this type, up to 128 characters.
metadata	String	Caller-defined metadata. Must be valid JSON; an empty string means none.
model	String	Model of the devices of this type, up to 128 characters.
name	String	Human-readable name, up to 128 characters.
profileToken	String	Token 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.
token	String!	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 field	Type	Description
pageNumber	Int!	Page to return, starting at 1. Values below 1 are read as 1.
pageSize	Int!	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 field	Type	Description
backgroundColor	String	New background colour, or null to clear it.
borderColor	String	New border colour, or null to clear it.
description	String	New description, or null to clear it.
foregroundColor	String	New foreground colour, or null to clear it.
icon	String	New icon name, or null to clear it.
imageUrl	String	New image URL, or null to clear it.
manufacturer	String	New manufacturer, or null to clear it.
metadata	String	New metadata (valid JSON, replacing the stored document), or null to clear it.
model	String	New model, or null to clear it.
name	String	New name, or null to clear it.
profileToken	String	Token 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 field	Type	Description
description	String	New description, or null to clear it.
deviceTypeToken	String	Token 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.
externalId	String	New business identifier, or null to clear it. A value another device already has is refused with CONFLICT.
metadata	String	New metadata (valid JSON, replacing the stored document), or null to clear it.
name	String	New name, or null to clear it.

EntityAttributeSearchCriteria

input

No description yet.

Input field	Type	Description
attrKeys	[String!]	No description yet.
entity	String	No description yet.
entityType	String	No description yet.
pageNumber	Int!	No description yet.
pageSize	Int!	No description yet.
scope	String	No description yet.

EntityAttributeSetRequest

input

No description yet.

Input field	Type	Description
attrKey	String!	No description yet.
entity	String!	No description yet.
entityType	String!	No description yet.
scope	String!	No description yet.
value	String	No description yet.
valueType	String!	No description yet.

EntityGroupCreateRequest

input

No description yet.

Input field	Type	Description
backgroundColor	String	No description yet.
borderColor	String	No description yet.
description	String	No description yet.
foregroundColor	String	No description yet.
icon	String	No description yet.
imageUrl	String	No description yet.
memberType	String!	No description yet.
membershipMode	String	No description yet.
metadata	String	No description yet.
name	String	No description yet.
selector	String	No description yet.
token	String!	No description yet.

EntityGroupSearchCriteria

input

No description yet.

Input field	Type	Description
memberType	String	No description yet.
membershipMode	String	No description yet.
pageNumber	Int!	No description yet.
pageSize	Int!	No description yet.

EntityGroupUpdateRequest

input

No description yet.

Input field	Type	Description
backgroundColor	String	No description yet.
borderColor	String	No description yet.
description	String	No description yet.
foregroundColor	String	No description yet.
icon	String	No description yet.
imageUrl	String	No description yet.
metadata	String	No description yet.
name	String	No description yet.
selector	String	No description yet.

EntityRefInput

input

No description yet.

Input field	Type	Description
token	String!	No description yet.
type	String!	No description yet.

EntityRelationshipCreateRequest

input

No description yet.

Input field	Type	Description
metadata	String	No description yet.
relationshipType	String!	No description yet.
source	String!	No description yet.
sourceType	String!	No description yet.
target	String!	No description yet.
targetType	String!	No description yet.
token	String!	No description yet.

EntityRelationshipSearchCriteria

input

No description yet.

Input field	Type	Description
pageNumber	Int!	No description yet.
pageSize	Int!	No description yet.
relationshipType	String	No description yet.
source	String	No description yet.
sourceType	String	No description yet.
target	String	No description yet.
targetType	String	No description yet.
tracked	Boolean	No description yet.

EntityRelationshipTypeCreateRequest

input

No description yet.

Input field	Type	Description
description	String	No description yet.
metadata	String	No description yet.
name	String	No description yet.
token	String!	No description yet.
tracked	Boolean!	No description yet.

EntityRelationshipTypeSearchCriteria

input

No description yet.

Input field	Type	Description
pageNumber	Int!	No description yet.
pageSize	Int!	No description yet.

EntityRelationshipTypeUpdateRequest

input

No description yet.

Input field	Type	Description
description	String	No description yet.
metadata	String	No description yet.
name	String	No description yet.
tracked	Boolean	No description yet.

FacetKeySearchCriteria

input

No description yet.

Input field	Type	Description
memberType	String	No description yet.
pageNumber	Int!	No description yet.
pageSize	Int!	No description yet.

FacetKeySetRequest

input

No description yet.

Input field	Type	Description
key	String!	No description yet.
label	String	No description yet.
memberType	String!	No description yet.
valueType	String!	No description yet.
values	[String!]	No description yet.

GeoFenceCreateRequest

input

No description yet.

Input field	Type	Description
description	String	No description yet.
geometry	String!	No description yet.
metadata	String	No description yet.
name	String	No description yet.
token	String!	No description yet.

GeoFenceSearchCriteria

input

No description yet.

Input field	Type	Description
pageNumber	Int!	No description yet.
pageSize	Int!	No description yet.

GeoFenceUpdateRequest

input

No description yet.

Input field	Type	Description
description	String	No description yet.
geometry	String	No description yet.
metadata	String	No description yet.
name	String	No description yet.

MetricDefinitionCreateRequest

input

Fields for a new metric definition.

Input field	Type	Description
dataType	String!	The value type: DOUBLE, INT or BOOLEAN. STRING is refused, because a metric must be numeric; report string values as attributes instead.
description	String	Free-text description, up to 1024 characters.
descriptor	String	Optional semantic tag, such as a Web of Things type.
deviceProfileToken	String!	Token of the profile to declare the metric on. An unknown token fails the request.
enum	String	Allowed values as a JSON array of strings. Must be valid JSON.
maxValue	Float	Largest value accepted for a DOUBLE or INT metric.
metadata	String	Caller-defined metadata. Must be valid JSON; an empty string means none.
metricKey	String!	The key measurements will use for this metric, at most 128 characters. A key the profile already declares is refused with CONFLICT.
minValue	Float	Smallest value accepted for a DOUBLE or INT metric.
name	String	Human-readable name, up to 128 characters.
token	String!	Identifier for the new metric definition. A token already in use in the tenant is refused with CONFLICT.
unit	String	Unit of measure, such as a UCUM code (Cel, kW).

MetricDefinitionSearchCriteria

input

Criteria for searching metric definitions. Results are newest first.

Input field	Type	Description
deviceProfile	String	Return only definitions on the profile with this token. An unknown token matches nothing.
metricKey	String	Return only definitions with exactly this metric key.
pageNumber	Int!	Page to return, starting at 1. Values below 1 are read as 1.
pageSize	Int!	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 field	Type	Description
dataType	String	New value type: DOUBLE, INT or BOOLEAN. An explicit null is refused.
description	String	New description, or null to clear it.
descriptor	String	New semantic tag, or null to clear it.
deviceProfileToken	String	Token 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.
enum	String	New allowed values as a JSON array of strings, or null to allow any value.
maxValue	Float	New upper bound, or null to remove it.
metadata	String	New metadata (valid JSON, replacing the stored document), or null to clear it.
metricKey	String	New key for the metric, unique within the profile the definition ends up in. An explicit null or a blank value is refused.
minValue	Float	New lower bound, or null to remove it.
name	String	New name, or null to clear it.
unit	String	New unit, or null to clear it.

PaginationInput

input

Which page of results to return.

Input field	Type	Description
pageNumber	Int!	Page to return, starting at 1. Values below 1 are read as 1.
pageSize	Int!	Results per page. Below 1 means the default of 100; above 1000 is capped at 1000.

ProvisioningProfileCreateRequest

input

No description yet.

Input field	Type	Description
credentialType	String	No description yet.
description	String	No description yet.
deviceTypeToken	String!	No description yet.
enabled	Boolean!	No description yet.
expiresAt	String	No description yet.
metadata	String	No description yet.
name	String	No description yet.
provisionKey	String!	No description yet.
provisionSecret	String!	No description yet.
strategy	String!	No description yet.
token	String!	No description yet.

ProvisioningProfileSearchCriteria

input

No description yet.

Input field	Type	Description
deviceType	String	No description yet.
enabled	Boolean	No description yet.
pageNumber	Int!	No description yet.
pageSize	Int!	No description yet.
strategy	String	No description yet.

ProvisioningProfileUpdateRequest

input

No description yet.

Input field	Type	Description
description	String	No description yet.
deviceTypeToken	String	No description yet.
enabled	Boolean	No description yet.
expiresAt	String	No description yet.
metadata	String	No description yet.
name	String	No description yet.
provisionKey	String	No description yet.
provisionSecret	String	No description yet.
strategy	String	No description yet.

Enums

DeviceFacet

DeviceFacet

enum

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

Value	Description
MANUFACTURER	The manufacturer field of device types.
MODEL	The model field of device types.
CATEGORY	The category field of device profiles.