GMS REST API documentation

Introduction
Web services
Web services push LNS

pushDataUp
pushDataDownEvent

DTOs
Error codes
List of tags
License

Introduction

This document presents the Wanesy Management Center API of the REST web services.
Different functional components can be addressed through this API :

GMS : Gateway Management Service
LNS : LoRa Network Server
BSC : Base Station Controller
RNC : Radio Network Controller
WG : Wanesy Geolocation
MDR : Message Detail Record

REST architecture

REST is an architecture style which relies on a stateless, client-server, cacheable communications protocol. REST stands for REpresentational State Transfer. RESTful is also used.
It refers to web services implementing such an architecture. Restful web services are Platform-independent, Language-independent, and Standards-based. They runs on top of HTTP. A Restful Web services architecture follows basic design principles :

It exposes a tree of resources via URI
It is stateless. Each request from any client contains all the information necessary to service the request, and session state is held in the client.
A resource is represented by an hypermedia type, for example JSON
It uses HTTP methods explicitly (GET, POST, PUT, DELETE, ?) and other HTTP standards
hypertext links to reference state
hypertext links to reference-related resources

A GET request provides the content of the resource pointed by the URI. A POST/PUT request creates or updates the resource pointed by the URI using provided parameters. Most of time, the request body is intended to be in JSON format.

Overview

Let examine the following uri :
GET /application/customers?page=3&PageSize=20 This web service allows to get the page number 3 of the list of customers.

Verb	Protocol	Domain	Path	Query string
GET	http://	kerlink.fr	/application/customers	?page=33&PageSize=20

The list of possible verbs is : GET, POST, PUT, DELETE, PATCH

POST : creates a new resource
GET : gets a resource
PUT : updates an existing resource
PATCH : updates a subset of fields of an existing resource
DELETE : deletes a resource

HTTP status

Different families of HTTP response status codes are defined :

2xx : Success
3xx : Redirection
4xx : Client side error
5xx : Server side error

Data Transfer Object

A Data Transfer Object, called DTO, is used to send data to the client or to receive data from the client. A DTO is composed of fields which contains the useful data for the client. Almost all the web services of this API use a JSON representation for the DTO.
All the DTO are defined in the chapter DTOs

Authorized and mandatory fields

Authorized and mandatory are two concepts that concerns the DTO fields that the client post in the request body.

- An authorized field can be provided by the client of the web service. It can be null. For example the identifier of a resource like the customer id is not authorized because it is managed by the server.
- A mandatory field is a field that cannot be null and that must be provided at the creation of a resource.

Conventions

Creating a new entity : At least all the authorized and mandatory fields must be provided by the client
Updating an existing entity : All the authorized fields must be provided by the client
Partially updates an existing entity : Any authorized field can be provided by the client

When creating a resource which depends on a parent resource (for example creating a fleet attached to its customer parent) only the identifier of the parent must be provided.
Example :


			{
				"customer": {
					"id": 1
				},
				"name": "fleet 1"
			}

General rules

Let?s consider the following web service URI :
http://kerlink.fr/gms/application/customers/198?page=33&PageSize=40
The part of the URI in bold contains path parameters.
The query string contains the query parameters. First parameter is preceded by a ?, and others by a &.
- Some web services use a date field. Each value of field of type date is a timestamp which is the difference, measured in milliseconds, between the current time and midnight January 1, 1970 UTC.
- Both correct and error response bodies are in JSON format.

Encoding

The URL parameters can contain special characters which are reserved keys, so the client must encode the URL parameters before sending it to the server.
An example of site which encode the URL is Encode URL

Example : getCustomers with a search condition in JSON
Non encoded URL
http://host:8080/gms/application/customers?page=1&pageSize=200&search={"operand":"name","operation":"eq","values":["foo"]}

Encoded URL
http://host:8080/gms/application/customers?page=1&pageSize=200&search=%7B%22operand%22%3A%22name%22%2C%22operation%22%3A%22eq%22%2C%22values%22%3A%5B%22foo%22%5D%7D

Naming

The DTO fields, paths, and web service names are written using the lower camelCase convention :

DTO Field (examples : name, lastName, gwEui)
Path (examples : customerId, devEui)
Web service name : (examples : getUser, patchEndDevice)

The DTO names are written using the upper camelCase convention :

DTO name (examples : CustomerDto, LastEventDto)

When an acronym appears in the name (like for example XML), not all the acronym is upper case but just the first letter like getXmlFile instead of getXMLFile because you may encounter ambiguous cases like these: XMLFile which should be xMLFile

Case

The strings used in the path parameters are case insensitive. For example customer/customerId and /customer/customerid are equivalent.
The strings used in the query parameters are case sensitive. For example pageSize and PageSize are different.
The DTO field name are case sensitive. For example, a JSON body dto {"name":"fleet1"} is different from {"Name":"fleet1"}

CSV files

All the CSV files used in the application use the following conventions :

The charset is UTF-8
The first row is used to define the columns
The separator is a comma ','
Each row ends with a line break
No empty row is authorized
A null value is defined with the string 'NULL'

Example :
id,firstName,LastName,phone
1,John,Doe,123
2,Paul,Deters,456
3,Peter,Brown,NULL

Response body

Almost every web services will return DTO object in JSON representation.
DTO stands for Data Transfer Object. All the DTO are defined in the chapter DTOs

One of the main principle of a REST architecture is to start from an entry endpoint and to navigate form a resource to another, as you would do with a browser. This concept is called HATEOAS (Hypermedia as the Engine of Application State) To do so, the response contains links which allow the customer to directly access to others resources.
A link contains two fields :

rel : the name of the resource.
href : relative path of the resource

Example 1 : first page of the list of customers
rel = first
href = /gms/application/customers?page=1

Example 2: list of fleets
rel = fleets
href = /gms/application/fleets

Entry point

The GMS web services tree has a unique entry point which is the web service getApplication.
This web service returns an PaginatedDto which contains the links to reach other resources.

Request parameters

Request parameters are the parameters that follow the path in the URI.
The first parameters start by a ? and the followers start with &.
Available parameters depends on the web service that is called.

Parameter fields

The request parameter named fields allows to define the list of DTO fields that will be displayed in the response body.
It can be useful for limiting the size of the response when the performance or bandwith is an issue.
When ommitted, all the fields are displayed.
Syntax : fields=<@><!>field1, <@><!>field2, ... <@><!>fieldn
The character @ is used to define a group. A group is a set of fields. Only some DTOs offer the group functionality.
The character ! is used to exclude a field or a group.

Examples :
fields = id,name ? displays id and name
fields = name,@time ? displays name,day,time
fields = !id ? all fields but id
fields = !id,!name ? all fields but id and name
fields = !id,!@time ? all fields but id and group time

Parameter search

The search parameter is used to specify a search query in order to retrieve entities that match the condition.
A search can therefore be used when a paginated result is sent.

Syntax :
search = e|c
e = expression = <operator><operand><operation>[value]
c = condition = <or|and>(<c|e>,<c|e>,?<c|e>)
operator = OR|AND|NOT

The operand is the name of a DTO field. For example, for a customer, it could be id, name.

Condition

FIELD	TYPE	MANDATORY	DESCRIPTION
operator	string		{OR, AND, NOT}
operand	string	?	A DTO field
operation	string	?	EQ, NE, GT, LT, GTE, LTE, IN, BET, LIKE
values	string[]		An array of string
conditions	Condition[]		The list of conditions to combine with an OR or AND operator

Operation

OPERATION	DESCRIPTION
EQ	Equals to
NE	Not Equals to
GT	Greater than
LT	Less than
GTE	Greater than or equals to
LTE	Less than or equals to
IN	In set
BET	Between
LIKE	Like operation, '' is a special character (Examples : te means words starting by te, te means words ending by te, te* means words containg te)

Nested operands

A nested operand corresponds to an operand of a child resource.
Syntax: <operand>.<operand>
For example, if you want to use the cpu field of a state resource, the syntax will be : state.cpu

Examples:

Example 1 : name = foo


			{
  				"operand": "name",
  				"operation": "EQ",
  				"values": ["foo"]
			}

The request param will be :
?search={"operand":"name","operation":"EQ","values":["foo"]}

Example 2 : (name = foo1) OR (name = foo2)


			{
			  "operator": "OR",
			  "conditions": [
			    {
			      "operand": "name",
			      "operation": "EQ",
			      "values": [
			        "foo1"
			      ]
			    },
			    {
			      "operand": "name",
			      "operation": "EQ",
			      "values": [
			        "foo2"
			      ]
			    }
			  ]
			}

Example 3 : id in {3,5}


			{
			  "operand": "id",
			  "operation": "IN",
			  "values": ["3", "5"]
			}

Example 4 : name like 'fo%


			{
			  "operand": "name",
			  "operation": "LIKE",
			  "values": ["fo*"]
			}

Example 5 : name != null


			{
			  "operand": "name",
			  "operation": "NE",
			  "values": null
			}

Alternative syntax


			{
			  "operand": "name",
			  "operation": "NE",
			  "values": []
			}

Other syntax (without the field values)


			other syntax (without values field)
			{
			  "operand": "name",
			  "operation": "NE"
			}

Example 6 : connected = true


			{
			  "operand": "connected",
			  "operation": "EQ",
			  "values": ["true"]
			}

Parameter sort

The web services which return lists of DTO can use the optional parameter sort in order to obtain a sorted result.

Syntax :
sort=[operator]<field>,[operator]<field>
operator : + | - (+ for ascending, - for descending)
field : a DTO field

Examples :
sort=+name : ascending sort by name
sort=-name : descending sort by name
sort=-date,+name : descending sort by date and ascending by name

Parameter criteria

A criteria is a list of (key,value) that are attached to a task.
This criteria will be used later for searching some specific tasks.

Syntax
Criteria=<key>=<value>
criteria=key1=value1&criteria=key2=value2, ? &criteria=keyn=valuen
If the key contains leading and trailing white spaces, they are deleted.

Reserved keys
A list of keys are reserved to the application usage, so the user cannot use them :
{customerId, userId, fleetId, gatewayEui, firmwareFileName, fileExchangeName, modemLocation, spectrumFileName}

Asynchronous web services

Web services are most of time synchronous : the user sends a request and he receives the answer in a synchronous mode.
Two use cases need to use a different way because :
- The task may take a long time to be processed (for example a spectrum with a long duration)
- The task needs to be launched within another process (new thread)
The sequence diagram for those use cases is the following :
The status response of an asynchronous web service is 202 Accepted.
The header Content-Location contains the path to the web service to poll in order to retrieve the result.

Single response

A single response is a response which contains only one resource with its fields. For example, the request GET /users/{userId} will return a User resource. The resources returned in the response body are called Data Transfer Object (DTO). In the above example, the object returned is more precisely a UserDto. All the DTO are described in the chapter DTOs.
The representation of a DTO is JSON.
The feature available for a single response is filtering (with the request parameter fields)

Paginated response

A multiple response is used when the response contains a list of resources. For example the request GET /users will return a list of UserDto. Those entities are not sent in one time but page by page with the pagination functionality.
The features available for a paginated web services are : filtering, pagination, sorting, searching

Pagination

The web services that return a list are paginated in order to avoid to send a huge amount of data to the client. The request specifies two query parameters that the user can set : the page number and the page size, which are set to a default value when omitted. The PaginatedDto is described in the DTOs chapter.

The PaginatedDto can contain an array of Links depending on the context :
- first : absolute URI to go to the first page
- last : absolute URI to go to the last page
- next : absolute URI to go to the next page
- previous : absolute URI to go to the previous page

Versioning

Most of time the modifications done on a web service ensure a backward compatibility. But sometimes the way to request the web service, or the way to analyse the response need to define an upgraded version of the web service. If all the users agreed with this new version, the old web service may be deprecated or deleted, but it is rarely the case: we need to provide the new version but also ensure that nothing has changed for the users of the old version. The principle of the versioning adopted for the API is to define a version number in the request headers Accept and Content-Type, according to the HTTP content negotiation specification.

The following value enables to call the first version of a web service:

application/vnd.kerlink.iot-v1+json

If the web service is upgraded to a new version, clients will be able to access the new version via a new header value:

application/vnd.kerlink.iot-v2+json

The way to define the version the client wants to retrieve is to set the Accept request header.
If the web service does not implement this version, it will send an error with status code 406 (Not Acceptable).
This header is not mandatory. If the version is not specified, the last version of the web service will be called by default.

The way to define the version the client wants to use when sending data in the request body is to set the Content-Type request header.
If no value is provided or the web service does not implement this version, it will send an error with status code 415 (Unsupported Media Type).
This header is mandatory. If the version is not specified, the last version of the web service will be called by default.

Security

The web services are available over Transport Layer Security (TLS) layer with certificates. Most of web services require to be authenticated, so the user must first authenticate via the login web service which requires to post the login and the password. This web service returns a token (JSON Web Token) which has a Time to live expiration date. All the other web services except those which don't require any authentication will consume a token. If the token has expired, the HTTP 401 status code is sent.

A token is used by sending it in the Authorization request header :
Authorization: Bearer <token value> All the passwords stored in the database are encrypted.

HTTPS

When accessible via the Saas, the API is reachable over the HTTPS protocol, otherwise it depends on the configuration chosen by the customer.

JWT token

When a user calls an authenticated web service, the application checks for the validity of the token :
- It is well formed and has not been modified
- It is not expired
The token contains data that are used to validate some functional rules. If one of those rules is not respected, an error will be returned. For example, the user corresponding to the token no longer exists.

Roles

Roles are defined both on users and web services.
Each user is attached to one role.
All the web services (excepted those which don't need authentication) are attached to one role.
When a user tries to access to an authenticated web service, his role must be greater than or equals to the web service role.
In this documentation when we say for example "A user is ADMIN" it is a shortcut for a user has the role ADMIN.

There are four roles :

READER

The user can access to the web services which have the role READER.

USER

The user can access to the web services which have the role USER or READER.

ADMIN

The user can access to the web services which have the role ADMIN, USER or READER.

SUPER_ADMIN

The user can access to the web services which have the role SUPER_ADMIN, ADMIN, USER or READER.

User rate limiting

Rate limits are defined per user for the web services which need authentication. This mechanism prevents from user or scripts to execute too many requests during a defined period.
Three configuration properties allow to manage the user rate limit.
request.max.rate : defines the maximum number of requests per second
request.max.rate.duration : defines the period in seconds during which the user exceeds the maximum number of requests per seconds
user.suspended.duration : defines the period in seconds during which the user is suspended
If the user exceeds the maximum number of requests per second during a period, then he is suspended.
For example, with the default values, this results in : if the user exceeds 10 requests/s during 10 s, he is suspended for 30 s.
If he tries to access to any web service during his suspension period, an error with status 429 Too Many Requests will be sent.
The properties request.max.rate and request.max.rate.duration can be overloaded by respectively patching the fields requestMaxRate and requestMaxRateDuration of the UserDto.

Error management

When a web service request ends with an error, due to the client or the server, a formated error is sent to the client in order to identify the origin of the problem and to facilitate the diagnostic.
The error sent is an ErrorDto resource.

Revisions

Revision is a metadata. It consists of an action applied to one property. A revision may generate a breaking change.
A property can be :

A DTO
A DTO field
A web service
A web service parameter

An action can be :

ADDED : a property has been added
DEPRECATED : a property has been deprecated
UPDATED : a property has been updated
DELETED : a property has been deleted

Rules :

A deprecated property will be removed in the next version of the application.

Graphic styles :

Action	No breaking change	Breaking change
ADDED	added	added
DEPRECATED	deprecated
UPDATED	updated	updated
DELETED	deleted	deleted

Web services

addEndDeviceToMulticastGroup END_DEVICEMULTICAST Since: 3.0.0

PUT

/application/multicastGroups/{id}/endDevices/{devEui}

ADMIN

Description

This web service allows to add an end-device to a multicastGroup.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
devEui	PATH	string	?	End-device EUI
id	PATH	integer	?	MulticastGroup identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

addSoftware SOFTWARE Since: 3.2.0

POST

/application/softwares

SUPER_ADMIN

Description

This web service allows to add a software in the repository.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	multipart/form-data	?	The Media type of the request body
file	BODY	MultipartFile	?	The file content
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

cancelOneDataDown DATA_DOWN Since: 3.1.0

DELETE

/application/dataDown/{id}

USER

Description

This web service allows to cancel one dataDown. This will result in having a DataDown with a status equals to CANCELLED.
If the DataDown switches to the status OK or KO during the cancellation order then it will not be cancelled (the cancellation order came too late).
If the cancellation order succeeded (status = CANCELLED) it may occur that the DataDown is pending/waiting for LNS acknowledgments steps, according to end-device response it may result in changing the status again even if it was tagged CANCELLED.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)
If the parameter cancel is not provided or if it equals to false an error occurs which explains that deleting a dataDown is not authorized.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	string	?	DataDown identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
cancel	QUERY	boolean		true means that the dataDown will be cancelled.

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

cancelOneMulticastDataDown MULTICAST Since: 3.1.0

DELETE

/application/multicastDataDown/{id}

USER

Description

This web service allows to cancel one multicast dataDown. This will result in having a multicast dataDown with a status equals to CANCELLED.

Rules

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	string	?	multicast dataDown identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
cancel	QUERY	boolean		true means that the multicast dataDown will be cancelled.

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

createApplicationSettings APPLICATIONSETTING Since: 1.1.12

POST

/application/applicationSettings

SUPER_ADMIN

Description

This web service allows to create application settings.

Rules

All the settings must be valid otherwhise none of them will be created or updated
If a setting already exists, it is updated
If a setting overrides an existing private setting an error message occurs and all the list is rejected

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
applicationSettings	BODY	ApplicationSettingDto[]	?
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
201 CREATED	BODY
4xx, 5xx	BODY		ErrorDto

createBrand GATEWAYGATEWAY_TYPE Since: 3.2.0

POST

/application/brands

SUPER_ADMIN

Description

This web service allows to create a new Brand.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
brandDto	BODY	BrandDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
201 CREATED	BODY
4xx, 5xx	BODY		ErrorDto

createCluster CLUSTER Since: 1.1.12

POST

/application/clusters

ADMIN

Description

This web service allows to create a new cluster.

Rules

accessType is mandatory if pushUrl is provided
msgDetailLevel is mandatory if pushUrl is provided
pushUser and pushPassword are mandatory if one or the other is provided

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
clusterDto	BODY	ClusterDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
201 CREATED	BODY
201 CREATED	HEADER	Location	/application/clusters/{id}	Created resource path
4xx, 5xx	BODY		ErrorDto

createCustomer CUSTOMER Since: 1.1.12

POST

/application/customers

SUPER_ADMIN

Description

This web service allows to create a new customer.

Rules

Only a SUPER_ADMIN user can write the field geolocalisationEnabled.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
customerDto	BODY	CustomerDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
201 CREATED	BODY
201 CREATED	HEADER	Location	/application/customers/{id}	Created resource path
4xx, 5xx	BODY		ErrorDto

createCustomersSettings CUSTOMERSETTING Since: 1.1.12

POST

/application/customersSettings

ADMIN

Description

This web service allows to create customers settings. If a customer setting already exists, it is updated.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
customerSettings	BODY	CustomerSettingDto[]	?
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
201 CREATED	BODY
4xx, 5xx	BODY		ErrorDto

createDataDown DATA_DOWN Since: 1.1.12

POST

/application/dataDown

USER

Eligible for workflow: END_DEVICE

Description

This web service allows to create a data down.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
dataDownDto	BODY	DataDownDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
201 CREATED	BODY
201 CREATED	HEADER	Location	/application/dataDown/{id}	Created resource path
4xx, 5xx	BODY		ErrorDto

createEndDevices END_DEVICE Since: 1.1.12

POST

/application/endDevices/bulk

ADMIN

Asynchronous

Description

This web service allows to create a list of end-devices from a CSV file. The CSV file contains a list of CsvEndDeviceDto.
This web service is asynchronous. It sends a 202 Accepted response and the header Location allows to request for the progress monitoring returned by the web service getCreateEndDevicesStatus

Rules

The connected user can manage the customer of each end-device (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	multipart/form-data	?	The Media type of the request body
file	BODY	MultipartFile	?	The CSV file containing a list of end-devices
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY
202 ACCEPTED	HEADER	Content-Location	/application/endDevices/bulk/{id}	Location for retrieving the data
4xx, 5xx	BODY		ErrorDto

Asynchronous response

ProgressMonitorDto

createEndDevicesDeletion END_DEVICE Since: 2.2.0

POST

/application/endDevices/deletions

ADMIN

Asynchronous

Description

This web service allows to delete a list of end-devices.
This web service is asynchronous. It sends a 202 Accepted response status.
The response header Content-Location allows to poll the ProgressMonitorDto with the web service getEndDevicesDeletion.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json	?	The Media type of the request body
devEuis	BODY	String[]	?	The list of end-devices devEui (exemple : ["AAAAAAAAAAAAAA16","BBBBBBBBBBBBBB16","CCCCCCCCCCCCCC16"])
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY
4xx, 5xx	BODY		ErrorDto

Asynchronous response

ProgressMonitorDto

createEndDevicesExport END_DEVICEEXPORT Since: 2.2.0

POST

/application/endDevices/exports

READER

Asynchronous

Description

This web service allows to export all the end-devices to a CSV file.
This web service is asynchronous. It sends a 202 Accepted response status.
The response header Content-Location allows to poll the ProgressMonitorDto with the web service getEndDevicesExport.
The parameters sort and search refer to a EndDeviceDto.
The generated CSV file is a list of CsvEndDeviceDto.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).
If the connected user is SUPER_ADMIN then all end-devices are exported, otherwise only the end-devices attached to his customer.
If the parameter importable is set to true, then the csv file will contain only the authorized fields of a CsvEndDeviceDto.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
importable	QUERY	boolean		true means that csv is importable from web service createEndDevices.
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY
202 ACCEPTED	HEADER	Content-Location	/application/endDevices/exports/{id}	Location for retrieving the data
4xx, 5xx	BODY		ErrorDto

Asynchronous response

ProgressMonitorDto

createFleet FLEET Since: 1.1.12

POST

/application/fleets

ADMIN

Description

This web service allows to create a new fleet.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
fleetDto	BODY	FleetDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
201 CREATED	BODY
201 CREATED	HEADER	Location	/application/fleets/{id}	Created resource path
4xx, 5xx	BODY		ErrorDto

createGateway GATEWAY Since: 1.1.12

PUT

/application/gateways/{eui}

USER

Description

This web service allows to create a new gateway.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)
The fields {gpsPositionAllowed, maxTxPower, networkMaxDelayDown, networkMaxDelayUp} are set if the user is at least ADMIN.
The maximum number of gateways of the customer cannot be exceeded.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
eui	PATH	string	?	Gateway EUI
gatewayDto	BODY	GatewayDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

createGatewayCommand COMMANDGATEWAY Since: 1.1.12

POST

/application/gateways/{eui}/commands

USER

Asynchronous

Eligible for workflow: GATEWAY

Description

This web services allows to execute a command on the remote gateway.
Caution : only the commands based on a request <=> response will be correctly managed; a command like vi file.txt will not work as it needs an interactive mode.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
command	QUERY	string	?	The Linux command to execute
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
criteria	QUERY	String[]		Task criteria. Pre-registered are : {customerId, userId, fleetId, gatewayEui}

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY		TaskDto
202 ACCEPTED	HEADER	Content-Location	/application/tasks/{id}	Location for retrieving the data
4xx, 5xx	BODY		ErrorDto

Asynchronous response

CommandDto

createGatewayCpCommand COMMANDGATEWAY Since: 1.1.12

POST

/application/gateways/{eui}/commands/cp

USER

Asynchronous

Description

This web service allows to copy file from source to destination on a gateway.
If the source contains sub directories they will be recursively copied.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
destination	QUERY	string	?	Absolute directory destination where to copy source
source	QUERY	string	?	absolute source path to copy
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
criteria	QUERY	String[]		Task criteria. Pre-registered are : {customerId, userId, fleetId, gatewayEui}

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY		TaskDto
202 ACCEPTED	HEADER	Content-Location	/application/tasks/{id}	Location for retrieving the data
4xx, 5xx	BODY		ErrorDto

createGatewayGetFileCommand COMMANDFILEGATEWAY Since: 1.1.12

POST

/application/gateways/{eui}/commands/get

USER

Asynchronous

Description

This web service allows to retrieve a file from the gateway file system.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
filePath	QUERY	string	?	absolute path of the gateway file (ex: /tmp/conf/foo.txt)
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
criteria	QUERY	String[]		Task criteria. Pre-registered are : {customerId, userId, fleetId, gatewayEui}

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY		TaskDto
202 ACCEPTED	HEADER	Content-Location	/application/tasks/{id}	Location for retrieving the data
4xx, 5xx	BODY		ErrorDto

Asynchronous response

application/octet-stream

createGatewayLsCommand COMMANDGATEWAY Since: 1.1.12

POST

/application/gateways/{eui}/commands/ls

USER

Asynchronous

Description

This web service allows to execute the command 'ls' on the gateway. It browses the directory non recursively.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
directory	QUERY	string	?	The absolute path to browse (example : /tmp/dir)
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
criteria	QUERY	String[]		Task criteria. Pre-registered are : {customerId, userId, fleetId, gatewayEui}
fields	QUERY	string		List of fields to display for FileDto

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY		TaskDto
202 ACCEPTED	HEADER	Content-Location	/application/tasks/{id}	Location for retrieving the data
4xx, 5xx	BODY		ErrorDto

Asynchronous response

FileDto

createGatewayMkDirCommand COMMANDGATEWAY Since: 1.1.12

POST

/application/gateways/{eui}/commands/mkdir

USER

Asynchronous

Description

This web service allows to execute the command mkdir on one gateway.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
directory	QUERY	string	?	absolute path of the directory to create (ex: /tmp/conf)
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
criteria	QUERY	String[]		Task criteria. Pre-registered are : {customerId, userId, fleetId, gatewayEui}

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY		TaskDto
4xx, 5xx	BODY		ErrorDto

createGatewayModemSpectrum GATEWAYMODEMSPECTRUM Since: 1.1.12

POST

/application/gateways/{eui}/modems/{modemLocation}/spectrums

USER

Asynchronous

Description

This web service allows to create a new spectrum analysis on one modem of the gateway.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
modemLocation	PATH	integer	?	Modem location (starting at 1)
duration	QUERY	integer	?	Duration of the spectrum analysis in seconds (integer > 0 and < 86400)
modemSerialNumber	QUERY	string	?	Modem serial number
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
criteria	QUERY	String[]		Task criteria. Pre-registered are : {customerId, userId, fleetId, gatewayEui}

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY		TaskDto
4xx, 5xx	BODY		ErrorDto

Asynchronous response

application/octet-stream

