Group

Get the list of all the groups of the user

Get general information of a group

Create a Group

Update a group information

Invite user to a group

Update user to a group

Remove user from a group

Get the list of Devices of a group

Get the list of role of a group

Get the list of users of a group

Get all metrics of a group

Get the list of all the groups of the user

GET /user/groups

Get the list of all the groups of the user

You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

Name	In	Type	Required	Description
limit	query	integer	false	The maximum number of items to retrieve
nextToken	query	string	false	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.

Responses

Status	Meaning	Description	Schema
200	OK	Success response	GroupConnection
400	Bad Request	Bad request	None

Get general information of a group

GET /group

Get general information of a group

You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

Name	In	Type	Required	Description
groupId	query	string	true	The id of the group

Responses

Status	Meaning	Description	Schema
200	OK	succesfully retrieve informations of the group	Inline
400	Bad Request	Bad request	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[Group]	false	none	none

Create a Group

POST /group

Create a Group

You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Body parameter

{
  "name": "string",
  "description": "string",
  "tags": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
parentId	query	string	false	none
body	body	GroupInput	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success response	Group
400	Bad Request	Bad request	None

Update a group information

PUT /group

Update a group information

You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Body parameter

{
  "groupId": "string",
  "ownerId": "string",
  "name": "string",
  "roleId": "string",
  "description": "string",
  "parent": "string",
  "tags": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	UpdateGroupInput	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success response	Group
400	Bad Request	Bad request	None

Invite user to a group

PUT /group/invite

Invite user to a group

You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Body parameter

{
  "email": "string",
  "groupId": "string",
  "roleId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	InviteUserInput	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success response	GenericReturn
400	Bad Request	Bad request	None

Update user to a group

PUT /group/user

Update user to a group

You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Body parameter

{
  "userId": "string",
  "groupId": "string",
  "roleId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	UpdateUserRoleGroupInput	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success response	GenericReturn
400	Bad Request	Bad request	None

Remove user from a group

DELETE /group/user

Remove user from a group

You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

Name	In	Type	Required	Description
groupId	query	string	true	The ID of a Group
userId	query	string	false	The ID of a User, if nothing provided, it will take the current user

Responses

Status	Meaning	Description	Schema
200	OK	Success response	GroupUserRelation
400	Bad Request	Bad request	None

Get the list of Devices of a group

GET /group/devices

Get the list of Devices of a group

You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

Name	In	Type	Required	Description
groupId	query	string	true	The id of the group
limit	query	integer	false	none
nextToken	query	string	false	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.

Responses

Status	Meaning	Description	Schema
200	OK	Success response	DeviceConnection
400	Bad Request	Bad request	None

Get the list of role of a group

GET /group/roles

Get the list of role of a group

You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

Name	In	Type	Required	Description
limit	query	integer	false	none
nextToken	query	string	false	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.

Responses

Status	Meaning	Description	Schema
200	OK	Success response	RoleConnection
400	Bad Request	Bad request	None

Get the list of users of a group

GET /group/users

Get the list of users of a group

You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

Name	In	Type	Required	Description
groupId	query	string	true	The id of the group
limit	query	integer	false	none
nextToken	query	string	false	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.

Responses

Status	Meaning	Description	Schema
200	OK	Success response	UserConnection
400	Bad Request	Bad request	None

Get all metrics of a group

GET /group/metrics

Get all metrics of a group

You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

Name	In	Type	Required	Description
groupId	query	string	true	The id of the group
beginDate	query	string(date)	true	TThe begin timestamp of the period to get the data from
endDate	query	string(date)	true	The end timestamp of the period to get the data from
timeSpan	query	string(date)	false	The timespan between each item in seconds

Responses

Status	Meaning	Description	Schema
200	OK	Success response	GroupMetrics
400	Bad Request	Bad request	None

Schemas

GenericReturn

{
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
message	string	false	none	none

GenericReturnBoolean

{
  "message": "string",
  "value": true
}

Properties

Name	Type	Required	Restrictions	Description
message	string	false	none	none
value	boolean	false	none	none

RetryPolicy

{
  "retryDelay": 0,
  "maxRetry": 0
}

Properties

Name	Type	Required	Restrictions	Description
retryDelay	integer	false	none	none
maxRetry	integer	false	none	none

DataFailurePolicy

{
  "strongDuration": 0,
  "hasData": true,
  "startTime": "2019-08-24",
  "resending": true
}

Properties

Name	Type	Required	Restrictions	Description
strongDuration	integer	false	none	none
hasData	boolean	false	none	none
startTime	string(date)	false	none	none
resending	boolean	false	none	none

Group

{
  "id": "string",
  "userId": "string",
  "name": "string",
  "description": "string",
  "token": "string",
  "administratorRole": "string",
  "defaultRole": "string",
  "createdAt": "2019-08-24",
  "updatedAt": "2019-08-24",
  "createdBy": "string",
  "updatedBy": "string",
  "parent": "string",
  "role": {
    "id": "string",
    "name": "string",
    "description": "string",
    "permissions": [
      "string"
    ],
    "removable": true
  },
  "ownerId": "string",
  "numberOfDevices": 0,
  "numberOfNotifications": 0,
  "numberOfConnectors": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	none
userId	string	true	none	none
name	string	false	none	none
description	string	false	none	none
token	string	false	none	none
administratorRole	string	false	none	none
defaultRole	string	false	none	none
createdAt	string(date)	false	none	none
updatedAt	string(date)	false	none	none
createdBy	string	false	none	none
updatedBy	string	false	none	none
parent	string	false	none	none

GroupUserRelation

{
  "id": "string",
  "userId": "string",
  "role": {
    "id": "string",
    "name": "string",
    "description": "string",
    "permissions": [
      "string"
    ],
    "removable": true
  },
  "token": "string",
  "description": "string",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	none
userId	string	true	none	none

GroupConnection

{
  "items": [
    {
      "id": "string",
      "userId": "string",
      "name": "string",
      "description": "string",
      "token": "string",
      "administratorRole": "string",
      "defaultRole": "string",
      "createdAt": "2019-08-24",
      "updatedAt": "2019-08-24",
      "createdBy": "string",
      "updatedBy": "string",
      "parent": "string",
      "role": {
        "id": "string",
        "name": "string",
        "description": "string",
        "permissions": [
          "string"
        ],
        "removable": true
      },
      "ownerId": "string",
      "numberOfDevices": 0,
      "numberOfNotifications": 0,
      "numberOfConnectors": 0
    }
  ],
  "nextToken": "string"
}

Properties

Name	Type	Required	Restrictions	Description
items	[Group]	false	none	none

GroupUserInput

{
  "groupId": "string",
  "userId": "string",
  "roleId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
groupId	string	true	none	none
userId	string	true	none	none
roleId	string	true	none	none

GroupInput

{
  "name": "string",
  "description": "string",
  "tags": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
description	string	false	none	none
tags	[string]	false	none	none

UpdateGroupInput

{
  "groupId": "string",
  "ownerId": "string",
  "name": "string",
  "roleId": "string",
  "description": "string",
  "parent": "string",
  "tags": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
groupId	string	true	none	none
ownerId	string	false	none	none
name	string	false	none	none
roleId	string	false	none	none
description	string	false	none	none
parent	string	false	none	none
tags	[string]	false	none	none

DeleteGroupUserInput

{
  "groupId": "string",
  "userId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
groupId	string	true	none	none
userId	string	false	none	none

DeleteGroupInput

{
  "groupId": "string",
  "userId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
groupId	string	true	none	none
userId	string	true	none	none

DeleteGroupUserRelationInput

{
  "groupId": "string",
  "userId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
groupId	string	true	none	none
userId	string	true	none	none

Role

{
  "id": "string",
  "name": "string",
  "description": "string",
  "permissions": [
    "string"
  ],
  "removable": true
}

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	none
name	string	true	none	none
description	string	true	none	none
permissions	[string]	true	none	none
removable	boolean	false	none	none

RoleConnection

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "permissions": [
        "string"
      ],
      "removable": true
    }
  ],
  "nextToken": "string"
}

Properties

Name	Type	Required	Restrictions	Description
items	[Role]	false	none	none

InviteUserInput

{
  "email": "string",
  "groupId": "string",
  "roleId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
email	string	true	none	none
groupId	string	true	none	none
roleId	string	true	none	none

UpdateUserRoleGroupInput

{
  "userId": "string",
  "groupId": "string",
  "roleId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
userId	string	true	none	none
groupId	string	true	none	none
roleId	string	true	none	none

RequestGroupByDeviceIdInput

{
  "email": "string",
  "network": "string",
  "username": "string",
  "deviceId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
email	string	true	none	none
network	string	true	none	none
username	string	true	none	none
deviceId	string	true	none	none

DeviceConnection

{
  "items": [
    {
      "deviceId": "string",
      "groupId": "string",
      "name": "string",
      "type": "string",
      "network": "string",
      "originalId": "string",
      "battery": "string",
      "seenAt": 0,
      "createdAt": "2019-08-24",
      "updatedAt": "2019-08-24",
      "createdBy": "string",
      "updatedBy": "string",
      "information": "string",
      "configuration": "string",
      "tags": [
        "string"
      ]
    }
  ],
  "nextToken": "string"
}

Properties

Name	Type	Required	Restrictions	Description
items	[Device]	false	none	none

UserConnection

{
  "items": [
    {
      "id": "string",
      "email": "string",
      "name": "string",
      "seenAt": "2019-08-24",
      "firstName": "string",
      "lastName": "string",
      "createdAt": "2019-08-24",
      "updatedAt": "2019-08-24",
      "role": {
        "id": "string",
        "name": "string",
        "description": "string",
        "permissions": [
          "string"
        ],
        "removable": true
      }
    }
  ],
  "nextToken": "string"
}

Properties

Name	Type	Required	Restrictions	Description
items	[PublicUser]	false	none	none

Device

{
  "deviceId": "string",
  "groupId": "string",
  "name": "string",
  "type": "string",
  "network": "string",
  "originalId": "string",
  "battery": "string",
  "seenAt": 0,
  "createdAt": "2019-08-24",
  "updatedAt": "2019-08-24",
  "createdBy": "string",
  "updatedBy": "string",
  "information": "string",
  "configuration": "string",
  "tags": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
deviceId	string	true	none	none
groupId	string	true	none	none
name	string	true	none	none
type	string	true	none	none
network	string	true	none	none
originalId	string	true	none	none
battery	string	false	none	none
seenAt	integer	false	none	none
createdAt	string(date)	true	none	none
updatedAt	string(date)	true	none	none
createdBy	string	true	none	none
updatedBy	string	true	none	none
information	string	false	none	none
configuration	string	false	none	none
tags	[string]	false	none	none

PublicUser

{
  "id": "string",
  "email": "string",
  "name": "string",
  "seenAt": "2019-08-24",
  "firstName": "string",
  "lastName": "string",
  "createdAt": "2019-08-24",
  "updatedAt": "2019-08-24",
  "role": {
    "id": "string",
    "name": "string",
    "description": "string",
    "permissions": [
      "string"
    ],
    "removable": true
  }
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
email	string	false	none	none
name	string	false	none	none
seenAt	string(date)	false	none	none
firstName	string	false	none	none
lastName	string	false	none	none
createdAt	string(date)	false	none	none
updatedAt	string(date)	false	none	none

GroupMetric

{
  "groupId": "string",
  "timestamp": "2019-08-24",
  "totalConnectorMessageError": 0,
  "totalConnectorMessageProcessed": 0,
  "totalConnectorMessageProcessing": 0,
  "totalConnectorMessageStarted": 0,
  "totalConnectorRetryMessageError": 0,
  "totalConnectorRetryMessageProcessed": 0,
  "totalConnectorRetryMessageStarted": 0,
  "totalDeviceData": 0,
  "totalDeviceEvent": 0,
  "totalDeviceGeoloc": 0,
  "totalDeviceTelemetry": 0,
  "totalDeviceMessage": 0,
  "totalDeviceSigfoxDownlink": 0,
  "totalDeviceSigfoxUplink": 0,
  "totalSigfoxDataAdvancedMessage": 0,
  "totalSigfoxDataMessage": 0
}

Properties

Name	Type	Required	Restrictions	Description
groupId	string	false	none	none
timestamp	string(date)	false	none	none
totalConnectorMessageError	integer	false	none	none
totalConnectorMessageProcessed	integer	false	none	none
totalConnectorMessageProcessing	integer	false	none	none
totalConnectorMessageStarted	integer	false	none	none
totalConnectorRetryMessageError	integer	false	none	none
totalConnectorRetryMessageProcessed	integer	false	none	none
totalConnectorRetryMessageStarted	integer	false	none	none
totalDeviceData	integer	false	none	none
totalDeviceEvent	integer	false	none	none
totalDeviceGeoloc	integer	false	none	none
totalDeviceTelemetry	integer	false	none	none
totalDeviceMessage	integer	false	none	none
totalDeviceSigfoxDownlink	integer	false	none	none
totalDeviceSigfoxUplink	integer	false	none	none
totalSigfoxDataAdvancedMessage	integer	false	none	none
totalSigfoxDataMessage	integer	false	none	none

GroupMetrics

{
  "type": "object",
  "properties": {
    "deviceId": null,
    "type": "string",
    "groupId": {
      "type": "string"
    },
    "beginDate": {
      "type": "string",
      "format": "date"
    },
    "endDate": {
      "type": "string",
      "format": "date"
    },
    "totalConnectorMessageError": {
      "type": "integer"
    },
    "totalConnectorMessageProcessed": {
      "type": "integer"
    },
    "totalConnectorMessageProcessing": {
      "type": "integer"
    },
    "totalConnectorMessageStarted": {
      "type": "integer"
    },
    "totalConnectorRetryMessageError": {
      "type": "integer"
    },
    "totalConnectorRetryMessageProcessed": {
      "type": "integer"
    },
    "totalConnectorRetryMessageStarted": {
      "type": "integer"
    },
    "totalDeviceData": {
      "type": "integer"
    },
    "totalDeviceEvent": {
      "type": "integer"
    },
    "totalDeviceGeoloc": {
      "type": "integer"
    },
    "totalDeviceTelemetry": {
      "type": "integer"
    },
    "totalDeviceMessage": {
      "type": "integer"
    },
    "totalDeviceSigfoxDownlink": {
      "type": "integer"
    },
    "totalDeviceSigfoxUplink": {
      "type": "integer"
    },
    "totalSigfoxDataAdvancedMessage": {
      "type": "integer"
    },
    "totalSigfoxDataMessage": {
      "type": "integer"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "groupId": {
            "type": "string"
          },
          "timestamp": {
            "type": "string",
            "format": "date"
          },
          "totalConnectorMessageError": {
            "type": "integer"
          },
          "totalConnectorMessageProcessed": {
            "type": "integer"
          },
          "totalConnectorMessageProcessing": {
            "type": "integer"
          },
          "totalConnectorMessageStarted": {
            "type": "integer"
          },
          "totalConnectorRetryMessageError": {
            "type": "integer"
          },
          "totalConnectorRetryMessageProcessed": {
            "type": "integer"
          },
          "totalConnectorRetryMessageStarted": {
            "type": "integer"
          },
          "totalDeviceData": {
            "type": "integer"
          },
          "totalDeviceEvent": {
            "type": "integer"
          },
          "totalDeviceGeoloc": {
            "type": "integer"
          },
          "totalDeviceTelemetry": {
            "type": "integer"
          },
          "totalDeviceMessage": {
            "type": "integer"
          },
          "totalDeviceSigfoxDownlink": {
            "type": "integer"
          },
          "totalDeviceSigfoxUplink": {
            "type": "integer"
          },
          "totalSigfoxDataAdvancedMessage": {
            "type": "integer"
          },
          "totalSigfoxDataMessage": {
            "type": "integer"
          }
        }
      }
    },
    "activeDevices": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "numberActiveDevices": {
      "type": "integer"
    },
    "activeConnectors": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "numberActiveConnectors": {
      "type": "integer"
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
type	any	false	none	none
groupId	string	false	none	none
beginDate	string(date)	false	none	none
endDate	string(date)	false	none	none
totalConnectorMessageError	integer	false	none	none
totalConnectorMessageProcessed	integer	false	none	none
totalConnectorMessageProcessing	integer	false	none	none
totalConnectorMessageStarted	integer	false	none	none
totalConnectorRetryMessageError	integer	false	none	none
totalConnectorRetryMessageProcessed	integer	false	none	none
totalConnectorRetryMessageStarted	integer	false	none	none
totalDeviceData	integer	false	none	none
totalDeviceEvent	integer	false	none	none
totalDeviceGeoloc	integer	false	none	none
totalDeviceTelemetry	integer	false	none	none
totalDeviceMessage	integer	false	none	none
totalDeviceSigfoxDownlink	integer	false	none	none
totalDeviceSigfoxUplink	integer	false	none	none
totalSigfoxDataAdvancedMessage	integer	false	none	none
totalSigfoxDataMessage	integer	false	none	none
items	[GroupMetric]	false	none	none