Field | Argument | Type | Description |
---|---|---|---|
appId | String! | ||
groupId | String! |
Field | Argument | Type | Description |
---|---|---|---|
groupId | String! | The ID of the group | |
id | String! | The ID of the connector | |
name | String | The name given to the connector | |
description | String | The description given to the connector | |
params | AWSJSON! | The settings of the connector (e.g. splunk and its collector URL, mqtt and its user information) | |
type | String! | The connector type (e.g. HTTPS, MQTT, Splunk, etc.) | |
createdAt | AWSTimestamp! | The timestamp corresponding to the creation of the connector | |
updatedAt | AWSTimestamp! | The timestamp corresponding to the last update of the connector | |
updatedBy | String! | The ID of the user who updated the connector for the last time | |
createdBy | String! | The ID of the user who created the connector | |
error | ConnectorError | The error object contains an attribute 'message' with a string describing the error and an attribute 'at' with the timestamp when the error has occured. It is null or does not exist if there is no error | |
deviceTypes | [String] | The list of devices type: which type of device data are sent through the connector | |
enabled | Boolean | The boolean represents if the connector is enabled or not. If enabled is true, the connector will be processed. Otherwise, it will be ignored | |
messageFilter | String | The list of type of data you want to receive in the connector (data, event, geoloc, telemetry) | |
format | String | The format to convert the data into, when it does not exist, it will be JSON | |
dataFailurePolicy | DataFailurePolicy | When the device data send failure, the startTime will fill the first record of time store in the s3 the unit is minute | |
retryPolicy | RetryPolicy | The retry policy of the connector (e.g. maxRetry representing the number of retry and retryDelay the delay between two retries, in seconds) | |
tags | [String] | The tags |
Field | Argument | Type | Description |
---|---|---|---|
items | [Connector] | ||
nextToken | String |
Field | Argument | Type | Description |
---|---|---|---|
at | AWSTimestamp | ||
message | String |
Field | Argument | Type | Description |
---|---|---|---|
connectorId | String! | The ID of the Device | |
timestamp | AWSTimestamp | The timestamp when the event was sent | |
status | String | The status of the event |
Field | Argument | Type | Description |
---|---|---|---|
items | [ConnectorEvent] | ||
stats | ConnectorEventStats |
Field | Argument | Type | Description |
---|---|---|---|
totalStillProcessing | Int | Number of messages still processing during this period | |
totalSucceed | Int | Number of messages succeed during this period | |
totalFailed | Int | Number of messages failed to be sent during this period |
Field | Argument | Type | Description |
---|---|---|---|
groupId | String | The Group ID of the Connector | |
connectorId | String | The ID of the connector | |
timestamp | AWSTimestamp | The starting date | |
totalConnectorMessageError | Int | The number of messages that have failed | |
totalConnectorMessageProcessed | Int | The number of messages that have processed | |
totalConnectorMessageProcessing | Int | The number of messages that are still processing | |
totalConnectorMessageStarted | Int | The number of messages that have started to be computed. | |
totalConnectorRetryMessageError | Int | The number of messages that have failed and failed even after the retry | |
totalConnectorRetryMessageProcessed | Int | The number of messages that have failed and have been successfully later | |
totalConnectorRetryMessageStarted | Int | The number of messages that have failed and started to be computed. |
Field | Argument | Type | Description |
---|---|---|---|
groupId | String | The Group ID of the Connector | |
connectorId | String | The ID of the connector | |
beginDate | AWSTimestamp | The starting date | |
endDate | AWSTimestamp | The ending date | |
totalConnectorMessageError | Int | The number of messages that have failed | |
totalConnectorMessageProcessed | Int | The number of messages that have processed | |
totalConnectorMessageProcessing | Int | The number of messages that are still processing | |
totalConnectorMessageStarted | Int | The number of messages that have started to be computed. | |
totalConnectorRetryMessageError | Int | The number of messages that have failed and failed even after the retry | |
totalConnectorRetryMessageProcessed | Int | The number of messages that have failed and have been successfully later | |
totalConnectorRetryMessageStarted | Int | The number of messages that have failed and started to be computed. | |
items | [ConnectorMetric] | Metric by time interval |
Field | Argument | Type | Description |
---|---|---|---|
expectedParameters | AWSJSON! | The parameters specific to the connector type | |
type | String! | The name of the connector type | |
formatAvailable | [String] | The format available for this connector | |
name | String | The name of the connector type |
Field | Argument | Type | Description |
---|---|---|---|
items | [ConnectorType] | ||
nextToken | String |
Field | Argument | Type | Description |
---|---|---|---|
storingDuration | Int | The duration time in second to store the data that have failed into a storage | |
hasData | Boolean | The flag showing if the storage contains data failed | |
startTime | AWSTimestamp | The time of the error has been encountered | |
resending | Boolean | The flag if the connector is currently resending data |
Field | Argument | Type | Description |
---|---|---|---|
name | String! | UnaConnect Group Id | |
appClientId | String! | The APP Client id to provide |
Field | Argument | Type | Description |
---|---|---|---|
deviceId | String! | The ID of the device | |
groupId | String! | The ID of the group that the device belongs to | |
name | String! | The name of the device | |
type | String! | The type of the device | |
network | String! | The name of the Network used by the device | |
originalId | String! | The ID provided by the network of the device | |
battery | AWSJSON | The battery level of the device. The units depends on the type of the device (e.g. percent or voltage) | |
seenAt | Int | The timestamp when the device has been active for the last time. The device is considered active when there was any connection between the device and the network. | |
createdAt | AWSTimestamp! | The timestamp when the device has been added to UnaConnect | |
updatedAt | AWSTimestamp! | The timestamp when the device has been updated for the last time | |
createdBy | String! | The ID of the user who added the device to UnaConnect | |
updatedBy | String! | The ID of the user who updated the device for the last time | |
information | AWSJSON | The information of the device | |
configuration | AWSJSON | The configuration of the device. The format to follow is accessible via deviceTypes Query | |
tags | [String] | The tags |
Field | Argument | Type | Description |
---|---|---|---|
items | [Device] | ||
nextToken | String |
Field | Argument | Type | Description |
---|---|---|---|
deviceId | String! | The ID of the device that sent the data | |
timestamp | AWSTimestamp! | The timestamp when the data has been sent from the device | |
data | AWSJSON! | The data after being parsed by UnaConnect | |
configuration | AWSJSON | The configuration of the device | |
raw | AWSJSON | The original data received by UnaConnect and sent by the Device or the Network | |
deviceType | String | The type of the device that sent the data | |
mode | String | The message mode | |
reason | String | Reason of why the data has been sent : 'data' | |
deviceName | String | The name of the device that sent the data | |
groupId | String | The id of the group owning the device that sent the data |
Field | Argument | Type | Description |
---|---|---|---|
items | [DeviceData] | ||
nextToken | String |
Field | Argument | Type | Description |
---|---|---|---|
deviceId | String! | The ID of the Device | |
timestamp | AWSTimestamp! | The timestamp when the event was sent | |
deviceType | String | The device type of the device that sent the message | |
groupId | String | The id of the group owning the device that sent the data | |
message | String | The event message describing what is the message | |
type | String! | The type of the event | |
data | AWSJSON | Extra data | |
severity | String | The severity of the event |
Field | Argument | Type | Description |
---|---|---|---|
items | [DeviceEvent] | ||
nextToken | String |
Field | Argument | Type | Description |
---|---|---|---|
timestamp | AWSTimestamp! | The timestamp corresponding to when UnaConnect has received the data | |
status | Int | The status of the computation made by the location service: 0: No position, 1: Ok, 2: Fallback of WiFi location, 3: Invalid payload | |
source | Int | The source from which the geolocation has been computed: 1: Location computed using the GPS data inside the payload, 2: Location computed by Network location, 6: Location computed by WiFi location (External Provider) | |
radius | Int | The radius of the location precision in meters | |
lat | Float | The latitude of the device geolocation | |
lng | Float | The longitude of the device geolocation | |
groupId | String | The id of the group owning the device that sent the data | |
deviceId | String! | The ID of the device | |
location | String | The address of the location | |
data | AWSJSON | The geolocation data: country, network quality signal, sequence number, operator | |
raw | AWSJSON | The raw data before being parsed by UnaConnect |
Field | Argument | Type | Description |
---|---|---|---|
items | [DeviceGeoloc] | ||
nextToken | String |
Field | Argument | Type | Description |
---|---|---|---|
deviceId | String | Describe all the metrics of a Connector | |
groupId | String | The ID of the group | |
timestamp | AWSTimestamp | The starting date | |
totalDeviceData | Int | The total number of message of type Data sent by all devices of the group | |
totalDeviceEvent | Int | The total number of message of type Event sent by all devices of the group | |
totalDeviceGeoloc | Int | The total number of message of type Geoloc sent by all devices of the group | |
totalDeviceTelemetry | Int | The total number of message of type Telemetry sent by all devices of the group | |
totalDeviceMessage | Int | The total number of messages sent by all devices of the group | |
totalDeviceSigfoxDownlink | Int | The total number of SIGFOX downlink message sent by all devices of the group | |
totalDeviceSigfoxUplink | Int | The total number of SIGFOX uplink message sent by all devices of the group | |
totalSigfoxDataAdvancedMessage | Int | The total number of SIGFOX Data Advanced message received from all devices of the group | |
totalSigfoxDataMessage | Int | The total number of SIGFOX Data message received from all devices of the group |
Field | Argument | Type | Description |
---|---|---|---|
deviceId | String | Describe all the metrics of a Connector | |
groupId | String | The ID of the group | |
beginDate | AWSTimestamp | The starting date | |
endDate | AWSTimestamp | The ending date | |
totalDeviceData | Int | The total number of message of type Data sent by all devices of the group | |
totalDeviceEvent | Int | The total number of message of type Event sent by all devices of the group | |
totalDeviceGeoloc | Int | The total number of message of type Geoloc sent by all devices of the group | |
totalDeviceTelemetry | Int | The total number of message of type Telemetry sent by all devices of the group | |
totalDeviceMessage | Int | The total number of messages sent by all devices of the group | |
totalDeviceSigfoxDownlink | Int | The total number of SIGFOX downlink message sent by all devices of the group | |
totalDeviceSigfoxUplink | Int | The total number of SIGFOX uplink message sent by all devices of the group | |
totalSigfoxDataAdvancedMessage | Int | The total number of SIGFOX Data Advanced message received from all devices of the group | |
totalSigfoxDataMessage | Int | The total number of SIGFOX Data message received from all devices of the group | |
items | [DeviceMetric] | Metric by time interval |
Field | Argument | Type | Description |
---|---|---|---|
deviceId | String! | The ID of the Device | |
timestamp | AWSTimestamp! | The timestamp when the event was sent | |
deviceType | String | The device type of the device that sent the message | |
duplicates | [AWSJSON] | All information about the Base Stations that received the message | |
data | AWSJSON | The data such as country code, SIGFOX operator name, sequence number | |
score | Int | The UnaScore representing the quality of the signal | |
nbBS | Int | The number of base stations that have received the message | |
rc | Int | The radio configuration zone : RC1, RC2, RC3, RC4 | |
groupId | String | The id of the group owning the device that sent the data |
Field | Argument | Type | Description |
---|---|---|---|
items | [DeviceTelemetry] | ||
nextToken | String |
Field | Argument | Type | Description |
---|---|---|---|
name | String | The name of the device type | |
displayName | String | The name to display on user intefaces | |
defaultConfiguration | AWSJSON | The default configuration as reference | |
battery | AWSJSON | The battery default information and unit | |
firmwareVersion | String | The firmware version |
Field | Argument | Type | Description |
---|---|---|---|
items | [DeviceType] | ||
nextToken | String |
Field | Argument | Type | Description |
---|---|---|---|
token | String | ||
type | String | ||
createdAt | AWSTimestamp | ||
createdBy | String | ||
deviceName | String | ||
enabled | Boolean |
Field | Argument | Type | Description |
---|---|---|---|
groupId | String! | The ID of the Group | |
name | String! | The name of the API Key | |
type | String! | The type of the API Key | |
token | String | The key | |
createdBy | String | The ID of the creator of the API Key | |
updatedBy | String | The ID of the last user who has modified the API Key | |
createdAt | AWSTimestamp | The timestamp of the creation | |
updatedAt | AWSTimestamp | The timestamp of the last update |
Field | Argument | Type | Description |
---|---|---|---|
id | String | Unique identifier for the firmware | |
groupId | String | ID of the group owner of the firmware | |
checksum | Int | the checksum of the firmware | |
url | String | the URL of the firmware | |
productId | String | the product ID related to the device | |
deviceType | String | the unaconnect device type | |
version | String | the version of the firmware | |
createdBy | String | The ID of the creator of the firmware | |
updatedBy | String | The ID of the last user who has modified the firmware | |
createdAt | AWSTimestamp | The timestamp of the creation | |
updatedAt | AWSTimestamp | The timestamp of the last update |
Field | Argument | Type | Description |
---|---|---|---|
items | [Firmware] | ||
nextToken | String |
Field | Argument | Type | Description |
---|---|---|---|
message | String | Generic message |
Field | Argument | Type | Description |
---|---|---|---|
message | String | Generic message | |
value | Boolean |
Field | Argument | Type | Description |
---|---|---|---|
id | String! | The ID of the Group | |
userId | String! | The ID of the user who owns the group (e.g. first user who created the group) | |
name | String | The name of Group | |
description | String | The description of the group (its purpose) | |
token | String | The security token to be used on networks backend (e.g. sigfox as Authorization) | |
administratorRole | String | The name of the administrator role of the group | |
defaultRole | String | The name of the default role of the group | |
createdAt | AWSTimestamp | The timestamp corresponding to the creation of the group | |
updatedAt | AWSTimestamp | The timestamp corresponding to the last update of the group | |
createdBy | String | The ID of the user, creator of the group | |
updatedBy | String | The ID of the user who updated the group for the last time | |
parent | String | The ID of the parent group | |
role | Role | The role of the user in the group | |
ownerId | String | The creator of the group | |
numberOfDevices | Int | The number of devices | |
numberOfNotifications | Int | The number of notifications | |
numberOfConnectors | Int | The number of connectors | |
deviceTypes | [String] | The list of device types present in the group |
Field | Argument | Type | Description |
---|---|---|---|
groupId | String! | UnaConnect Group Id | |
appClientId | String! | The APP Client id to provide | |
secret | String! | The APP Client secret to provide | |
description | String | The description of the purpose of the APP Client. | |
expiration | Int | The time after which the refresh token expires. The value is day, minimum is 1 day, the maximum is 3650. |
Field | Argument | Type | Description |
---|---|---|---|
items | [Group] | ||
nextToken | String |
Field | Argument | Type | Description |
---|---|---|---|
groupId | String | The ID of the group | |
timestamp | AWSTimestamp | The starting date | |
totalConnectorMessageError | Int | The total number of messages that have failed across all the connectors of the group | |
totalConnectorMessageProcessed | Int | The total number of messages that have processed across all the connectors of the group | |
totalConnectorMessageProcessing | Int | The total number of messages that are still processing across all the connectors of the group | |
totalConnectorMessageStarted | Int | The total number of messages that have started to be computed across all the connectors of the group | |
totalConnectorRetryMessageError | Int | The total number of messages that have failed and failed even after the retry across all the connectors of the group | |
totalConnectorRetryMessageProcessed | Int | The total number of messages that have failed and have been successfully later across all the connectors of the group | |
totalConnectorRetryMessageStarted | Int | The total number of messages that have failed and started to be computed across all the connectors of the group | |
totalDeviceData | Int | The total number of message of type Data sent by all devices of the group | |
totalDeviceEvent | Int | The total number of message of type Event sent by all devices of the group | |
totalDeviceGeoloc | Int | The total number of message of type Geoloc sent by all devices of the group | |
totalDeviceTelemetry | Int | The total number of message of type Telemetry sent by all devices of the group | |
totalDeviceMessage | Int | The total number of messages sent by all devices of the group | |
totalDeviceSigfoxDownlink | Int | The total number of SIGFOX downlink message sent by all devices of the group | |
totalDeviceSigfoxUplink | Int | The total number of SIGFOX uplink message sent by all devices of the group | |
totalSigfoxDataAdvancedMessage | Int | The total number of SIGFOX Data Advanced message received from all devices of the group | |
totalSigfoxDataMessage | Int | The total number of SIGFOX Data message received from all devices of the group |
Field | Argument | Type | Description |
---|---|---|---|
groupId | String | The ID of the group | |
beginDate | AWSTimestamp | The starting date | |
endDate | AWSTimestamp | The ending date | |
totalConnectorMessageError | Int | The total number of messages that have failed across all the connectors of the group | |
totalConnectorMessageProcessed | Int | The total number of messages that have processed across all the connectors of the group | |
totalConnectorMessageProcessing | Int | The total number of messages that are still processing across all the connectors of the group | |
totalConnectorMessageStarted | Int | The total number of messages that have started to be computed across all the connectors of the group | |
totalConnectorRetryMessageError | Int | The total number of messages that have failed and failed even after the retry across all the connectors of the group | |
totalConnectorRetryMessageProcessed | Int | The total number of messages that have failed and have been successfully later across all the connectors of the group | |
totalConnectorRetryMessageStarted | Int | The total number of messages that have failed and started to be computed across all the connectors of the group | |
totalDeviceData | Int | The total number of message of type Data sent by all devices of the group | |
totalDeviceEvent | Int | The total number of message of type Event sent by all devices of the group | |
totalDeviceGeoloc | Int | The total number of message of type Geoloc sent by all devices of the group | |
totalDeviceTelemetry | Int | The total number of message of type Telemetry sent by all devices of the group | |
totalDeviceMessage | Int | The total number of messages sent by all devices of the group | |
totalDeviceSigfoxDownlink | Int | The total number of SIGFOX downlink message sent by all devices of the group | |
totalDeviceSigfoxUplink | Int | The total number of SIGFOX uplink message sent by all devices of the group | |
totalSigfoxDataAdvancedMessage | Int | The total number of SIGFOX Data Advanced message received from all devices of the group | |
totalSigfoxDataMessage | Int | The total number of SIGFOX Data message received from all devices of the group | |
items | [GroupMetric] | Metric by time interval | |
activeDevices | [String] | The ids of the devices seen during the period (current limit is 1000 devices) | |
numberActiveDevices | Int | The number of the devices seen during the period | |
activeConnectors | [String] | The ids of the connectors active during the period (current limit is 1000 connectors) | |
numberActiveConnectors | Int | The number of the connectors seen during the period |
Field | Argument | Type | Description |
---|---|---|---|
id | String! | The ID of a Group | |
userId | String! | The ID of a User | |
role | Role | The role of the user in the group | |
token | String | ||
description | String | ||
name | String |
Field | Argument | Type | Description |
---|---|---|---|
data | DeviceData | Latest message of Type Data | |
telemetry | DeviceTelemetry | Latest message of Type Telemetry | |
event | DeviceEvent | Latest message of Type Event | |
geoloc | DeviceGeoloc | Latest message of Type Geoloc |
Field | Argument | Type | Description |
---|---|---|---|
groupId | String! | The ID of the group which the notification is applied to | |
id | String! | The ID of a notification | |
name | String | The name given to the notification | |
description | String | The description of the purpose of the notification | |
params | AWSJSON! | The parameters of the notification (e.g. email address for Email, the phone number for SMS) | |
type | String! | The type of the notification : 'email' or 'expo'. The list of the all notification types is accessible with the Query 'notificationType' | |
createdAt | AWSTimestamp! | The timestamp corresponding to the creation of the notification | |
updatedAt | AWSTimestamp! | The timestamp corresponding to the last update of the notification | |
updatedBy | String! | The ID of the user who updated the notification for the last time | |
createdBy | String! | The ID of the user who created the notification | |
deviceId | String | Nonmandatory: Device ID for which the notification is applied, it will be thus applied only to the corresponding device. If not specified, the notification will be triggered for any device ID | |
deviceTypes | [String] | Nonmandatory: Device Type list for which the notification is applied, it will be thus applied only to the corresponding devices. If not specified, the notification will be triggered for any device type | |
reason | String | Nonmandatory: The reason of the notification: A reason can be 'telemetry' (Each time a telemetry message is received by UnaConnect), 'event' (Each time a device event received by UnaConnect), 'data' (Each time the device sends a data message to UnaConnect). If not specified, the notification will be triggered for any reason | |
schedule | AWSJSON | Nonmandatory: Schedule to send the notification at a specific moment. If not specified, the notification will trigger at each message. If the message received is in the range of the schedule, the notification will trigger. Otherwise, it will not. | |
enabled | Boolean | Boolean represents if the notification is enabled or not. If enabled is true, the notification will be processed. Otherwise, it will be ignored | |
tags | [String] | The tags |
Field | Argument | Type | Description |
---|---|---|---|
items | [Notification] | ||
nextToken | String |
Field | Argument | Type | Description |
---|---|---|---|
expectedParameters | AWSJSON! | The parameters specific to the notification type | |
type | String! | The name of the notification type | |
name | String | The name of the notification type |
Field | Argument | Type | Description |
---|---|---|---|
items | [NotificationType] | ||
nextToken | String |
Field | Argument | Type | Description |
---|---|---|---|
id | String! | The ID of the Permission | |
name | String! | The name of the Permission | |
description | String! | The description of the Permission |
Field | Argument | Type | Description |
---|---|---|---|
items | [Permission] | ||
nextToken | String |
Field | Argument | Type | Description |
---|---|---|---|
id | String | The ID of the user | |
AWSEmail | The email of the user | ||
name | String | The name of the user | |
seenAt | AWSTimestamp | The timestamp corresponding to the last connection of the user on UnaConnect | |
firstName | String | The user's first name | |
lastName | String | The user's last name | |
createdAt | AWSTimestamp | The timestamp corresponding to the creation of the user | |
updatedAt | AWSTimestamp | The timestamp corresponding to the last update of the user | |
role | Role |
Field | Argument | Type | Description |
---|---|---|---|
retryDelay | Int | Delay between two retries of a data (max value: 900) | |
maxRetry | Int | Maximum number of retry (max value : 30) |
Field | Argument | Type | Description |
---|---|---|---|
id | String! | The id of the role | |
name | String! | The name of the role | |
description | String! | The description of the role | |
permissions | [String]! | The list of Permission of the role | |
removable | Boolean | The Role objec can be removable |
Field | Argument | Type | Description |
---|---|---|---|
items | [Role] | ||
nextToken | String |
Field | Argument | Type | Description |
---|---|---|---|
url | String | URL string |
Field | Argument | Type | Description |
---|---|---|---|
deviceId | String | ||
originalId | String | ||
data | AWSJSON |
Field | Argument | Type | Description |
---|---|---|---|
deviceId | String | ||
originalId | String | ||
data | AWSJSON |
Field | Argument | Type | Description |
---|---|---|---|
appClientId | String! | UnaConnect Client id | |
secret | String! | ||
name | String! | UnaConnect Client name | |
expiration | Int | The time after which the refresh token expires. The value is day, minimum is 1 day, the maximum is 3650. |
Field | Argument | Type | Description |
---|---|---|---|
id | String | The ID of the user | |
AWSEmail | The email of the user | ||
name | String | The name of the user | |
seenAt | AWSTimestamp | The timestamp corresponding to the last connection of the user on UnaConnect | |
firstName | String | The user's first name | |
lastName | String | The user's last name | |
createdAt | AWSTimestamp | The timestamp corresponding to the creation of the user | |
updatedAt | AWSTimestamp | The timestamp corresponding to the last update of the user | |
gender | String | ||
devices | [ExpoToken] | The Expo Devices |
Field | Argument | Type | Description |
---|---|---|---|
items | [PublicUser] | ||
nextToken | String |
Field | Type | Description | |
---|---|---|---|
token | String! | The Expo token | |
deviceName | String | The user device name (aka phone's name, tablet's name) |
Field | Type | Description | |
---|---|---|---|
deviceId | String! | The ID of the device | |
groupId | String! | The ID of the group that the device belongs to | |
type | String! | The device type to change into |
Field | Type | Description | |
---|---|---|---|
groupId | String! | The ID of the group | |
id | String | The ID of the connector | |
name | String | The name given to the connector | |
description | String | The description given to the connector | |
params | AWSJSON! | The settings of the connector (e.g. splunk and its collector URL, mqtt and its user information) | |
type | String! | The connector type (e.g. HTTPS, MQTT, Splunk, etc.) | |
deviceTypes | [String] | The list of devices type: which type of device data are sent through the connector | |
deviceIds | [String] | The list of devices id: which device(s) data are sent through the connector | |
messageFilter | String | The list of type of data you want to receive in the connector (data, event, geoloc, telemetry) | |
format | String | The format to convert the data into, when it does not exist, it will be JSON | |
dataFailurePolicy | DataFailurePolicyInput | When the device data send failure, the startTime will fill the first record of time store in the s3 the unit is minute | |
retryPolicy | RetryPolicyInput | The retry policy of the connector (e.g. maxRetry representing the number of retry and retryDelay the delay between two retries, in seconds) |
Field | Type | Description | |
---|---|---|---|
expectedParameters | AWSJSON! | The parameters of the connector | |
type | String! | The name of type |
Field | Type | Description | |
---|---|---|---|
originalDevicesIds | [String]! | The original IDs of the devices | |
groupId | String! | The ID of the group to add the device into | |
type | String! | The type of the device | |
network | String! | The name of the Network used by the device | |
tags | [String] | The tags |
Field | Type | Description | |
---|---|---|---|
storingDuration | Int | The duration time in second to store the data that have failed into a storage | |
hasData | Boolean | The flag showing if the storage contains data failed | |
startTime | AWSTimestamp | The time of the error has been encountered | |
resending | Boolean | The flag if the connector is currently resending data |
Field | Type | Description | |
---|---|---|---|
deviceId | String! | The id of the device |
Field | Type | Description | |
---|---|---|---|
groupId | String! | The id of the group | |
connectorId | String! | The id of the connector to delete |
Field | Type | Description | |
---|---|---|---|
type | String! |
Field | Type | Description | |
---|---|---|---|
devicesIds | [String]! | The ids of the different devices | |
groupId | String! | The id of the original group of the devices |
Field | Type | Description | |
---|---|---|---|
deviceId | String! | The id of the device | |
timestamp | AWSTimestamp! | The time of the data |
Field | Type | Description | |
---|---|---|---|
deviceId | String! | The id of the device | |
timestamp | AWSTimestamp! | The time of the data |
Field | Type | Description | |
---|---|---|---|
deviceId | String! | The id of the device | |
timestamp | AWSTimestamp! | The time of the data |
Field | Type | Description | |
---|---|---|---|
deviceId | String! | The id of the device | |
groupId | String! | The id of the owner group of the device |
Field | Type | Description | |
---|---|---|---|
deviceId | String! | The id of the device | |
timestamp | AWSTimestamp! | The time of the data |
Field | Type | Description | |
---|---|---|---|
displayName | String! | ||
name | String! |
Field | Type | Description | |
---|---|---|---|
groupId | String! | The ID of the Group | |
type | String! | The API key type (e.g. sigfox) |
Field | Type | Description | |
---|---|---|---|
name | String! | The name of the App Client |
Field | Type | Description | |
---|---|---|---|
groupId | String! | The id of the group | |
userId | String! | the id of the owner of the group |
Field | Type | Description | |
---|---|---|---|
groupId | String! | The ID of a Group | |
userId | String | The ID of a User, if nothing provided, it will take the current user |
Field | Type | Description | |
---|---|---|---|
groupId | String! | the id of the group | |
userId | String! | the id of the user in the group |
Field | Type | Description | |
---|---|---|---|
groupId | String! | the id of the group of the notification | |
notificationId | String! | the id of the notification |
Field | Type | Description | |
---|---|---|---|
type | String! |
Field | Type | Description | |
---|---|---|---|
permissionId | String! |
Field | Type | Description | |
---|---|---|---|
groupId | String! | ||
roleId | String! | ||
userId | String! |
Field | Type | Description | |
---|---|---|---|
deviceId | String! | The ID of the device that sent the data | |
timestamp | AWSTimestamp! | The timestamp when the data has been sent from the device | |
data | AWSJSON! | The data after being parsed by UnaConnect | |
configuration | AWSJSON! | The configuration of the device when the data came in | |
raw | AWSJSON! | The original data received by UnaConnect and sent by the Device or the Network | |
deviceType | String! | The type of the device that sent the data | |
mode | String | The message mode | |
reason | String | Reason of why the data has been sent : 'data' | |
deviceName | String | The name of the device that sent the data | |
groupId | String | The id of the group owning the device that sent the data |
Field | Type | Description | |
---|---|---|---|
deviceId | String! | The ID of the Device | |
timestamp | AWSTimestamp! | The timestamp when the event was sent | |
deviceType | String | The device type of the device that sent the message | |
groupId | String | The ID of the group in which the device belongs to | |
message | String | The event message describing what is the message | |
type | String! | The type of the event | |
data | AWSJSON | Extra data | |
severity | String | The severity of the event |
Field | Type | Description | |
---|---|---|---|
timestamp | AWSTimestamp! | The timestamp corresponding to when UnaConnect has received the data | |
deviceId | String! | The ID of the device | |
status | Int | The status of the computation made by the location service : 0: No position, 1: Ok, 2: Fallback of WiFi location, 3: Invalid payload | |
source | Int | The source from which the geolocation has been computed: 1: Location computed using the GPS data inside the payload, 2: Location computed by Network location, 6: Location computed by WiFi location (External Provider) | |
radius | Int | The radius of the location precision in meters | |
lat | Float | The latitude of the device geolocation | |
lng | Float | The longitude of the device geolocation | |
location | String | The address of the location | |
data | AWSJSON | The geolocation data: country, network quality signal, sequence number, operator | |
raw | AWSJSON | The raw data before being parsed by UnaConnect | |
groupId | String | The id of the group owning the device that sent the data |
Field | Type | Description | |
---|---|---|---|
groupId | String! | The ID of the group to add the device into | |
name | String! | The name of the device | |
type | String! | The type of the device | |
originalId | String! | The ID provided by the network of the device | |
network | String! | The name of the Network used by the device | |
tags | [String] | The tags |
Field | Type | Description | |
---|---|---|---|
deviceId | String! | The ID of the Device | |
timestamp | AWSTimestamp! | The timestamp when the event was sent | |
deviceType | String! | The device type of the device that sent the message | |
duplicates | [AWSJSON] | All information about the Base Stations that received the message | |
data | AWSJSON | The data such as country code, SIGFOX operator name, sequence number | |
score | Int | The UnaScore representing the quality of the signal | |
nbBS | Int | The number of base stations that have received the message | |
rc | Int | The radio configuration zone : RC1, RC2, RC3, RC4 |
Field | Type | Description | |
---|---|---|---|
displayName | String! | ||
name | String! | ||
defaultConfiguration | AWSJSON! | ||
battery | AWSJSON! | ||
firmwareVersion | String! |
Field | Type | Description | |
---|---|---|---|
groupId | String! | The ID of the Group | |
type | String! | The API key type (e.g. sigfox) | |
token | String! | The API Token | |
name | String! | The API KEY name |
Field | Type | Description | |
---|---|---|---|
id | String! | Unique identifier for the firmware | |
groupId | String! | ID of the group owner of the firmware |
Field | Type | Description | |
---|---|---|---|
groupId | String! | ID of the group owner of the firmware | |
url | String! | the url of the firmware sent by getStoragePresignedUrl | |
productId | String! | the product ID related to the device | |
deviceType | String | the unaconnect device type | |
version | String! | the version of the firmware |
Field | Type | Description | |
---|---|---|---|
id | String! | Unique identifier for the firmware | |
groupId | String! | ID of the group owner of the firmware | |
productId | String | the product ID related to the device | |
deviceType | String | the unaconnect device type | |
version | String | the version of the firmware |
Field | Type | Description | |
---|---|---|---|
groupId | String! | The ID of the Group | |
name | String! | The APP Client name |
Field | Type | Description | |
---|---|---|---|
name | String! | The name of Group | |
description | String | The description | |
tags | [String] | The tags |
Field | Type | Description | |
---|---|---|---|
groupId | String! | The ID of a Group | |
userId | String! | The ID of a User | |
roleId | String! | The ID of a Role |
Field | Type | Description | |
---|---|---|---|
AWSEmail! | |||
groupId | String! | ||
roleId | String! |
Field | Type | Description | |
---|---|---|---|
AWSEmail! | |||
firstName | String! | The user's first name | |
lastName | String! | The user's last name |
Field | Type | Description | |
---|---|---|---|
groupId | String! | The ID of the group which the notification is applied to | |
params | AWSJSON! | The parameters of the notification (e.g. email address for Email, the phone number for SMS) | |
type | String! | The type of the notification : List of the all notification types accessible with the Query 'notificationType' | |
name | String! | Name given to the notification | |
description | String | The description of the purpose of the notification | |
deviceId | String | Nonmandatory: Device ID for which the notification is applied, it will be thus applied only to the corresponding device. If not specified, the notification will be triggered for any device ID | |
reason | String | Nonmandatory: The reason of the notification: A reason can be "telemetry" (Each time a telemetry message is received by UnaConnect), "event" (Each time a device event received by UnaConnect), "data" (Each time the device sends a data message to UnaConnect). If not specified, the notification will be triggered for any reason | |
schedule | [Schedule] | Nonmandatory: Schedule to send the notification at a specific moment.If not specified, the notification will trigger at each message. If the message received is in the range of the schedule, the notification will trigger. Otherwise, it will not. | |
deviceTypes | [String] | Nonmandatory: Device Type list for which the notification is applied, it will be thus applied only to the corresponding devices. If not specified, the notification will be triggered for any device type | |
tags | [String] | The tags |
Field | Type | Description | |
---|---|---|---|
expectedParameters | AWSJSON! | ||
type | String! |
Field | Type | Description | |
---|---|---|---|
permissionId | String! | The ID of the permission (e.g. 'add.group.device', 'read.device.data', etc.) | |
name | String! | The name of the permission | |
description | String! | The description of the permission |
Field | Type | Description | |
---|---|---|---|
token | String! | The Expo token to remove |
Field | Type | Description | |
---|---|---|---|
AWSEmail! | The email of the user requesting | ||
network | String! | The network of the device | |
username | String! | the name of the user | |
deviceId | String! | the ID of the device registered in the network (ex 123ABC) |
Field | Type | Description | |
---|---|---|---|
connectorId | String! | ||
groupId | String! |
Field | Type | Description | |
---|---|---|---|
retryDelay | Int! | Delay between two retries of a data (max value: 900) | |
maxRetry | Int! | Maxmimum number of retry (max value : 30) |
Field | Type | Description | |
---|---|---|---|
name | String! | The name of the role | |
description | String! | The description of the role | |
permissions | [String]! | The permissions allowed for the role |
Field | Type | Description | |
---|---|---|---|
Day | Int! | Day (0 (= Sunday) to 6 (= Saturday)) | |
From | Time! | Starting time | |
To | Time! | Ending time |
Field | Type | Description | |
---|---|---|---|
id | String! | ||
deviceTypeId | String! | ||
deviceName | String! | ||
pac | String! | ||
activable | Boolean | ||
automaticRenewal | Boolean | ||
lat | Float | ||
lng | Float |
Field | Type | Description | |
---|---|---|---|
Hours | Int! | Hours from 0 to 23 | |
Minutes | Int! | Minutes from 0 to 59 | |
Seconds | Int | Seconds from 0 to 59 |
Field | Type | Description | |
---|---|---|---|
devicesIds | [String]! | The ids of the different devices | |
groupId | String! | The id of the original group of the devices | |
toGroupId | String! | The id of the new group |
Field | Type | Description | |
---|---|---|---|
deviceId | String! | The id of the device to transfer | |
groupId | String! | The id of the original group | |
toGroupId | String! | The id of the new group of the device |
Field | Type | Description | |
---|---|---|---|
connectorId | String! | The ID | |
groupId | String! | The ID of the group | |
params | AWSJSON | The settings of the connector (e.g. splunk and its collector URL, mqtt and its user information) | |
name | String | The name given to the notification | |
description | String | The description given to the connector | |
type | String | The connector type (e.g. HTTPS, MQTT, Splunk, etc.) | |
deviceTypes | [String] | The list of devices type: which type of device data are sent through the connector | |
deviceIds | [String] | The list of devices id: which device(s) data are sent through the connector | |
messageFilter | String | The list of type of data you want to receive in the connector (data, event, geoloc, telemetry) | |
dataFailurePolicy | DataFailurePolicyInput | When the device data send failure, the startTime will fill the first record of time store in the s3 the unit is minute | |
retryPolicy | RetryPolicyInput | The retry policy of the connector (e.g. maxRetry representing the number of retry and retryDelay the delay between two retries, in seconds) | |
format | String | The format to convert the data into, when it does not exist, it will be JSON | |
enabled | Boolean | The boolean represents if the connector is enabled or not. If enabled is true, the connector will be processed.Otherwise, it will be ignored | |
tags | [String] | The tags |
Field | Type | Description | |
---|---|---|---|
devicesIds | [String] | The IDs of the devices | |
groupId | String! | The ID of the group | |
type | String! | The type of the device | |
configuration | AWSJSON! | The configuration to apply to all devices |
Field | Type | Description | |
---|---|---|---|
deviceId | String! | The ID of the device | |
groupId | String! | The ID of the group that the device belongs to | |
name | String | The name of the device | |
configuration | AWSJSON | The type of the device | |
tags | [String] | The tags |
Field | Type | Description | |
---|---|---|---|
displayName | String! | ||
name | String! | ||
defaultConfiguration | AWSJSON | ||
battery | AWSJSON | ||
firmwareVersion | String! |
Field | Type | Description | |
---|---|---|---|
groupId | String! | The ID of the Group | |
type | String! | The API key type (e.g. sigfox) | |
token | String | The API Token | |
name | String | The API KEY name |
Field | Type | Description | |
---|---|---|---|
name | String! | The name of the App Client | |
newName | String! | ||
groupId | String! |
Field | Type | Description | |
---|---|---|---|
groupId | String! | The id of the group | |
ownerId | String | The id of the owner | |
name | String | The name | |
roleId | String | The name of the administrator role of the group | |
description | String | The description of the group | |
parent | String | The ID of the parent group | |
tags | [String] | The tags |
Field | Type | Description | |
---|---|---|---|
notificationId | String! | The id of the notification | |
groupId | String! | The ID of the group which the notification is applied to | |
params | AWSJSON | The parameters of the notification (e.g. email address for Email, the phone number for SMS) | |
name | String | Name given to the notification | |
description | String | The description of the purpose of the notification | |
type | String | The type of the notification : List of the all notification types accessible with the Query 'notificationType' | |
deviceId | String | Nonmandatory: Device ID for which the notification is applied, it will be thus applied only to the corresponding device. If not specified, the notification will be triggered for any device ID | |
reason | String | Nonmandatory: The reason of the notification: A reason can be "telemetry" (Each time a telemetry message is received by UnaConnect), "event" (Each time a device event received by UnaConnect), "data" (Each time the device sends a data message to UnaConnect). If not specified, the notification will be triggered for any reason | |
schedule | [Schedule] | Nonmandatory: Schedule to send the notification at a specific moment.If not specified, the notification will trigger at each message. If the message received is in the range of the schedule, the notification will trigger. Otherwise, it will not. | |
enabled | Boolean | Boolean represents if the notification is enabled or not.If enabled is true, the notification will be processed. Otherwise, it will be ignored | |
deviceTypes | [String] | Nonmandatory: Device Type list for which the notification is applied, it will be thus applied only to the corresponding devices. If not specified, the notification will be triggered for any device type | |
tags | [String] | The tags |
Field | Type | Description | |
---|---|---|---|
roleId | String! | The ID of the role | |
groupId | String! | The ID of the group | |
name | String | The name of the role | |
description | String | The description of the role | |
permissions | [String] | The permissions allowed for the role |
Field | Type | Description | |
---|---|---|---|
gender | String | The gender of the user | |
name | String | The name of the user | |
firstName | String | The user's first name | |
lastName | String | The's last name |
Field | Type | Description | |
---|---|---|---|
userId | String! | ||
groupId | String! | ||
roleId | String! |
Boolean
scalar type represents true
or false
.Float
scalar type represents signed double-precision fractional values as specified by IEEE 754.Int
scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.String
scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.