createGatewayMvCommand COMMANDGATEWAY Since: 1.1.12

POST

/application/gateways/{eui}/commands/mv

USER

Asynchronous

Description

This web service allows to rename or move a file on a gateway.Examples
mv /tmp/foo.txt /tmp/foo2.txt : renames foo.txt to foo2.txt
mv /tmp/foo.txt /tmp/subdir : moves foo.txt to /tmp/subdir directory

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
destination	QUERY	string	?	Absolute destination path of the new name or the destination directory
source	QUERY	string	?	absolute source path to move or rename
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
criteria	QUERY	String[]		Task criteria. Pre-registered are : {customerId, userId, fleetId, gatewayEui}

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY		TaskDto
202 ACCEPTED	HEADER	Content-Location	/application/tasks/{id}	Location for retrieving the data
4xx, 5xx	BODY		ErrorDto

createGatewayPutFileCommand COMMANDFILEGATEWAY Since: 1.1.12

POST

/application/gateways/{eui}/commands/put

USER

Asynchronous

Eligible for workflow: GATEWAY

Description

This web service allows to put a file on the gateway file system.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
destinationPath	QUERY	string	?	absolute path of the gateway directory that will receive the file (ex: /tmp/destination)
file	BODY	MultipartFile	?	The file to put on the gateway destinationPath
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
criteria	QUERY	String[]		Task criteria. Pre-registered are : {customerId, userId, fleetId, gatewayEui}

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY		TaskDto
202 ACCEPTED	HEADER	Content-Location	/application/tasks/{id}	Location for retrieving the data
4xx, 5xx	BODY		ErrorDto

createGatewayRmCommand COMMANDGATEWAY Since: 1.1.12

POST

/application/gateways/{eui}/commands/rm

USER

Asynchronous

Description

This web service allows to delete file on a gateway.Examples
rm /tmp/foo.txt : deletes the file foo.txt
rv /tmp : deletes /tmp directory

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
file	QUERY	string	?	Absolute path of the file to delete
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
criteria	QUERY	String[]		Task criteria. Pre-registered are : {customerId, userId, fleetId, gatewayEui}

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY		TaskDto
202 ACCEPTED	HEADER	Content-Location	/application/tasks/{id}	Location for retrieving the data
4xx, 5xx	BODY		ErrorDto

createGateways GATEWAY Since: 2.1.0

POST

/application/gateways/bulk

USER

Asynchronous

Description

Creates several gateways from a CSV file for one ore more customers. The CSV file contains a list of CsvGatewayDto.
This web service is asynchronous. It sends a 202 Accepted response and the header Location allows to request for the progress monitoring returned by the web service getCreateGatewaysStatus

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)
The already exist gateways are ignored.
The fields {gpsPositionAllowed, maxTxPower, networkMaxDelayDown, networkMaxDelayUp} are set if the user is at least ADMIN, otherwise an error is returned.
If the customer has a limited number of gateways, then this limit cannot be exceeded.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	multipart/form-data	?	The Media type of the request body
file	BODY	MultipartFile	?	The CSV file wich contains a list of CsvGatewayDto
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY
202 ACCEPTED	HEADER	Content-Location	/application/gateways/bulk/{id}	Location for retrieving the data
4xx, 5xx	BODY		ErrorDto

Asynchronous response

ProgressMonitorDto

createGatewaysDeletion GATEWAY Since: 2.2.0

POST

/application/gateways/deletions

USER

Description

This web service deletes a list of gateways.
This web service is asynchronous. It sends a 202 Accepted response and the header Location allows to request for the progress monitoring.
The request body contains an array of eui.
If errors occur, the result field of the ProgressMonitorDto contains the set of gateway identifiers which are on error.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json	?	The Media type of the request body
euis	BODY	String[]	?	The list of gateways eui (Example : ["AAAAAAAAAAAAAA16","BBBBBBBBBBBBBB16","CCCCCCCCCCCCCC16"])
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY
202 ACCEPTED	HEADER	Content-Location	/application/gateways/deletions/{id}	Location for retrieving the data
4xx, 5xx	BODY		ErrorDto

createGatewaysExport EXPORTGATEWAY Since: 2.2.0

POST

/application/gateways/exports

USER

Description

This web service allows to export the gateways to a CSV file.
This web service is asynchronous. It sends a 202 Accepted response status.
The response header Content-Location allows to poll the ProgressMonitorDto with the web service getGatewaysExport.
The parameters sort and search refer to a GatewayDto.
The generated CSV file is a list of CsvGatewayDto.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).
If the connected user is SUPER_ADMIN then all gateways are exported, otherwise only the gateways attached to his customer.
If the parameter importable is set to true, then the csv file will contain only the authorized fields of a CsvGatewayDto.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
importable	QUERY	boolean		true means that csv is importable from web service createGateways.
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY
202 ACCEPTED	HEADER	Content-Location	/application/gateways/exports/{id}	Location for retrieving the data
4xx, 5xx	BODY		ErrorDto

createMulticastDataDown DATA_DOWNMULTICAST Since: 3.0.0

POST

/application/multicastDataDown

USER

Description

This web service allows to create a multicast dataDown.
Searchable and sortable fields are : {fPort, fPort, status, timestamp} and mcGroup.id

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
multicastDataDownDto	BODY	MulticastDataDownDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
201 CREATED	BODY
201 CREATED	HEADER	Location	/application/multicastDataDown/{id}	Created resource path
4xx, 5xx	BODY		ErrorDto

createMulticastGroup MULTICAST Since: 3.0.0

POST

/application/multicastGroups

ADMIN

Description

This web service allows to create a new multicastGroup.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
multicastGroupDto	BODY	MulticastGroupDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
201 CREATED	BODY
201 CREATED	HEADER	Location	/application/multicastGroups/{id}	Created resource path
4xx, 5xx	BODY		ErrorDto

createPushConfiguration PUSH_CONFIGURATION Since: 3.1.0

POST

/application/pushConfigurations

ADMIN

Description

This web service allows to create a new PushConfiguration.
Data are sent as multipart/form-data.
Data are a mix of a mandatory PushConfigurationDto and three optional files.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)
The pushConfiguration name is unique for one customer.
The value pairs of fields {mqttClientId, mqttHost} are unique.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	multipart/form-data	?	The Media type of the request body
dto	BODY	PushConfigurationDto	?	The PushConfigurationDto content in JSON format
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
tlsCaFile	BODY	MultipartFile		TLS CA cert file
tlsCertFile	BODY	MultipartFile		TLS Cert file
tlsKeyFile	BODY	MultipartFile		TLS Private Key

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
201 CREATED	BODY
201 CREATED	HEADER	Location	/application/pushConfigurations/{id}	Created resource path
4xx, 5xx	BODY		ErrorDto

createSelection SELECTION Since: 2.1.0

POST

/application/selections

USER

Description

This web service allows to create a new user selection.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
selectionDto	BODY	SelectionDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
201 CREATED	BODY
201 CREATED	HEADER	Location	/application/selections/{id}	Created resource path
4xx, 5xx	BODY		ErrorDto

createUser USER Since: 1.1.12

POST

/application/users

ADMIN

Description

