Queries

me

Type: User!

Description: Get the information of the user. It returns data such as the ID of the user, the name, the pending group invitations, the favorite items and other details.

connectorTypes

Type: ConnectorTypeConnection!

Description: Get the list of all UnaConnect connector types

Arguments

Name Description

Name	Description
`limit` (`Int`)	The maximum number of items to retrieve
`nextToken` (`String`)	The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

limit (Int)

The maximum number of items to retrieve

nextToken (String)

The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

connectorType

Type: ConnectorType!

Description: Get a connectorType

Arguments

Name Description

Name	Description
`type` (`String!`)	No description

type (String!)

No description

deviceType

Type: DeviceType!

Description: Get a deviceType

Arguments

Name Description

Name	Description
`type` (`String!`)	No description

type (String!)

No description

notificationType

Type: NotificationType!

Description: Get a notificationType

Arguments

Name Description

Name	Description
`type` (`String!`)	No description

type (String!)

No description

deviceTypes

Type: DeviceTypeConnection!

Description: Get the list of all UnaConnect device types

Arguments

Name Description

Name	Description
`limit` (`Int`)	The maximum number of items to retrieve
`nextToken` (`String`)	The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

limit (Int)

The maximum number of items to retrieve

nextToken (String)

The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

notificationTypes

Type: NotificationTypeConnection!

Description: Get the list of all UnaConnect notification types

Arguments

Name Description

Name	Description
`limit` (`Int`)	The maximum number of items to retrieve
`nextToken` (`String`)	The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

limit (Int)

The maximum number of items to retrieve

nextToken (String)

The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

permissions

Type: PermissionConnection!

Description: Get the list of all UnaConnect user permissions

Arguments

Name Description

Name	Description
`limit` (`Int`)	The maximum number of items to retrieve
`nextToken` (`String`)	The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

limit (Int)

The maximum number of items to retrieve

nextToken (String)

The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

group

Type: Group!

Description: Get general information of a group

Arguments

Name Description

groupId (String!)

The id of the group

connectors

Type: ConnectorConnection!

Description: Get the list of Connectors of a group

Arguments

Name Description

groupId (String!)

The id of the group

limit (Int)

The maximum number of items to retrieve

nextToken (String)

The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

connector

Type: Connector!

Description: Get the single connector of a group

Arguments

Name Description

Name	Description
`connectorId` (`String!`)	The connector id
`groupId` (`String!`)	The id of the group

connectorId (String!)

The connector id

groupId (String!)

The id of the group

devicesByGroupId

Type: DeviceConnection!

Description: Get the list of Devices of a group

Arguments

Name	Description
`groupId` (`String!`)	The id of the group
`limit` (`Int`)	The maximum number of items to retrieve
`nextToken` (`String`)	The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
`ascending` (`Boolean`)	The order of the items by default is ordered by last seen value (most recent seen to the latest seen). If ascending is true, we show the latest seen to the most recent seen.
`orderedByLastSeen` (`Boolean`)	DEPRECATED

roles

Type: RoleConnection!

Description: Get the list of role of a group

Arguments

Name Description

Name	Description
`limit` (`Int`)	The maximum number of items to retrieve
`nextToken` (`String`)	The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

limit (Int)

The maximum number of items to retrieve

nextToken (String)

The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

users

Type: UserConnection!

Description: Get the list of users of a group

Arguments

Name Description

Name	Description
`groupId` (`String!`)	No description
`limit` (`Int`)	The maximum number of items to retrieve
`nextToken` (`String`)	The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

groupId (String!)

No description

limit (Int)

The maximum number of items to retrieve

nextToken (String)

The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

user

Type: User!

Description: Get the information of the user

Arguments

Name Description

Name	Description
`userId` (`String!`)	No description

userId (String!)

No description

groups

Type: GroupConnection!

Description: Get the list of all the groups of the user

Arguments

Name Description