This web service allows to create a new user.
The user will receive an email with a link to validate his account
The links has a TTL of 72h. If the token expires, updating the user (even without any changements) will send a new email.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)
If the customer has a limited number of users, then this limit cannot be exceeded.
The role cannot be greater than the role of the connected user.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
url	QUERY	string	?	Base url called to validate the user account (exemple : https:///#validateUser)
userDto	BODY	UserDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
201 CREATED	BODY
201 CREATED	HEADER	Location	/application/users/{id}	Created resource path
4xx, 5xx	BODY		ErrorDto

createWorkflowTemplate WORKFLOW Since: 3.1.0

POST

/application/workflow/templates

SUPER_ADMIN

Description

This web service allows creating a new workflow template.

A workflow template defines a succession of any WMC eligible web services. These web services are grouped by entity types (workflowGroups):

GATEWAY (web service concerning gateways)
END_DEVICE (web service concerning end-devices)

A workflow template can be executed on many entities and must contain only web services of the same group.

In order to create a worflow template, you must be familiar with the BPMN 2.0 standard and respect the following rules.

Tasks definition

Each web service of a workflow template corresponds to a step and is composed of two tasks chained by a "sequenceFlow":

A "userTask" which calls the web service. This task must set the following assignee attribute:
```
activiti:assignee="workflowStepExecutor"
```
A "userTask" which checks the previous task result. This task must set the following assignee attribute:
```
activiti:assignee="tasksStatusCheck"
```

Any other value will lead to a step failure at execution time!

Tasks content

"userTask" - Web service

This "userTask" must define the following "formProperty" (with "id" and "name" attributes equals to):

"webService", corresponds to the web service path. Example:

"httpMethod", corresponds to the web service method {GET, POST, PUT, PATCH, DELETE}. Example:

<activiti:formProperty id="httpMethod" name="httpMethod" type="string" variable="PATCH" writable="false" required="true"></activiti:formProperty>

"wsType", corresponds to the web service type {synchronous, asynchronous}. Example:

<activiti:formProperty id="wsType" name="wsType" type="string" variable="synchronous" writable="false" required="true"></activiti:formProperty>

"argType", corresponds to the type of the parameters {string, dto}. Example:

<activiti:formProperty id="argType" name="argType" type="string" variable="dto" writable="false" required="true|false"></activiti:formProperty>

A synchronous task can reply with a "link". This link will automatically be called at the end of the step execution to retrieve the result and the associated DTO.
An asynchronous task sends back a TaskDto (WMC way). This so called TaskDto will be reused to determine the task progression as well as the result.

This task must also define the request parameters of the web service as "formProperty" like this:

<activiti:formProperty id="command" name="command" type="String" writable="false" required="true"></activiti:formProperty>

If a web service requires a DTO, each field of the DTO must be defined as "formProperty" like the request parameters. Example:

<activiti:formProperty id="cpuAlarmThreshold" name="cpuAlarmThreshold" type="integer" writable="false"></activiti:formProperty>

If a web service requres a file, the task must define a "formProperty" like this:

<activiti:formProperty id="file" name="file" type="MultipartFile" writable="false" required="true"></activiti:formProperty>

"userTask" - Result check

This "userTask" must stay empty.

Tasks chaining

You can chain steps with "sequenceFlow".
You can also use the response of "userTask" - result check to make conditions. This result is a boolean "result" equals to true if the previous "userTask" web service succeed, false otherwise.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
category	QUERY	string		The category of the workflow
fileAsString	QUERY	string		The file BPMN content as string (this parameter is ignored if the parameter "file" is provided)
processName	QUERY	string		Name of the process (length <= 255)
versionning	QUERY	boolean		If the workfow template already exists (same BPMN id and name), versionning=true will create a new version of the workflow template, versionning=false will return a RESOURCE_ALREADY_EXISTS error
file	BODY	MultipartFile		The file with the BPMN (XML)

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
201 CREATED	BODY
201 CREATED	HEADER	Location	/application/workflow/templates/{id}	Created resource path
4xx, 5xx	BODY		ErrorDto

deleteApplicationSetting APPLICATIONSETTING Since: 1.1.12

DELETE

/application/applicationSettings/{id}

SUPER_ADMIN

Description

This web service allows to delete an application setting.

Rules

If the applicationSetting is private an exception will occur.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Application settings identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

deleteBrand GATEWAYGATEWAY_TYPE Since: 3.2.0

DELETE

/application/brands/{id}

SUPER_ADMIN

Description

This web service allows to delete a Brand.

Rules

The brand must have no linked gateways

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Resource identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

deleteCluster CLUSTER Since: 1.1.12

DELETE

/application/clusters/{id}

ADMIN

Description

This web service allows to delete a cluster.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Cluster identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

deleteCustomer CUSTOMER Since: 1.1.12

DELETE

/application/customers/{id}

SUPER_ADMIN

Description

This web service allows to delete a customer.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Customer identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

deleteCustomerSetting CUSTOMERSETTING Since: 1.1.12

DELETE

/application/customersSettings/{id}

ADMIN

Description

This web service allows to delete one customer setting.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Customer settings identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

deleteEndDevice END_DEVICE Since: 1.1.12

DELETE

/application/endDevices/{devEui}

ADMIN

Description

This web service allows to delete an end-device.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
devEui	PATH	string	?	End-device EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

deleteFleet FLEET Since: 1.1.12

DELETE

/application/fleets/{id}

ADMIN

Description

This web service allows to delete one fleet.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Fleet identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

deleteGateway GATEWAY Since: 1.1.12

DELETE

/application/gateways/{eui}

USER

Description

This web service allows to delete a gateway.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

deleteLnsGatewayAesKey GATEWAY Since: 1.1.12

DELETE

/application/gateways/{eui}/aesKeys/{index}

ADMIN

Description

This web service allows to delete an AES key by index for a gateway.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
index	PATH	integer	?	AES key index
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

deleteMulticastGroup MULTICAST Since: 3.0.0

DELETE

/application/multicastGroups/{id}

ADMIN

Description

This web service allows to delete a multicastGroup.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	MulticastGroup identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

deletePushConfiguration PUSH_CONFIGURATION Since: 3.1.0

DELETE

/application/pushConfigurations/{id}

ADMIN

Description

This web service allows to delete a pushConfiguration.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	PushConfiguration identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

deleteSelection SELECTION Since: 2.1.0

DELETE

/application/selections/{id}

USER

Description

This web service allows to delete a selection.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Selection identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

deleteSpectrum SPECTRUM Since: 2.3.0

DELETE

/application/spectrums/{id}

USER

Description

Deletes a specific spectrum.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Spectrum identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

deleteUser USER Since: 1.1.12

DELETE

/application/users/{id}

ADMIN

Description

This web service allows to delete a user.

Rules

authenticated user is SUPER_ADMIN or he is ADMIN and belongs to the same customer
authenticatedUser is not the user AND (authenticatedUser is SUPER_ADMIN OR (authenticatedUser is ADMIN and authenticatedUser role ? user role))

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	User identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

deleteWorkflowTemplate WORKFLOW Since: 3.1.0

DELETE

/application/workflow/templates/{id}

SUPER_ADMIN

Description

This web service allows deleting a specific workflow template. In reality, the workflow template get only suspended.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	string	?	Resource identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
allVersions	QUERY	boolean		If true, suspends all the versions of the workflow template

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

getActions ACTION Since: 1.1.12

GET

/application/actions

SUPER_ADMIN

Description

This web service allows to get the list of actions.
The following actions are not stored : {getActions, ping}

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<ActionDto>
4xx, 5xx	BODY		ErrorDto

getAlgorithms WG Since: 3.1.0

GET

/application/algorithms

READER

Description

This web service allows to retrieve the list of WG solver algorithms.
Although it returns a paginatedDto, this web service is not paginated. All the results are returned within the same page.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<AlgorithmDto>
4xx, 5xx	BODY		ErrorDto

getApplication APPLICATION Since: 1.1.12

GET

/application

Description

This web service allows to get the application data like the version, the build date.
It is the entry point of the web services map

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		ApplicationDto
4xx, 5xx	BODY		ErrorDto

getApplicationSetting APPLICATIONSETTING Since: 1.1.12

GET

/application/applicationSettings/{id}

READER

Description

This web service allows to get an application setting.

Rules

If the applicationSetting is private an exception will occur

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Application settings identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		ApplicationSettingDto
4xx, 5xx	BODY		ErrorDto

getApplicationSettings APPLICATIONSETTING Since: 1.1.12

GET

/application/applicationSettings

READER

Description

This web service allows to get the settings of the application.

Rules

Only the public settings will be returned

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<ApplicationSettingDto>
4xx, 5xx	BODY		ErrorDto

getAuthenticatedUser USER Since: 1.1.12

GET

/application/authenticatedUser

READER

Description

This web service allows to get the authenticated user.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		UserDto
4xx, 5xx	BODY		ErrorDto

getBrands GATEWAYGATEWAY_TYPE Since: 3.0.0

GET

/application/brands

READER

Description

This web service allows to get the list of Brands.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		BrandDto[]
4xx, 5xx	BODY		ErrorDto

getCapabilities CAPABILITY Since: 1.1.12

GET

/application/capabilities

READER

Description

This web service allows to get the capabilities of the application.
It defines the list of the features managed or not by each Base Station Controller (BSC)

Rules

If at least one BSC failed to provide its capabilities an error is thrown

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		BscDto[]
4xx, 5xx	BODY		ErrorDto

getChangelog CHANGELOGDOC Since: 3.0.0

GET

/application/doc/changelog

Description

This web service allows to get the change logs of the API.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		string
4xx, 5xx	BODY		ErrorDto

getCluster CLUSTER Since: 1.1.12

GET

/application/clusters/{id}

READER

Description

This web service allows to retrieve a cluster.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Cluster identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		ClusterDto
4xx, 5xx	BODY		ErrorDto

getClusterLastEvents CLUSTERLAST_EVENTLNS Since: 1.1.12

GET

/application/clusters/{id}/events/last

READER

Description

This web service allows to retrieve the LNS last events of one cluster.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Cluster identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<LnsEventDto>
4xx, 5xx	BODY		ErrorDto

getClusters CLUSTER Since: 1.1.12

GET

/application/clusters

READER

Description

This web service allows to retrieve the list of clusters.
Searchable and sortable fields are : {geolocEnabled, name, pushEnabled} and pushConfiguration.id

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<ClusterDto>
4xx, 5xx	BODY		ErrorDto

getCreateEndDevicesStatus END_DEVICE Since: 2.1.0

GET

/application/endDevices/bulk/{id}

USER

Description

This web service allows to retrieve the status of a createEndDevices web service execution.
If errors occur, the progressMonitor field result contains the lines in error.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	string	?	Bulk identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		ProgressMonitorDto
4xx, 5xx	BODY		ErrorDto

getCreateGatewaysStatus GATEWAY Since: 2.1.0

GET

/application/gateways/bulk/{id}

USER

Description

This web service allows to retrieve the progress monitor of the createGateways web service.
The ProgressMonitor will be OK if all the unexisted gateways are created correctly. It will be KO if at least one error occurs.
If errors occur, the server builds a CSV file wich contains all the lines in error. This file can be retrieved by following the link named csvErrors in the progressMonitorDto.

Purge : the monitor is purged 2 days after the last access. If the monitor is never accessed, it will be purged after 2 days.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	string	?	Bulk identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		ProgressMonitorDto
4xx, 5xx	BODY		ErrorDto

getCustomer CUSTOMER Since: 1.1.12

GET

/application/customers/{id}

READER

Description

This web service allows to get a customer.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Customer identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		CustomerDto
4xx, 5xx	BODY		ErrorDto

getCustomerMdr CUSTOMERMDR Since: 2.3.0

GET

/application/customers/{id}/mdr

ADMIN

Description

This web service allows to retrieve the MDR (Message Detail Recording) of one customer.

Example of exchange :

Request :
curl -v --header "Accept: application/vnd.kerlink.iot-v1+json,text/csv" --header "Authorization: Bearer
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxIiwiaXNzIjoib3NzQ2xpZW50IiwiZ3Jv
dXBJZCI6MSwicm9sZSI6IlNVUEVSX0FETUlOIiwiZXhwIjoxNTIyNTMzNjAwfQ.u_sln5nI-
wN6enzN_9Xi6IMK65ofLvBsWjyoJyHldLA" "http://localhost:80/gms/application/customers/1/mdr?day=20180211" | gunzip > MDR_120180211.csv

Response (CSV) :
Timestamp,DevEUI,Direction,DataRate,FramePayloadSize,PhysicalPayloadSize,ClusterId,CustomerId
1536451302143,1337133713371337,UPLINK,SF7BW125,16,29,207,1
1536451602142,1337133713371337,UPLINK,SF7BW125,16,29,207,1
1536451902142,1337133713371337,UPLINK,SF7BW125,16,29,207,1
1536452202142,1337133713371337,UPLINK,SF7BW125,16,29,207,1

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Customer identifier
day	QUERY	string	?	The day for which you want the data. Format : YYYYMMDD
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json,text/csv		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		ErrorDto
4xx, 5xx	BODY		ErrorDto

getCustomerSetting CUSTOMERSETTING Since: 1.1.12

GET

/application/customersSettings/{id}

READER

Description

This web service allows to get one customer setting.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Customer settings identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		CustomerSettingDto
4xx, 5xx	BODY		ErrorDto

getCustomers CUSTOMER Since: 1.1.12

GET

/application/customers

SUPER_ADMIN

Description

This web service allows to get the list of customers.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<CustomerDto>
4xx, 5xx	BODY		ErrorDto

getCustomersLastEventsCounters COUNTERCUSTOMERLAST_EVENT Since: 2.2.0

GET

/application/customers/events/last/counters

READER

Description

This web service allows to retrieve all the unread last events counters attached to all the customers.
The result contains the main alarm and notification counters. It is also aggregated by customer and fleet.
All the fleets are retrieved for each customer.
The customers without any counters (or counters equal 0) are not retrieved.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		CustomersLastEventsCountersDto
4xx, 5xx	BODY		ErrorDto

getCustomersSettings CUSTOMERSETTING Since: 1.1.12

GET

/application/customersSettings

READER

Description

This web service allows to get the settings of customers.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<CustomerSettingDto>
4xx, 5xx	BODY		ErrorDto

getDataDown DATA_DOWN Since: 1.1.12

GET

/application/dataDown

READER

Description

This web service allows to retrieve the data down

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<DataDownDto>
4xx, 5xx	BODY		ErrorDto

getDataUp DATA_UP Since: 1.1.12

GET

/application/dataUp

READER

Description

This web service allows to retrieve the data up.
The unsent dataUp messages can be retrieved using a search query param like :
{"operand":"pushed","operation":"eq","values":["false"]}

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<DataUpDto>
4xx, 5xx	BODY		ErrorDto

getDoc DOC Since: 3.0.0

GET

/application/doc

Description

This web service allows to get API documentation of the web services.

Request

NAME	LOCATION	TYPE	DESCRIPTION
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json	Media type(s) that is(are) acceptable for the response
search	QUERY	Condition	Search condition
sort	QUERY	string	Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		string
4xx, 5xx	BODY		ErrorDto

getDto DTO Since: 2.0.2

GET

/application/dtos/{name}

READER

Description

This web service allows to get a DTO. A DTO contains metadata that describe its structure.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
name	PATH	string	?	Identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
role	QUERY	string		The user role applied to the dto

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		MetaDto
4xx, 5xx	BODY		ErrorDto

getDtos DTO Since: 2.0.2

GET

/application/dtos

READER

Description

This web service allows to get the list of DTO. Each DTO contains metadata that describe its structure.
Although it returns a paginatedDto, this web service is not paginated. All the results are returned within the same page.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
names	QUERY	string		List of DTO names to filter (comma separated list)
role	QUERY	string		The user role applied to the dtos

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<MetaDto>
4xx, 5xx	BODY		ErrorDto

getEndDevice END_DEVICE Since: 1.1.12

GET

/application/endDevices/{devEui}

READER

Description

This web service allows to retrieve an end-device.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
devEui	PATH	string	?	End-device EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		EndDeviceDto
4xx, 5xx	BODY		ErrorDto

getEndDeviceChannels END_DEVICE Since: 3.2.0

GET

/application/endDevices/{devEui}/channels

READER

Description

This web service allows to get the channel plan of one end-device.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
devEui	PATH	string	?	End-device EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		ChannelDto[]
4xx, 5xx	BODY		ErrorDto

getEndDeviceEvents END_DEVICEEVENTLNS Since: 1.1.12

GET

/application/endDevices/{devEui}/events

READER

Description

This web service allows to retrieve the LNS events of one end-device.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
devEui	PATH	string	?	End-device EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<LnsEventDto>
4xx, 5xx	BODY		ErrorDto

getEndDeviceGatewaysPositions WG Since: 3.1.0

GET

/application/endDevices/{devEui}/positions/gateways

READER

Description

This web service allows to retrieve the list of positions of the gateways which have routed an endDevice.
Although it returns a paginatedDto, this web service is not paginated. All the results are returned within the same page.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
devEui	PATH	string	?	Identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
maxTimestamp	QUERY	integer		Maximum timestamp. Default value is 2147483646
minTimestamp	QUERY	integer		Minimum timestamp. Default value is 0
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
processingId	QUERY	integer		Processing identifier

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<GatewayPositionDto>
4xx, 5xx	BODY		ErrorDto

getEndDeviceLastEvents END_DEVICELAST_EVENTLNS Since: 1.1.12

GET

/application/endDevices/{devEui}/events/last

READER

Description

This web service allows to retrieve the LNS last events of one end-device.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
devEui	PATH	string	?	End-device EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<LnsEventDto>
4xx, 5xx	BODY		ErrorDto

getEndDeviceLastGateways END_DEVICEGATEWAYLNS Since: 1.1.12

GET

/application/endDevices/{devEui}/gateways/last

READER

Description

This web service allows to get the gateways which have seen the end-device.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
devEui	PATH	string	?	End-device EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<EndDeviceLastGatewayDto>
4xx, 5xx	BODY		ErrorDto

getEndDeviceMessages END_DEVICE Since: 2.2.0

GET

/application/endDevices/{devEui}/messages

READER

Description

This web service allows to retrieve the messages of one end-device.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
devEui	PATH	string	?	End-device EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<EndDeviceMessageDto>
4xx, 5xx	BODY		ErrorDto

getEndDevicePositions END_DEVICEWG Since: 1.1.12

GET

/application/endDevices/{devEui}/positions

READER

Description

This web service allows to get the positions of an end-device.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
devEui	PATH	string	?	End-device EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
algorithm	QUERY	string		The algorithm
fields	QUERY	string		List of fields to display
gpsDist	QUERY	boolean		GPS dist. Default value is false
maxTimestamp	QUERY	integer		Maximum timestamp. Default value is 2147483646
method	QUERY	string		Method
minTimestamp	QUERY	integer		Minimum timestamp. Default value is 0
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<EndDevicePositionDto>
4xx, 5xx	BODY		ErrorDto

getEndDevices END_DEVICE Since: 1.1.12

GET

/application/endDevices

READER

Description

This web service allows to retrieve the list of end-devices.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<EndDeviceDto>
4xx, 5xx	BODY		ErrorDto

getEndDevicesDeletion END_DEVICE Since: 2.2.0

GET

/application/endDevices/deletions/{id}

ADMIN

Description

This web service allows to retrieve the progress monitor of the createEndDevicesDeletion web service.
Purge: The monitor is purged 2 days after the last access. If the monitor is never accessed, it will be purged after 2 days.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	string	?	Deletion identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
	BODY		ProgressMonitorDto
4xx, 5xx	BODY		ErrorDto

getEndDevicesExport END_DEVICEEXPORT Since: 2.2.0

GET

/application/endDevices/exports/{id}

READER

Description

This web service allows to get the progress monitor of the end-devices export web service (createEndDevicesExport).
When the progress monitor is terminated, one or two links are created depending on the status:
- Link with a rel field called success for the successfuly exported end-devices
- Link with a rel field called failed for the exported end-devices with errors
Purge: The monitor is purged 2 days after the last access. If the monitor is never accessed, it will be purged after 2 days.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	string	?	Export identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
	BODY		ProgressMonitorDto
4xx, 5xx	BODY		ErrorDto

getFleet FLEET Since: 1.1.12

GET

/application/fleets/{id}

READER

Description

This web service allows to retrieve one fleet.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Fleet identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		FleetDto
4xx, 5xx	BODY		ErrorDto

getFleetEvents EVENTFLEET Since: 1.1.12

GET

/application/fleets/{id}/events

READER

Description

This web service allows to retrieve the list of the events of one fleet.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Fleet identifier
endDate	QUERY	string	?	The end date of the period
startDate	QUERY	string	?	The start date of the period
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
type	QUERY	string		Event type : {CPU_ON, CPU_OFF, DISK_SYSTEM_ON, DISK_SYSTEM_OFF, DISK_USER_ON, DISK_USER_OFF, DOOR_OPEN, DOOR_CLOSED, DOOR_NOT_APPLICABLE, GPS_UNLOCKED, GPS_LOCKED, GPS_NOT_APPLICABLE, RAM_ON, RAM_OFF, RSSI_ON, RSSI_OFF, TEMPERATURE_ON, TEMPERATURE_OFF, START, SHUTDOWN, RESTART, POWER_LOST, AUTOMATIC_SYSTEM_RESTORATION, AUTOMATIC_SYSTEM_RESTORATION_FACTORY, PREVIOUS_CONFIG_RESTORATION, HELLO, SNMP_AUTHENTICATION_FAILURE, CONNECTED, DISCONNECTED}

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<GatewayEventDto>
4xx, 5xx	BODY		ErrorDto

getFleetLastEvents FLEETLAST_EVENT Since: 1.1.12

GET

/application/fleets/{id}/events/last

READER

Description

This web service allows to retrieve the last events attached to all the gateways belonging to a fleet.
An event can be an alarm or a notification or both, depends on its value.
For example, a disconnection will produce an alarm but a reconnection will produce a notification.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Fleet identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<LastEventDto>
4xx, 5xx	BODY		ErrorDto

getFleetLastEventsCounters COUNTERFLEETLAST_EVENT Since: 1.1.12

GET

/application/fleets/{id}/events/last/counters

READER

Description

This web service allows to retrieve all the unread last events counters attached to a fleet.
The result is composed of the fleet and the list of its last events counters.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Fleet identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
search	QUERY	Condition		Search condition

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		FleetLastEventCounterDto
4xx, 5xx	BODY		ErrorDto

getFleetLastOperations FLEETLAST_OPERATION Since: 1.1.12

GET

/application/fleets/{id}/lastOperations

READER

Description

This web service allows to retrieve the last operations attached to one fleet.
An operation is an action done on a gateway (example : command line, get configuration, set control, ....

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Fleet identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<LastOperationDto>
4xx, 5xx	BODY		ErrorDto

getFleetLastStatistics FLEETLAST_STATISTIC Since: 1.1.12

GET

/application/fleets/{id}/lastStatistics

READER

Description

This web service allows to retrieve the last statistics of one fleet.
The statisitics consists of counting the number of gateways for which a numeric metric belongs to a range.
The statistic of each metric concerns the average value.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Fleet identifier
metricNames	QUERY	string	?	A comma separated list of metric names. {ALTITUDE, CPU, EXTRA_DISK, GPS_LOCK_RATIO, GPS_SATELLITES_NUMBER, LATITUDE, LONGITUDE, RAM, RSSI, SUPPLY_POWER_MILLI_VOLT, SYSTEM_DISK, TEMPERATURE, USER_DISK}
ranges	QUERY	string	?	Ranges values ranges: min,max; ? min,max Example: 10,20 means 10 ? value ? 20 min: integer or null max: integer or null null means no limit. For example null,10 means value ? 10 35,null means value >= 35
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
search	QUERY	Condition		Search condition

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<GatewaysStatisticDto>
4xx, 5xx	BODY		ErrorDto

getFleets FLEET Since: 1.1.12

GET

/application/fleets

READER

Description

This web service allows to get the list of the fleets.
If the connected user is not SUPER_ADMIN, only the fleets belonging to his customer are returned.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<FleetDto>
4xx, 5xx	BODY		ErrorDto

getGateway GATEWAY Since: 2.1.0

GET

/application/gateways/{eui}

READER

Description

This web service allows to retrieve a gateway.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Resource extended unique identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		GatewayDto
4xx, 5xx	BODY		ErrorDto

getGatewayConfigurations CONFIGURATIONGATEWAY Since: 1.1.12

GET

/application/gateways/{eui}/configurations

READER

Description

Retrieves the configurations historic of the gateway.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<GatewayConfigurationDto>
200 OK	HEADER	Content-Location	/application/tasks/{id}	Location for retrieving the data
4xx, 5xx	BODY		ErrorDto

getGatewayConnections CONNECTIONGATEWAY Since: 1.1.12

GET

/application/gateways/{eui}/connections

READER

Description

This web service allows to retrieve the connections of one gateway.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
untilDate	QUERY	string		Until the date of (EPOCH date in ms), default is current time

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<GatewayConnectionDto>
4xx, 5xx	BODY		ErrorDto

getGatewayControl CONTROLGATEWAY Since: 1.1.12

GET

/application/gateways/{eui}/control

READER

Asynchronous

Eligible for workflow: GATEWAY

Description

This web service allows to retrieve the control data of a gateway.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
criteria	QUERY	String[]		Task criteria. Pre-registered are : {customerId, userId, fleetId, gatewayEui}
fields	QUERY	string		List of fields to display for GatewayControlDto
groups	QUERY	string		A comma separated list of GatewayControl groups from predefined set {door, rssi, diskUser, temperature, diskSystem, cpu, gps, ram}

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY		TaskDto
4xx, 5xx	BODY		ErrorDto

Asynchronous response

GatewayControlDto

getGatewayCurrentConfiguration CONFIGURATIONGATEWAY Since: 1.1.12

GET

/application/gateways/{eui}/configurations/current

READER

Asynchronous

Eligible for workflow: GATEWAY

Description

This web service allows to retrieve the current configuration of one gateway.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
criteria	QUERY	String[]		Task criteria. Pre-registered are : {customerId, userId, fleetId, gatewayEui}
fields	QUERY	string		List of fields to display for GatewayConfigurationDto
groups	QUERY	string		A comma separated list of GatewayConfigurationDto groups : {deviceManagement, wan, vpn, lan, time}

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY		TaskDto
4xx, 5xx	BODY		ErrorDto

Asynchronous response

GatewayConfigurationDto

getGatewayCurrentVersion GATEWAYVERSION Since: 1.1.12

GET

/application/gateways/{eui}/versions/current

READER

Asynchronous

Eligible for workflow: GATEWAY

Description

This web service allows to retrieve the current version of one gateway.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
criteria	QUERY	String[]		Task criteria. Pre-registered are : {customerId, userId, fleetId, gatewayEui}
fields	QUERY	string		List of fields to display for GatewayVersionDto

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY		TaskDto
4xx, 5xx	BODY		ErrorDto

Asynchronous response

GatewayVersionDto

getGatewayEvents EVENTGATEWAY Since: 1.1.12

GET

/application/gateways/{eui}/events

READER

Description

This web service allows to retrieve the events attached to one gateway.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
endDate	QUERY	string		The end date of the period
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
startDate	QUERY	string		The start date of the period
type	QUERY	string		Event type from predefined set {AUTOMATIC_SYSTEM_RESTORATION, AUTOMATIC_SYSTEM_RESTORATION_FACTORY, CONNECTED, CPU_OFF, CPU_ON, DISCONNECTED, DISK_SYSTEM_OFF, DISK_SYSTEM_ON, DISK_USER_OFF, DISK_USER_ON, DOOR_CLOSED, DOOR_NOT_APPLICABLE, DOOR_OPEN, GPS_LOCKED, GPS_NOT_APPLICABLE, GPS_UNLOCKED, HELLO, POWER_LOST, PREVIOUS_CONFIG_RESTORATION, RAM_OFF, RAM_ON, RESTART, RSSI_OFF, RSSI_ON, SHUTDOWN, SNMP_AUTHENTICATION_FAILURE, START, TEMPERATURE_OFF, TEMPERATURE_ON}

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<GatewayEventDto>
4xx, 5xx	BODY		ErrorDto

getGatewayLastConfiguration CONFIGURATIONGATEWAY Since: 1.1.12

GET

/application/gateways/{eui}/configurations/last

READER

Description

This web service allows to retrieve the last configuration of one gateway.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		GatewayConfigurationDto
4xx, 5xx	BODY		ErrorDto

getGatewayLastConnection CONNECTIONGATEWAY Since: 1.1.12

GET

/application/gateways/{eui}/connections/last

READER

Description

This web service allows to retrieve the last connection of one gateway.
For the gateways which have never been connected, the response body will be empty.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		GatewayConnectionDto
4xx, 5xx	BODY		ErrorDto

getGatewayLastEvents GATEWAYLAST_EVENT Since: 1.1.12

GET

/application/gateways/{eui}/events/last

READER

Description

This web service allows to retrieve the last events attached to a gateway.
An event can be an alarm or a notification or both, depends on its value.
For example, a disconnection will produce an alarm but a reconnection will produce a notification.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<LastEventDto>
4xx, 5xx	BODY		ErrorDto

getGatewayLastOperations GATEWAYLAST_OPERATION Since: 1.1.12

GET

/application/gateways/{eui}/lastOperations

READER

Description

This web service allows to retrieve the last operations attached to one gateway.
An operation is an action done on a gateway (example : command line, get configuration, set control, ....

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<LastOperationDto>
4xx, 5xx	BODY		ErrorDto

getGatewayLastStatistics GATEWAYLAST_STATISTIC Since: 1.1.12

GET

/application/gateways/{eui}/lastStatistics

READER

Description

This web service allows to retrieve the last statistics attached to one gateway.
The statisitics consists of counting the number of gateways for which a numeric metric belongs to a range.
The statistic of each metric concerns the average value.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<LastStatisticDto>
4xx, 5xx	BODY		ErrorDto

getGatewayLastVersion GATEWAYVERSION Since: 1.1.12

GET

/application/gateways/{eui}/versions/last

READER

Description

This web service allows to retrieve the last version of one gateway.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		GatewayVersionDto
4xx, 5xx	BODY		ErrorDto

getGatewayManagement GATEWAYMANAGEMENT Since: 1.1.12

GET

/application/gateways/{eui}/management

ADMIN

Asynchronous

Eligible for workflow: GATEWAY

Description

This web service allows to retrieve the management fields of a gateway.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
criteria	QUERY	String[]		Task criteria. Pre-registered are : {customerId, userId, fleetId, gatewayEui}
fields	QUERY	string		List of fields to display for GatewayManagementDto

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY		TaskDto
4xx, 5xx	BODY		ErrorDto

Asynchronous response

GatewayManagementDto

getGatewayModems GATEWAYMODEMSPECTRUM Since: 1.1.12

GET

/application/gateways/{eui}/modems

READER

Asynchronous

Description

This web service allows to retrieve the modems of one gateway.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
criteria	QUERY	String[]		Task criteria. Pre-registered are : {customerId, userId, fleetId, gatewayEui}
fields	QUERY	string		List of fields to display for GatewayModemDto

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY		TaskDto
4xx, 5xx	BODY		ErrorDto

Asynchronous response

PaginatedDto<GatewayModemDto>

getGatewayNumericStatistics GATEWAYSTATISTIC Since: 1.1.12

GET

/application/gateways/{eui}/statistics/numeric

READER

Description

This web service retrieves the numeric statistics of one gateway.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
endDate	QUERY	string	?	The end date of the period (EPOCH ms). The value must between -9223372036854 and 9223372036854.
startDate	QUERY	string	?	The start date of the period (EPOCH ms). The value must between -9223372036854 and 9223372036854.
temporalUnit	QUERY	string	?	The temporal unit {DAY, HOUR, MONTH, YEAR}
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
metricNames	QUERY	string		A comma separated list of metric names. Metric names : {abortReboot, userDiskUsed, startNumber, gsmMinRssi, ramAvg, gsmAvgRssi, ramMin, cpuThreshold, temperatureMax, sizeDownlinkSum, systemDiskHysteresis, sizeUplinkSum, cpuMax, cpuHysteresis, restartSum, ackrAvg, userDiskHysteresis, systemDiskThreshold, abortCrash, nbDownlinkMessageSum, gpsSatellitesNumber, gsmRssiHysteresis, cpuMin, cpuAvg, gpsLockRatio, nbUplinkMessageSum, extraDiskHysteresis, supplyPowerMilliVolts, ramHysteresis, extraDiskUsed, gsmMaxRssi, temperatureAvg, userDiskThreshold, temperatureMin, systemDiskUsed, temperatureThreshold, extraDiskThreshold, temperatureHysteresis, rxperAvg, ramThreshold, uptimeAvg, ramMax, gsmRssiThreshold, maliciousSshLoginSum}
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<GatewayNumericStatisticsDto>
4xx, 5xx	BODY		ErrorDto

getGatewaySnmpLogs GATEWAYSNMP Since: 1.1.12

GET

/application/gateways/{eui}/snmpLogs

READER

Description

This web service retrieves the SNMP logs of a gateway.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
endDate	QUERY	integer	?	The end date of the period (EPOCH ms)
startDate	QUERY	integer	?	The start date of the period (EPOCH ms)
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
action	QUERY	string		Action from predefined set {ALARM_CPU, ALARM_DISK_SYSTEM, ALARM_DISK_USER, ALARM_DOOR_EVENT, ALARM_GPS, ALARM_RAM, ALARM_RSSI, ALARM_TEMPERATURE, CONNEXION_CHANGE, FILE_EXCHANGE_ABORT, FILE_EXCHANGE_EXECUTE, FILE_EXCHANGE_STATUS, GATEWAY_DESCRIPTION_CHANGE, GATEWAY_IP_PORT_CHANGE, GET_CONFIGURATION, GET_CONFIGURATIONS, GET_CONTROLS, GET_GATEWAY_DESCRIPTION, GET_HASH_CONFIGURATIONS, GET_HASH_VERSIONS, GET_LAN_MODULES, GET_STATISTIC, GET_STATISTIC_INDEX, GET_VALUES, GET_VERSION, GET_VERSIONS, HELLO, MANAGEMENT_EXECUTE, MANAGEMENT_GET_VALUES, NETWORK_EVENT, NOTIFICATION_AUTHENTICATION_FAILURE, NOTIFICATION_AUTOMATIC_SYSTEM_RESTORATION, NOTIFICATION_AUTOMATIC_SYSTEM_RESTORATION_FACTORY, NOTIFICATION_COLD_START, NOTIFICATION_FILE_EXCHANGE_ABORT, NOTIFICATION_FILE_EXCHANGE_EXECUTE, NOTIFICATION_IP_CHANGE, NOTIFICATION_POWER_LOST, NOTIFICATION_PREVIOUS_CONFIG_RESTORATION, NOTIFICATION_RESTART, NOTIFICATION_SHUTDOWN, NOTIFICATION_SPECIFIC_COMMAND_ABORT, NOTIFICATION_SPECIFIC_COMMAND_EXECUTE, NOTIFICATION_SPECTRUM_ANALYSIS_ABORT, NOTIFICATION_SPECTRUM_ANALYSIS_EXECUTE, NOTIFICATION_START, NOTIFICATION_UPDATE_ABORT, NOTIFICATION_UPDATE_EXECUTE, PING, PING_EVENT, RETURN_KO_STATUS, RETURN_SENDING_STATUS, RETURN_TIMEOUT_STATUS, SET_CONFIGURATION, SET_CONTROLS, SET_VALUES, SIMULATE_ALARM_DOOR_EVENT, SIMULATE_ALARM_GPS_EVENT, SPECIFIC_COMMAND_ABORT, SPECIFIC_COMMAND_EXECUTE, SPECIFIC_COMMAND_STATUS, SPECTRUM_ANALYSIS_ABORT, SPECTRUM_ANALYSIS_EXECUTE, SPECTRUM_ANALYSIS_STATUS, STATISTIC, UPDATE_ABORT, UPDATE_EXECUTE, UPDATE_STATUS}
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
requestId	QUERY	string		SNMP request identifier

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<GatewaySnmpLogDto>
4xx, 5xx	BODY		ErrorDto

getGatewayTermStatistics GATEWAYSTATISTIC Since: 1.1.12

GET

/application/gateways/{eui}/statistics/term

READER

Description

This web service retrieves the term statistics of one gateway.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
endDate	QUERY	string	?	The end date of the period (EPOCH ms). The value must between -9223372036854 and 9223372036854.
metricName	QUERY	string	?	The metric name {doorState, gpsStatus, supplyPowerSource, bootCause}
startDate	QUERY	string	?	The start date of the period (EPOCH ms). The value must between -9223372036854 and 9223372036854.
temporalUnit	QUERY	string	?	The temporal unit {DAY, HOUR, MONTH, YEAR}
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<GatewayTermStatisticsDto>
4xx, 5xx	BODY		ErrorDto

getGatewayVersions GATEWAYVERSION Since: 1.1.12

GET

/application/gateways/{eui}/versions

READER

Description

This web service allows to retrieve the versions of one gateway.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<GatewayVersionDto>
4xx, 5xx	BODY		ErrorDto

getGateways GATEWAY Since: 1.1.12

GET

/application/gateways

READER

Description

This web service allows to get the list of gateways.If the authenticated user is SUPER_ADMIN all the gateways are returned, otherwise only the gateways attached to the customer of the authenticated user are returned.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<GatewayDto>
4xx, 5xx	BODY		ErrorDto

getGatewaysDeletion GATEWAY Since: 2.2.0

GET

/application/gateways/deletions/{id}

USER

Description

This web service allows to retrieve the progress monitor of a gateways deletion.

Purge : the monitor is purged 2 days after the last access. If the monitor is never accessed, it will be purged after 2 days.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	string	?	Deletion identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		ProgressMonitorDto
4xx, 5xx	BODY		ErrorDto

getGatewaysExport EXPORTGATEWAY Since: 2.2.0

GET

/application/gateways/exports/{id}

USER

Description

This web service allows to get the progress monitor of the gateways export web service (createGatewaysExport).
When the progress monitor is terminated, one or two links are created depending on the status:
- Link with a rel field called success for the successfuly exported gatways
- Link with a rel field called failed for the exported gateways with errors
Purge: The monitor is purged 2 days after the last access. If the monitor is never accessed, it will be purged after 2 days.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	string	?	Resource identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		ProgressMonitorDto
4xx, 5xx	BODY		ErrorDto

getLastGatewayStatistics BSCGATEWAYLAST_STATISTIC Since: 1.1.12

GET

/application/gateways/{eui}/statistics/last

READER

Description

This web service retrieves the last statistics of one gateway.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		GatewayStatisticsDto
4xx, 5xx	BODY		ErrorDto

getLnsCustomersLastEventsCounters COUNTERCUSTOMERLNS Since: 1.1.12

GET

/application/customers/lnsEvents/last/counters

READER

Description

This web service allows to retrieve all the LNS last events counters.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).
If the connected user has the role SUPER_ADMIN, all the counters are returned otherwise only the counters attached to his customer.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		LnsCustomersLastEventsCountersDto
4xx, 5xx	BODY		ErrorDto

getModemStatistics MODEMSTATISTIC Since: 1.1.12

GET

/application/gateways/{eui}/modems/{serialNumber}/statistics

READER

Description

This web service retrieves the statistics of one modem.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
serialNumber	PATH	string	?	Modem serial number
endDate	QUERY	string	?	The end date of the period (EPOCH ms)
startDate	QUERY	string	?	The start date of the period (EPOCH ms)
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<GatewayModemStatisticDto>
4xx, 5xx	BODY		ErrorDto

getMulticastDataDown DATA_DOWNMULTICAST Since: 3.0.0

GET

/application/multicastDataDown

READER

Description

This web service allows to retrieve the multicast dataDown.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<MulticastDataDownDto>
4xx, 5xx	BODY		ErrorDto

getMulticastGroup MULTICAST Since: 3.0.0

GET

/application/multicastGroups/{id}

READER

Description

This web service allows to get a multicastGroup.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	MulticastGroup identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		MulticastGroupDto
4xx, 5xx	BODY		ErrorDto

getMulticastGroups MULTICAST Since: 3.0.0

GET

/application/multicastGroups

READER

Description

This web service allows to retrieve the list of multicastGroups.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<MulticastGroupDto>
4xx, 5xx	BODY		ErrorDto

getOneMulticastDataDown MULTICAST Since: 3.0.0

GET

/application/multicastDataDown/{id}

READER

Description

This web service allows to get a multicast DataDown.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	string	?	MulticastDataDown identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		MulticastDataDownDto
4xx, 5xx	BODY		ErrorDto

getOpenApi DOC Since: 3.0.0

GET

/application/openapi

Description

This web service allows to get the Open API description of the web services, formatted as JSON.
Feel free to visit the Swagger website to learn how you can take advantage of this content.
For example, you can use the Swagger Codegen tool to generate API clients or server stubs.

Request

NAME	LOCATION	TYPE	DESCRIPTION
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json,application/octet-stream	Media type(s) that is(are) acceptable for the response
download	QUERY	boolean	true to download the content, false to display it. Default is false.
search	QUERY	Condition	Search condition
sort	QUERY	string	Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		string
4xx, 5xx	BODY		ErrorDto

getPasswordStrength LOGINUSER Since: 1.1.12

GET

/application/password/strength

Description

This web service allows to get the strengh of a password.

0: risky password: "too guessable"
1: modest protection from throttled online attacks: "very guessable"
2: modest protection from unthrottled online attacks: "somewhat guessable"
3: modest protection from offline attacks: "safely unguessable" (assuming a salted, slow hash function)
4: strong protection from offline attacks: "very unguessable" (assuming a salted, slow hash function)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
password	QUERY	string	?	The password to get strength
Accept	HEADER	text/plain		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		string
4xx, 5xx	BODY		ErrorDto

getPushConfiguration PUSH_CONFIGURATION Since: 3.1.0

GET

/application/pushConfigurations/{id}

READER

Description

This web service allows to retrieve a PushConfiguration.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	PushConfiguration identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PushConfigurationDto
4xx, 5xx	BODY		ErrorDto

getPushConfigurationHealth PUSH_CONFIGURATION Since: 3.1.0

GET

/application/pushConfigurations/{id}/health

ADMIN

Description

This web service allows to retrieve the pushConfiguration health.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Resource identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PushConfigurationHealthDto
4xx, 5xx	BODY		ErrorDto

getPushConfigurations PUSH_CONFIGURATION Since: 3.1.0

GET

/application/pushConfigurations

READER

Description

This web service allows to retrieve the list of PushConfigurations.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<PushConfigurationDto>
4xx, 5xx	BODY		ErrorDto

getRncCustomerEndDeviceKpi CUSTOMEREND_DEVICEKPIRNC Since: 3.0.0

GET

/application/endDevices/{devEui}/kpis/{kpi}

READER

Description

This web service returns a KPI by customer and end-device for one end-device.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
devEui	PATH	string	?	End-device EUI
kpi	PATH	string	?	Kpi identifier from predefined set {DOWNLINK_BYTES, NB_DOWNLINK, NB_END_DEVICE, NB_UPLINK, PING, RSSI_UPLINK_MESSAGE, SNR_UPLINK_MESSAGE, TOA_DOWNLINK_MESSAGE, TOA_UPLINK_MESSAGE, UPLINK_BYTES}
period	QUERY	string	?	Aggregation period from predefined set {DAY, HOUR, MINUTE, MONTH, WEEK, YEAR}
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
activationType	QUERY	string		For kpi=NB_END_DEVICE only Predefined set {ABP, OTAA}
frq	QUERY	string		For kpi=TOA_UPLINK_MESSAGE only
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
sf	QUERY	string		For kpi=TOA_UPLINK_MESSAGE only

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<KpiDto>
4xx, 5xx	BODY		ErrorDto

getRncCustomerGatewayKpi CUSTOMERGATEWAYKPIRNC Since: 3.0.0

GET

/application/gateways/{eui}/kpis/{kpi}

READER

Description

This web service returns a KPI by customer and gateway for one gateway.
KPI : {DOWNLINK_BYTES, NB_DOWNLINK, NB_END_DEVICE, NB_UPLINK, PING, RSSI_UPLINK_MESSAGE, SNR_UPLINK_MESSAGE, TOA_DOWNLINK_MESSAGE, TOA_UPLINK_MESSAGE, UPLINK_BYTES}period : {DAY, HOUR, MINUTE, MONTH, WEEK, YEAR}

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
eui	PATH	string	?	Gateway EUI
kpi	PATH	string	?	Kpi identifier from predefined set {DOWNLINK_BYTES, NB_DOWNLINK, NB_END_DEVICE, NB_UPLINK, PING, RSSI_UPLINK_MESSAGE, SNR_UPLINK_MESSAGE, TOA_DOWNLINK_MESSAGE, TOA_UPLINK_MESSAGE, UPLINK_BYTES}
period	QUERY	string	?	Aggregation period from predefined set {DAY, HOUR, MINUTE, MONTH, WEEK, YEAR}
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
activationType	QUERY	string		For kpi=NB_END_DEVICE only Predefined set {ABP, OTAA}
frq	QUERY	string		For kpi=TOA_DOWNLINK_MESSAGE only
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
sf	QUERY	string		For kpi=TOA_DOWNLINK_MESSAGE only

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<KpiDto>
4xx, 5xx	BODY		ErrorDto

getRncCustomerKpi CUSTOMERKPIRNC Since: 3.0.0

GET

/application/customers/{id}/kpis/{kpi}

READER

Description

This web service returns a KPI by customer for one customer.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Kpi identifier from predefined set {DOWNLINK_BYTES, NB_DOWNLINK, NB_END_DEVICE, NB_UPLINK, PING, RSSI_UPLINK_MESSAGE, SNR_UPLINK_MESSAGE, TOA_DOWNLINK_MESSAGE, TOA_UPLINK_MESSAGE, UPLINK_BYTES}
kpi	PATH	string	?	Identifier
period	QUERY	string	?	Aggregation period from predefined set {DAY, HOUR, MINUTE, MONTH, WEEK, YEAR}
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
activationType	QUERY	string		For kpi=NB_END_DEVICE only KPI : {ABP, OTAA}
frq	QUERY	string		For kpi=TOA_DOWNLINK_MESSAGE only
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
sf	QUERY	string		For kpi=TOA_DOWNLINK_MESSAGE only

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<KpiDto>
4xx, 5xx	BODY		ErrorDto

getRncCustomersLastEventsCounters COUNTERCUSTOMERLAST_EVENTRNC Since: 2.3.0

GET

/application/customers/rncEvents/last/counters

READER

Description

This web service returns the counters of the unread RNC last events of all the customers.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		RncCustomerLastEventsCountersDto
4xx, 5xx	BODY		ErrorDto

getRncGatewaysEvents EVENTGATEWAYRNC Since: 2.3.0

GET

/application/rncEvents/gateways

READER

Description

This web service returns RNC events of all gateways of one or several customers.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<RncGatewayEventDto>
4xx, 5xx	BODY		ErrorDto

getRncGatewaysLastEvents GATEWAYLAST_EVENTRNC Since: 2.3.0

GET

/application/rncEvents/gateways/last

READER

Description

This web service returns RNC last events of all gateways of one or several customers.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<RncGatewayLastEventDto>
4xx, 5xx	BODY		ErrorDto

getRncNetworkKpi KPIRNC Since: 3.0.0

GET

/application/kpis/{kpi}

SUPER_ADMIN

Description

This web service returns a KPI on the network.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
kpi	PATH	string	?	Kpi identifier from predefined set {DOWNLINK_BYTES, NB_DOWNLINK, NB_END_DEVICE, NB_UPLINK, PING, RSSI_UPLINK_MESSAGE, SNR_UPLINK_MESSAGE, TOA_DOWNLINK_MESSAGE, TOA_UPLINK_MESSAGE, UPLINK_BYTES}
period	QUERY	string	?	Aggregation period from predefined set {DAY, HOUR, MINUTE, MONTH, WEEK, YEAR}
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
activationType	QUERY	string		For kpi=NB_END_DEVICE only {ABP, OTAA}
frq	QUERY	string		For kpi=TOA_DOWNLINK_MESSAGE only
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
sf	QUERY	string		For kpi=TOA_DOWNLINK_MESSAGE only

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<KpiDto>
4xx, 5xx	BODY		ErrorDto

getRoles ROLE Since: 1.1.12

GET

/application/roles

ADMIN

Description

This web service allows to get the list of roles.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<RoleDto>
4xx, 5xx	BODY		ErrorDto

getSelection SELECTION Since: 2.1.0

GET

/application/selections/{id}

READER

Description

This web service allows to get a selection.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Selection identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		SelectionDto
4xx, 5xx	BODY		ErrorDto

getSelections SELECTION Since: 2.1.0

GET

/application/selections

READER

Description

This web service allows to get the list of selections.
If the authenticated user is SUPER_ADMIN all the selections are returned, otherwise only the authenticated user selections are returned.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<SelectionDto>
4xx, 5xx	BODY		ErrorDto

getSoftwares SOFTWARE Since: 3.2.0

GET

/application/softwares

USER

Description

This web service allows to get the list of softwares from the repository.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		FileDto[]
4xx, 5xx	BODY		ErrorDto

getSpectrum SPECTRUM Since: 2.3.0

GET

/application/spectrums/{id}

USER

Description

Retrieves a specific spectrum analysis.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Spectrum identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		SpectrumDto
4xx, 5xx	BODY		ErrorDto

getSpectrumFile FILESPECTRUM Since: 2.3.0

GET

/application/spectrums/{id}/file

USER

Description

Retrieves the spectrum analysis file content.
Two formats can be produced according to the value of the format parameter:
1) Format = HEXA: rssi hexadecimal values
2) Format = DECIMAL: rssi decimal values

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Spectrum identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json,application/octet-stream		Media type(s) that is(are) acceptable for the response
format	QUERY	string		The spectrum content format {HEXA, DECIMAL}

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY
4xx, 5xx	BODY		ErrorDto

getSpectrums SPECTRUM Since: 2.3.0

GET

/application/spectrums

USER

Description

This web service allows to retrieve the spectrum analyses on modems.
If the authenticated user is SUPER_ADMIN all the spectrum analyses are returned, otherwise only the spectrum analyses on gateways attached to the customer of the authenticated user are returned.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<SpectrumDto>
4xx, 5xx	BODY		ErrorDto

getStats STATISTIC Since: 1.1.12

GET

/application/stats

READER

Description

This web service allows to get the statistics about the application (counters, ...).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		StatsDto
4xx, 5xx	BODY		ErrorDto

getTask TASK Since: 1.1.12

GET

/application/tasks/{id}

READER

Description

This web service allows to retrieve a task.
If the task status is OK and the parameter result set to true then the result DTO is returned, otherwise the taskDto is returned.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Task identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json,application/octet-stream		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
result	QUERY	boolean		If true the result DTO is returned, otherwise it is the taskDto.

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		Dto
4xx, 5xx	BODY		ErrorDto

getTaskMessages TASK Since: 1.1.12

GET

/application/tasks/{id}/messages

READER

Description

This web service allows to retrieve the messages of a task.
Although it returns a paginatedDto, this pagination functionalities are not available. Therefore all the results are returned within the same page.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Task identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<TaskMessageDto>
4xx, 5xx	BODY		ErrorDto

getTaskSnmpLogs SNMPTASK Since: 1.1.12

GET

/application/tasks/{id}/snmpLogs

READER

Description

This web service retrieves the SNMP logs attached to a task.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Resource identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<GatewaySnmpLogDto>
4xx, 5xx	BODY		ErrorDto

getTasks TASK Since: 1.1.12

GET

/application/tasks

READER

Description

This web service retrieves a list of tasks matching the parameters.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
action	QUERY	string		A comma separated list of actions from predefined set {ALARM_CPU, ALARM_DISK_SYSTEM, ALARM_DISK_USER, ALARM_DOOR_EVENT, ALARM_GPS, ALARM_RAM, ALARM_RSSI, ALARM_TEMPERATURE, CONNEXION_CHANGE, FILE_EXCHANGE_ABORT, FILE_EXCHANGE_EXECUTE, FILE_EXCHANGE_STATUS, GATEWAY_DESCRIPTION_CHANGE, GATEWAY_IP_PORT_CHANGE, GET_CONFIGURATION, GET_CONFIGURATIONS, GET_CONTROLS, GET_GATEWAY_DESCRIPTION, GET_HASH_CONFIGURATIONS, GET_HASH_VERSIONS, GET_LAN_MODULES, GET_STATISTIC, GET_STATISTIC_INDEX, GET_VALUES, GET_VERSION, GET_VERSIONS, HELLO, MANAGEMENT_EXECUTE, MANAGEMENT_GET_VALUES, NETWORK_EVENT, NOTIFICATION_AUTHENTICATION_FAILURE, NOTIFICATION_AUTOMATIC_SYSTEM_RESTORATION, NOTIFICATION_AUTOMATIC_SYSTEM_RESTORATION_FACTORY, NOTIFICATION_COLD_START, NOTIFICATION_FILE_EXCHANGE_ABORT, NOTIFICATION_FILE_EXCHANGE_EXECUTE, NOTIFICATION_IP_CHANGE, NOTIFICATION_POWER_LOST, NOTIFICATION_PREVIOUS_CONFIG_RESTORATION, NOTIFICATION_RESTART, NOTIFICATION_SHUTDOWN, NOTIFICATION_SPECIFIC_COMMAND_ABORT, NOTIFICATION_SPECIFIC_COMMAND_EXECUTE, NOTIFICATION_SPECTRUM_ANALYSIS_ABORT, NOTIFICATION_SPECTRUM_ANALYSIS_EXECUTE, NOTIFICATION_START, NOTIFICATION_UPDATE_ABORT, NOTIFICATION_UPDATE_EXECUTE, PING, PING_EVENT, RETURN_KO_STATUS, RETURN_SENDING_STATUS, RETURN_TIMEOUT_STATUS, SET_CONFIGURATION, SET_CONTROLS, SET_VALUES, SIMULATE_ALARM_DOOR_EVENT, SIMULATE_ALARM_GPS_EVENT, SPECIFIC_COMMAND_ABORT, SPECIFIC_COMMAND_EXECUTE, SPECIFIC_COMMAND_STATUS, SPECTRUM_ANALYSIS_ABORT, SPECTRUM_ANALYSIS_EXECUTE, SPECTRUM_ANALYSIS_STATUS, STATISTIC, UPDATE_ABORT, UPDATE_EXECUTE, UPDATE_STATUS} A logical OR operator is used between the members
criteria	QUERY	String[]		A comma separated list of couples key=value. A logical OR operation is used between the members. Example : criteria=customerId=10,fleetId=78 => (customerId=10) OR (fleetId=78)
endDate	QUERY	integer		The end date of the period
eui	QUERY	string		The gateway EUI
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
startDate	QUERY	integer		The start date of the period
status	QUERY	string		A comma separated list of status from predefined set {KO, OK, PENDING} A logical OR operator is used between the members. Example : status=PENDING,OK => (status=PENDING) OR (status=OK)
taskIds	QUERY	string		A comma separated list of task identifiers

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<TaskDto>
4xx, 5xx	BODY		ErrorDto

getUser USER Since: 1.1.12

GET

/application/users/{id}

READER

Description

This web service allows to retrieve a user.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)
The connected user is the user identified by userId or the connected user is at least ADMIN

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	User identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		UserDto
4xx, 5xx	BODY		ErrorDto

getUsers USER Since: 1.1.12

GET

/application/users

READER

Description

This web service allows to get the list of users.If the authenticated user is SUPER_ADMIN all the users are returned.
If the authenticated user is ADMIN all the users belonging to his customer are returned.
otherwise only the authenticated user is returned.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<UserDto>
4xx, 5xx	BODY		ErrorDto

getWebServices WEB_SERVICE Since: 2.0.2

GET

/application/webServices

READER

Description

This web service allows to get the list of web services. Each web service contains metadata that describe its structure.
Although it returns a paginatedDto, this web service is not paginated. All the results are returned within the same page.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
search	QUERY	Condition		Search condition
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<WebServiceDto>
4xx, 5xx	BODY		ErrorDto

getWorkflowInstance WORKFLOW Since: 3.1.0

GET

/application/workflow/instances/{id}

USER

Description

This web service allows retrieving a workflow process instance.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	string	?	Resource identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		InstanceDto
4xx, 5xx	BODY		ErrorDto

getWorkflowInstanceActivities WORKFLOW Since: 3.1.0

GET

/application/workflow/instances/{id}/activities

USER

Description

This web service allows retrieving the activities of a workflow process instance.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	string	?	Resource identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<ActivityDto>
4xx, 5xx	BODY		ErrorDto

getWorkflowProcessInstances WORKFLOW Since: 3.1.0

GET

/application/workflow/processes/{id}/instances

USER

Description

This web service allows retrieving the instances of one workflow process.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	string	?	Resource identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
sort	QUERY	string		Sort value
status	QUERY	string		filter on workflow process instances status that equal this value (case insensitive)

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<InstanceDto>
4xx, 5xx	BODY		ErrorDto

getWorkflowProcesses WORKFLOW Since: 3.1.0

GET

/application/workflow/processes

USER

Description

This web service allows retrieving the list of the executed workflow processes.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
ended	QUERY	boolean		Retrieves only ended processes if true
fields	QUERY	string		List of fields to display
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
sort	QUERY	string		Sort value
templateName	QUERY	string		filter on workflow processes template that contains this value (case insensitive)

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<ProcessDto>
4xx, 5xx	BODY		ErrorDto

getWorkflowTemplate WORKFLOW Since: 3.1.0

GET

/application/workflow/templates/{id}

USER

Description

This web service allows retrieving a specific workflow template.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	string	?	Resource identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		TemplateDto
4xx, 5xx	BODY		ErrorDto

getWorkflowTemplates WORKFLOW Since: 3.1.0

GET

/application/workflow/templates

USER

Description

This web service allows retrieving the list of existing workflow templates.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
category	QUERY	string		filter on workflow templates category that equal this value (case sensitive)
description	QUERY	string		filter on workflow templates description that contains this value (case insensitive)
fields	QUERY	string		List of fields to display
latest	QUERY	boolean		If true, returns only the last version of the workflow templates
name	QUERY	string		filter on workflow templates name that contains this value (case insensitive)
page	QUERY	string		Page number
pageSize	QUERY	string		Page size value
sort	QUERY	string		Sort value

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		PaginatedDto<TemplateDto>
4xx, 5xx	BODY		ErrorDto

POST

/application/login

Description

This web service allows a user to authenticate to the platform by providing his login and his password.
In case of success he gets a token that he will provide for the next requests.
The token has an expiration date.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
userDto	BODY	UserDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
201 CREATED	BODY		JwtDto
4xx, 5xx	BODY		ErrorDto

patchBrand GATEWAYGATEWAY_TYPE Since: 3.2.0

PATCH

/application/brands/{id}

SUPER_ADMIN

Description

This web service allows to patch a Brand.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
id	PATH	integer	?	Resource identifier
brandDto	BODY	BrandDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

patchCluster CLUSTER Since: 1.1.12

PATCH

/application/clusters/{id}

ADMIN

Description

This web service allows to patch a cluster.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
id	PATH	integer	?	Cluster identifier
clusterDto	BODY	ClusterDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

patchCustomer CUSTOMER Since: 1.1.12

PATCH

/application/customers/{id}

ADMIN

Description

This web service allows to patch a customer.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)
Only a SUPER_ADMIN user can manage the fields {maxEndDevices, maxGateways, maxUsers}
The maxGateways value cannot be less than the actual number of gateways.
The maxEndDevices value cannot be less than the actual number of end-devices.
The maxUsers value cannot be less than the actual number of users.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
id	PATH	integer	?	Customer identifier
customerDto	BODY	CustomerDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

patchEndDevice END_DEVICE Since: 1.1.12

PATCH

/application/endDevices/{devEui}

ADMIN

Description

This web service allows to update an end-device.
Some fields of EndDeviceDto cannot be updated: activation, macVersion, rfRegion, regParamsRevision
Also depending on activation:
OTAA: appEui, appKey
ABP: devAddr, nwkSKey, appSKey

Rules

The fields {fcntDown, fcntUp} can be updated for the end-devices ABP if the status is different from DATAUP_SUCCESS.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
devEui	PATH	string	?	End-device EUI
endDeviceDto	BODY	EndDeviceDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

patchGateway GATEWAY Since: 1.1.12

PATCH

/application/gateways/{eui}

ADMIN

Description

This web service allows to patch a gateway.
It also allows to move the gateway to another fleet by defining the id field of the fleet object.If the customer has changed, the maximum number of gateways cannot be exceeded.

Rules

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
eui	PATH	string	?	Resource extended unique identifier
gatewayDto	BODY	GatewayDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

patchLastEvent LAST_EVENT Since: 1.1.12

PATCH

/application/events/last/{id}

USER

Description

This web service allows to patch a lastEvent of a gateway.
The main use case is for marking the LastEvent as read by setting the field markAsRead to true.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
id	PATH	integer	?	Resource identifier
lastEventDto	BODY	LastEventDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

patchLnsLastEvent LAST_EVENTLNS Since: 1.1.12

PATCH

/application/lnsEvents/last/{id}

READER

Description

This web service allows to patch a LNS last event.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	string	?	LNS Last event identifier
lnsEventDto	BODY	LnsEventDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

patchMulticastGroup MULTICAST Since: 3.0.0

PATCH

/application/multicastGroups/{id}

ADMIN

Description

This web service allows to patch a multicastGroup.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
id	PATH	integer	?	MulticastGroup identifier
multicastGroupDto	BODY	MulticastGroupDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

patchOneDataUp DATA_UP Since: 1.1.12

PATCH

/application/dataUp/{id}

READER

Description

This web service allows to mark a data up as pushed.

Rules

A SUPER_ADMIN cannot update messages status.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
id	PATH	string	?	Resource identifier
dataUpDto	BODY	DataUpDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

patchPushConfiguration PUSH_CONFIGURATION Since: 3.1.0

POST

/application/pushConfigurations/{id}

ADMIN

Description

This web service allows to patch a pushConfiguration.
Data are sent as multipart/form-data.
Data are a mix of an optional PushConfigurationDto and three optional files.

Rules

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	multipart/form-data	?	The Media type of the request body
id	PATH	integer	?	PushConfiguration identifier
dto	BODY	PushConfigurationDto	?	The PushConfigurationDto content in JSON format
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
tlsCaFile	BODY	MultipartFile		TLS CA cert file
tlsCertFile	BODY	MultipartFile		TLS Cert file
tlsKeyFile	BODY	MultipartFile		TLS Private Key

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

patchRncGatewayLastEvent GATEWAYLAST_EVENTRNC Since: 2.3.0

PATCH

/application/rncEvents/gateways/last/{id}

USER

Description

This web service allows to patch a RNC last event.
The main use case is for marking the last event as read by setting the field read to true.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
id	PATH	integer	?	Rnc Gateway LastEvent identifier
rncGatewayLastEventDto	BODY	RncGatewayLastEventDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

patchUser USER Since: 1.1.12

PATCH

/application/users/{id}

READER

Description

This web service allows to patch a user.

Rules

Each user can edit the fields {avatar, email, firstName, lastName, login, password, phone} of his profile.
The connected user can edit the fields {avatar, email, firstName, lastName, login, password, phone} of another user if he is SUPER_ADMIN or he is ADMIN with a role greater than or equals to the role of the user.
The connected user can edit the fields {enabled, expirationDate} if he is not the user and (he is SUPER_ADMIN or he is ADMIN with a role greater than or equals to the role of the user).
The connected user can edit the field {role} if he is SUPER_ADMIN or he is ADMIN and belongs to the same customer as the user.
The connected user can edit the field {role} if he is not the user and (he is SUPER_ADMIN or he is ADMIN with a role greater than or equals to the role of the user).
The role cannot be greater than the role of the connected user.
If the user has changed of customer and the new customer has a limited number of users, then this limit cannot be exceeded.
The field login cannot be patched.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
id	PATH	integer	?	User identifier
userDto	BODY	UserDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
url	QUERY	string		Base url called to validate the new user email (if provided) example : https:///#validateUser

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

ping MONITORING Since: 1.1.12

GET

/application/ping

Description

This web service allows to ping the API in order to check its state. A "204 No Content" pong is returned when the API is up.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

pushDataDownEvent LNSPUSH_API Since: 1.1.12

POST

{pushUrl}/dataDownEvent

Description

This web service allows to return the different status of a dataDown message (sent to the gateway)
Only the fields {dataDownId, event, nbAttempts, status} are posted in the body.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Content-Type	HEADER	application/json	?	The Media type of the request body
pushUrl	PATH	string	?	The URL where to post data
pushDataDownEventDto	BODY	PushDataDownEventDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
201 CREATED	BODY
4xx, 5xx	BODY		ErrorDto

pushDataUp LNSPUSH_API Since: 1.1.12

POST

{pushUrl}/dataUp

Description

This web service allows to send a dataUp message to the customer. The cluster msgDetailLevel field sets the granularity of the returned information. 3 levels are available :
- Payload : Returns only the userdata tag without motetx
- Radio : Returns the userdata
- Network : Returns userdata tag and gwrx

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Content-Type	HEADER	application/json	?	The Media type of the request body
KLK-UNSENT-DATAUP	HEADER	boolean	?	true if there are still unsent messages
pushUrl	PATH	string	?	The URL where to post data
pushDataUpDto	BODY	PushDataUpDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
201 CREATED	BODY
4xx, 5xx	BODY		ErrorDto

putEndDevice END_DEVICE Since: 1.1.12

PUT

/application/endDevices/{devEui}

ADMIN

Description

This web service allows to create an end-device.

Rules

The fields {fcntDown, fcntUp} can be set for the end-devices ABP. Default values are 0.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
devEui	PATH	string	?	End-device EUI
endDeviceDto	BODY	EndDeviceDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
201 CREATED	BODY
201 CREATED	HEADER	Location	/application/endDevices/{devEui}	Created resource path
4xx, 5xx	BODY		ErrorDto

putLicense LICENSE Since: 1.1.12

POST

/application/licenses

SUPER_ADMIN

Description

This web service allows to put a license file.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	multipart/form-data	?	The Media type of the request body
licenseFile	BODY	MultipartFile	?	File containing the license
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

putLnsGatewayAesKey GATEWAY Since: 1.1.12

PUT

/application/gateways/{eui}/aesKeys/{index}

ADMIN

Description

This web service allows to set a new AES key for a gateway used for fine timestamp decryption.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
eui	PATH	string	?	Gateway EUI
index	PATH	integer	?	AES key index
lnsGatewayKeyDto	BODY	LnsGatewayKeyDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
201 CREATED	BODY
4xx, 5xx	BODY		ErrorDto

removeEndDeviceFromMulticastGroup END_DEVICEMULTICAST Since: 3.0.0

DELETE

/application/multicastGroups/{id}/endDevices/{devEui}

ADMIN

Description

This web service allows to remove an end-device from a multicastGroup.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
devEui	PATH	string	?	End-device EUI
id	PATH	integer	?	MulticastGroup identifier
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

removeSoftware SOFTWARE Since: 3.2.0

DELETE

/application/softwares

SUPER_ADMIN

Description

This web service allows to remove a software from the repository.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
fileName	QUERY	string	?	The software file name
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

requestPassword LOGINUSER Since: 1.1.12

POST

/application/password/request

Description

When the user does not remember his password, this web service will allow him to redefine a new one. After having called this web service, the user will receive an email (defined in his profile) which will contain a link.
The user wil have 15 min to change his password. After this date, the link will be no longer valid and the user will have to repeat the procedure.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
email	QUERY	string	?	The user email address used to ask for a new password
url	QUERY	string	?	The url to call for reseting the password
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY
4xx, 5xx	BODY		ErrorDto

resetEndDeviceFrameCounters END_DEVICE Since: 1.1.12

PUT

/application/endDevices/{devEui}/resetFrameCounters

USER

Eligible for workflow: END_DEVICE

Description

This web service allows reset the fCntUp and fCntDown to 0.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
devEui	PATH	string	?	End-device EUI
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

resetPassword LOGINUSER Since: 1.1.12

POST

/application/password/reset

READER

Description

This web service allows to update the user password after having requested for a new password (see requestPassword web service).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
userDto	BODY	UserDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
201 CREATED	BODY		JwtDto
4xx, 5xx	BODY		ErrorDto

sendValidationEmail USER Since: 3.2.0

POST

/application/users/{id}/validationEmail

ADMIN

Description

This web service allows to send a validation email to the user in order to validate his email address.
The user will receive an email with a link to validate his account. The link is valid for 72h.

Rules

If the user is already validated an error is returned.
The email cannot be sent to a user who has a higher role (SUPER_ADMIN).

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	integer	?	Resource identifier
url	QUERY	string	?	Base url called to validate the user account (exemple : https:///#validateUser)
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY
4xx, 5xx	BODY		ErrorDto

startWorkflowTemplate WORKFLOW Since: 3.1.0

POST

/application/workflow/templates/{id}

USER

Description

This web service allows starting a workflow process on a workflow template. It returns the workflow process identifier.

The "workflowParams" parameter provides the parameters of the web services defined into the executed workflow template.

The JSON must provide a "pathParams" key which is a list of the entities properties. These properties correspond to the path parameters of each web services. Example:

"pathParams": [
    {
      "eui": "7276FF00080E0F9F",
    },
    {
      "eui": "7276FF0039030418",
    }
  ]

The JSON must also provide the parameters for each step which is identified by its sequence number (as string) starting at "0".
The parameters must be provided as key:value object like this:

"0": {
    "webService": "/application/gateways/{eui}/commands",
    "httpMethod": "POST",
    "wsType": "asynchronous",
    "command": "ls"
  }

All the steps must be defined even if there are no parameters for a step. In this case, just set the step as:

"0": {}

If a parameter consists of a file, it must be provided as base64 like this:

"0": {
    "webService": "/application/gateways/firmware",
    "httpMethod": "POST",
    "wsType": "asynchronous",
    "fileName": "update.gzip",
    "fileB64": "data:application/json;base64,eyANCiAgICAic3dhZ2dlci[...]",
    "when": 1548846000000
  }

Rules

The workflow process is executed with the role associated to the user calling this web service. So, he must have rights at least as high as the highest right required at any step for the whole workflow to work.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
id	PATH	string	?	Resource identifier
workflowParams	QUERY	string	?	JSON of paramters
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
name	QUERY	string		Name of the workflow process

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		string
4xx, 5xx	BODY		ErrorDto

updateApplicationSetting APPLICATIONSETTING Since: 1.1.12

PUT

/application/applicationSettings/{id}

ADMIN

Description

This web service allows to update an application setting.

Rules

If the applicationSetting is private an exception will occur.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
id	PATH	integer	?	Application settings identifier
applicationSettingDto	BODY	ApplicationSettingDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

updateCustomerSetting CUSTOMERSETTING Since: 1.1.12

PUT

/application/customersSettings/{id}

ADMIN

Description

This web service allows to update one customer setting.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
id	PATH	integer	?	Customer settings identifier
customerSettingDto	BODY	CustomerSettingDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

updateFleet FLEET Since: 1.1.12

PUT

/application/fleets/{id}

ADMIN

Description

This web service allows to update one fleet.
It also allows to move the fleet to another customer by defining the id field of the customer object.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN).
If the customer has changed, the maximum number of gateways cannot be exceeded.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
id	PATH	integer	?	Fleet identifier
fleetDto	BODY	FleetDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
204 NO_CONTENT	BODY
4xx, 5xx	BODY		ErrorDto

updateGatewayControl CONTROLGATEWAY Since: 1.1.12

PATCH

/application/gateways/{eui}/control

USER

Asynchronous

Eligible for workflow: GATEWAY

Description

This web service allows to update the control data of a gateway.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
eui	PATH	string	?	Gateway EUI
gatewayControlDto	BODY	GatewayControlDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
criteria	QUERY	String[]		Task criteria. Pre-registered are : {customerId, userId, fleetId, gatewayEui}

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY		TaskDto
4xx, 5xx	BODY		ErrorDto

updateGatewayCurrentConfiguration CONFIGURATIONGATEWAY Since: 1.1.12

PATCH

/application/gateways/{eui}/configurations/current

ADMIN

Asynchronous

Description

This web service allows to update the current configuration of one gateway.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)
The field 'configVpn' can be set only with at least role ADMIN.
The list 'gsmOperators' has a maximum size of 10.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
eui	PATH	string	?	Gateway EUI
gatewayConfigurationDto	BODY	GatewayConfigurationDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
criteria	QUERY	String[]		Task criteria. Pre-registered are : {customerId, userId, fleetId, gatewayEui}

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY		TaskDto
4xx, 5xx	BODY		ErrorDto