Name	Description
`limit` (`Int`)	The maximum number of items to retrieve
`nextToken` (`String`)	The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

limit (Int)

The maximum number of items to retrieve

nextToken (String)

The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

requestGroupByDeviceId

Type: GenericReturn!

Description: No description

Arguments

Name Description

Name	Description
`input` (`RequestGroupByDeviceIdInput`)	No description

input (RequestGroupByDeviceIdInput)

No description

notifications

Type: NotificationConnection!

Description: Get the list of notification of the user per groupId

Arguments

Name Description

Name	Description
`groupId` (`String`)	The group identifier
`limit` (`Int`)	The maximum number of items to retrieve
`nextToken` (`String`)	The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

groupId (String)

The group identifier

limit (Int)

The maximum number of items to retrieve

nextToken (String)

The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

notification

Type: Notification!

Description: Get the notification

Arguments

Name Description

Name	Description
`notificationId` (`String!`)	The notification identifier
`groupId` (`String!`)	The group identifier

notificationId (String!)

The notification identifier

groupId (String!)

The group identifier

device

Type: Device!

Description: Get the information of a particular device by providing its id

Arguments

Name Description

deviceId (String!)

The device identifier

groupId (String)

The group identifier

deviceData

Type: DeviceDataConnection!

Description: Get the generic data of a particular device by providing its id

Arguments

Name	Description
`deviceId` (`String!`)	The device identifier
`limit` (`Int`)	The maximum number of items to retrieve
`nextToken` (`String`)	The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
`beginDate` (`AWSTimestamp`)	The begin timestamp of the period to get the data from
`endDate` (`AWSTimestamp`)	The end timestamp of the period to get the data from
`ascending` (`Boolean`)	The order of the items by default is ascending

deviceEvent

Type: DeviceEventConnection!

Description: Get the event data of a particular device by providing its id

Arguments

Name	Description
`deviceId` (`String!`)	The device identifier
`limit` (`Int`)	The maximum number of items scan
`nextToken` (`String`)	The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
`beginDate` (`AWSTimestamp`)	The begin timestamp of the period to get the data from
`endDate` (`AWSTimestamp`)	The end timestamp of the period to get the data from
`ascending` (`Boolean`)	The order of the items by default is ascending

deviceGeoloc

Type: DeviceGeolocConnection!

Description: Get the geolocation data of a particular device by providing its id

Arguments

Name	Description
`deviceId` (`String!`)	The ID of a device
`limit` (`Int`)	The maximum number of items to retrive
`nextToken` (`String`)	The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
`beginDate` (`AWSTimestamp`)	The begin timestamp of the period to get the data from
`endDate` (`AWSTimestamp`)	The end timestamp of the period to get the data from
`ascending` (`Boolean`)	The order of the items by default is ascending

deviceTelemetry

Type: DeviceTelemetryConnection!

Description: Get the telemetry data of a particular device by providing its id

Arguments

Name	Description
`deviceId` (`String!`)	The ID of a device
`limit` (`Int`)	The maximum number of items to retrive
`nextToken` (`String`)	The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
`beginDate` (`AWSTimestamp`)	The begin timestamp of the period to get the data from
`endDate` (`AWSTimestamp`)	The end timestamp of the period to get the data from
`ascending` (`Boolean`)	The order of the items by default is ascending

connectorEvent

Type: ConnectorEventConnection!

Description: Get all events of a connector

Arguments

Name	Description
`connectorId` (`String!`)	The id of the connector
`groupId` (`String!`)	The id of the group
`beginDate` (`AWSTimestamp!`)	The begin timestamp of the period to get the data from
`endDate` (`AWSTimestamp!`)	The end timestamp of the period to get the data from
`ascending` (`Boolean`)	The order of the items by default is ascending

firmwares

Type: FirmwareConnection!

Description: Get the firmwares uploaded in a group

Arguments

Name Description