updateGatewayManagement GATEWAYMANAGEMENT Since: 1.1.12

PUT

/application/gateways/{eui}/management

ADMIN

Asynchronous

Eligible for workflow: GATEWAY

Description

This web services allow to update the current gateway management data.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Content-Type	HEADER	application/json,application/vnd.kerlink.iot-v1+json	?	The Media type of the request body
eui	PATH	string	?	Gateway EUI
gatewayManagementDto	BODY	GatewayManagementDto	?	The DTO JSON representation to put in the request body
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
criteria	QUERY	String[]		A comma separated list of couples key=value. A logical OR operation is used between the members. Example : criteria=customerId=10,fleetId=78 => (customerId=10) OR (fleetId=78)

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY		TaskDto
4xx, 5xx	BODY		ErrorDto

updateGatewaysFirmware FIRMWAREGATEWAY Since: 1.1.12

POST

/application/gateways/firmware

USER

Asynchronous

Description

This web service allows to update the firmware of a list of gateways.
The firmware file name will be formated according to this syntax :
originFileName_UUID.extension where UUID is a unique string
Example : firmware_2016.05v1.5_cd31160f-95b3-471b-a0a4-f524ed7d53b9.tar.gz

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
euis	QUERY	string	?	A comma separated list of gateway EUI
file	BODY	MultipartFile	?	The firmware file. The extension must be in the set {tar.gz, tgz, ipk, tar}
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
criteria	QUERY	String[]		Task criteria. Pre-registered are : {customerId, userId, fleetId, firmwareFileName}
fields	QUERY	string		List of fields to display
when	QUERY	string		The date when to execute the update (EPOCH ms). Default value is current time.

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY		PaginatedDto<TaskDto>
4xx, 5xx	BODY		ErrorDto

updateGatewaysManagedSoftware GATEWAYSOFTWARE Since: 3.2.0

POST

/application/gateways/managedSoftware

USER

Asynchronous

Eligible for workflow: GATEWAY

Description

This web service allows to update the software of a list of gateways.
The software corresponding to the file name is retrieved from the repository.

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
euis	QUERY	string	?	A comma separated list of gateway EUI
fileName	QUERY	string	?	The file name of the software
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
criteria	QUERY	String[]		Task criteria. Pre-registered are : {customerId, userId, fleetId, softwareFileName}
fields	QUERY	string		List of fields to display
when	QUERY	string		The date when to execute the update (EPOCH ms). Default value is current time.

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY		PaginatedDto<TaskDto>
4xx, 5xx	BODY		ErrorDto

updateGatewaysSoftware GATEWAYSOFTWARE Since: 3.2.0

POST

/application/gateways/software

USER

Asynchronous

Description

This web service allows to update the software of a list of gateways.
The software file name will be formated according to this syntax :
originFileName_UUID.extension where UUID is a unique string
Example : software_2016.05v1.5_cd31160f-95b3-471b-a0a4-f524ed7d53b9.tar.gz

Rules

The connected user can manage the customer (he belongs to the customer or he is SUPER_ADMIN)

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
euis	QUERY	string	?	A comma separated list of gateway EUI
file	BODY	MultipartFile	?	The software file. The extension must be in the set {tar.gz, tgz, ipk, tar}
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
criteria	QUERY	String[]		Task criteria. Pre-registered are : {customerId, userId, fleetId, softwareFileName}
fields	QUERY	string		List of fields to display
when	QUERY	string		The date when to execute the update (EPOCH ms). Default value is current time.

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
202 ACCEPTED	BODY		PaginatedDto<TaskDto>
4xx, 5xx	BODY		ErrorDto

validateUser USER Since: 2.3.0

POST

/application/validateUser

READER

Description

This web service allows to validate a user. A user is validated when his email address has been validated. This web service must be called when a new user is created or when a user changes his email address.

Request

NAME	LOCATION	TYPE	MANDATORY	DESCRIPTION
Authorization	HEADER	string	?	Authentication credentials : Bearer JWT_value
Accept	HEADER	application/json,application/vnd.kerlink.iot-v1+json		Media type(s) that is(are) acceptable for the response
fields	QUERY	string		List of fields to display

Responses

STATUS	LOCATION	NAME	VALUE	DESCRIPTION
200 OK	BODY		UserDto
4xx, 5xx	BODY		ErrorDto

Web services push LNS

This chapter describes the web services to be implemented by the customer. The server will send the following information to the push url defined when creating a cluster.
Kerlink guarantees to its customers that the data of the gateways will not be lost. Messages from gateways will be stored and pushed to the customer.
If a HTTP 200 status is returned during the push, the message is deleted. Otherwise, the message remains in the storage space for the duration of its TTL (time to live).
Each pushed message contains an additional attribute to indicate that there are still messages waiting.

Push via a HTTP request
The messages are sent to the customer via the web service pushDataUp. The customer has to install an HTTP server and configure the URL, the login and password.

Push via WebSocket
It is also possible to send messages via a WebSocket. The customer has to install a WebSocket server and configure the URL, the login and password.

DTOs

A DTO is displayed in a table containing five columns:

FIELD : the field name
TYPE : the field type
DESCRIPTION : the field description
CONTROLS : the four predefined controls (Authorized, Mandatory, Sortable, Searchable)
CONSTRAINTS : the comma separated list of constraints (min length, max length, min, max, default, set, regex)

Graphic styles for controls:

Control	Description	Icon
Authorized	Defines if the field is authorized when creating or updating a resource
Mandatory	Defines if the field is mandatory when creating or updating a resource
Sortable	Defines if the field is sortable when getting a list of resources
searchable	Defines if the field is searchable when getting a list of resources

ActionDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Identifier	min=-9223372036854775808, max=9223372036854775807
date	integer	Date EPOCH (ms)	min=-9223372036854775808, max=9223372036854775807, default=null
duration	integer	Duration in ms	min=-2147483648, max=2147483647, default=null
ip	string	IP of the remote host	max length=255, default=null
kti	string	Kerlink Transaction Identifier	max length=255, default=null
parameters	ActionParameterDto[]	Input and output parameters	default=null
status	integer	HTTP response status	min=-2147483648, max=2147483647, default=null
userAgent	string	User agent request header	max length=255, default=null
userLogin	string	User login	max length=255, default=null
webServiceName	string	Name	max length=255, default=null

ActionParameterDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
direction	string	Direction from predefined set	default=null, set=[REQUEST, RESPONSE]
key	string	Name	max length=255, default=null
location	string	Location from predefined set	default=null, set=[PATH, QUERY, HEADER, BODY]
value	string	Value	max length=255, default=null

ActivityDto

FIELD	TYPE	CONSTRAINTS
id	string	max length=255
activityId	string	max length=255, default=null
activityName	string	max length=255, default=null
activityType	string	max length=255, default=null
assignee	string	max length=255, default=null
calledProcessInstanceId	string	max length=255, default=null
deleteReason	string	max length=255, default=null
durationInMillis	integer	min=-9223372036854775808, max=9223372036854775807, default=null
endTime	date	default=null
executionId	string	max length=255, default=null
processDefinitionId	string	max length=255, default=null
processInstanceId	string	max length=255, default=null
response	string	max length=255, default=null
startTime	date	default=null
status	string	max length=255, default=null
taskId	string	max length=255, default=null
tenantId	string	max length=255, default=null

AlgorithmDto

FIELD	TYPE	DESCRIPTION	CONTROLS	CONSTRAINTS
id	string	Identifier		max length=255
name	string	Name		max length=255, default=null

ApplicationDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Identifier	min=-9223372036854775808, max=9223372036854775807
name	string	Name	max length=255
status	string	Status from predefined set	set=[KO, NOT_CONFIGURED, OK]
description	string	Description	max length=255, default=null
vendor	string	Application provider	max length=255, default=null
version	string	Version	max length=255, default=null
components	ApplicationDto[]	List of potential components	default=null
date	integer	Build date (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
license	LicenseDto	Licence DTO	default=null
links	LinkDto[]	actions, algorithms, authenticatedUser, brands, capabilities, clusters, createEndDevices, createEndDevicesDeletion, createEndDevicesExport, createGateways, createGatewaysDeletion, createGatewaysExport, customers, customersLastEventsCounters, customersSettings, dataDown, dataUp, dtos, endDevices, file, fleets, gatewayTypes, gateways, lnsCustomersLastEventsCounters, login, multicastDataDown, multicastGroups, passwordStrength, pushConfigurations, requestPassword, resetPassword, rncCustomersLastEventsCounters, rncGatewaysEvents, rncGatewaysLastEvents, rncKpis, roles, selections, self, softwares, spectrums, stats, tasks, updateGatewaysFirmware, updateGatewaysManagedSoftware, updateGatewaysSoftware, users, validateUser, webServices, workflowInstances, workflowProcesses, workflowTemplates

ApplicationSettingDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Identifier	min=-9223372036854775808, max=9223372036854775807
application	ApplicationDto	The application who this applicationSetting belongs to. For creation or update, use only the field id.
category	string	A string used for grouping some keys	max length=255
key	string	Key	max length=255
value	string	Value corresponding to the key	max length=255, default=null
links	LinkDto[]	self

BrandDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Identifier	min=-9223372036854775808, max=9223372036854775807
bscUrl	string	URL of the BSC instance which manages this brand	max length=255
name	string	Name	max length=255
links	LinkDto[]	self

BscDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
brand	string	Brand	max length=255, default=null
capabilities	CapabilitiesDto	Capabilities	default=null
gatewayType	string	Gateway type	max length=255, default=null

CapabilitiesDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
configuration	boolean	Configuration	default=null
control	boolean	Control	default=null
features	map{string,map{string,boolean}}	Features by gateway type	default=null
fileExchange	boolean	FileExchange	default=null
linkStatus	boolean	LinkStatus	default=null
management	boolean	Management	default=null
messageStep	boolean	MessageStep	default=null
modem	boolean	Modem	default=null
modemStatistic	boolean	ModemStatistic	default=null
remoteSsh	boolean	RemoteSsh	default=null
snmpLog	boolean	SnmpLog	default=null
specificCommand	boolean	SpecificCommand	default=null
spectrumAnalysis	boolean	SpectrumAnalysis	default=null
statistic	boolean	Statistic	default=null
update	boolean	Update	default=null
version	boolean	Version	default=null

ChannelDto

FIELD	TYPE	DESCRIPTION	CONTROLS	CONSTRAINTS
frequency	real	Frequency in MHz		min=0, max=999.9999, default=null
number	integer	Number		min=1, max=96, default=null

ClusterCountersDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
alarms	integer	Number of alarms for the cluster	min=-2147483648, max=2147483647, default=null
cluster	ClusterDto	Cluster DTO	default=null
notifications	integer	Number of notifications for the cluster	min=-2147483648, max=2147483647, default=null

ClusterDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Identifier	min=-9223372036854775808, max=9223372036854775807
customer	CustomerDto	The customer who this cluster belongs to. The field customer.id is sortable and searchable.. For creation or update, use only the field id.
geolocEnabled	boolean	Enable Geolocalisation
name	string	Name	min length=1, max length=255
hexa	boolean	If true, pushed payload is encoded as hexadecimal string, base64 otherwise	default=null
pushConfiguration	PushConfigurationDto	The pushConfiguration attached to this cluster. Only the field pushConfiguration.id is sortable and searchable.. For creation or update, use only the field id.	default=null
pushEnabled	boolean	True to enable the push, false otherwise. If true then pushConfiguration is mandatory	default=null
geolocExpirationDate	integer	Geolocalisation expiration date	min=-9223372036854775808, max=9223372036854775807, default=null
links	LinkDto[]	clusterLastEvents, customer, endDevices, self

CommandDto

FIELD	TYPE	DESCRIPTION	CONTROLS	CONSTRAINTS
content	string	Content		max length=255

CsvEndDeviceDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
devEui	string	64 bit end-device id, EUI-64 (unique)	max length=255, regex=[[0-9A-F]{16}]
activation	string	Activation from predefined set	set=[OTAA, ABP]
classType	string	Class type value from predefined set	set=[A, B, C]
clusterId	integer	Cluster identifier	min=-9223372036854775808, max=9223372036854775807, regex=[[0-9]+]
geolocation	string	Geolocation value from predefined set	set=[MANUAL, INHERITED]
macVersion	string	Mac version from predefined set	set=[1.0.3, 1.0.1, 1.1.0, 1.0.2]
profile	string	Profile from predefined set	set=[WALKING, VEHICLE, STATIC]
regParamsRevision	string	Regional parameters revision	set=[A, B, C]
rfRegion	string	RF region from predefined set	set=[AS923, AU915, CN470, EU433, KR920, RU864, EU868, CN779, IN865, US915]
adrEnabled	boolean	Adaptive data rate enabled or disabled	default=null
altitude	integer	meters above sea level (mandatory if geolocation = MANUAL)	min=-2147483648, max=2147483647, default=null
appEui	string	Global application identifier in IEEE EUI64 (mandatory if activation = OTAA and cluster decryption = true)	max length=255, regex=[[0-9A-F]{16}], default=null
appKey	string	AES 128 application key (optional and for activation = OTAA only, if missing join will be performed on remote JS)	max length=255, regex=[[0-9A-F]{32}], default=null
appSKey	string	AES 128 application session key (mandatory if activation = ABP)	max length=255, regex=[[0-9A-F]{32}], default=null
cfList	string[]	List of Frequencies in MHz or Channel masks (comma separated list)	default=null
clusterName	string	Cluster name	max length=255, default=null
country	string	Country from predefined set if rfRegion= AS923	default=null, set=[JP, VN, ID]
devAddr	string	32 bit device address (non-unique) within the current network (mandatory if activation = ABP)	max length=255, regex=[[0-9A-F]{8}], default=null
devNonceCounter	boolean	Based on 'Technical Recommendations for Preventing State Synchronization Issues around LoRaWANTM 1.0.x Join Procedure'. An OTAA end device SHALL use a DevNonce value that is based on a counter starting at 0 when the End-device is initially powered up and incremented with every Join-request. Set this option to true when end device implements this recommendation.	default=null
dwellTime	boolean	Apply dwell time for this device (dwell time is the maximum continuous transmission time of a packet over the air). Ignored for regions which doesn?t permit dwell time modification.	default=null
fNwkSIntKey	string	Forwarding Network session integrity key	max length=255, default=null
fcntDown	integer	Frame counter downlink	min=-9223372036854775808, max=9223372036854775807, default=0
fcntUp	integer	Frame counter uplink	min=-9223372036854775808, max=9223372036854775807, default=0
latitude	real	Latitude in decimal degrees (mandatory if geolocation = MANUAL)	min=-90.0, max=90.0, default=null
longitude	real	Longitude in decimal degrees (mandatory if geolocation = MANUAL)	min=-180.0, max=180.0, default=null
name	string	Name	max length=255, default=null
nwkSKey	string	AES 128 network session key (mandatory if activation = ABP)	max length=255, regex=[[0-9A-F]{32}], default=null
pingSlotDr	string	Used downlink DataRate on ping slots. Present only if supportClassB = true. Must be valid for current end-device region.	max length=255, default=null
pingSlotFreq	real	Used downlink Frequency in MHz on ping slots. Present only if supportClassB = true. Must be valid for current end-device region.	min=0, max=999.9999, default=null
rx1Delay	integer	Delay between data down and RX1 window [0..15] (in seconds)	min=0, max=15, default=null
rx1DrOffset	integer	Offset between the uplink data rate and the downlink data rate. It is used to communicate with the end-device on the first reception slot RX1	min=0, max=7, default=null
rx2Dr	integer	RX2 data rate [0..15]	min=0, max=15, default=null
rx2Freq	real	RX2 frequency in MHz	min=0, max=999.9999, default=null
rxWindows	string	RX window from predefined set	default=null, set=[AUTO, RX1, RX2]
sNwkSIntKey	string	Serving Network session integrity key	max length=255, default=null
lastDataDownMessage	integer	Last data down date (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
lastDataUpDr	string	Last data up data rate	max length=255, default=null
lastDataUpMessage	integer	Last data up date (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
status	string	Status from predefined set	default=null, set=[DATAUP_SUCCESS, JOIN_SUCCESS, NEVER_SEEN, JOIN_DEVADDR_ERR, JOIN_MIC_ERR, JOIN_DEVNONCE_ERR, DATAUP_MIC_ERR]

CsvGatewayDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
eui	string	Extended Unique Identifier. Value from the 'EUI-64' number space managed by the IEEE	max length=255, regex=[[0-9A-F]{16}]
adaptiveLatencyEnabled	boolean	Enabling adaptive latency
dlAllowed	boolean	Allow or not the downlink
fleetId	integer	Fleet identifier	min=-9223372036854775808, max=9223372036854775807
region	string	LoRaWAN Regional Parameters from predefined set	set=[AS923, AU915, CN470, EU433, KR920, RU864, EU868, CN779, IN865, US915]
visibility	string	Visibility	set=[PUBLIC, PRIVATE]
altitude	integer	Altitude in meters	min=-2147483648, max=2147483647, default=null
brandId	integer	Brand identifier	min=-9223372036854775808, max=9223372036854775807, default=null
brandName	string	Brand name	max length=255, default=null
country	string	Country from predefined set if region= AS923	default=null, set=[JP, VN, ID]
fleetName	string	Fleet name	max length=255, default=null
gatewayTypeId	integer	GatewayType identifier	min=-9223372036854775808, max=9223372036854775807, default=null
gpsPositionAllowed	boolean	Authorizes the update of the GPS location default = true	default=true
ip	string	IP address	max length=255, default=null
latitude	real	Latitude in decimal degrees	min=-90.0, max=90.0, default=null
longitude	real	Longitude in decimal degrees	min=-180.0, max=180.0, default=null
maxTxPower	integer	maximum transmission power (dBm)	min=0, max=38, default=27
name	string	Name	max length=255, default=null
networkMaxDelayDown	integer	Duration of the downstream paquet transfer from LNS (ms)	min=0, max=15000, default=350
networkMaxDelayUp	integer	Duration of the upstream paquet transfer to LNS (ms)	min=0, max=15000, default=350
port	integer	Port	min=-2147483648, max=2147483647, default=null
bearer	string	Network bearer from predefined set	default=null, set=[GSM, WLAN, ETHERNET, UNKNOWN]
connection	boolean	Connection status (null:never connected, true: connected, false:disconnected	default=null
description	string	General description	max length=255, default=null
door	string	Door state from predefined set	default=null, set=[CLOSED, OPEN]
gps	string	GPS State from predefined set	default=null, set=[UNLOCKED, LOCKED]
gpsAltitude	integer	Altitude from GPS in meters	min=-2147483648, max=2147483647, default=null
gpsLatitude	real	Latitude from GPS in decimal degrees	min=-90.0, max=90.0, default=null
gpsLongitude	real	Longitude from GPS in decimal degrees	min=-180.0, max=180.0, default=null
interfaceVersion	integer	The current interface version of the MIB of the gateway	min=1, max=2147483647, default=null

CustomerDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Identifier	min=1, max=9223372036854775807
name	string	Name	min length=1, max length=255
billing	boolean	Indicator for producing the billing data of the customer	default=false
geolocationAuthorized	boolean	Authorization for the customer to manage the geolocation functionality	default=false
geolocationExpirationDate	integer	The expiration date of the geolocation functionality (null means no limit)	min=0, max=9223372036854775807, default=null
logo	string	Logo URL	max length=255, default=null
maxEndDevices	integer	Maximum number of endDevices attached to the customer (null means no limit)	min=0, max=2147483647, default=null
maxGateways	integer	Maximum number of gateways attached to the customer (null means no limit)	min=0, max=2147483647, default=null
maxUsers	integer	Maximum number of users attached to the customer (null means no limit)	min=0, max=2147483647, default=null
links	LinkDto[]	clusters, fleets, gateways, rncKpis, self

CustomerLastEventsCountersDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
alarmsCount	integer	Number of unread alarms	min=-2147483648, max=2147483647, default=null
customer	CustomerDto	Customer DTO	default=null
fleets	FleetCountersDto[]	List of fleet counters DTO	default=null
notificationsCount	integer	Number of unread notifications	min=-2147483648, max=2147483647, default=null

CustomerSettingDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Identifier	min=-9223372036854775808, max=9223372036854775807
category	string	A string used for grouping keys	max length=255
customer	CustomerDto	Customer DTO. For creation or update, use only the field id.
key	string	key	max length=255
value	string	Value corresponding to the key	max length=255, default=null
links	LinkDto[]	self

CustomersLastEventsCountersDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
alarmsCount	integer	Number of unread alarms of all customers	min=-2147483648, max=2147483647, default=null
customers	CustomerLastEventsCountersDto[]	List of customer counters	default=null
notificationsCount	integer	Number of unread notifications of all customers	min=-2147483648, max=2147483647, default=null

DataDownDlParametersDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
dataRate	string	Data rate	max length=255, default=null
freq	real	Frequency in MHz	min=0, max=999.9999, default=null
rxWindow	string	RX window	max length=255, default=null

DataDownDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	string	Identifier	max length=255
confirmed	boolean	Confirmed indicator
contentType	string	Content type from predefined set	set=[HEXA, TEXT]
endDevice	EndDeviceDto	End-device which the dataDown belongs to. Possibles searches : {endDevice.devEui, gwEui, timestamp, fPort, status}. For creation or update, use only the field devEui.
fPort	integer	Port	min=-2147483648, max=2147483647
payload	string	Content (base64 or hexa if clusterDto.hexa = true)	max length=255
maxAttempts	integer	Maximum of attempts	min=-2147483648, max=2147483647, default=null
ttl	integer	Time To Live in seconds	min=-2147483648, max=2147483647, default=null
dlParameters	DataDownDlParametersDto[]	Downlink parameters	default=null
encodingType	string	Encoding type from predefined set	default=null, set=[BASE64, HEXA]
event	string	Last event from predifined set	default=null, set=[MAX_ATTEMPTED, CREATED, EXPIRED, IN PROGRESS, INTERNAL_ERROR, ACKED, ROAMING_UNSENT, NOT_ACKED, SENT]
fCntDown	integer	Frame counter downlink	min=-2147483648, max=2147483647, default=null
gwEui	string	Gateway EUI	max length=255, default=null
historic	DataDownStatusDto[]	Historic of datadown status	default=null
nbAttempts	integer	Number of attempts	min=-2147483648, max=2147483647, default=null
status	string	Status from predefined set	default=null, set=[KO, PENDING, OK]
timestamp	integer	Creation date (EPOCH ms	min=-9223372036854775808, max=9223372036854775807, default=null
links	LinkDto[]	self

DataDownStatusDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
date	integer	Date (EPOCH ms)	min=-9223372036854775808, max=9223372036854775807, default=null
event	string	Event from predefined set	default=null, set=[IN_PROGRESS, MAX_ATTEMPTED, CREATED, EXPIRED, INTERNAL_ERROR, ACKED, ROAMING_UNSENT, GATEWAY_SELECTED, SENT, NOT_ACKED]
status	string	Status from predefined set	default=null, set=[KO, PENDING, OK]

DataUpDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	string	Identifier	max length=255
pushed	boolean		default=null
adr	boolean	Adaptative data rate	default=null
classB	boolean	true if end-device operates as a class B	default=null
codingRate	string		max length=255, default=null
confirmed	boolean		default=null
dataRate	string	Data rate	max length=255, default=null
delayed	boolean	true if Uplink sent by gateway after buffering	default=null
encodingType	string	Encoding type from predefined set	default=null, set=[BASE64, HEXA]
encrypted	boolean	Encrypted	default=null
endDevice	EndDeviceDto	End-device which the dataUp belongs to	default=null
fCntDown	integer	Frame counter downlink	min=-2147483648, max=2147483647, default=null
fCntUp	integer	Frame counter uplink	min=-2147483648, max=2147483647, default=null
fPort	integer	Port	min=-2147483648, max=2147483647, default=null
gwCnt	integer		min=-2147483648, max=2147483647, default=null
gwInfo	GatewayInfoDto[]		default=null
gwRecvTime	integer		min=-9223372036854775808, max=9223372036854775807, default=null
modulation	string		max length=255, default=null
payload	string	Content (base64 or hexa if clusterDto.hexa = true)	max length=255, default=null
recvTime	integer		min=-9223372036854775808, max=9223372036854775807, default=null
ulFrequency	real	Transmission frequency in MHz	min=0, max=999.9999, default=null
links	LinkDto[]	self

EndDeviceDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
devEui	string	64 bit end-device id, EUI-64 (unique)	max length=255, regex=[[0-9A-F]{16}]
activation	string	Activation from predefined set	set=[OTAA, ABP]
classType	string	Class type value from predefined set	set=[A, B, C]
cluster	ClusterDto	Cluster which the end-device belongs to. For creation or update, use only the field id.
geolocation	string	Geolocation value from predefined set	set=[MANUAL, INHERITED]
macVersion	string	Mac version from predefined set	set=[1.0.3, 1.0.1, 1.1.0, 1.0.2]
profile	string	Profile from predefined set	set=[WALKING, VEHICLE, STATIC]
regParamsRevision	string	Regional parameters revision	set=[A, B, C]
rfRegion	string	RF region from predefined set	set=[AS923, AU915, CN470, EU433, KR920, RU864, EU868, CN779, IN865, US915]
adrEnabled	boolean	Adaptive data rate enabled or disabled	default=null
altitude	integer	meters above sea level (mandatory if geolocation = MANUAL)	min=-2147483648, max=2147483647, default=null
appEui	string	Global application identifier in IEEE EUI64 (mandatory if activation = OTAA and cluster decryption = true)	max length=255, regex=[[0-9A-F]{16}], default=null
appKey	string	AES 128 application key (optional and for activation = OTAA only, if missing join will be performed on remote JS)	max length=255, regex=[[0-9A-F]{32}], default=null
appSKey	string	AES 128 application session key (mandatory if activation = ABP)	max length=255, regex=[[0-9A-F]{32}], default=null
cfList	string[]	List of Frequencies in MHz or Channel masks	default=null
country	string	Country from predefined set if rfRegion= AS923	default=null, set=[JP, VN, ID]
devAddr	string	32 bit device address (non-unique) within the current network (mandatory if activation = ABP)	max length=255, regex=[[0-9A-F]{8}], default=null
devNonceCounter	boolean	Based on 'Technical Recommendations for Preventing State Synchronization Issues around LoRaWANTM 1.0.x Join Procedure'. An OTAA end device SHALL use a DevNonce value that is based on a counter starting at 0 when the End-device is initially powered up and incremented with every Join-request. Set this option to true when end device implements this recommendation.	default=null
dwellTime	boolean	Apply dwell time for this device (dwell time is the maximum continuous transmission time of a packet over the air). Ignored for regions which doesn?t permit dwell time modification.	default=null
fNwkSIntKey	string	Forwarding Network session integrity key	max length=255, default=null
fcntDown	integer	Frame counter downlink	min=-9223372036854775808, max=9223372036854775807, default=0
fcntUp	integer	Frame counter uplink	min=-9223372036854775808, max=9223372036854775807, default=0
latitude	real	Latitude in decimal degrees (mandatory if geolocation = MANUAL)	min=-90.0, max=90.0, default=null
longitude	real	Longitude in decimal degrees (mandatory if geolocation = MANUAL)	min=-180.0, max=180.0, default=null
name	string	Name	max length=255, default=null
nwkSKey	string	AES 128 network session key (mandatory if activation = ABP)	max length=255, regex=[[0-9A-F]{32}], default=null
pingSlotDr	string	Used downlink DataRate on ping slots. Present only if supportClassB = true. Must be valid for current end-device region.	max length=255, default=null
pingSlotFreq	real	Used downlink Frequency in MHz on ping slots. Present only if supportClassB = true. Must be valid for current end-device region.	min=0, max=999.9999, default=null
rx1Delay	integer	Delay between data down and RX1 window [0..15] (in seconds)	min=0, max=15, default=null
rx1DrOffset	integer	Offset between the uplink data rate and the downlink data rate. It is used to communicate with the end-device on the first reception slot RX1	min=0, max=7, default=null
rx2Dr	integer	RX2 data rate [0..15]	min=0, max=15, default=null
rx2Freq	real	RX2 frequency in MHz	min=0, max=999.9999, default=null
rxWindows	string	RX window from predefined set	default=null, set=[AUTO, RX1, RX2]
sNwkSIntKey	string	Serving Network session integrity key	max length=255, default=null
lastDataDownDate	integer	Last data down date (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
lastDataUpDataRate	string	Last data up data rate	max length=255, default=null
lastDataUpDate	integer	Last data up date (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
status	string	Status from predefined set	default=null, set=[DATAUP_SUCCESS, JOIN_SUCCESS, NEVER_SEEN, JOIN_DEVADDR_ERR, JOIN_MIC_ERR, JOIN_DEVNONCE_ERR, DATAUP_MIC_ERR]
links	LinkDto[]	cluster, createMacCommand, customer, dataDown, dataUp, endDeviceChannels, endDeviceEvents, endDeviceGatewaysPositions, endDeviceLastEvents, endDeviceLastGateways, endDeviceMessages, endDevicePositions, resetEndDeviceFrameCounters, rncKpis, self

EndDeviceLastGatewayDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
latitude	real	Latitude	min=-1.7976931348623157E308, max=1.7976931348623157E308, default=null
longitude	real	Longitude	min=-1.7976931348623157E308, max=1.7976931348623157E308, default=null
eui	string	Gateway EUI	max length=255, default=null
lastDate	integer	Last date (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null

EndDeviceMessageDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	string		max length=255
ack	boolean		default=null
classB	boolean	true if end-device operates as a class B	default=null
date	integer		min=-9223372036854775808, max=9223372036854775807, default=null
delayed	boolean	true if Uplink sent by gateway after buffering	default=null
devEui	string		max length=255, default=null
direction	string	Direction from predefined set	default=null, set=[UPLINK, DOWNLINK]
encodingType	string	Encoding type from predefined set	default=null, set=[BASE64, HEXA]
fCnt	integer		min=-2147483648, max=2147483647, default=null
fPort	integer		min=-2147483648, max=2147483647, default=null
gwInfo	GatewayInfoDto[]		default=null
macCommand	EndDeviceMessageMacCommandDto[]	Mac command. Possible search on macCommand.name	default=null
phyPayload	string		max length=255, default=null
radioParameters	EndDeviceMessageRadioParameterDto[]		default=null
type	string		max length=255, default=null

EndDeviceMessageMacCommandDto

FIELD	TYPE	DESCRIPTION	CONTROLS	CONSTRAINTS
command				default=null
name				default=null

EndDeviceMessageRadioParameterDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
codingRate	string		max length=255, default=null
dataRate	string		max length=255, default=null
freq	real	frequency in MHz	min=0, max=999.9999, default=null
modulation	string		max length=255, default=null

EndDevicePositionDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
algorithm	string	Algorithm	max length=255, default=null
altitude	real	Altitude	min=-1.7976931348623157E308, max=1.7976931348623157E308, default=null
confidence	real	Confidence on the the quality of the the estimation. Usually the lower the better.	default=null
coordinates	Double[]	Coodinates	default=null
devEui	string	End-device EUI	max length=255, default=null
distanceToGPS	real	Distance to GPS	min=-1.7976931348623157E308, max=1.7976931348623157E308, default=null
endpointeui	string	End-device EUI	max length=255, default=null
fCntUp	integer	Frame counter uplink	min=-9223372036854775808, max=9223372036854775807, default=null
gpsAltitude	real	GPS altitude	min=-1.7976931348623157E308, max=1.7976931348623157E308, default=null
gpsLatitude	real	GPS latitude	min=-1.7976931348623157E308, max=1.7976931348623157E308, default=null
gpsLongitude	real	GPS longitude	min=-1.7976931348623157E308, max=1.7976931348623157E308, default=null
latitude	real	Latitude	min=-1.7976931348623157E308, max=1.7976931348623157E308, default=null
longitude	real	Longitude	min=-1.7976931348623157E308, max=1.7976931348623157E308, default=null
method	string	Method used to perform the geolocation (TDOA, RSSIS, ...)	max length=255, default=null
originalTimestamp	integer	Timestamp at which the gateway received the frames (?2s) in seconds	min=-9223372036854775808, max=9223372036854775807, default=null
processingId	integer	Processing identifier	min=-9223372036854775808, max=9223372036854775807, default=null
processingTimestamp	integer	Timestamp at which the position was estimated in seconds	min=-9223372036854775808, max=9223372036854775807, default=null
type	string	Geometry type	max length=255, default=null

ErrorDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
code	string	Error code	max length=255, default=null
component	string	Component name at the origin of the error	max length=255, default=null
errors	ErrorDto[]	List of potential sub errors	default=null
message	string	Error message	max length=255, default=null
params	Object[]	Error parameters	default=null

FileDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
date	integer	Last modified date (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
directory	boolean	File type (true : directory, false : file)	default=null
name	string	Name	max length=255, default=null
permissions	string	Files permissions LINUX format, example : -rw-rw-r--	max length=255, default=null
size	integer	Size in bytes	min=-9223372036854775808, max=9223372036854775807, default=null

FleetCountersDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
alarmsCount	integer	Number of unread alarms	min=-2147483648, max=2147483647, default=null
fleet	FleetDto	Fleet DTO	default=null
notificationsCount	integer	Number of unread notifications	min=-2147483648, max=2147483647, default=null

FleetDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Identifier	min=-9223372036854775808, max=9223372036854775807
customer	CustomerDto	The customer who this fleet belongs to. For creation or update, use only the field id.
name	string	Name	min length=1, max length=255
links	LinkDto[]	customer, fleetEvents, fleetLastEvents, fleetLastEventsCounters, fleetLastStatistics, gateways, self

FleetLastEventCounterDto

FIELD	TYPE	DESCRIPTION	CONTROLS	CONSTRAINTS
counters	LastEventCounterDto[]	List of LastEventCounter DTO		default=null
fleet	FleetDto	Fleet DTO		default=null

GatewayConfigurationDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
apn	string	Access Point Name to use	max length=255, default=null, group=wan
configRadio	string	Radio configuration file content	default=null, group=lan
defaultBroadcast	string	If dhcp is false, indicates broadcast address to use (format: xxx.xxx.xxx.255)	max length=255, default=null, group=wan
defaultGateway	string	If dhcp is false, indicates gateway address to use (format: xxx.xxx.xxx.xxx)	max length=255, default=null, group=wan
defaultIp	string	If dhcp is false, indicates IP address to use (format: xxx.xxx.xxx.xxx)	max length=255, default=null, group=wan
defaultNetmask	string	If dhcp is false, indicates netmask to use (format ex.: 255.255.255.0)	max length=255, default=null, group=wan
dhcp	string	True indicates DHCP server is used to obtain eth address	default=null, group=wan, set=[TRUE, FALSE]
dns1	string	First DNS used when dhcp is set to false	max length=255, default=null, group=wan
dns2	string	Second DNS used when dhcp is set to false	max length=255, default=null, group=wan
durationThreshold	integer	Minimal duration of signal presence (in seconds)	min=-2147483648, max=2147483647, default=null, group=lan
gsmOperators	GsmOperatorDto[]	List of GSM operators	default=null, group=wan
login	string	Login of PDP context	max length=255, default=null, group=wan
mode	string	Wireless network security mode: WEP or WPA	default=null, group=wan, set=[WEP, WPA]
ntp1	string	Primary NTP server address	max length=255, default=null, group=time
ntp2	string	Secondary NTP server address	max length=255, default=null, group=time
password	string	Password of PDP context	max length=255, default=null, group=wan
passwordWlan	string	Wireless network password to use	max length=255, default=null, group=wan
periodResolution	string	Period (in secondes, minutes or hours) between two NTP requests	default=null, group=time, set=[PR16SEC, PR17MIN, PR36HOUR, PR1HOUR, PR18HOUR, PR1MIN, PR9HOUR]
pinCode	string	Pin code of SIM card (format: empty or 4 to 8 digits	max length=255, regex=[([0-9]{4,8})?], default=null, group=wan
powerThreshold	integer	Threshold of signal power	min=-2147483648, max=2147483647, default=null, group=lan
ptpMaster	string	Indicates if the gateway is source of PTP time	default=null, group=time, set=[TRUE, FALSE]
rollBackTmo	integer	The number of minutes to rollback after losing WAN connectivity following a configuration	min=-2147483648, max=2147483647, default=null, group=deviceManagement
sourceAux	string	Auxiliary source used to synchronize time on the platform	default=null, group=time, set=[NTP, PTP]
ssid	string	Wireless network SSID	max length=255, default=null, group=wan
statsPeriod	integer	Statistics Period of time. The statistics are produced over this period of time	min=-2147483648, max=2147483647, default=null, group=deviceManagement
wanInterfaceTypes	WanInterfaceTypeDto[]	The table containing WAN interfaces by order of priority	default=null, group=wan
whitelist	string	White list definition to access to configuration via SMS or IP call. Each number is separated by a comma. The length is limited to 255 chars	max length=255, default=null, group=deviceManagement
configVpn	string	VPN configuration file content	default=null, group=vpn
eui	string	Gateway EUI	max length=255, default=null
fromDate	integer	Start date (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
hash	string	Configuration hash code	max length=255, default=null
lastSuccessQueryDate	integer	Date of the last success (EPOCH date in ms)	min=-2147483648, max=2147483647, default=null
toDate	integer	End date (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null

GatewayConnectionDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Connection identifier	min=-9223372036854775808, max=9223372036854775807
connected	boolean	true: connected, false: disconnected, null: never connected	default=null
endDate	integer	The end date of the period (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
eui	string	Gateway EUI	max length=255, default=null
failCause	string	Failed cause	max length=255, default=null
ip	string	IP address	max length=255, default=null
networkBearer	string	Network bearer {GSM,ETHERNET,WLAN,UNKNOWN}	max length=255, default=null
startDate	integer	The start date of the period (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null

GatewayControlDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
cpuAlarmHysteresis	integer	CPU alarm hysteresis (%). Used in conjunction with threshold to stop the alarm when CPU is below abs(threshold - hysteres- is)	min=-2147483648, max=2147483647, default=null, group=cpu
cpuAlarmThreshold	integer	CPU alarm threshold [0..100] When reached, a CPU alarm is sent.	min=0, max=100, default=null, group=cpu
diskSystemAlarmHysteresis	integer	Disk system alarm hysteresis. Used in conjunction with threshold to stop the alarm when current disk volume is below abs (threshold - hysteresis)	min=-2147483648, max=2147483647, default=null, group=diskSystem
diskSystemAlarmThreshold	integer	Disk system usage threshold[0..100]. When reached, a disk alarm is sent.	min=0, max=100, default=null, group=diskSystem
diskUserAlarmHysteresis	integer	Disk user alarm hysteresis. Used in conjunction with threshold to stop the alarm when user disk volume is below abs(threshold - hysteresis)	min=-2147483648, max=2147483647, default=null, group=diskUser
diskUserAlarmThreshold	integer	Disk user usage threshold [0..100]. When reached, a disk alarm is sent.	min=0, max=100, default=null, group=diskUser
doorThreshold	integer	Threshold value in lux (illuminance) to detect that the door is open [0..80000]	min=0, max=80000, default=null, group=door
gpsThreshold	integer	Threshold value in seconds to trigger a GPS unlocked alarm [0..3600]	min=0, max=3600, default=null, group=gps
ramAlarmHysteresis	integer	RAM alarm hysteresis. Used in conjunction with threshold to stop the alarm when ram is below abs(threshold - hysteresis)	min=-2147483648, max=2147483647, default=null, group=ram
ramAlarmThreshold	integer	RAM usage threshold. When reached, a RAM alarm is sent	min=0, max=100, default=null, group=ram
rssiAlarmHysteresis	integer	RSSI alarm hysteresis. Used in conjunction with threshold to stop the alarm when rssi value above (threshold + hysteresis). [0..50]	min=0, max=50, default=null, group=rssi
rssiAlarmThreshold	integer	RSSI alarm threshold [-120..-50]. When reached (RSSI value below threshold), a RSSI alarm is sent.	min=-120, max=-50, default=null, group=rssi
temperatureAlarmHysteresis	integer	Temperature alarm hysteresis. Used in conjunction with threshold to stop the alarm when temperature below abs(threshold - hysteresis)	min=-2147483648, max=2147483647, default=null, group=temperature
temperatureAlarmThreshold	integer	Temperature threshold. When reached, a temperature alarm is sent.	min=-2147483648, max=2147483647, default=null, group=temperature
cpuAlarmState	string	Current CPU alarm status from predefined set	default=null, group=cpu, set=[OFF, ON]
cpuCurrent	integer	Current CPU level (in %)	min=-2147483648, max=2147483647, default=null, group=cpu
diskSystemAlarmState	string	Current disk system alarm status from predefined set	default=null, group=diskSystem, set=[OFF, ON]
diskSystemVolumeCurrent	integer	Current storage level of system disk volume (in % of used volume	min=-2147483648, max=2147483647, default=null, group=diskSystem
diskUserAlarmState	string	Current disk user alarm status from predefined set	default=null, group=diskUser, set=[OFF, ON]
diskUserVolumeCurrent	integer	Current storage level of user disk volume (in % of used volume	min=-2147483648, max=2147483647, default=null, group=diskUser
doorStateCurrent	string	Door state from predefined set	default=null, group=door, set=[CLOSED, OPEN]
gpsStatusCurrent	string	GPS state from predefined set	default=null, group=gps, set=[UNLOCKED, LOCKED]
ramAlarmState	string	RAM alarm from prredefined set	default=null, group=ram, set=[OFF, ON]
ramCurrent	integer	Current RAM level. (in % of used memory)	min=-2147483648, max=2147483647, default=null, group=ram
rssiAlarmState	string	GSM RSSI alarm state from predefined set	default=null, group=rssi, set=[OFF, ON]
rssiCurrent	integer	Current GSM RSSI level in dBm. Possible values are -113 dBm to -51 dBm. 0 to indicate not known or not detectable	min=-2147483648, max=2147483647, default=null, group=rssi
systemUptime	integer	Elapsed time since the system is up (in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
temperatureAlarmState	string	Temperature alarm state from predefined set	default=null, group=temperature, set=[OFF, ON]
temperatureCurrent	integer	Current temperature in degrees Celsius.	min=-2147483648, max=2147483647, default=null, group=temperature

GatewayDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
eui	string	Extended Unique Identifier. Value from the 'EUI-64' number space managed by the IEEE	max length=255, regex=[[0-9A-F]{16}]
adaptiveLatencyEnabled	boolean	Enabling adaptive latency
dlAllowed	boolean	Allow or not the downlink
fleet	FleetDto	The fleet which this gateway is attached to. For creation or update, use only the field id.
region	string	LoRaWAN Regional Parameters from predefined set	set=[AS923, AU915, CN470, EU433, KR920, RU864, EU868, CN779, IN865, US915]
visibility	string	Visibility	set=[PUBLIC, PRIVATE]
altitude	integer	Altitude in meters	min=-2147483648, max=2147483647, default=null
brand	BrandDto	Brand (Only the field id must be provided.). For creation or update, use only the field id.	default=null
country	string	Country from predefined set if region= AS923	default=null, set=[JP, VN, ID]
gatewayKeys	LnsGatewayKeyDto[]	List of AES keys DTO	default=null
gpsPositionAllowed	boolean	Authorizes the update of the GPS location default = true	default=true
ip	string	IP address	max length=255, default=null
lastEvents	LastEventDto[]	List of last events	default=null
lastStatistics	LastStatisticDto[]	List of statistics	default=null
latitude	real	Latitude in decimal degrees	min=-90.0, max=90.0, default=null
longitude	real	Longitude in decimal degrees	min=-180.0, max=180.0, default=null
maxTxPower	integer	maximum transmission power (dBm)	min=0, max=38, default=27
name	string	Name	max length=255, default=null
networkMaxDelayDown	integer	Duration of the downstream paquet transfer from LNS (ms)	min=0, max=15000, default=350
networkMaxDelayUp	integer	Duration of the upstream paquet transfer to LNS (ms)	min=0, max=15000, default=350
port	integer	Port	min=-2147483648, max=2147483647, default=null
type	BrandDto	Gateway type managed by the BSC (Only the field id must be provided.). For creation or update, use only the field id.	default=null
bearer	string	Network bearer from predefined set	default=null, set=[GSM, WLAN, ETHERNET, UNKNOWN]
connection	boolean	Connection status (null:never connected, true: connected, false:disconnected	default=null
description	string	General description	max length=255, default=null
door	string	Door state from predefined set	default=null, set=[CLOSED, OPEN]
gps	string	GPS State from predefined set	default=null, set=[UNLOCKED, LOCKED]
gpsAltitude	integer	Altitude from GPS in meters	min=-2147483648, max=2147483647, default=null
gpsLatitude	real	Latitude from GPS in decimal degrees	min=-90.0, max=90.0, default=null
gpsLongitude	real	Longitude from GPS in decimal degrees	min=-180.0, max=180.0, default=null
interfaceVersion	integer	The current interface version of the MIB of the gateway	min=1, max=2147483647, default=null
links	LinkDto[]	createGatewayCommand, createGatewayCpCommand, createGatewayGetFileCommand, createGatewayLsCommand, createGatewayMkDirCommand, createGatewayMvCommand, createGatewayPutFileCommand, createGatewayRmCommand, dataDown, dataUp, gatewayConfigurations, gatewayConnections, gatewayControl, gatewayCurrentConfiguration, gatewayCurrentVersion, gatewayEvents, gatewayLastConfiguration, gatewayLastConnection, gatewayLastEvents, gatewayLastStatistics, gatewayLastVersion, gatewayManagement, gatewayModems, gatewayNumericStatistics, gatewaySnmpLogs, gatewayTermStatistics, gatewayVersions, lastGatewayStatistics, lnsGatewayAesKeys, rncKpis, self

GatewayEventDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Gateway event identifier	min=-9223372036854775808, max=9223372036854775807
createTimeStamp	integer	Date of the event (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
eui	string	gateway EUI	max length=255, default=null
type	string	Event type	default=null, set=[GPS_LOCKED, CPU_OFF, DISK_SYSTEM_ON, PREVIOUS_CONFIG_RESTORATION, AUTOMATIC_SYSTEM_RESTORATION, GPS_NOT_APPLICABLE, POWER_LOST, AUTHENTICATION_FAILURE, CPU_ON, RSSI_ON, TEMPERATURE_OFF, RESTART, DISK_SYSTEM_OFF, SHUTDOWN, DOOR_CLOSED, RAM_OFF, DISK_USER_OFF, RAM_ON, HELLO, DISK_USER_ON, AUTOMATIC_SYSTEM_RESTORATION_FACTORY, DISCONNECTED, TEMPERATURE_ON, DOOR_OPEN, START, CONNECTED, GPS_UNLOCKED, DOOR_NOT_APPLICABLE, RSSI_OFF]
value	integer	Event value	min=-2147483648, max=2147483647, default=null

GatewayInfoDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
altitude	integer	Altitude	min=-2147483648, max=2147483647, default=null
antenna	integer	Antenna	min=-2147483648, max=2147483647, default=null
channel	integer	Channel	min=-2147483648, max=2147483647, default=null
fineTimestamp	integer	Fine timestamp	min=-2147483648, max=2147483647, default=null
frequencyOffset	integer	Frequency Offset	min=-2147483648, max=2147483647, default=null
gwEui	string	Gateway EUI	max length=255, default=null
latitude	real	Latitude	min=-3.4028235E38, max=3.4028235E38, default=null
longitude	real	Longitude	min=-3.4028235E38, max=3.4028235E38, default=null
radioId	integer	Radio Identifier (brd or rfch according to the gateway type)	min=-2147483648, max=2147483647, default=null
rfRegion	string	RF Region	max length=255, default=null
rssi	integer	RSSI	min=-2147483648, max=2147483647, default=null
rssis	integer	RSSIS	min=-2147483648, max=2147483647, default=null
rssisd	integer	RSSID	min=-2147483648, max=2147483647, default=null
snr	real	Signal noise ratio	min=-3.4028235E38, max=3.4028235E38, default=null

GatewayManagementDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
address	string	IP address	max length=255, default=null
addressType	string	Address type from predefined set	default=null, set=[IPV6, IPV4, DNS, IPV6Z, UNKNOWN, IPV4Z]
agentPort	integer	Port number on which agent is listening. By default the value is 161	min=-2147483648, max=2147483647, default=null
managerCommunity	string	Community name used by manager when sending notifications (trap or inform)	max length=255, default=null
managerPort	integer	Port number on which the manager is listening. By default the value is 162	min=-2147483648, max=2147483647, default=null

GatewayModemDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
lanRadioAntennaNumber	integer	Number of antenna	min=-2147483648, max=2147483647, default=null
lanRadioCentralFrequency	integer	Central frequency in Hz	min=-2147483648, max=2147483647, default=null
lanRadioFrontRfHwVersion	string	Font radio frequency version	max length=255, default=null
lanRadioHwVersion	string	Hardware version	max length=255, default=null
lanRadioMaxRxFrequency	integer	Maximum frequency on rx path in Hz	min=-2147483648, max=2147483647, default=null
lanRadioMaxTxFrequency	integer	Maximum frequency on tx path in Hz	min=-2147483648, max=2147483647, default=null
lanRadioMinRxFrequency	integer	Minimum frequency on rx path in Hz	min=-2147483648, max=2147483647, default=null
lanRadioMinTxFrequency	integer	Minimum frequency on tx path in Hz	min=-2147483648, max=2147483647, default=null
lanRadioPathWidth	integer	Width of radio path in kHz	min=-2147483648, max=2147483647, default=null
lanRadioRfFrontInputPathNumber	integer	Number of input radio path	min=-2147483648, max=2147483647, default=null
lanRadioRfPathNumber	integer	Number of radio path	min=-2147483648, max=2147483647, default=null
lanRadioSwVersion	string	Software version	max length=255, default=null
lanRadioType	string	LAN radio type from predefined set	default=null, set=[TYPE_LORA_LOC, TYPE_169_OR_868, TYPE_LORA_MONO, TYPE_LORA_DUAL]
location	integer	Position of the modem on the gateway	min=-2147483648, max=2147483647, default=null
serialNumber	string	Serial Number	max length=255, default=null
links	LinkDto[]	createGatewayModemSpectrum

GatewayModemStatisticDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
date	integer	Date (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
interferers	ModemStatisticInterferDto[]	List of interferers	default=null
scanData	map{integer,map{string,integer}}	Data	default=null

GatewayNumericStatisticsDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
data	map{string,object}	Statitics data	default=null
eui	string	Gateway EUI	max length=255, default=null
timestamp	integer	Date of the statistic (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null

GatewayPositionDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
coordinates	Double[]	Coordinates	default=null
gatewayEui	string	Gateway EUI	max length=255, default=null
timestamp	integer	Specifies the gateway at a certain point in time. (timestamp in seconds)	min=-9223372036854775808, max=9223372036854775807, default=null
type	string	Geometry type	max length=255, default=null

GatewaySnmpLogDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	GatewaySnmpLog Identifier	min=-9223372036854775808, max=9223372036854775807
action	string	Task action from predefined set	default=null, set=[SPECIFIC_COMMAND_ABORT, GATEWAY_DESCRIPTION_CHANGE, NOTIFICATION_FILE_EXCHANGE_ABORT, SET_CONTROLS, RETURN_KO_STATUS, UPDATE_ABORT, ALARM_RSSI, NOTIFICATION_IP_CHANGE, PING_EVENT, NOTIFICATION_POWER_LOST, RETURN_TIMEOUT_STATUS, SPECTRUM_ANALYSIS_STATUS, NETWORK_EVENT, NOTIFICATION_START, GET_CONFIGURATIONS, GATEWAY_IP_PORT_CHANGE, HELLO, GET_CONFIGURATION, NOTIFICATION_AUTHENTICATION_FAILURE, NOTIFICATION_FILE_EXCHANGE_EXECUTE, SET_VALUES, ALARM_DISK_USER, MANAGEMENT_GET_VALUES, STATISTIC, SET_CONFIGURATION, SPECIFIC_COMMAND_EXECUTE, GET_VERSIONS, MANAGEMENT_EXECUTE, GET_HASH_CONFIGURATIONS, ALARM_TEMPERATURE, NOTIFICATION_AUTOMATIC_SYSTEM_RESTORATION, NOTIFICATION_COLD_START, FILE_EXCHANGE_EXECUTE, UPDATE_STATUS, NOTIFICATION_SHUTDOWN, UPDATE_EXECUTE, NOTIFICATION_PREVIOUS_CONFIG_RESTORATION, SIMULATE_ALARM_GPS_EVENT, NOTIFICATION_SPECIFIC_COMMAND_ABORT, GET_VALUES, NOTIFICATION_SPECTRUM_ANALYSIS_EXECUTE, GET_VERSION, NOTIFICATION_SPECIFIC_COMMAND_EXECUTE, GET_HASH_VERSIONS, PING, ALARM_DOOR_EVENT, FILE_EXCHANGE_ABORT, NOTIFICATION_RESTART, NOTIFICATION_SPECTRUM_ANALYSIS_ABORT, GET_CONTROLS, CONNEXION_CHANGE, RETURN_SENDING_STATUS, NOTIFICATION_UPDATE_ABORT, GET_STATISTIC, FILE_EXCHANGE_STATUS, GET_LAN_MODULES, SIMULATE_ALARM_DOOR_EVENT, GET_GATEWAY_DESCRIPTION, NOTIFICATION_AUTOMATIC_SYSTEM_RESTORATION_FACTORY, NOTIFICATION_UPDATE_EXECUTE, SPECTRUM_ANALYSIS_ABORT, ALARM_RAM, SPECIFIC_COMMAND_STATUS, ALARM_GPS, GET_STATISTIC_INDEX, ALARM_DISK_SYSTEM, SPECTRUM_ANALYSIS_EXECUTE, ALARM_CPU]
content	string	Log content	max length=255, default=null
createTimeStamp	integer	Ceation date (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
eui	string	Gateway EUI	max length=255, default=null
origin	string	Origin : {FROM_GATEWAY,TO_GATEWAY}	default=null, set=[FROM_GATEWAY, TO_GATEWAY]
requestId	string	SNMP request identifier	max length=255, default=null
transactionId	string	Transaction identifier. Format : <bsc_key>.<taskId>	max length=255, default=null

GatewayStatisticsDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
abortCrash	integer	Abort crash	min=-2147483648, max=2147483647, default=null
abortReboot	integer	Abort reboot	min=-2147483648, max=2147483647, default=null
ackrAvg	integer	Percentage of uplink messages acknowledged	min=-2147483648, max=2147483647, default=null, group=uplink
bootCause	string	Boot cause	max length=255, default=null
cpuAvg	integer	Average CPU utilization (%)	min=-2147483648, max=2147483647, default=null, group=cpu
cpuHysteresis	integer	CPU alarm hysteresis	min=-2147483648, max=2147483647, default=null, group=cpu
cpuMax	integer	Maximum CPU utilization (%)	min=-2147483648, max=2147483647, default=null, group=cpu
cpuMin	integer	Minimum CPU utilization (%)	min=-2147483648, max=2147483647, default=null, group=cpu
cpuThreshold	integer	CPU alarm threshold (%)	min=-2147483648, max=2147483647, default=null, group=cpu
doorLastClose	integer	Door last closed date (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null, group=door
doorLastOpen	integer	Door last open date (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null, group=door
doorState	string	Door state	max length=255, default=null, group=door
extraDiskHysteresis	integer	Extra disk hysteresis	min=-2147483648, max=2147483647, default=null, group=extra
extraDiskThreshold	integer	Extra disk threshold (%)	min=-2147483648, max=2147483647, default=null, group=extra
extraDiskUsed	integer	Extra disk utilization (%)	min=-2147483648, max=2147483647, default=null, group=extra
fleetId	integer	Fleet identifier	min=-9223372036854775808, max=9223372036854775807, default=null
gpsAltitude	integer	GPS altitude (meters)	min=-2147483648, max=2147483647, default=null, group=gps
gpsLatitude	real	GPS latitude	min=-1.7976931348623157E308, max=1.7976931348623157E308, default=null, group=gps
gpsLockRatio	integer	GPS lock ratio	min=-2147483648, max=2147483647, default=null, group=gps
gpsLongitude	real	GPS longitude	min=-1.7976931348623157E308, max=1.7976931348623157E308, default=null, group=gps
gpsSatellitesNumber	integer	Number of satellites	min=-2147483648, max=2147483647, default=null, group=gps
gpsStatus	string	GPS status	max length=255, default=null, group=gps
gsmAvgRssi	integer	Average GSM RSSI (db)	min=-2147483648, max=2147483647, default=null, group=gsm
gsmMaxRssi	integer	Maximum GSM RSSI (db)	min=-2147483648, max=2147483647, default=null, group=gsm
gsmMinRssi	integer	Minimum GSM RSSI (db)	min=-2147483648, max=2147483647, default=null, group=gsm
gsmRssiHysteresis	integer	GSM RSSI alarm hysteresis	min=-2147483648, max=2147483647, default=null, group=gsm
gsmRssiThreshold	integer	GSM RSSI alarm threshold (db)	min=-2147483648, max=2147483647, default=null, group=gsm
instant	integer	Instant of the statistics (format : YYYYMMDDHH)	min=-2147483648, max=2147483647, default=null
instantInTimestamp	integer	Instant (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
maliciousSshLoginSum	integer	Total number of ssh intrusions	min=-2147483648, max=2147483647, default=null
modemStats	GatewayModemStatisticDto[]	List of GatewayModemStatisticDto	default=null
nbDownlinkMessageSum	integer	Number of downlink messages	min=-9223372036854775808, max=9223372036854775807, default=null, group=downlink
nbUplinkMessageSum	integer	Number of uplink messages	min=-9223372036854775808, max=9223372036854775807, default=null, group=uplink
ramAvg	integer	Average RAM utilization (%)	min=-2147483648, max=2147483647, default=null, group=ram
ramHysteresis	integer	RAM alarm hysteresis	min=-2147483648, max=2147483647, default=null, group=ram
ramMax	integer	Maximum RAM utilization (%)	min=-2147483648, max=2147483647, default=null, group=ram
ramMin	integer	Minimum RAM utilization (%)	min=-2147483648, max=2147483647, default=null, group=ram
ramThreshold	integer	RAM alarm threshold (%)	min=-2147483648, max=2147483647, default=null, group=ram
restartSum	integer	Number of packet forwarder restarts during the period	min=-9223372036854775808, max=9223372036854775807, default=null, group=packetForwarder
rollTimestamp	integer	Roll timestamp (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
rxperAvg	integer	Percentage of uplink messages in error	min=-2147483648, max=2147483647, default=null, group=uplink
sizeDownlinkSum	integer	Size of downlink (byte)	min=-9223372036854775808, max=9223372036854775807, default=null, group=downlink
sizeUplinkSum	integer	Size of uplink (byte)	min=-9223372036854775808, max=9223372036854775807, default=null, group=uplink
startNumber	integer	Start number	min=-2147483648, max=2147483647, default=null
supplyPowerMilliVolts	integer	Power suplly (mv)	min=-2147483648, max=2147483647, default=null, group=supply
supplyPowerSource	string	Power source {MAIN, AUX}	max length=255, default=null, group=supply
systemDiskHysteresis	integer	System disk hysteresis	min=-2147483648, max=2147483647, default=null, group=system
systemDiskThreshold	integer	System disk threshold (%)	min=-2147483648, max=2147483647, default=null, group=system
systemDiskUsed	integer	System disk utilization (%)	min=-2147483648, max=2147483647, default=null, group=system
temperatureAvg	integer	Average temperature utilization (%)	min=-2147483648, max=2147483647, default=null, group=temperature
temperatureHysteresis	integer	Temperature alarm hysteresis	min=-2147483648, max=2147483647, default=null, group=temperature
temperatureMax	integer	Maximum temperature utilization (%)	min=-2147483648, max=2147483647, default=null, group=temperature
temperatureMin	integer	Minimum temperature utilization (%)	min=-2147483648, max=2147483647, default=null, group=temperature
temperatureThreshold	integer	Temperature alarm threshold (%)	min=-2147483648, max=2147483647, default=null, group=temperature
uptimeAvg	integer	Packet forwarder uptime (ms)	min=-9223372036854775808, max=9223372036854775807, default=null, group=packetForwarder
userDiskHysteresis	integer	User disk hysteresis	min=-2147483648, max=2147483647, default=null, group=user
userDiskThreshold	integer	User disk threshold (%)	min=-2147483648, max=2147483647, default=null, group=user
userDiskUsed	integer	User disk utilization (%)	min=-2147483648, max=2147483647, default=null, group=user

GatewayTermStatisticsDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
data	map{string,map{string,integer}}	Statitics data	default=null
eui	string	Gateway EUI	max length=255, default=null
timestamp	integer	Date of the statistic (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null

GatewayVersionDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
eui	string	Gateway EUI	max length=255, default=null
fromDate	integer	Start date (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
hash	string	HASH code	max length=255, default=null
lastSuccessQueryDate	integer	Last query date (EPOCH date in ms)	min=-2147483648, max=2147483647, default=null
toDate	integer	End date (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
versions	VersionDto[]	List of versions	default=null

GatewaysStatisticDto

FIELD	TYPE	DESCRIPTION	CONTROLS	CONSTRAINTS
metricName	string	Metric name		max length=255, default=null
numericStatistics	NumericStatisticDto[]	List of NumericStatisticDto		default=null

GsmOperatorDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
operatorApn	string	Access Point Name (APN)	max length=255, default=null, group=wan
operatorLogin	string	Login of Packet Data Protocol (PDP) context	max length=255, default=null, group=wan
operatorMcc	string	Mobile Country Code (MCC) of the operator. Null if gateway.interfaceVersion = 3, mandatory otherwise	max length=255, default=null, group=wan
operatorMnc	string	Mobile Network Code (MNC) of the operator. Null if gateway.interfaceVersion = 3, mandatory otherwise	max length=255, default=null, group=wan
operatorPassword	string	Password of Packet Data Protocol (PDP) context	max length=255, default=null, group=wan
operatorPinCode	string	Pin code of SIM card (format: empty or 4 to 8 digits). Used only if gateway.interfaceVersion = 3, null otherwise	max length=255, default=null, group=wan

InstanceDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	string		max length=255
deleteReason	string		max length=255, default=null
deploymentId	string		max length=255, default=null
description	string		max length=255, default=null
durationInMillis	integer		min=-9223372036854775808, max=9223372036854775807, default=null
endActivityId	string		max length=255, default=null
endTime	date		default=null
name	string		max length=255, default=null
processId	string		max length=255, default=null
processVariables	map{string,object}		default=null
startActivityId	string		max length=255, default=null
startTime	date		default=null
startUserId	string		max length=255, default=null
status	string		max length=255, default=null
superProcessInstanceId	string		max length=255, default=null
templateId	string		max length=255, default=null
templateName	string		max length=255, default=null
tenantId	string		max length=255, default=null
links	LinkDto[]	self, workflowInstanceActivities

ItemDto

FIELD	TYPE	DESCRIPTION	CONTROLS	CONSTRAINTS
id	integer	Identifier		min=-9223372036854775808, max=9223372036854775807
key	string	Key depends on SelectionDto.type value : END_DEVICE (EndDeviceDto.devEui), GATEWAY (GatewayDto.eui)		max length=255

JwtDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
expiredDate	integer	Expiration date (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
token	string	Token value	max length=255, default=null
tokenType	string	Type (BEARER)	max length=255, default=null

KpiDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
avg	real	Average value of the KPI	min=-1.7976931348623157E308, max=1.7976931348623157E308, default=null
customerId	integer	Customer identifier	min=-9223372036854775808, max=9223372036854775807, default=null
endDeviceEui	string	End-device EUI	max length=255, default=null
frq	string	Frequency	max length=255, default=null
gatewayEui	string	Gateway EUI	max length=255, default=null
max	real	Maximum value of the KPI	min=-1.7976931348623157E308, max=1.7976931348623157E308, default=null
min	real	Minimum value of the KPI	min=-1.7976931348623157E308, max=1.7976931348623157E308, default=null
ratio	real	Ratio value of the KPI on the current period	min=-1.7976931348623157E308, max=1.7976931348623157E308, default=null
sf	string	Spreading factor	max length=255, default=null
time	integer	Time of the event in timestamp milliseconds	min=-9223372036854775808, max=9223372036854775807, default=null
value	real	KPI value	min=-1.7976931348623157E308, max=1.7976931348623157E308, default=null

LastEventCounterDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Identifier	min=-9223372036854775808, max=9223372036854775807
count	integer	Number of unread last events with this type, for the fleet	min=-2147483648, max=2147483647, default=null
fleet	FleetDto	Fleet DTO	default=null
name	string	LastEvent Name	max length=255, default=null
type	string	LastEvent type from predefined set	default=null, set=[NOTIFICATION, ALARM]

LastEventDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Identifier	min=-9223372036854775808, max=9223372036854775807
read	boolean	true : read, false : not read	set=[false, true]
date	integer	Date (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
domain	string	Domain	max length=255, default=null
gateway	GatewayDto	Gateway	default=null
name	string	AUTOMATIC_SYSTEM_RESTORATION : system has been automatically restored (NOTIFICATION), AUTOMATIC_SYSTEM_RESTORATION_FACTORY : system has been automatically restored to its factory settings (NOTIFICATION), HELLO : sent every 24 hours to notify the presence of the gateway (NOTIFICATION), PREVIOUS_CONFIG_RESTORATION : previous configuration has been restored (NOTIFICATION), RESTART : SNMP agent has been restarted (NOTIFICATION), START : SNMP agent has started running (NOTIFICATION), POWER_LOST : power has been lost (ALARM), SHUTDOWN : SNMP agent is in the process of being shut down (ALARM), CONNECTION : gateway is connected/disconnected (NOTIFICATION/ALARM), CPU : gateway CPU alarm is OFF/ON (NOTIFICATION/ALARM), DOOR : gateway door is CLOSED/OPEN (NOTIFICATION/ALARM), GPS : gateway GPS is locked/unlocked (NOTIFICATION/ALARM), RAM : gateway RAM alarm is OFF/ON (NOTIFICATION/ALARM), RSSI : gateway RSSI alarm is OFF/ON (NOTIFICATION/ALARM), SYSTEM_DISK : gateway system disk alarm is OFF/ON (NOTIFICATION/ALARM), TEMPERATURE : gateway temperature alarm is OFF/ON (NOTIFICATION/ALARM), USER_DISK : gateway user disk alarm is OFF/ON (NOTIFICATION/ALARM)	default=null, set=[USER_DISK, SYSTEM_DISK, HELLO, CPU, AUTOMATIC_SYSTEM_RESTORATION_FACTORY, GPS, PREVIOUS_CONFIG_RESTORATION, AUTOMATIC_SYSTEM_RESTORATION, DOOR, POWER_LOST, CONNECTION, RSSI, TEMPERATURE, RESTART, START, SHUTDOWN, RAM]
type	string	Type from predefined set	default=null, set=[NOTIFICATION, ALARM]
value	string	Value	max length=255, default=null
links	LinkDto[]	self

LastOperationDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Identifier	min=-9223372036854775808, max=9223372036854775807
date	integer	Date (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
gateway	GatewayDto	Gateway DTO	default=null
status	string	Status from predefined set	default=null, set=[CANCELLED, KO, PENDING, OK]
transactionId	string	Task transaction identifier	max length=255, default=null
type	string	Type from predefined set	default=null, set=[SET_MANAGEMENT, SPECIFIC_COMMAND, SET_CONTROLS, GET_CONFIGURATION, UPDATE_FIRMWARE, GET_LAN_MODULES, GET_MANAGEMENT, GET_VALUES, SET_VALUES, SPECTRUM_ANALYSIS, FILE_EXCHANGE, SET_CONFIGURATION, GET_CONTROLS, GET_VERSIONS]
links	LinkDto[]	gateway, taskSnmpLogs

LastStatisticDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Identifier	min=-9223372036854775808, max=9223372036854775807
average	real	Average value	min=-1.7976931348623157E308, max=1.7976931348623157E308, default=null
date	integer	Date (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
gateway	GatewayDto	Gateway DTO	default=null
max	real	Maximum value	min=-1.7976931348623157E308, max=1.7976931348623157E308, default=null
min	real	Minimum value	min=-1.7976931348623157E308, max=1.7976931348623157E308, default=null
name	string	Name from predefined set	default=null, set=[USER_DISK, SYSTEM_DISK, LONGITUDE, CPU, SUPPLY_POWER_MILLI_VOLT, ALTITUDE, RSSI, GPS_LOCK_RATIO, TEMPERATURE, EXTRA_DISK, LATITUDE, GPS_SATELLITES_NUMBER, RAM]
links	LinkDto[]	gateway

LicenseDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
expirationDate	integer	Expiration date (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
maxEndDevices	integer	Maximum number of end-devices per customer	min=-2147483648, max=2147483647, default=null
maxGateways	integer	Maximum number of gateways per customer	min=-2147483648, max=2147483647, default=null
maxUsers	integer	Maximum number of users per customer	min=-2147483648, max=2147483647, default=null
official	boolean	Indicates if the license is an official one	default=null
validError	ErrorDto	Error DTO	default=null

LinkDto

FIELD	TYPE	DESCRIPTION	CONTROLS	CONSTRAINTS
href	string	Relative path to the resource		max length=255, default=null
rel	string	Name of the resource		max length=255, default=null

LnsCustomerLastEventsCountersDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
clusterAlarms	integer	Number of cluster alarms	min=-2147483648, max=2147483647, default=null
clusterNotifications	integer	Number of cluster notifications	min=-2147483648, max=2147483647, default=null
clusters	ClusterCountersDto[]	Cluster counters DTO	default=null
customer	CustomerDto	Customer DTO	default=null

LnsCustomersLastEventsCountersDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
clusterAlarms	integer	Number of cluster alarms	min=-2147483648, max=2147483647, default=null
clusterNotifications	integer	Number of cluster notifications	min=-2147483648, max=2147483647, default=null
customers	LnsCustomerLastEventsCountersDto[]	List of LnsCustomerLastEventsCounters DTO	default=null

LnsEventDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	string	Identifier	max length=255
read	boolean	true: read, false: not read	set=[false, true]
date	integer	Date (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
eui	string	Device EUI	max length=255, default=null
name	string	Name	default=null, set=[DATADOWN_FCNTDOWN_ERR, DOWNLINK_UNABLE_TO_SEND, PUSH_SERVER_ERR, JOIN_SUCCESS, DATADOWN_GW_NACK, PUSH_NOT_FOUND, JOIN_MIC_ERR, PUSH_TIMEOUT, DATADOWN_TIMEOUT, DATAUP_SUCCESS, DATADOWN_MAXATTEMPTS, JOIN_DEVADDR_ERR, PUSH_AUTH_FAILED, JOIN_DEVNONCE_ERR, DATAUP_MIC_ERR]
type	string	Type from predefined set	default=null, set=[NOTIFICATION, ALARM]
value	string	Value	max length=255, default=null
links	LinkDto[]	self

LnsGatewayKeyDto

FIELD	TYPE	DESCRIPTION	CONTROLS	CONSTRAINTS
aesKey	string	AES 128 Key used to decrypt the fine timestamp		min length=32, max length=32, regex=[[0-9A-F]{32}], default=null
index	integer	Index of the key used by the gateway to encrypt the fine timestamp		min=0, max=256, default=null

MetaDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
fields	MetaFieldDto[]	List of MetaFieldDto	default=null
name	string	DTO name	max length=255, default=null
revisions	RevisionDto[]	List of revisions	default=null
links	LinkDto[]	self

MetaFieldDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
authorized	boolean	True if the field can be provided in the request body	default=null
defaultValue	object	Default value	default=null
description	string	Description	max length=255, default=null
group	string	Group name	max length=255, default=null
mandatory	boolean	True for a mandatory field (a not null value)	default=null
max	string	Maximum field value	max length=255, default=null
maxLength	integer	Maximum length of the field value	min=-2147483648, max=2147483647, default=null
min	string	Minimum field value	max length=255, default=null
minLength	integer	Minimum length of the field value (example minLength=1 means that the field cannot be empty)	min=-2147483648, max=2147483647, default=null
name	string	Name	max length=255, default=null
primaryKey	boolean	true: the field is a primary key, false otherwise	default=null
regex	string	List of regex to apply to the field for validatin its value	max length=255, default=null
revisions	RevisionDto[]	List of revisions	default=null
searchable	boolean	true: it is possible to search on this field, false otherwise	default=null
set	string	Finite set of possible values for a field. Example : ["A", "B", "C"]	max length=255, default=null
sortable	boolean	true: it is possible to sort on this field, false otherwise	default=null
type	string	Type from predefined set	default=null, set=[boolean, string, list<?>, integer, real, object]
write	boolean	Defines the authorization to write the field according to the role	default=null

ModemStatisticInterferDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
dutyCycle	integer	Interferer duty cycle	min=-9223372036854775808, max=9223372036854775807, default=null
frequencyMax	integer	Interferer maximum frequency (Hz)	min=-9223372036854775808, max=9223372036854775807, default=null
frequencyMin	integer	Interferer minimum frequency (Hz)	min=-9223372036854775808, max=9223372036854775807, default=null
powerAvg	integer	Interferer average power (dBm)	min=-9223372036854775808, max=9223372036854775807, default=null
powerMax	integer	Interferer maximum power (dBm)	min=-9223372036854775808, max=9223372036854775807, default=null

MulticastDataDownDlParametersDto

FIELD	TYPE	DESCRIPTION	CONTROLS	CONSTRAINTS
dataRate	string	Data rate		max length=255, default=null
freq	real	Frequency in MHz		min=0, max=999.9999, default=null

MulticastDataDownDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	string	Identifier	max length=255
contentType	string	Content type	set=[HEXA, TEXT]
fPort	integer	Port	min=0, max=223
mcGroup	MulticastGroupDto	MulticasGroup which the multicastDataDown belongs to. Searchable and sortable fields : mcGroup.id. For creation or update, use only the field id.
payload	string	Content (base64 or hexa if clusterDto.hexa = true)	max length=255
confirmed	boolean	Confirmed indicator	default=null
encodingType	string	Encoding type from predefined set	default=null, set=[BASE64, HEXA]
event	string	Last event from predifined set	default=null, set=[MAX_ATTEMPTED, CREATED, EXPIRED, IN PROGRESS, INTERNAL_ERROR, ACKED, ROAMING_UNSENT, GATEWAY_SELECTED, NOT_ACKED, SENT]
fCntDown	integer	Frame counter downlink	min=-2147483648, max=2147483647, default=null
historic	DataDownStatusDto[]	Historic of datadown status	default=null
maxAttempts	integer	Maximum of attempts	min=-2147483648, max=2147483647, default=null
nbAttempts	integer	Number of attempts	min=-2147483648, max=2147483647, default=null
paths	MulticastDataDownPathDto[]	list of paths	default=null
status	string	Status from predefined set	default=null, set=[KO, PENDING, OK]
timestamp	integer	Creation date (EPOCH ms)	min=-9223372036854775808, max=9223372036854775807, default=null
ttl	integer	Time To Live in seconds	min=-2147483648, max=2147483647, default=null
links	LinkDto[]	self

MulticastDataDownPathDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
dlParameters	MulticastDataDownDlParametersDto[]	Downlink parameters	default=null
gwEui	string	Gateway EUI	max length=255, default=null
historic	DataDownStatusDto[]	Gateway status historic	default=null
status	string	Last message status from predefined set	default=null, set=[KO, PENDING, OK]

MulticastGroupDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Identifier	min=-9223372036854775808, max=9223372036854775807
appSKey	string	AES 128 application session key	max length=255, regex=[[0-9A-F]{32}]
cluster	ClusterDto	Cluster which the multicastGroup belongs to. For creation or update, use only the field id.
dataRate	string	Data rate. SFxxBWyyy with xx from 7 to 12, yyy = 125/250/500 with LoRa modulation or 50000 with FSK modulation. Depends on rfRegion	max length=255
fcntDown	integer	Next frame counter value of the multicast downlink to be sent by the server for this group	min=0, max=9223372036854775807
freq	real	Frequency to use in Hz	min=0, max=999.9999
macVersion	string	Mac version from predefined set	set=[1.0.3, 1.0.1, 1.1.0, 1.0.2]
mcAddr	string	Mac address	max length=255
nwkSKey	string	AES 128 network session key	max length=255, regex=[[0-9A-F]{32}]
regParamsRevision	string	Regional parameters revision from predefined set	set=[A, B, C]
rfRegion	string	RF region from list of regions	max length=255
country	string	Country from predefined set if rfRegion= AS923	default=null, set=[JP, VN, ID]
endDevices	String[]	List of end-devices EUI	default=null
name	string	Name	max length=255, default=null
links	LinkDto[]	cluster, multicastDataDown, self

NumericStatisticDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
max	integer	Maximum range value	min=-2147483648, max=2147483647, default=null
min	integer	Minimum range value	min=-2147483648, max=2147483647, default=null
value	integer	Statistic value	min=-2147483648, max=2147483647, default=null

PaginatedDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
count	integer	The number of elements in the page	min=-2147483648, max=2147483647, default=null
list	T[]	The elements of the page	default=null
nbPages	integer	Number of pages	min=-2147483648, max=2147483647, default=null
page	integer	Page number	min=1, max=2147483647, default=1
pageSize	integer	Page size	min=1, max=2147483647, default=50
totalCount	integer	The total number of elements	min=-9223372036854775808, max=9223372036854775807, default=null
links	LinkDto[]	first, last, next, previous

ProcessDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	string		max length=255
endTime	date		default=null
nbFail	integer		min=-2147483648, max=2147483647, default=null
nbPending	integer		min=-2147483648, max=2147483647, default=null
nbSuccess	integer		min=-2147483648, max=2147483647, default=null
startTime	date		default=null
templateId	string		max length=255, default=null
templateName	string		max length=255, default=null
links	LinkDto[]	workflowProcessInstances

ProgressMonitorDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
accessDate	integer	Date of access to the monitor by a user (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
creationDate	integer	Creation date of the monitor (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
currentDate	integer	Date of the treatment of the current element (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
done	integer	Number of elements treated	min=-2147483648, max=2147483647, default=null
endDate	integer	End date of the progress monitor (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
error	ErrorDto	The error if the status is KO	default=null
result	object	A representation of the web service result	default=null
startDate	integer	Start date of the progress monitor (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
status	string	Status in predefined set	default=null, set=[IN_PROGRESS, KO, OK]
total	integer	Total number of elements to treat	min=-2147483648, max=2147483647, default=null

PushConfigurationDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Identifier	min=-9223372036854775808, max=9223372036854775807
customer	CustomerDto	The customer who this pushConfiguration belongs to. Sort and search available on id. For creation or update, use only the field id.
msgDetailLevel	string	Message detail level from predefined set	set=[NETWORK, PAYLOAD, RADIO]
name	string	Name	max length=255
type	string	Type from predefined set	set=[MQTT, HTTP, WEBSOCKET]
headers	PushConfigurationHeaderDto[]	custom headers for HTTP / WS connections	default=null
httpDataDownEventRoute	string	Default '/dataDownEvent'	max length=255, default=null
httpDataUpRoute	string	Customize dataUp push route. Default '/dataUp'.	max length=255, default=null
mqttCleanSession	boolean	MQTT clean session flag. Default to true	default=null
mqttClientId	string	if no provided, a random id will be generated	max length=255, default=null
mqttConnectTimeout	integer	MQTT timeout in seconds. Default to 30 s	min=-2147483648, max=2147483647, default=null
mqttDataDownEventTopic	string	Default '/dataDownEvent'	max length=255, default=null
mqttDataUpTopic	string	customize dataUp push route, this path can be dynamic. Default '/dataUp'. Supports push to topic based on string interpolation. A string surrounded by '%' are replaced by the corresponding dto field, supported names are : %deveui% (endDevice.DevEui), %devaddr% (endDevice.DevAddr), %clusterid% (Cluster ID), %fport% (fPort). !!Note that because empty payloads can be pushed, fport can be null. In this case, a payload with a dataUp Topic configuration push/%fport% will be pushed to push/null	max length=255, default=null
mqttHost	string	broker Address / Hostname. Mandatory if type is MQTT. Mandatory if type = MQTT	max length=255, default=null
mqttKeepAlive	integer	MQTT keep alive in seconds. Default to 30 s	min=-2147483648, max=2147483647, default=null
mqttPassword	string	MQTT password	max length=255, default=null
mqttPort	integer	default to 1883 (dash). Mandatory if type is MQTT	min=-2147483648, max=2147483647, default=null
mqttQoS	integer	MQTT quality of service from predefined set (dash, default 0). Mandatory if type = MQTT	min=-2147483648, max=2147483647, default=null, set=[0, 1, 2]
mqttTlsEnabled	boolean	Use SSL/TLS secure connection	default=null
mqttUser	string	MQTT user	max length=255, default=null
mqttWillPayload	string	Will message payload	max length=255, default=null
mqttWillQoS	integer	Will message QoS from predefined set	min=-2147483648, max=2147483647, default=null
mqttWillTopic	string	Will message topic	max length=255, default=null
password	string	HTTP / WS password, for BasicAuth authentication, mandatory if user is set	max length=255, default=null
tlsCaFileName	string	TLS CA file Name if set	max length=255, default=null
tlsCertFileName	string	TLS Cert file Name if TLS is set	max length=255, default=null
tlsKeyFileName	string	TLS Private Key file Name if set	max length=255, default=null
url	string	URL where the data will be pushed. Used for HTTP and WS, includes protocol scheme (i.e. http://). Mandatory if type is HTTP or WEBSOCKET	max length=255, default=null
user	string	HTTP / WS user, for BasicAuth authentication	max length=255, default=null
links	LinkDto[]	customer, pushConfigurationHealth, self

PushConfigurationHeaderDto

FIELD	TYPE	DESCRIPTION	CONTROLS	CONSTRAINTS
key	string	Header name		max length=255
value	string	Header value		max length=255

PushConfigurationHealthDto

FIELD	TYPE	DESCRIPTION	CONTROLS	CONSTRAINTS
message	string	Error message describing the reason of fail result		default=null
success	boolean	Indicator of success or fail		default=null

PushDataDownEventDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
clusterId	integer	Cluster identifier	min=-9223372036854775808, max=9223372036854775807, default=null
dataDownId	string	dataDown identifier	max length=255, default=null
event	string	Event which has produced the status update	max length=255, default=null
multicast	boolean	true for multicast, false for unicast	default=null
nbAttempts	integer	Number of send attempts	min=-2147483648, max=2147483647, default=null
status	string	Status from predefined set	default=null, set=[IN_PROGRESS, KO, OK]

PushDataUpDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	string	Identifier	max length=255
adr	boolean	Adaptative data rate	default=null
classB	boolean	true if end-device operates as a class B	default=null
codingRate	string		max length=255, default=null
confirmed	boolean		default=null
dataRate	string	Data rate	max length=255, default=null
delayed	boolean	true if Uplink sent by gateway after buffering	default=null
encodingType		Encoding type from predefined set	default=null, set=[BASE64, HEXA]
encrypted	boolean	Encrypted	default=null
endDevice	EndDeviceDto	End-device which the dataUp belongs to	default=null
fCntDown	integer	Frame counter downlink	min=-2147483648, max=2147483647, default=null
fCntUp	integer	Frame counter uplink	min=-2147483648, max=2147483647, default=null
fPort	integer	Port	min=-2147483648, max=2147483647, default=null
gwCnt	integer		min=-2147483648, max=2147483647, default=null
gwInfo	GatewayInfoDto[]		default=null
gwRecvTime	integer	If uplink is delayed, Gateway receive time if not delayed Lns receive time	min=-9223372036854775808, max=9223372036854775807, default=null
modulation	string		max length=255, default=null
payload	string	Content (base64 or hexa if clusterDto.hexa = true)	max length=255, default=null
recvTime	integer	Lns receive time	min=-9223372036854775808, max=9223372036854775807, default=null
ulFrequency	real	Transmission frequency in MHz	min=0, max=999.9999, default=null

RevisionDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Identifier	min=-9223372036854775808, max=9223372036854775807
action	string	Action from predefined set	default=null, set=[ADDED, UPDATED, DELETED, DEPRECATED]
breakingChange	boolean	Indicates if the revision results in a breaking change	default=null
description	string	Description	max length=255, default=null
origin	string	The web service or the DTO at the origin of the revision	max length=255, default=null
property	string	Property concerned by the revision	max length=255, default=null
webServices	string	Web services name concerned by the revision	max length=255, default=null

RncCustomerLastEventsCountersDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
endDeviceAlarmsCount	integer	Number of end-devices alarms	min=-2147483648, max=2147483647, default=null
endDeviceNotificationsCount	integer	Number of end-devices notifications	min=-2147483648, max=2147483647, default=null
gatewayAlarmsCount	integer	Number of gateways alarms	min=-2147483648, max=2147483647, default=null
gatewayNotificationsCount	integer	Number of gateways notifications	min=-2147483648, max=2147483647, default=null

RncGatewayEventDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
category1	string	First category among the gateway. The value depends on the event type. type = FRQ_DUTY_CYCLE => The channel frequency (example: ?868.1?)	max length=255, default=null
customerId	integer	Customer identifier	min=-9223372036854775808, max=9223372036854775807, default=null
eui	string	Gateway EUI	max length=255, default=null
instant	integer	Time of the event in timestamp milliseconds	min=-9223372036854775808, max=9223372036854775807, default=null
name	string	Name from predefined set	default=null, set=[FRQ_DUTY_CYCLE]
type	string	Type from predefined set	default=null, set=[NOTIFICATION, ALARM]
value	string	Value	max length=255, default=null

RncGatewayLastEventDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Identifier	min=-9223372036854775808, max=9223372036854775807
read	boolean	true: read, false: not read	set=[false, true]
category1	string	First category among the gateway. The value depends on the event type. type = FRQ_DUTY_CYCLE => The channel frequency (example: ?868.1?)	max length=255, default=null
customerId	integer	Customer identifier	min=-9223372036854775808, max=9223372036854775807, default=null
eui	string	Gateway EUI	max length=255, default=null
fleetId	integer	Fleet identifier	min=-9223372036854775808, max=9223372036854775807, default=null
name	string	Name from predefined set	default=null, set=[FRQ_DUTY_CYCLE]
time	integer	Time of the event in timestamp milliseconds	min=-9223372036854775808, max=9223372036854775807, default=null
type	string	Type from predefined set	default=null, set=[GPS_LOCKED, CPU_OFF, DISK_SYSTEM_ON, PREVIOUS_CONFIG_RESTORATION, AUTOMATIC_SYSTEM_RESTORATION, GPS_NOT_APPLICABLE, POWER_LOST, AUTHENTICATION_FAILURE, CPU_ON, RSSI_ON, TEMPERATURE_OFF, RESTART, DISK_SYSTEM_OFF, SHUTDOWN, DOOR_CLOSED, RAM_OFF, DISK_USER_OFF, RAM_ON, HELLO, DISK_USER_ON, AUTOMATIC_SYSTEM_RESTORATION_FACTORY, DISCONNECTED, TEMPERATURE_ON, DOOR_OPEN, START, CONNECTED, GPS_UNLOCKED, DOOR_NOT_APPLICABLE, RSSI_OFF]
value	string	Value	max length=255, default=null

RoleDto

FIELD	TYPE	DESCRIPTION	CONTROLS	CONSTRAINTS
level	integer	Level		min=0, max=40
name	string	Name from predefined set		min length=1, set=[SUPER_ADMIN, READER, ADMIN, USER]

SelectionDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Identifier	min=-9223372036854775808, max=9223372036854775807
name	string	Name	max length=255
type	string	Type from predefined set	set=[GATEWAY, END_DEVICE]
user	UserDto	User who manage this selection. For creation or update, use only the field id.
description	string	description	max length=255, default=null
items	ItemDto[]	List of Item DTO	default=null
count	integer	Number of DTO in the list of items	min=-2147483648, max=2147483647, default=null
dtos	Dto[]	List of DTO	default=null
links	LinkDto[]	self

SpectrumDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Identifier	min=-9223372036854775808, max=9223372036854775807
date	integer	Ceation date (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
duration	integer	Duration of the spectrum analysis in seconds	min=-2147483648, max=2147483647, default=null
gateway	GatewayDto	The gateway which this spectrum belongs to	default=null
modem	string	Modem serial number	max length=255, default=null
status	string	Task status	default=null, set=[KO, PENDING, OK]
links	LinkDto[]	self, spectrumFile

StatsDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
nbClusters	integer	Count of clusters	min=-2147483648, max=2147483647, default=null
nbCustomers	integer	Count of customers	min=-2147483648, max=2147483647, default=null
nbEndDevices	integer	Count of end-devices	min=-2147483648, max=2147483647, default=null
nbFleets	integer	Count of fleets	min=-2147483648, max=2147483647, default=null
nbGateways	integer	Count of gateways	min=-2147483648, max=2147483647, default=null
nbMulticastGroups	integer	Count of multicast groups	min=-2147483648, max=2147483647, default=null
nbUsers	integer	Count of users	min=-2147483648, max=2147483647, default=null

TaskDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Identifier	min=-9223372036854775808, max=9223372036854775807
action	string	Task predefined action	max length=255, default=null
callerPath	string	Path of the caller	max length=255, default=null
creationDate	integer	Creation date	min=-9223372036854775808, max=9223372036854775807, default=null
criteria	map{string,String}	Map of criteria for retrieving tasks	default=null
errorCode	string	Message describing the task status	max length=255, default=null
errorMessage	string	Error message	max length=255, default=null
eui	string	Gateway EUI	max length=255, default=null
message	string	Message describing the task status	max length=255, default=null
receivedParameters	string	Received parameters	max length=255, default=null
sendParameters	map{string,String}	Sent parameters	default=null
status	string	Task status	max length=255, default=null
links	LinkDto[]	self, taskMessages, taskSnmpLogs

TaskMessageDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Identifier	min=-9223372036854775808, max=9223372036854775807
date	integer	Date (EPOCH Date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
location	string	Location within the step. Examples: Message sending to equipment, RouterService.routeToApplication()	max length=255, default=null
message	string	Mesage	max length=255, default=null
next	boolean	True for executing next step, false otherwhise	default=null
step	string	Step from predefined set	default=null, set=[SEND_TO_EQUIPMENT, ROUTING_TO_APPLICATION, ROUTING_TO_EQUIPMENT, RECEIVED_FROM_APPLICATION, RECEIVED_FROM_EQUIPMENT]

TemplateDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	string		max length=255
category	string		max length=255, default=null
deploymentId	string		max length=255, default=null
description	string		max length=255, default=null
diagramResourceName	string		max length=255, default=null
engineVersion	string		max length=255, default=null
hasStartFormKey	boolean		default=null
isGraphicalNotationDefined	boolean		default=null
key	string		max length=255, default=null
name	string		max length=255, default=null
processVariables	map{string,object}		default=null
resourceName	string		max length=255, default=null
suspended	boolean		default=null
tenantId	string		max length=255, default=null
version	integer		min=-2147483648, max=2147483647, default=null
xmlB64	string		max length=255, default=null
links	LinkDto[]	self

UserDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Identifier	min=-9223372036854775808, max=9223372036854775807
customer	CustomerDto	Customer DTO. For creation or update, use only the field id.
email	string	Email	min length=1, max length=255, regex=[^[_A-Za-z0-9-\+]+(\.[_A-Za-z0-9-]+)@[A-Za-z0-9-]+(\.[A-Za-z0-9]+)(\.[A-Za-z]{2,})$]
login	string	Login. This field cannot be patched.	min length=1, max length=255
password	string	Password	min length=1, max length=255
role	string	Role from predefined set	set=[SUPER_ADMIN, READER, ADMIN, USER]
avatar	string	Avatar	max length=255, default=null
enabled	boolean	Enabled means that the user can use the authenticated web services. Default to true	default=null
expirationDate	integer	Expiration date (EPOCH date in ms). Default to null which means no limit	min=-9223372036854775808, max=9223372036854775807, default=null
firstName	string	First name	max length=255, default=null
lastName	string	Last name	max length=255, default=null
phone	string	Phone	max length=255, default=null
requestMaxRate	integer	Maximum number of requests per second	min=-2147483648, max=2147483647, default=null
requestMaxRateDuration	integer	Duration of maximum number of requests exceeding in seconds	min=-2147483648, max=2147483647, default=null
validated	boolean	indicates if the email address has been validated	default=null
links	LinkDto[]	customer, self, validationEmail

VersionDto

FIELD	TYPE	DESCRIPTION	CONTROLS	CONSTRAINTS
description	string	Version number		max length=255, default=null
index	integer	Table index number		min=-2147483648, max=2147483647, default=null

WanInterfaceTypeDto

FIELD	TYPE	DESCRIPTION	CONTROLS	CONSTRAINTS
index	integer	Table index		min=-2147483648, max=2147483647, default=null
wanInterfaceType	string	Type from predefined set		default=null, set=[GSM, WLAN, ETHERNET]

WebServiceDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
name	string	Web service name	max length=255
asynchronous	boolean	True if the web service is asynchronous	default=null
asynchronousReturnType	string	The Dto returned by the asynchronous web service	max length=255, default=null
description	string	General description of the web service	max length=255, default=null
method	string	Method from predefined set	default=null, set=[DELETE, POST, GET, PUT, PATCH]
modificationDate	integer	Date of last modification of the web service (EPOCH date in ms)	min=-9223372036854775808, max=9223372036854775807, default=null
parameters	WebServiceParameterDto[]	Web service parameters	default=null
path	string	relative path	max length=255, default=null
returnType	string	The Dto returned by the web service	max length=255, default=null
revisions	RevisionDto[]	List of revisions	default=null
role	string	The required role for using the web service, from predefined set	default=null, set=[SUPER_ADMIN, READER, ADMIN, USER]
rules	string	Rules to apply to the web service	max length=255, default=null
scope	string	Scope from predefined set	default=null, set=[PUBLIC, PRIVATE]
since	string	The version since this web service exists	max length=255, default=null
status	string	The HTTP status code	max length=255, default=null
tags	string[]	List of tags	default=null
workflowGroups	string	list of workflow groups that the web service is elligible for. Values are separated by a comma.	max length=255, default=null

WebServiceParameterDto

FIELD	TYPE	DESCRIPTION	CONSTRAINTS
id	integer	Identifier	min=-9223372036854775808, max=9223372036854775807
description	string	Description	max length=255, default=null
direction	string	Direction from predefined set	default=null, set=[RESPONSE_ASYNCHRONOUS, REQUEST, RESPONSE]
location	string	Location from predefined set	default=null, set=[PATH, QUERY, HEADER, BODY]
mandatory	boolean	true : mandatory, false : optional	default=null
name	string	Name	max length=255, default=null
revisions	RevisionDto[]	List of revisions	default=null
type	string	Type	max length=255, default=null

Error codes

When an error occurs, the response body contains an ErrorDto object which consists of a code, a message and all the parameters.
The message is built by replacing all the {n} patterns of the template by the parameters values.
All the codes and templates are listed in the table below :

CODE	MESSAGE TEMPLATE
AUTHORIZED_FIELDS	Authorized fields are {0}.
BAD_SEPARATOR	The fields must be separated by a ''{0}''.
BODY_PARAMETER_INCORRECT	The body parameter ''{0}'' is incorrect.
BRAND_NOT_MANAGED	The brand ''{0}'' is not managed.
BSC_CAPABILITIES_ERROR	Failed to retrieve the BSC capabilities.
BSC_INSTANCE_CAPABILITIES_ERROR	The BSC which manages the gateway type ''{0}'' failed to provide its capabilities.
CONNECTION_FAILED	The connection to {0} has failed.
CSV_INCORRECT	CSV is incorrect.
CSV_ROW_IGNORED	CSV row {0} is ignored.
CSV_ROW_INCORRECT	CSV row {0} is incorrect.
CUSTOMER_MAXIMUM_END_DEVICES	The value of the field ''maxEndDevices'' ({0}) cannot be less than the actual number of end-devices ({1}).
CUSTOMER_MAXIMUM_END_DEVICES_REACHED	The customer ''{0}'' has reached its maximum number of end-devices ({1}).
CUSTOMER_MAXIMUM_GATEWAYS	The value of the field ''maxGateways'' ({0}) cannot be less than the actual number of gateways ({1}).
CUSTOMER_MAXIMUM_GATEWAYS_REACHED	The customer ''{0}'' has reached its maximum number of gateways ({1}).
CUSTOMER_MAXIMUM_USERS	The value of the field ''maxUsers'' ({0}) cannot be less than the actual number of users ({1}).
CUSTOMER_MAXIMUM_USERS_REACHED	The customer ''{0}'' has reached its maximum number of users ({1}).
CUSTOMER_MDR_ACCESS	The customer ''{0}'' is not configured to access to the MDR (billing is set to false).
DETACHED_RESOURCE	The resource of type ''{0}'' does not belong to any customer.
EMAIL_ERROR	Failed to send the email to ''{0}'' ({1}: {2}).
EMPTY_FILE	The file ''{0}'' cannot be empty.
ERROR_ON_FILE	Error on file ''{0}''
EXPIRED_DATE	The date has expired.
FIELD_GREATER_THAN_FIELD	The field ''{0}'' must be greater than the field ''{1}''.
FIELD_INCORRECT	The field ''{0}'' is incorrect.
FILE_ACCESS_ERROR	Error while accessing to the file ''{0}''.
FILE_CREATION_ERROR	Failed to create the file ''{0}''.
FILE_TRANSFER_FAILED	Failed to transfer the file ''{0}''.
LICENSE_BADLY_FORMATTED	The license is badly formatted.
LICENSE_EXPIRED	The license has expired since {0} (epoch={1}).
LICENSE_MAXIMUM_END_DEVICES_REACHED	The application has reached its maximum number of end-devices defined by the license ({0}).
LICENSE_MAXIMUM_GATEWAYS_REACHED	The application has reached its maximum number of gateways defined by the license ({0}).
LICENSE_MAXIMUM_USERS_REACHED	The application has reached its maximum number of users defined by the license ({0}).
LICENSE_SERVER_DENIED	The license is not intended for this server.
LICENSE_UNDEFINED	The license does not exist.
LICENSE_UNSIGNED	The signature of the license is not valid.
LNS_SERVER_ERROR	The LNS server has encountered a problem. Message is : {0}
MANDATORY_FIELD	The field ''{0}'' must be defined.
MAX_LENGTH	The maximum length is {0}.
MAX_REQUEST_RATE	The user ''{0}'' has reached the maximum number of requests per second ({1}). He is suspended for {2} seconds.
MAX_VALUE	The maximum value is {0}.
MICRO_SERVICE_NOT_CONFIGURED	The micro service ''{0}'' is not configured.
MIN_LENGTH	The minimum length is {0}.
MIN_VALUE	The minimum value is {0}.
MISSING_AUTHORIZED_AND_MANDATORY_FIELDS	Missing authorized and mandatory fields {0}. Authorized and mandatory fields are {1}.
MISSING_AUTHORIZED_FIELDS	Missing authorized fields {0}.
MISSING_PARENT_IDENTIFIER	Missing parent identifier {0}
PARAMETER_INCORRECT	The parameter ''{0}'' is incorrect.
PARAMETER_MISSING	The parameter ''{0}'' is missing.
PROGRESS_MONITOR_IN_PROGRESS	A progress monitoring is already in use. URI is ''{0}''.
QUERY_PARAMETER_INCORRECT	The query parameter ''{0}'' is incorrect.
RESERVED_VALUE	The values {0} are reserved.
RESOURCE_ALREADY_EXISTS	{0} with {1} ''{2}'' already exists.
RESOURCE_CREATE_ERROR	Failed to create the resource {0} with {1} ''{2}''.
RESOURCE_DELETE_ERROR	Failed to delete the resource {0} with {1} ''{2}''.
RESOURCE_INCORRECT	The resource has a bad syntax. Error details : {0}
RESOURCE_INVALID	The {0} is not valid.
RESOURCE_IS_LINKED	The resource {0} with {1} ''{2}'' is linked to {3} {4}.
RESOURCE_NOT_FOUND	{0} with {1} ''{2}'' not found.
RESOURCE_PATCH_ERROR	Failed to patch the resource {0} with {1} ''{2}''.
RESOURCE_UPDATE_ERROR	Failed to update the resource {0} with {1} ''{2}''.
RNC_SERVER_ERROR	The RNC server has encountered a problem. Message is : {0}
SECURITY_BAD_CREDENTIALS	Unknown user. Bad login or/and password.
SECURITY_BUILD_TOKEN	The token built has failed.
SECURITY_CUSTOMER_USER	The user ''{0}'' does not belong to the customer ''{1}''.
SECURITY_DELETE_CUSTOMER	You cannot delete your own customer.
SECURITY_FORBIDDEN	User is forbidden to access to the web service. Check his roles.
SECURITY_FORBIDDEN_CUSTOMER	The user ''{0}'' cannot manage the customer ''{1}''.
SECURITY_FORBIDDEN_FIELD	The field ''{0}'' cannot be managed with this role or this user.
SECURITY_FORBIDDEN_RESOURCE	{0} with {1} ''{2}'' cannot be accessed.
SECURITY_FORBIDDEN_ROLE	The user ''{0}'' cannot have the role ''{1}''.
SECURITY_FORBIDDEN_TASK	The user ''{0}'' cannot manage the task because it belongs to another customer.
SECURITY_USER_DISABLED	The user ''{0}'' is disabled.
SECURITY_USER_EXPIRED	The user ''{0}'' is expired since {1}.
SECURITY_USER_NOT_VALIDATED	The user ''{0}'' is not validated. His email address ''{1}'' must be validated.
SERVER_ERROR	Server error, details : {0}
SERVICE_UNAVAILABLE	Service temporary unavailable ''{0}''
SERVICE_UNAVAILABLE_SINCE	The component ''{0}'' is temporary unavailable since {1} s. It will be available again in {2} s.
SPECTRUM_GENERATION_ERROR	Failed to build the spectrum content file format {0} from the file ''{1}''.
SYNTAX_IS	The syntax is {0}.
TASK_KO	The task has failed, see error message for more details.
TASK_NOT_OK	The task status must be 'OK' for retrieving the result.
TASK_OK	The task has successfully been processed.
TASK_PENDING	The task is currently being processed.
UNAUTHORIZED_FIELD	Field ''{0}'' is not authorized.
UNAUTHORIZED_FIELDS	Fields {0} are not authorized. Authorized fields are {1}.
UNKNOWN_FIELD	The field ''{0}'' is unknown.
URI_INCORRECT	The URI ''{0}'' is incorrect.
USER_ALREADY_VALIDATED	The user is already validated.
VALUE_GREATER_THAN	The value must be greater than {0}.
VALUE_GREATER_THAN_OR_EQUALS_TO	The value must be greater than or equals to {0}.
VALUE_IN_INTERVAL	The value must belong to the interval [{0}..{1}].
VALUE_IN_SET	The value must belong to the set {0}.
VALUE_NOT_NULL	The value must be not null.
VALUE_NOT_NULL_NOT_BLANK	The value must be not null, not empty and not blank.
VALUE_NOT_NULL_NO_BLANKS	The value must be not null, not empty without any blanks.
VALUE_REGEX	The value must match the pattern {0}.
VALUE_STARTS_WITH	The value must start with {0}.
WEAK_PASSWORD	The password strength is {0}. The minimum required is {1}. Mix lowercase, uppercase, special characters, or use a passphrase.
WEB_SERVICE_ERROR	Errors occurred during the execution of the web service ''{0}''.
WORKFLOW_WEB_SERVICE_BAD_CATEGORY	The web service ''{0}'' is not authorized in workflow for category ''{1}''. Authorized category is ''{2}''
WORKFLOW_WEB_SERVICE_UNAUTHORIZED	The web service ''{0}'' is not authorized in workflow.

License

Modalities

Expiration date: 29-Apr-2037 22:00:00
Maximum user accounts: Unlimited
Maximum total gateways: Unlimited
Maximum total end-devices: Unlimited

Signature

U5JOpcF7DzAmKvZvzJ0Cy36p7rFa7ofHXh00Ut/i3SFVkB7be7a88wtCKWev5HVtOGt3hOTU68W2WpEs+NwzaLfxDigmJyAgPuBW+dfpuKnWez7W619bn9NMWBlTCGqrECNjIkJvgvzr+fNO/aJxYyh1KgiwE2z8o0lMK+GghQA+VWK3UfseaW7vllDuNsQaVMg4gZfhFjorzJO2R859UnuqNyPk+rX6cB341mQ1CGmrY0x99YhORmJimhzK34ywKa49kdpU+Yt5Bpbl9HQ4ngWgHdyVoxOzQ1Il75xuj/Eki9cbrqmYMeFYKPfzpC696qdS6L/t1wIUtt6FBNv6Kg==

Public key

MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAudGlCzqFO3v60jbYN61AHL8RzIfRaBKMhEzD+R8iRnOT6a8sCWdWp85HkoZgRfME8/+XbWxt5JrYd8oQfHnaqZiIXVDWeov6Xq629xmI+g5U1fM7DHDpqOBB9Hq411+Nq6rY2L8TNvAQRVyOtjzVWMWOjIgUvGfXQjMngu4lXVLq88t2VxNQE6wq8fJMMDqbuldnWlt57xwyyxyBie4iFqxGnnAHPvrGTuCtGk6WAOPRxsolpVMV1w1at+az+tAe3kbtbsDmKIbWd8+Fn0OsNW3TebEoIaYVOlxcUqVcdSqwFs9MLC4+X/Ex5DZMi6UKcFwKdfIBTc5JqkZNUzV/uwIDAQAB

Introduction

REST architecture

Overview

HTTP status

Data Transfer Object

Authorized and mandatory fields

General rules

Encoding

Naming

Case

CSV files

Response body

Navigation

Entry point

Request parameters

Parameter fields

Parameter search

Parameter sort

Parameter criteria

Asynchronous web services

Single response

Paginated response

Pagination

Versioning

Security

HTTPS

JWT token

Roles

User rate limiting

Error management

Revisions

Web services

Description

Rules

Request

Responses

Description

Request

Responses

Description

Rules

Request

Responses

Description

Rules

Request

Responses

Description

Rules

Request

Responses

Description

Request

Responses

Description

Rules

Request

Responses

Description

Rules

Request

Responses

Description

Rules

Request

Responses

Description

Rules

Request

Responses

Description

Rules

Request

Responses

Asynchronous response

Description

Rules

Request

Responses

Asynchronous response