Name	Description
`groupId` (`String!`)	The ID of the group
`limit` (`Int`)	The maximum number of items to retrieve
`nextToken` (`String`)	The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

groupId (String!)

The ID of the group

limit (Int)

The maximum number of items to retrieve

nextToken (String)

The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

connectorMetrics

Type: ConnectorMetrics!

Description: Get all metrics of a connector

Arguments

Name	Description
`groupId` (`String!`)	The id of the group
`connectorId` (`String!`)	The id of the connector
`beginDate` (`AWSTimestamp!`)	The begin timestamp of the period to get the data from
`endDate` (`AWSTimestamp!`)	The end timestamp of the period to get the data from
`timeSpan` (`AWSTimestamp`)	The timespan between each item in seconds

deviceMetrics

Type: DeviceMetrics!

Description: Get all metrics of a device

Arguments

Name	Description
`groupId` (`String!`)	The id of the group
`deviceId` (`String!`)	The id of the device
`beginDate` (`AWSTimestamp!`)	The begin timestamp of the period to get the data from
`endDate` (`AWSTimestamp!`)	The end timestamp of the period to get the data from
`timeSpan` (`AWSTimestamp`)	The timespan between each item in seconds

groupMetrics

Type: GroupMetrics!

Description: Get all metrics of a group

Arguments

Name	Description
`groupId` (`String!`)	The id of the group
`beginDate` (`AWSTimestamp!`)	The begin timestamp of the period to get the data from
`endDate` (`AWSTimestamp!`)	The end timestamp of the period to get the data from
`timeSpan` (`AWSTimestamp`)	The timespan between each item in seconds

searchDevices

Description: Get all metrics of a group

Arguments

Name Description

groupId (String!)

The id of the group

inputText (String!)

The input text

deviceLatestMessages

Type: LatestMessages!

Description: Get the device latest Messages of type Data, Geoloc, Event and Telemetry

Arguments

Name Description

deviceId (String!)

The device identifier

latestTimestamp (AWSTimestamp)

The end timestamp of the period to get the messages from, if no provided, it is the request time

exportDeviceMessages

Type: URL!

Description: Query to export the device messages as CSV files

Arguments

Name	Description
`devicesIds` (`[String]!`)	The devices IDs to export from
`groupId` (`String!`)	The group id
`beginDate` (`AWSTimestamp!`)	The begin timestamp of the period to get the data from
`endDate` (`AWSTimestamp!`)	The end timestamp of the period to get the data from
`type` (`String`)	Type of message to export if not provided, it will send Data messages. Can be DATA, GEOLOC, EVENT or TELEMETRY
`format` (`String`)	The format of the data. Can be CSV

getStoragePresignedUrl

Type: URL!

Description: Query to get a presigned URL to UnaConnect Blob Storage and be able to do a PUT to the URL received

Arguments

Name Description

Name	Description
`type` (`String!`)	The type of data to sent : FIRMWARE_FILE and DEVICE_LIST available
`fileName` (`String!`)	The name of file to send

type (String!)

The type of data to sent : FIRMWARE_FILE and DEVICE_LIST available

fileName (String!)

The name of file to send

appGroupId

Type: AppGroupId!

Description: Query to get the groupId according to the app

Arguments

Name Description

Name	Description
`appId` (`String!`)	The ID of the app

appId (String!)

The ID of the app

encryptCommand

Type: UnaSecuredCommand!

Description: Query to run an unasecured command. Command must be in base64

Arguments

Name Description

Name	Description
`deviceId` (`String!`)	No description
`command` (`String!`)	No description

deviceId (String!)

No description

command (String!)

No description

decryptCommand

Type: UnaSecuredCommand!

Description: Query to decrypt an unasecured command. Command must be in base64.

Arguments

Name Description

Name	Description
`deviceId` (`String!`)	No description
`command` (`String!`)	No description

deviceId (String!)

No description

command (String!)

No description