operator-manager-changelog-tpw-operator
Release 8.0
RDTP-15310
What's Changed
POST
/admins/operators/{operatorUid}/deviceProfiles
Create Profile
Request:
Updated LORAWAN
connectivity:
-
Changed property
macMaxTxEIRP
(array)Possible values: [0, 36]
-
Changed property
macMaxTxPower
(array)Possible values: [0, 36]
-
Changed property
macMinTxEIRP
(array)Possible values: [0, 36]
-
Changed property
macMinTxPower
(array)Possible values: [0, 36]
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)Updated
LORAWAN
connectivity:-
Changed property
macMaxTxEIRP
(array)Possible values: [0, 36]
-
Changed property
macMaxTxPower
(array)Possible values: [0, 36]
-
Changed property
macMinTxEIRP
(array)Possible values: [0, 36]
-
Changed property
macMinTxPower
(array)Possible values: [0, 36]
-
GET
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Retrieve Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)Updated
LORAWAN
connectivity:-
Changed property
macMaxTxEIRP
(array)Possible values: [0, 36]
-
Changed property
macMaxTxPower
(array)Possible values: [0, 36]
-
Changed property
macMinTxEIRP
(array)Possible values: [0, 36]
-
Changed property
macMinTxPower
(array)Possible values: [0, 36]
-
PUT
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Update Profile
Request:
Updated LORAWAN
connectivity:
-
Changed property
macMaxTxEIRP
(array)Possible values: [0, 36]
-
Changed property
macMaxTxPower
(array)Possible values: [0, 36]
-
Changed property
macMinTxEIRP
(array)Possible values: [0, 36]
-
Changed property
macMinTxPower
(array)Possible values: [0, 36]
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)Updated
LORAWAN
connectivity:-
Changed property
macMaxTxEIRP
(array)Possible values: [0, 36]
-
Changed property
macMaxTxPower
(array)Possible values: [0, 36]
-
Changed property
macMinTxEIRP
(array)Possible values: [0, 36]
-
Changed property
macMinTxPower
(array)Possible values: [0, 36]
-
RDTP-18707
What's Changed
GET
/admins/operators/{operatorUid}/partners/{networkPartnerUid}/stations/{baseStationUid}
Retrieve BaseStation
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Deleted property
alarm103settings
(string)
- Deleted property
PUT
/admins/operators/{operatorUid}/partners/{networkPartnerUid}/stations/{baseStationUid}
Update BaseStation
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Deleted property
alarm103settings
(string)
- Deleted property
RDTP-19476
What's New
GET
/admins/operators/{operatorUid}/sims
Retrieve the list of SIM cards associated with the operator.
RDTP-20333
What's Changed
GET
/admins/operators/{operatorUid}/devices
Parameters:
Added: imei
in query
IMEI filtering (exact match)
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed content type :
application/json
-
Changed property
data
(array)Changed items (object):
-
Added property
imei
(string)The 14 first chars of the IMEI of the device. Provided only for cellular devices.
-
Added property
connectivity
(string)Enum values:
LORAWAN
CELLULAR
-
Changed property
devAddr
(string)LoRaWAN DevAddr or cellular IP address
-
Changed property
devEUI
(string)DevEUI
-
-
RDTP-22321
What's Changed
GET
/admins/operators/{operatorUid}/cmdqueues
Return Type:
Changed response : 200 OK
Successful RETRIEVE
-
Changed property
data
(array)Changed items (object):
- Changed property
type
(string)Added new command type:
CHANGE_SUPPORT_PASSWORD
: change the support account's password
- Changed property
GET
/admins/operators/{operatorUid}/cmdqueues/{eventUid}
Return Type:
Changed response : 200 OK
Successful RETRIEVE
-
Changed property
data
(object)Changed items (object):
- Changed property
type
(string)Added new command type:
CHANGE_SUPPORT_PASSWORD
: change the support account's password
- Changed property
GET
/admins/operators/{operatorUid}/partners/{networkPartnerUid}/stations/{baseStationUid}
Return Type:
Changed response : 200 OK
Successful RETRIEVE
-
Changed property
data
(object)Changed items (object):
- Changed property
lastAcmdReqType
(string)Added new command type:
CHANGE_SUPPORT_PASSWORD
: change the support account's password
- Changed property
PUT
/admins/operators/{operatorUid}/partners/{networkPartnerUid}/stations/{baseStationUid}
Return Type:
Changed response : 200 OK
Successful UPDATE
-
Changed property
data
(object)Changed items (object):
- Changed property
lastAcmdReqType
(string)Added new command type:
CHANGE_SUPPORT_PASSWORD
: change the support account's password
- Changed property
Release 7.3
RDTP-10825
What's Changed
POST
/admins/operators/{operatorUid}/baseStationProfiles
Create Profile
Request:
-
Deprecated property
disks
(array)This property must no longer be used: it is useless and ignored.
-
Deprecated property
lrcs
(array)This property must no longer be used: it is useless and ignored.
-
Deprecated property
powerConfig
(string)This property must no longer be used: it is useless and ignored.
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Deprecated property
disks
(array)This property must no longer be used: it is useless and ignored.
-
Deprecated property
lrcs
(array)This property must no longer be used: it is useless and ignored.
-
Deprecated property
powerConfig
(string)This property must no longer be used: it is useless and ignored.
-
GET
/admins/operators/{operatorUid}/baseStationProfiles/{profileUid}
Retrieve Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Deprecated property
disks
(array)This property must no longer be used: it is useless and ignored.
-
Deprecated property
lrcs
(array)This property must no longer be used: it is useless and ignored.
-
Deprecated property
powerConfig
(string)This property must no longer be used: it is useless and ignored.
-
PUT
/admins/operators/{operatorUid}/baseStationProfiles/{profileUid}
Update Profile
Request:
-
Deprecated property
disks
(array)This property must no longer be used: it is useless and ignored.
-
Deprecated property
lrcs
(array)This property must no longer be used: it is useless and ignored.
-
Deprecated property
powerConfig
(string)This property must no longer be used: it is useless and ignored.
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Deprecated property
disks
(array)This property must no longer be used: it is useless and ignored.
-
Deprecated property
lrcs
(array)This property must no longer be used: it is useless and ignored.
-
Deprecated property
powerConfig
(string)This property must no longer be used: it is useless and ignored.
-
GET
/admins/operators/{operatorUid}/partners/{networkPartnerUid}/stations/{baseStationUid}
Retrieve BaseStation
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Deleted property
diskConfig
(string)Mounts configuration
-
Deleted property
gpsReceiverConfig
(string) -
Deleted property
lrcConfig
(string)LRCs configuration
-
Deleted property
powerConfig
(string)
-
PUT
/admins/operators/{operatorUid}/partners/{networkPartnerUid}/stations/{baseStationUid}
Update BaseStation
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Deleted property
diskConfig
(string)Mounts configuration
-
Deleted property
gpsReceiverConfig
(string) -
Deleted property
lrcConfig
(string)LRCs configuration
-
Deleted property
powerConfig
(string)
-
RDTP-11295
What's Changed
POST
/admins/operators/{operatorUid}/deviceProfiles
Create Profile
Request:
Updated LORAWAN
connectivity:
- Deprecated property
permanentlyListening
(integer)1 when the device receiver is permanently listening.
This property must no longer be used: forced to 0 for LoRaWAN MAC versions 1.0.4 (macMinorVersion=6) and 1.1 (macMinorVersion=10).
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)Updated
LORAWAN
connectivity:- Deprecated property
permanentlyListening
(integer)1 when the device receiver is permanently listening.
This property must no longer be used: forced to 0 for LoRaWAN MAC versions 1.0.4 (macMinorVersion=6) and 1.1 (macMinorVersion=10).
- Deprecated property
GET
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Retrieve Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)Updated
LORAWAN
connectivity:- Deprecated property
permanentlyListening
(integer)1 when the device receiver is permanently listening.
This property must no longer be used: forced to 0 for LoRaWAN MAC versions 1.0.4 (macMinorVersion=6) and 1.1 (macMinorVersion=10).
- Deprecated property
PUT
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Update Profile
Request:
Updated LORAWAN
connectivity:
- Deprecated property
permanentlyListening
(integer)1 when the device receiver is permanently listening.
This property must no longer be used: forced to 0 for LoRaWAN MAC versions 1.0.4 (macMinorVersion=6) and 1.1 (macMinorVersion=10).
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)Updated
LORAWAN
connectivity:- Deprecated property
permanentlyListening
(integer)1 when the device receiver is permanently listening.
This property must no longer be used: forced to 0 for LoRaWAN MAC versions 1.0.4 (macMinorVersion=6) and 1.1 (macMinorVersion=10).
- Deprecated property
RDTP-17900
What's Changed
All paths /admins/operators/\{operatorUid\}/*
Parameters:
Changed: operatorUid
in path
Unique identifier of the operator, either
- the sequential integer (
UID
) of the operator- the identifier (
ID
) of the operator prefixed byid:
- the string
mine
to reference the operator of the authenticated user requesting the API
RDTP-19834
What's Changed
GET
/admins/operators/{operatorUid}/baseStationProfiles
Retrieve BaseStationProfiles
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(array)Changed items (object):
-
Changed property
vendor
(object)The following properties are now optional:
name
-
POST
/admins/operators/{operatorUid}/baseStationProfiles
Create Profile
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
vendor
(object)The following properties are now optional:
name
-
GET
/admins/operators/{operatorUid}/baseStationProfiles/{profileUid}
Retrieve Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
vendor
(object)The following properties are now optional:
name
-
PUT
/admins/operators/{operatorUid}/baseStationProfiles/{profileUid}
Update Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
vendor
(object)The following properties are now optional:
name
-
GET
/admins/operators/{operatorUid}/baseStationVendors
Retrieve BaseStationVendors
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(array)Changed items (object):
The following properties are now optional:
name
POST
/admins/operators/{operatorUid}/baseStationVendors
Create Vendor
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)The following properties are now optional:
name
GET
/admins/operators/{operatorUid}/baseStationVendors/{vendorUid}
Retrieve Vendor
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)The following properties are now optional:
name
PUT
/admins/operators/{operatorUid}/baseStationVendors/{vendorUid}
Update Vendor
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)The following properties are now optional:
name
GET
/admins/operators/{operatorUid}/deviceVendors
Retrieve DeviceVendors
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(array)Changed items (object):
The following properties are now optional:
name
POST
/admins/operators/{operatorUid}/deviceVendors
Create Vendor
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)The following properties are now optional:
name
GET
/admins/operators/{operatorUid}/deviceVendors/{vendorUid}
Retrieve Vendor
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)The following properties are now optional:
name
PUT
/admins/operators/{operatorUid}/deviceVendors/{vendorUid}
Update Vendor
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)The following properties are now optional:
name
GET
/admins/operators/{operatorUid}/deviceProfiles
Retrieve DeviceProfiles
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(array)Changed items (object):
-
Changed property
vendor
(object)The following properties are now optional:
name
-
POST
/admins/operators/{operatorUid}/deviceProfiles
Create Profile
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
vendor
(object)The following properties are now optional:
name
-
GET
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Retrieve Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
vendor
(object)The following properties are now optional:
name
-
PUT
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Update Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
vendor
(object)The following properties are now optional:
name
-
GET
/admins/operators/{operatorUid}/partners
Retrieve Partners
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(array)Changed items (object):
The following properties are now optional:
delegateAdministration
delegateBsTagging
delegateBsValidation
POST
/admins/operators/{operatorUid}/partners
Create NetworkPartner
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)The following properties are now optional:
delegateAdministration
delegateBsTagging
delegateBsValidation
GET
/admins/operators/{operatorUid}/partners/{networkPartnerUid}
Retrieve NetworkPartner
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)The following properties are now optional:
delegateAdministration
delegateBsTagging
delegateBsValidation
PUT
/admins/operators/{operatorUid}/partners/{networkPartnerUid}
Update NetworkPartner
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)The following properties are now optional:
delegateAdministration
delegateBsTagging
delegateBsValidation
RDTP-20316
What's Changed
POST
/admins/operators/{operatorUid}/deviceProfiles
Create Profile
Request:
Updated CELLULAR
connectivity:
-
Changed property
mtcLteCategory
(string)Cellular LTE category
Added enum values:
CAT_M2
CAT_NB2
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)Updated
CELLULAR
connectivity:-
Changed property
mtcLteCategory
(string)Cellular LTE category
Added enum values:
CAT_M2
CAT_NB2
-
GET
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Retrieve Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)Updated
CELLULAR
connectivity:-
Changed property
mtcLteCategory
(string)Cellular LTE category
Added enum values:
CAT_M2
CAT_NB2
-
PUT
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Update Profile
Request:
Updated CELLULAR
connectivity:
-
Changed property
mtcLteCategory
(string)Cellular LTE category
Added enum values:
CAT_M2
CAT_NB2
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)Updated
CELLULAR
connectivity:-
Changed property
mtcLteCategory
(string)Cellular LTE category
Added enum values:
CAT_M2
CAT_NB2
-
Release 7.2
No change
Release 7.1
RDTP-12570
What's Deprecated
PUT
/admins/operators/{operatorUid}/partners/{networkPartnerUid}
This endpoint must no longer be used: the update of delegation flags is deprecated.
What's Changed
GET
/admins/operators/{operatorUid}/partners
Retrieve Partners
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(array)Changed items (object):
-
Deprecated property
delegateAdministration
(integer)This property must no longer be used: always set to 1.
-
Deprecated property
delegateBsTagging
(integer)This property must no longer be used: always set to 1.
-
Deprecated property
delegateBsValidation
(integer)This property must no longer be used: always set to 1.
-
POST
/admins/operators/{operatorUid}/partners
Create NetworkPartner
Request:
-
Deprecated property
delegateAdministration
(integer)This property must no longer be used: always set to 1.
-
Deprecated property
delegateBsTagging
(integer)This property must no longer be used: always set to 1.
-
Deprecated property
delegateBsValidation
(integer)This property must no longer be used: always set to 1.
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Deprecated property
delegateAdministration
(integer)This property must no longer be used: always set to 1.
-
Deprecated property
delegateBsTagging
(integer)This property must no longer be used: always set to 1.
-
Deprecated property
delegateBsValidation
(integer)This property must no longer be used: always set to 1.
-
GET
/admins/operators/{operatorUid}/partners/{networkPartnerUid}
Retrieve NetworkPartner
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Deprecated property
delegateAdministration
(integer)This property must no longer be used: always set to 1.
-
Deprecated property
delegateBsTagging
(integer)This property must no longer be used: always set to 1.
-
Deprecated property
delegateBsValidation
(integer)This property must no longer be used: always set to 1.
-
RDTP-15626
What's Changed
POST
/admins/operators/{operatorUid}/deviceProfiles
Create Profile
Request:
Updated LORAWAN
connectivity:
-
Changed property
regionalParameterVersion
(string)LoRaWAN Regional Parameters version implemented by the Device:
- A: revision A of the LoRaWAN MAC version defined by macMinorVersion
- B: revision B of the LoRaWAN MAC version defined by macMinorVersion
- C: revision C of the LoRaWAN MAC version defined by macMinorVersion
- D: RP 2-1.0.1
- E: RP 2-1.0.2/2-1.0.3
Added enum values:
D
E
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)Updated
LORAWAN
connectivity:-
Changed property
regionalParameterVersion
(string)LoRaWAN Regional Parameters version implemented by the Device:
- A: revision A of the LoRaWAN MAC version defined by macMinorVersion
- B: revision B of the LoRaWAN MAC version defined by macMinorVersion
- C: revision C of the LoRaWAN MAC version defined by macMinorVersion
- D: RP 2-1.0.1
- E: RP 2-1.0.2/2-1.0.3
Added enum values:
D
E
-
GET
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Retrieve Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)Updated
LORAWAN
connectivity:-
Changed property
regionalParameterVersion
(string)LoRaWAN Regional Parameters version implemented by the Device:
- A: revision A of the LoRaWAN MAC version defined by macMinorVersion
- B: revision B of the LoRaWAN MAC version defined by macMinorVersion
- C: revision C of the LoRaWAN MAC version defined by macMinorVersion
- D: RP 2-1.0.1
- E: RP 2-1.0.2/2-1.0.3
Added enum values:
D
E
-
PUT
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Update Profile
Request:
Updated LORAWAN
connectivity:
-
Changed property
regionalParameterVersion
(string)LoRaWAN Regional Parameters version implemented by the Device:
- A: revision A of the LoRaWAN MAC version defined by macMinorVersion
- B: revision B of the LoRaWAN MAC version defined by macMinorVersion
- C: revision C of the LoRaWAN MAC version defined by macMinorVersion
- D: RP 2-1.0.1
- E: RP 2-1.0.2/2-1.0.3
Added enum values:
D
E
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)Updated
LORAWAN
connectivity:-
Changed property
regionalParameterVersion
(string)LoRaWAN Regional Parameters version implemented by the Device:
- A: revision A of the LoRaWAN MAC version defined by macMinorVersion
- B: revision B of the LoRaWAN MAC version defined by macMinorVersion
- C: revision C of the LoRaWAN MAC version defined by macMinorVersion
- D: RP 2-1.0.1
- E: RP 2-1.0.2/2-1.0.3
Added enum values:
D
E
-
RDTP-18437
What's Changed
POST
/admins/operators/{operatorUid}/baseStationProfiles
Create Profile
Request:
-
Changed property
softwareType
(string)Type of software executed on the Base Station:
- LRR_LINUX: Actility LRR on Linux OS
- BASIC_STATION_LINUX: Semtech Basic Station on Linux OS
- LRR_FREERTOS: Actility LRR on FreeRTOS
Added enum value:
LRR_FREERTOS
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
softwareType
(string)Type of software executed on the Base Station:
- LRR_LINUX: Actility LRR on Linux OS
- BASIC_STATION_LINUX: Semtech Basic Station on Linux OS
- LRR_FREERTOS: Actility LRR on FreeRTOS
Added enum value:
LRR_FREERTOS
-
GET
/admins/operators/{operatorUid}/baseStationProfiles/{profileUid}
Retrieve Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
softwareType
(string)Type of software executed on the Base Station:
- LRR_LINUX: Actility LRR on Linux OS
- BASIC_STATION_LINUX: Semtech Basic Station on Linux OS
- LRR_FREERTOS: Actility LRR on FreeRTOS
Added enum value:
LRR_FREERTOS
-
PUT
/admins/operators/{operatorUid}/baseStationProfiles/{profileUid}
Update Profile
Request:
-
Changed property
softwareType
(string)Type of software executed on the Base Station:
- LRR_LINUX: Actility LRR on Linux OS
- BASIC_STATION_LINUX: Semtech Basic Station on Linux OS
- LRR_FREERTOS: Actility LRR on FreeRTOS
Added enum value:
LRR_FREERTOS
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
softwareType
(string)Type of software executed on the Base Station:
- LRR_LINUX: Actility LRR on Linux OS
- BASIC_STATION_LINUX: Semtech Basic Station on Linux OS
- LRR_FREERTOS: Actility LRR on FreeRTOS
Added enum value:
LRR_FREERTOS
-
Release 7.0
RDTP-12749
What's Changed
GET
/admins/operators/{operatorUid}/deviceVendors
Retrieve DeviceVendors
Parameters:
Added: loraVendorID
in query
LoRa Alliance™ vendor identifier. When specified, only the Device Vendor matching the loraVendorID is returned.
POST
/admins/operators/{operatorUid}/deviceVendors
Create Vendor
Request:
- Added property
loraVendorID
(string)Vendor identifier assigned by the LoRa Alliance™ to the vendor.
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Added property
loraVendorID
(string)Vendor identifier assigned by the LoRa Alliance™ to the vendor.
- Added property
GET
/admins/operators/{operatorUid}/deviceVendors/{vendorUid}
Retrieve Vendor
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Added property
loraVendorID
(string)Vendor identifier assigned by the LoRa Alliance™ to the vendor.
- Added property
PUT
/admins/operators/{operatorUid}/deviceVendors/{vendorUid}
Update Vendor
Request:
- Added property
loraVendorID
(string)Vendor identifier assigned by the LoRa Alliance™ to the vendor.
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Added property
loraVendorID
(string)Vendor identifier assigned by the LoRa Alliance™ to the vendor.
- Added property
GET
/admins/operators/{operatorUid}/deviceProfiles
Retrieve DeviceProfiles
Parameters:
Added: loraProfileID
in query
Return Device Profiles matching LoRa Alliance™ device profile identifier.
POST
/admins/operators/{operatorUid}/deviceProfiles
Create Profile
Request:
-
Added property
loraProfileIDs
(array)LoRa Alliance™ device profile identifiers corresponding to this device profile. A device profile may cover multiple LoRa Alliance™ device profile ientifiers.
Items (string):
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
loraProfileIDs
(array)LoRa Alliance™ device profile identifiers corresponding to this device profile. A device profile may cover multiple LoRa Alliance™ device profile ientifiers.
Items (string):
-
GET
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Retrieve Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
loraProfileIDs
(array)LoRa Alliance™ device profile identifiers corresponding to this device profile. A device profile may cover multiple LoRa Alliance™ device profile ientifiers.
Items (string):
-
PUT
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Update Profile
Request:
-
Added property
loraProfileIDs
(array)LoRa Alliance™ device profile identifiers corresponding to this device profile. A device profile may cover multiple LoRa Alliance™ device profile ientifiers.
Items (string):
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
loraProfileIDs
(array)LoRa Alliance™ device profile identifiers corresponding to this device profile. A device profile may cover multiple LoRa Alliance™ device profile identifiers.
Items (string):
-
RDTP-14248
What's Changed
POST
/admins/operators/{operatorUid}/deviceProfiles, PUT
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Request:
-
Changed property
allowedABPAutomaticReset
(integer)An implicit reset can be assumed when the FCntUp_32 rollbacks to 0, and when the LRC context is desynchronized. This field is forced to 0 for LoRaWAN versions 1.0.4 (macMinorVersion=6) and 1.1 (macMinorVersion=10).
-
Changed property
devNonceCounterBased
(integer)Device uses a counter per AppEUI to generate DevNonce. Each time a DevNonce is generated, it is the increment of previous DevNonce generated for the same AppEui. If set to 1, LRC uses this assumption to detect replay attack. This field is forced to 1 for LoRaWAN versions 1.0.4 (macMinorVersion=6) and 1.1 (macMinorVersion=10).
-
Changed property
macMinorVersion
(integer)Minor MAC version: depends on LoRaWAN version
- 0: LoRaWAN 0.9
- 3: LoRaWAN 1.0.0 or 1.0.1
- 4: LoRaWAN 1.0.2
- 5: LoRaWAN 1.0.3
- 6: LoRaWAN 1.0.4
- 10: LoRaWAN 1.1
-
Changed property
maxRedundancyForConfirmedUL
(integer)This attribute defines the maximum number of transmissions for a confirmed uplink frames. If set to 0, macMaxNbTrans is used for both confirmed and unconfirmed uplink frames. This field is forced to 0 for LoRaWAN versions 1.0.4 (macMinorVersion=6) and 1.1 (macMinorVersion=10).
-
Changed property
permanentlyListening
(integer)1 when the device receiver is permanently listening. This field is forced to 0 for LoRaWAN versions 1.0.4 (macMinorVersion=6) and 1.1 (macMinorVersion=10).
POST
/admins/operators/{operatorUid}/deviceProfiles, GET|PUT
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Return Type:
Changed response :
-
Changed property
allowedABPAutomaticReset
(integer)An implicit reset can be assumed when the FCntUp_32 rollbacks to 0, and when the LRC context is desynchronized. This field is forced to 0 for LoRaWAN versions 1.0.4 (macMinorVersion=6) and 1.1 (macMinorVersion=10).
-
Changed property
devNonceCounterBased
(integer)Device uses a counter per AppEUI to generate DevNonce. Each time a DevNonce is generated, it is the increment of previous DevNonce generated for the same AppEui. If set to 1, LRC uses this assumption to detect replay attack. This field is forced to 1 for LoRaWAN versions 1.0.4 (macMinorVersion=6) and 1.1 (macMinorVersion=10).
-
Changed property
macMinorVersion
(integer)Minor MAC version: depends on LoRaWAN version
- 0: LoRaWAN 0.9
- 3: LoRaWAN 1.0.0 or 1.0.1
- 4: LoRaWAN 1.0.2
- 5: LoRaWAN 1.0.3
- 6: LoRaWAN 1.0.4
- 10: LoRaWAN 1.1
-
Changed property
maxRedundancyForConfirmedUL
(integer)This attribute defines the maximum number of transmissions for a confirmed uplink frames. If set to 0, macMaxNbTrans is used for both confirmed and unconfirmed uplink frames. This field is forced to 0 for LoRaWAN versions 1.0.4 (macMinorVersion=6) and 1.1 (macMinorVersion=10).
-
Changed property
permanentlyListening
(integer)1 when the device receiver is permanently listening. This field is forced to 0 for LoRaWAN versions 1.0.4 (macMinorVersion=6) and 1.1 (macMinorVersion=10).
RDTP-16927
What's Changed
POST
/admins/operators/{operatorUid}/baseStationProfiles
Create Profile
Request:
-
Added property
softwareType
(string)Type of software executed on the Base Station:
- LRR_LINUX: Actility LRR on Linux OS
- BASIC_STATION_LINUX: Semtech Basic Station on Linux OS
Enum values:
LRR_LINUX
BASIC_STATION_LINUX
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
softwareType
(string)Type of software executed on the Base Station:
- LRR_LINUX: Actility LRR on Linux OS
- BASIC_STATION_LINUX: Semtech Basic Station on Linux OS
Enum values:
LRR_LINUX
BASIC_STATION_LINUX
-
GET
/admins/operators/{operatorUid}/baseStationProfiles/{profileUid}
Retrieve Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
softwareType
(string)Type of software executed on the Base Station:
- LRR_LINUX: Actility LRR on Linux OS
- BASIC_STATION_LINUX: Semtech Basic Station on Linux OS
Enum values:
LRR_LINUX
BASIC_STATION_LINUX
-
PUT
/admins/operators/{operatorUid}/baseStationProfiles/{profileUid}
Update Profile
Request:
-
Added property
softwareType
(string)Type of software executed on the Base Station:
- LRR_LINUX: Actility LRR on Linux OS
- BASIC_STATION_LINUX: Semtech Basic Station on Linux OS
Enum values:
LRR_LINUX
BASIC_STATION_LINUX
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
softwareType
(string)Type of software executed on the Base Station:
- LRR_LINUX: Actility LRR on Linux OS
- BASIC_STATION_LINUX: Semtech Basic Station on Linux OS
Enum values:
LRR_LINUX
BASIC_STATION_LINUX
-
RDTP-2420 / RDTP-12898
What's Changed
POST
/admins/operators/{operatorUid}/baseStationProfiles
Create Profile
Request:
- Deprecated property
wans
(object)
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Deprecated property
wans
(object)
- Deprecated property
GET
/admins/operators/{operatorUid}/baseStationProfiles/{profileUid}
Retrieve Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Deprecated property
wans
(object)
- Deprecated property
PUT
/admins/operators/{operatorUid}/baseStationProfiles/{profileUid}
Update Profile
Request:
- Deprecated property
wans
(object)
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Deprecated property
wans
(object)
- Deprecated property
GET|PUT
/admins/operators/{operatorUid}/partners/{networkPartnerUid}/stations/{baseStationUid}
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Deprecated property
wanConfig
(string)WAN backhaul interfaces of the base station.
This parameter must no longer be used: always empty.
- Deprecated property
RDTP-4710
What's New
GET
/admins/operators/{operatorUid}/rfRegions/export
Export RF Regions
Release 6.1
RDTP-15979
What's Changed
POST
/admins/operators/{operatorUid}/baseStationProfiles
Create Profile
Request:
-
Changed property
ismBands
(array)List of IMS band names associated with the BS profile
Changed items (object):
-
Changed property
ID
(string)ISM band ID
Added enum value:
ww2g4
-
Changed property
name
(string)ISM band name
Added enum value:
WW2400
-
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
ismBands
(array)List of IMS band names associated with the BS profile
Changed items (object):
-
Changed property
ID
(string)ISM band ID
Added enum value:
ww2g4
-
Changed property
name
(string)ISM band name
Added enum value:
WW2400
-
-
GET
/admins/operators/{operatorUid}/baseStationProfiles/{profileUid}
Retrieve Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
ismBands
(array)List of IMS band names associated with the BS profile
Changed items (object):
-
Changed property
ID
(string)ISM band ID
Added enum value:
ww2g4
-
Changed property
name
(string)ISM band name
Added enum value:
WW2400
-
-
PUT
/admins/operators/{operatorUid}/baseStationProfiles/{profileUid}
Update Profile
Request:
-
Changed property
ismBands
(array)List of IMS band names associated with the BS profile
Changed items (object):
-
Changed property
ID
(string)ISM band ID
Added enum value:
ww2g4
-
Changed property
name
(string)ISM band name
Added enum value:
WW2400
-
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
ismBands
(array)List of IMS band names associated with the BS profile
Changed items (object):
-
Changed property
ID
(string)ISM band ID
Added enum value:
ww2g4
-
Changed property
name
(string)ISM band name
Added enum value:
WW2400
-
-
POST
/admins/operators/{operatorUid}/deviceProfiles
Create Profile
Request:
Updated LORAWAN
connectivity:
-
Changed property
ismBands
(array)Changed items (object):
-
Changed property
ID
(string)ISM band ID
Added enum value:
ww2g4
-
Changed property
name
(string)ISM band name
Added enum value:
WW2400
-
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)Updated
LORAWAN
connectivity:-
Changed property
ismBands
(array)Changed items (object):
-
Changed property
ID
(string)ISM band ID
Added enum value:
ww2g4
-
Changed property
name
(string)ISM band name
Added enum value:
WW2400
-
-
GET
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Retrieve Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)Updated
LORAWAN
connectivity:-
Changed property
ismBands
(array)Changed items (object):
-
Changed property
ID
(string)ISM band ID
Added enum value:
ww2g4
-
Changed property
name
(string)ISM band name
Added enum value:
WW2400
-
-
PUT
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Update Profile
Request:
Updated LORAWAN
connectivity:
-
Changed property
ismBands
(array)Changed items (object):
-
Changed property
ID
(string)ISM band ID
Added enum value:
ww2g4
-
Changed property
name
(string)ISM band name
Added enum value:
WW2400
-
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)Updated
LORAWAN
connectivity:-
Changed property
ismBands
(array)Changed items (object):
-
Changed property
ID
(string)ISM band ID
Added enum value:
ww2g4
-
Changed property
name
(string)ISM band name
Added enum value:
WW2400
-
-
GET
/admins/operators/{operatorUid}/ismBands
Retrieve IsmBands
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(array)Changed items (object):
-
Changed property
ID
(string)ISM band ID
Added enum value:
ww2g4
-
Changed property
name
(string)ISM band name
Added enum value:
WW2400
-
GET
/admins/operators/{operatorUid}/rfRegions
Retrieve RF Regions
Parameters:
Changed: ismBandID
in query
ISM band ID filtering (exact match)
Return Type:
Changed response : 200 OK
Successful RETRIEVE
-
Changed property
data
(array)Changed items (object):
-
Changed property
ismBand
(object)-
Changed property
ID
(string)ISM band ID
Added enum value:
ww2g4
-
Changed property
name
(string)ISM band name
Added enum value:
WW2400
-
-
POST
/admins/operators/{operatorUid}/rfRegions
Create RF Region
Request:
-
Changed property
ismBand
(object)-
Changed property
ID
(string)ISM band ID
Added enum value:
ww2g4
-
Changed property
name
(string)ISM band name
Added enum value:
WW2400
-
Return Type:
Changed response : 201 Created
Successful CREATE, UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
ismBand
(object)-
Changed property
ID
(string)ISM band ID
Added enum value:
ww2g4
-
Changed property
name
(string)ISM band name
Added enum value:
WW2400
-
-
GET
/admins/operators/{operatorUid}/rfRegions/{rfRegionUid}
Retrieve RF Region
Return Type:
Changed response : 200 OK
Successful CREATE, UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
ismBand
(object)-
Changed property
ID
(string)ISM band ID
Added enum value:
ww2g4
-
Changed property
name
(string)ISM band name
Added enum value:
WW2400
-
-
PUT
/admins/operators/{operatorUid}/rfRegions/{rfRegionUid}
Update RF Region
Request:
-
Changed property
ismBand
(object)-
Changed property
ID
(string)ISM band ID
Added enum value:
ww2g4
-
Changed property
name
(string)ISM band name
Added enum value:
WW2400
-
Return Type:
Changed response : 200 OK
Successful CREATE, UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
ismBand
(object)-
Changed property
ID
(string)ISM band ID
Added enum value:
ww2g4
-
Changed property
name
(string)ISM band name
Added enum value:
WW2400
-
-
RDTP-16209
What's Changed
POST
/admins/operators/{operatorUid}/deviceProfiles
Create Profile
Request:
Updated LORAWAN
connectivity:
- Added property
dummyPayloadMaxSize
(integer)Maximum size in bytes for a "dummy" payload: if the size of a payload in an uplink frame is lower or equal to this value, the payload is ignored, and the uplink frame is processed as if it contains no payload.
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)Updated
LORAWAN
connectivity:- Added property
dummyPayloadMaxSize
(integer)Maximum size in bytes for a "dummy" payload: if the size of a payload in an uplink frame is lower or equal to this value, the payload is ignored, and the uplink frame is processed as if it contains no payload.
- Added property
GET
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Retrieve Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)Updated
LORAWAN
connectivity:- Added property
dummyPayloadMaxSize
(integer)Maximum size in bytes for a "dummy" payload: if the size of a payload in an uplink frame is lower or equal to this value, the payload is ignored, and the uplink frame is processed as if it contains no payload.
- Added property
PUT
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Update Profile
Request:
Updated LORAWAN
connectivity:
- Added property
dummyPayloadMaxSize
(integer)Maximum size in bytes for a "dummy" payload: if the size of a payload in an uplink frame is lower or equal to this value, the payload is ignored, and the uplink frame is processed as if it contains no payload.
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)Updated
LORAWAN
connectivity:- Added property
dummyPayloadMaxSize
(integer)Maximum size in bytes for a "dummy" payload: if the size of a payload in an uplink frame is lower or equal to this value, the payload is ignored, and the uplink frame is processed as if it contains no payload.
- Added property
RDTP-8486
What's New
GET
/admins/operators/{operatorUid}/baseStationProfiles/{profileUid}/configuration
Retrieve Profile Configuration
PUT
/admins/operators/{operatorUid}/baseStationProfiles/{profileUid}/configuration
Update Profile Configuration
GET
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}/configuration
Retrieve Profile Configuration
PUT
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}/configuration
Update Profile Configuration
GET
/admins/operators/{operatorUid}/rfRegions/{rfRegionUid}/configuration
Retrieve RF Region Configuration
PUT
/admins/operators/{operatorUid}/rfRegions/{rfRegionUid}/configuration
Update RF Region Configuration
What's Changed
GET
/admins/operators/{operatorUid}/baseStationProfiles
Retrieve BaseStationProfiles
Parameters:
Added: visibility
in query
Base Station Profile visibility filtering:
- ALL: don't filter by visibility
- VISIBLE: only Base Station Profiles visible by all Network Partners are returned
- HIDDEN: only Base Station Profiles hidden to all Network Partners are returned
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(array)Changed items (object):
New required properties:
-
configuration
-
Added property
configuration
(object)-
Property
visibility
(string)Base Station Profile visibility policy:
- VISIBLE: The Base Station Profile is visible by all Network Partners
- HIDDEN: The Base Station Profile is hidden to all Network Partners
Enum values:
VISIBLE
HIDDEN
-
-
POST
/admins/operators/{operatorUid}/baseStationProfiles
Create Profile
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
configuration
(object)-
Property
visibility
(string)Base Station Profile visibility policy:
- VISIBLE: The Base Station Profile is visible by all Network Partners
- HIDDEN: The Base Station Profile is hidden to all Network Partners
Enum values:
VISIBLE
HIDDEN
-
-
GET
/admins/operators/{operatorUid}/baseStationProfiles/{profileUid}
Retrieve Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
configuration
(object)-
Property
visibility
(string)Base Station Profile visibility policy:
- VISIBLE: The Base Station Profile is visible by all Network Partners
- HIDDEN: The Base Station Profile is hidden to all Network Partners
Enum values:
VISIBLE
HIDDEN
-
-
PUT
/admins/operators/{operatorUid}/baseStationProfiles/{profileUid}
Update Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
configuration
(object)-
Property
visibility
(string)Base Station Profile visibility policy:
- VISIBLE: The Base Station Profile is visible by all Network Partners
- HIDDEN: The Base Station Profile is hidden to all Network Partners
Enum values:
VISIBLE
HIDDEN
-
-
GET
/admins/operators/{operatorUid}/deviceProfiles
Retrieve DeviceProfiles
Parameters:
Added: visibility
in query
Device Profile visibility filtering:
- ALL: don't filter by visibility
- VISIBLE: only Device Profiles visible by all Subscriptions are returned
- HIDDEN: only Device Profiles hidden to all Subscriptions are returned
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(array)Changed items (object):
New required properties:
-
configuration
-
Added property
configuration
(object)-
Property
visibility
(string)Device Profile visibility policy:
- VISIBLE: The Device Profile is visible by all Subscriptions
- HIDDEN: The Device Profile is hidden to all Subscriptions
Enum values:
VISIBLE
HIDDEN
-
-
POST
/admins/operators/{operatorUid}/deviceProfiles
Create Profile
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
configuration
(object)-
Property
visibility
(string)Device Profile visibility policy:
- VISIBLE: The Device Profile is visible by all Subscriptions
- HIDDEN: The Device Profile is hidden to all Subscriptions
Enum values:
VISIBLE
HIDDEN
-
-
GET
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Retrieve Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
configuration
(object)-
Property
visibility
(string)Device Profile visibility policy:
- VISIBLE: The Device Profile is visible by all Subscriptions
- HIDDEN: The Device Profile is hidden to all Subscriptions
Enum values:
VISIBLE
HIDDEN
-
-
PUT
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Update Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
configuration
(object)-
Property
visibility
(string)Device Profile visibility policy:
- VISIBLE: The Device Profile is visible by all Subscriptions
- HIDDEN: The Device Profile is hidden to all Subscriptions
Enum values:
VISIBLE
HIDDEN
-
-
GET
/admins/operators/{operatorUid}/rfRegions
Retrieve RF Regions
Parameters:
Added: visibility
in query
RF Region visibility filtering:
- ALL: don't filter by visibility
- VISIBLE: only RF Regions visible by all Network Partners are returned
- HIDDEN: only RF Regions hidden to all Network Partners are returned
Return Type:
Changed response : 200 OK
Successful RETRIEVE
-
Changed property
data
(array)Changed items (object):
-
Added property
configuration
(object)-
Property
visibility
(string)RF Region visibility policy:
- VISIBLE: The RF Region is visible by all Network Partners
- HIDDEN: The RF Region is hidden to all Network Partners
Enum values:
VISIBLE
HIDDEN
-
-
POST
/admins/operators/{operatorUid}/rfRegions
Create RF Region
Return Type:
Changed response : 201 Created
Successful CREATE, UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
configuration
(object)-
Property
visibility
(string)RF Region visibility policy:
- VISIBLE: The RF Region is visible by all Network Partners
- HIDDEN: The RF Region is hidden to all Network Partners
Enum values:
VISIBLE
HIDDEN
-
-
GET
/admins/operators/{operatorUid}/rfRegions/{rfRegionUid}
Retrieve RF Region
Return Type:
Changed response : 200 OK
Successful CREATE, UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
configuration
(object)-
Property
visibility
(string)RF Region visibility policy:
- VISIBLE: The RF Region is visible by all Network Partners
- HIDDEN: The RF Region is hidden to all Network Partners
Enum values:
VISIBLE
HIDDEN
-
-
PUT
/admins/operators/{operatorUid}/rfRegions/{rfRegionUid}
Update RF Region
Return Type:
Changed response : 200 OK
Successful CREATE, UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
configuration
(object)-
Property
visibility
(string)RF Region visibility policy:
- VISIBLE: The RF Region is visible by all Network Partners
- HIDDEN: The RF Region is hidden to all Network Partners
Enum values:
VISIBLE
HIDDEN
-
-
RDTP-9170
What's Changed
POST
/admins/operators/{operatorUid}/deviceProfiles
Create Profile
Request:
-
Added property
driverMetadata
(object)Metadata for Driver selection
-
Property
model
(string)Model metadata for Driver selection. Syntax:
<producerId>:<moduleId>:<version>
-
Property
applications
(array)List of supported Applications metadata for Driver selection. The first item of the list is the default one. Used to allow override of the application metadata at Device level.
Items (string):
Application metadata for Driver selection Syntax:
<producerId>:<moduleId>:<version>
-
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
driverMetadata
(object)Metadata for Driver selection
-
Property
model
(string)Model metadata for Driver selection. Syntax:
<producerId>:<moduleId>:<version>
-
Property
applications
(array)List of supported Applications metadata for Driver selection. The first item of the list is the default one. Used to allow override of the application metadata at Device level.
Items (string):
Application metadata for Driver selection Syntax:
<producerId>:<moduleId>:<version>
-
-
GET
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Retrieve Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
driverMetadata
(object)Metadata for Driver selection
-
Property
model
(string)Model metadata for Driver selection. Syntax:
<producerId>:<moduleId>:<version>
-
Property
applications
(array)List of supported Applications metadata for Driver selection. The first item of the list is the default one. Used to allow override of the application metadata at Device level.
Items (string):
Application metadata for Driver selection Syntax:
<producerId>:<moduleId>:<version>
-
-
PUT
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Update Profile
Request:
-
Added property
driverMetadata
(object)Metadata for Driver selection
-
Property
model
(string)Model metadata for Driver selection. Syntax:
<producerId>:<moduleId>:<version>
-
Property
applications
(array)List of supported Applications metadata for Driver selection. The first item of the list is the default one. Used to allow override of the application metadata at Device level.
Items (string):
Application metadata for Driver selection Syntax:
<producerId>:<moduleId>:<version>
-
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
driverMetadata
(object)Metadata for Driver selection
-
Property
model
(string)Model metadata for Driver selection. Syntax:
<producerId>:<moduleId>:<version>
-
Property
applications
(array)List of supported Applications metadata for Driver selection. The first item of the list is the default one. Used to allow override of the application metadata at Device level.
Items (string):
Application metadata for Driver selection Syntax:
<producerId>:<moduleId>:<version>
-
-
Release 6.0
RDTP-2543
What's New
GET
/admins/operators/{operatorUid}/rfRegions/{rfRegionUid}/lcs
Retrieve RF Region Logical Channels
Release 5.2.2
RDTP-2411-2764
What's Changed
GET
/operators/{operatorUid}/hsmGroups/{hsmGroupUid}
Retrieve HsmGroup
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Added property
hsmExchangeKeyVersion
(string)HSM Exchange Key version
- Added property
PUT
/operators/{operatorUid}/hsmGroups/{hsmGroupUid}
Update HsmGroup
Request:
- Added property
hsmExchangeKeyVersion
(string)HSM Exchange Key version
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Added property
hsmExchangeKeyVersion
(string)HSM Exchange Key version
- Added property
POST
/operators/{operatorUid}/hsmGroups/{hsmGroupUid}
Create HsmGroup
Request:
- Added property
hsmExchangeKeyVersion
(string)HSM Exchange Key version
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Added property
hsmExchangeKeyVersion
(string)HSM Exchange Key version
- Added property
RDTP-4777
What's Changed
GET
/operators/{operatorUid}/baseStationProfiles/{profileUid}/lrrSwVersions
Retrieve LrrSwVersions
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(array)Changed items (object):
- Added property
package
(string)Base Station LRR software package name
- Added property
POST
/operators/{operatorUid}/baseStationProfiles/{profileUid}/lrrSwVersions
Create Version
Request:
- Added property
package
(string)Base Station LRR software package name
Return Type:
Changed response : 201 Created
Successful CREATE
-
Changed property
data
(object)- Added property
package
(string)Base Station LRR software package name
- Added property
RDTP-7723
What's Changed
GET
/admins/operators/{operatorUid}/hsmGroups/{hsmGroupUid}
Retrieve HsmGroup
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
hsmKiKeyVersion
(string)HSM Ki Key version
-
Added property
hsmOperatorKeyVersion
(string)HSM Operator Key version
-
PUT
/admins/operators/{operatorUid}/hsmGroups/{hsmGroupUid}
Update HsmGroup
Request:
-
Added property
hsmKiKeyVersion
(string)HSM Ki Key version
-
Added property
hsmOperatorKeyVersion
(string)HSM Operator Key version
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
hsmKiKeyVersion
(string)HSM Ki Key version
-
Added property
hsmOperatorKeyVersion
(string)HSM Operator Key version
-
POST
/admins/operators/{operatorUid}/hsmGroups/{hsmGroupUid}
Create HsmGroup
Request:
-
Added property
hsmKiKeyVersion
(string)HSM Ki Key version
-
Added property
hsmOperatorKeyVersion
(string)HSM Operator Key version
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
hsmKiKeyVersion
(string)HSM Ki Key version
-
Added property
hsmOperatorKeyVersion
(string)HSM Operator Key version
-
RDTP-7849
What's Changed
POST
/admins/operators/{operatorUid}/baseStationProfiles/{profileUid}/lrrSwVersions
Create Version
Request:
-
Added property
compatibilities
(array)Items (object):
-
Property
criteria
(string)Compatibility criteria
Enum values:
FIRMWARE_VERSION
FPGA_VERSION
-
Property
value
(string)Compatible value
-
Return Type:
Changed response : 201 Created
Successful CREATE, RETRIEVE or UPDATE
-
Changed property
data
(object)-
Added property
compatibilities
(array)Items (object):
-
Property
criteria
(string)Compatibility criteria
Enum values:
FIRMWARE_VERSION
FPGA_VERSION
-
Property
value
(string)Compatible value
-
-
GET
/admins/operators/{operatorUid}/baseStationProfiles/{profileUid}/lrrSwVersions/{versionUid}
Retrieve Version
Return Type:
Changed response : 200 OK
Successful CREATE, RETRIEVE or UPDATE
-
Changed property
data
(object)-
Added property
compatibilities
(array)Items (object):
-
Property
criteria
(string)Compatibility criteria
Enum values:
FIRMWARE_VERSION
FPGA_VERSION
-
Property
value
(string)Compatible value
-
-
PUT
/admins/operators/{operatorUid}/baseStationProfiles/{profileUid}/lrrSwVersions/{versionUid}
Update Version
Request:
-
Added property
compatibilities
(array)Items (object):
-
Property
criteria
(string)Compatibility criteria
Enum values:
FIRMWARE_VERSION
FPGA_VERSION
-
Property
value
(string)Compatible value
-
Return Type:
Changed response : 200 OK
Successful CREATE, RETRIEVE or UPDATE
-
Changed property
data
(object)-
Added property
compatibilities
(array)Items (object):
-
Property
criteria
(string)Compatibility criteria
Enum values:
FIRMWARE_VERSION
FPGA_VERSION
-
Property
value
(string)Compatible value
-
-
RDTP-8539
What's Changed
POST
/admins/operators/{operatorUid}/baseStationProfiles/catalog
Import Catalog
Parameters:
Added: force
in query
When set, the catalog upgrade will be forced, even if the uploaded catalog version is equal to the version already loaded in local system.
POST
/admins/operators/{operatorUid}/deviceProfiles/catalog
Import Catalog
Parameters:
Added: force
in query
When set, the catalog upgrade will be forced, even if the uploaded catalog version is equal to the version already loaded in local system.
POST
/admins/operators/{operatorUid}/rfRegions/catalog
Import Catalog
Parameters:
Added: force
in query
When set, the catalog upgrade will be forced, even if the uploaded catalog version is equal to the version already loaded in local system.
RDTP-8739
What's Changed
POST
/admins/operators/{operatorUid}/baseStationProfiles
Create Profile
Request:
- Changed property
ID
(string)At creation the Base Station Profile ID must be prefixed with "CUSTOM/". Otherwise the prefix "CUSTOM/" is automatically added.
The length of the Base Station Profile ID, including the prefix "CUSTOM/", must not exceed 40 characters.
POST
/admins/operators/{operatorUid}/deviceProfiles
Create Profile
Request:
- Changed property
ID
(string)At creation the Device Profile ID must be prefixed with "CUSTOM/". Otherwise the prefix "CUSTOM/" is automatically added.
The length of the Device Profile ID, including the prefix "CUSTOM/", must not exceed 40 characters.
POST
/admins/operators/{operatorUid}/rfRegions
Create RF Region
Request:
- Changed property
ID
(string)At creation the RF Region ID must be prefixed with "CUSTOM/". Otherwise the prefix "CUSTOM/" is automatically added.
The length of the RF Region ID, including the prefix "CUSTOM/", must not exceed 40 characters.
Release 5.1
RDTP-4085
What's Changed
POST
/admins/operators/{operatorUid}/baseStationProfiles/catalog/selfUpdate
Import Catalog from repository
Parameters:
Added: force
in query
When set, the catalog upgrade will be forced, even if the catalog version in the repository is equal to the version already loaded in local system.
POST
/admins/operators/{operatorUid}/deviceProfiles/catalog/selfUpdate
Import Catalog from repository
Parameters:
Added: force
in query
When set, the catalog upgrade will be forced, even if the catalog version in the repository is equal to the version already loaded in local system.
POST
/admins/operators/{operatorUid}/rfRegions/catalog/selfUpdate
Import Catalog from repository
Parameters:
Added: force
in query
When set, the catalog upgrade will be forced, even if the catalog version in the repository is equal to the version already loaded in local system.
RDTP-7807
What's Changed
GET
/admins/operators/{operatorUid}/baseStationProfiles
Retrieve BaseStationProfiles
Parameters:
Added: source
in query
Base Station Profile source filtering:
- ALL: all Base Station Profiles are returned
- CATALOG: only Base Station Profiles coming from the catalog are returned
- CUSTOM: only Base Station Profiles created by the Operator are returned
GET
/admins/operators/{operatorUid}/deviceProfiles
Retrieve DeviceProfiles
Parameters:
Added: source
in query
Device Profile source filtering:
- ALL: all Device Profiles are returned
- CATALOG: only Device Profiles coming from the catalog are returned
- CUSTOM: only Device Profiles created by the Operator are returned
GET
/admins/operators/{operatorUid}/rfRegions
Retrieve RF Regions
Parameters:
Added: source
in query
RF Region source filtering:
- ALL: all RF Regions are returned
- CATALOG: only RF Regions coming from the catalog are returned
- CUSTOM: only RF Regions created by the Operator are returned
RDTP-2213-3250-4160
What's Changed
GET
/admins/operators/{operatorUid}/hsmGroups/{hsmGroupUid}
Retrieve HsmGroup
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Added property
hsmNwkKeyVersion
(string)HSM Network Key version
- Added property
PUT
/admins/operators/{operatorUid}/hsmGroups/{hsmGroupUid}
Update HsmGroup
Request:
- Added property
hsmNwkKeyVersion
(string)HSM Network Key version
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Added property
hsmNwkKeyVersion
(string)HSM Network Key version
- Added property
POST
/admins/operators/{operatorUid}/hsmGroups/{hsmGroupUid}
Create HsmGroup
Request:
- Added property
hsmNwkKeyVersion
(string)HSM Network Key version
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Added property
hsmNwkKeyVersion
(string)HSM Network Key version
- Added property
RDTP-2238
What's Changed
POST
/admins/operators/{operatorUid}/deviceProfiles
Create Profile
Request:
Updated LORAWAN
connectivity:
-
Added property
downlinkDwellTime
(integer)Maximum downlink dwell time:
- 0: no limit
- 1: 400 ms
Only applicable to AS923MHz ISM Band.
-
Added property
uplinkDwellTime
(integer)Maximum uplink dwell time:
- 0: no limit
- 1: 400 ms
Only applicable to AS923MHz ISM Band.
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)Updated
LORAWAN
connectivity:-
Added property
downlinkDwellTime
(integer)Maximum downlink dwell time:
- 0: no limit
- 1: 400 ms
Only applicable to AS923MHz ISM Band.
-
Added property
uplinkDwellTime
(integer)Maximum uplink dwell time:
- 0: no limit
- 1: 400 ms
Only applicable to AS923MHz ISM Band.
-
GET
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Retrieve Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)Updated
LORAWAN
connectivity:-
Added property
downlinkDwellTime
(integer)Maximum downlink dwell time:
- 0: no limit
- 1: 400 ms
Only applicable to AS923MHz ISM Band.
-
Added property
uplinkDwellTime
(integer)Maximum uplink dwell time:
- 0: no limit
- 1: 400 ms
Only applicable to AS923MHz ISM Band.
-
PUT
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Update Profile
Request:
Updated LORAWAN
connectivity:
-
Added property
downlinkDwellTime
(integer)Maximum downlink dwell time:
- 0: no limit
- 1: 400 ms
Only applicable to AS923MHz ISM Band.
-
Added property
uplinkDwellTime
(integer)Maximum uplink dwell time:
- 0: no limit
- 1: 400 ms
Only applicable to AS923MHz ISM Band.
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)Updated
LORAWAN
connectivity:-
Added property
downlinkDwellTime
(integer)Maximum downlink dwell time:
- 0: no limit
- 1: 400 ms
Only applicable to AS923MHz ISM Band.
-
Added property
uplinkDwellTime
(integer)Maximum uplink dwell time:
- 0: no limit
- 1: 400 ms
Only applicable to AS923MHz ISM Band.
-
RDTP-3365
What's New
GET
/admins/operators/{operatorUid}/rfRegions
Retrieve RF Regions
POST
/admins/operators/{operatorUid}/rfRegions
Create RF Region
GET
/admins/operators/{operatorUid}/rfRegions/{rfRegionUid}
Retrieve RF Region
PUT
/admins/operators/{operatorUid}/rfRegions/{rfRegionUid}
Update RF Region
DELETE
/admins/operators/{operatorUid}/rfRegions/{rfRegionUid}
Delete RF Region
GET
/admins/operators/{operatorUid}/rfRegions/{rfRegionUid}/locals/{languageTag}
Retrieve Local
PUT
/admins/operators/{operatorUid}/rfRegions/{rfRegionUid}/locals/{languageTag}
Update Local
GET
/admins/operators/{operatorUid}/rfRegions/{rfRegionUid}/logo
Retrieve Logo
POST
/admins/operators/{operatorUid}/rfRegions/{rfRegionUid}/logo
Create Logo
GET
/admins/operators/{operatorUid}/rfRegions/catalog
Retrieve Catalog version
POST
/admins/operators/{operatorUid}/rfRegions/catalog
Import Catalog
GET
/admins/operators/{operatorUid}/rfRegions/catalog/selfUpdate
Retrieve latest Catalog version
POST
/admins/operators/{operatorUid}/rfRegions/catalog/selfUpdate
Import Catalog from repository
What's Changed
GET
/admins/operators/{operatorUid}/provqueues
Retrieve Provqueues
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(array)Changed items (object):
-
Changed property
type
(string)Type of the provisioning request:
- DEVICE: Device request (activation, update or deactivation)
- BASE_STATION: Base Station request (activation, update or deactivation)
- ROUTING_PROFILE: AS routing profile (creation, update and deletion)
- SERVICE_PROFILE: Service profile (creation, update and deletion)
- DEVICE_PROFILE: Device profile (creation, update and deletion)
- HSM_GROUP: HSM group (creation, update and deletion)
- BASE_STATION_GROUP: Base Station Group request (creation, update and deletion)
- FLEET: Fleet request (creation, update and deletion)
- NETWORK_CONTEXT: Network Context request (creation, update and deletion)
- ENFORCEMENT_PROFILE: Enforcement Profile request (creation, update and deletion)
- MICROFLOW_PROFILE: Microflow Profile request (creation, update and deletion)
- RF_REGION: RF Region request (creation, update and deletion)
Added enum value:
RF_REGION
-
GET
/admins/operators/{operatorUid}/provqueues/{eventUid}
Retrieve Event
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
type
(string)Type of the provisioning request:
- DEVICE: Device request (activation, update or deactivation)
- BASE_STATION: Base Station request (activation, update or deactivation)
- ROUTING_PROFILE: AS routing profile (creation, update and deletion)
- SERVICE_PROFILE: Service profile (creation, update and deletion)
- DEVICE_PROFILE: Device profile (creation, update and deletion)
- HSM_GROUP: HSM group (creation, update and deletion)
- BASE_STATION_GROUP: Base Station Group request (creation, update and deletion)
- FLEET: Fleet request (creation, update and deletion)
- NETWORK_CONTEXT: Network Context request (creation, update and deletion)
- ENFORCEMENT_PROFILE: Enforcement Profile request (creation, update and deletion)
- MICROFLOW_PROFILE: Microflow Profile request (creation, update and deletion)
- RF_REGION: RF Region request (creation, update and deletion)
Added enum value:
RF_REGION
-
RDTP-3366
What's New
GET
/admins/operators/{operatorUid}/baseStationVendors/{vendorUid}/locals/{languageTag}
Retrieve Local
PUT
/admins/operators/{operatorUid}/baseStationVendors/{vendorUid}/locals/{languageTag}
Update Local
GET
/admins/operators/{operatorUid}/deviceVendors/{vendorUid}/locals/{languageTag}
Retrieve Local
PUT
/admins/operators/{operatorUid}/deviceVendors/{vendorUid}/locals/{languageTag}
Update Local
What's Changed
GET
/admins/operators/{operatorUid}/baseStationProfiles
Retrieve BaseStationProfiles
Parameters:
Changed: language-tag
in query
Returns items by using the language-tag.
When this query parameter is not specified in the request or when requested language is not available, items are returned by using the default language of the Operator.
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
vendor
(object)-
Added property
commercialName
(string)Commercial name of the base station vendor
-
Added property
commercialDescription
(string)Commercial description of the base station vendor
-
Deprecated property
name
(string)BS Vendor name
-
-
POST
/admins/operators/{operatorUid}/baseStationProfiles
Create Profile
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
vendor
(object)-
Added property
commercialName
(string)Commercial name of the base station vendor
-
Added property
commercialDescription
(string)Commercial description of the base station vendor
-
Deprecated property
name
(string)BS Vendor name
-
-
GET
/admins/operators/{operatorUid}/baseStationProfiles/{profileUid}
Retrieve Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
vendor
(object)-
Added property
commercialName
(string)Commercial name of the base station vendor
-
Added property
commercialDescription
(string)Commercial description of the base station vendor
-
Deprecated property
name
(string)BS Vendor name
-
-
PUT
/admins/operators/{operatorUid}/baseStationProfiles/{profileUid}
Update Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
vendor
(object)-
Added property
commercialName
(string)Commercial name of the base station vendor
-
Added property
commercialDescription
(string)Commercial description of the base station vendor
-
Deprecated property
name
(string)BS Vendor name
-
-
GET
/admins/operators/{operatorUid}/baseStationVendors
Retrieve BaseStationVendors
Parameters:
Added: language-tag
in query
Returns items by using the language-tag.
When this query parameter is not specified in the request or when requested language is not available, items are returned by using the default language of the Operator.
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
commercialName
(string)Commercial name of the base station vendor
-
Added property
commercialDescription
(string)Commercial description of the base station vendor
-
Deprecated property
name
(string)Base Station Vendor name
-
POST
/admins/operators/{operatorUid}/baseStationVendors
Create Vendor
Request:
- Deprecated property
name
(string)Base Station Vendor name
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Deprecated property
name
(string)Base Station Vendor name
- Deprecated property
GET
/admins/operators/{operatorUid}/baseStationVendors/{vendorUid}
Retrieve Vendor
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Deprecated property
name
(string)Base Station Vendor name
- Deprecated property
PUT
/admins/operators/{operatorUid}/baseStationVendors/{vendorUid}
Update Vendor
Request:
- Changed property
name
(string)Deprecated Station Vendor name
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Deprecated property
name
(string)Base Station Vendor name
- Deprecated property
GET
/admins/operators/{operatorUid}/deviceVendors
Retrieve DeviceVendors
Parameters:
Added: language-tag
in query
Returns items by using the language-tag.
When this query parameter is not specified in the request or when requested language is not available, items are returned by using the default language of the Operator.
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
commercialName
(string)Commercial name of the device vendor
-
Added property
commercialDescription
(string)Commercial description of the device vendor
-
Deprecated property
name
(string)Device Vendor name
-
POST
/admins/operators/{operatorUid}/deviceVendors
Create Vendor
Request:
- Deprecated property
name
(string)Device Vendor name
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Deprecated property
name
(string)Device Vendor name
- Deprecated property
GET
/admins/operators/{operatorUid}/deviceVendors/{vendorUid}
Retrieve Vendor
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Deprecated property
name
(string)Device Vendor name
- Deprecated property
PUT
/admins/operators/{operatorUid}/deviceVendors/{vendorUid}
Update Vendor
Request:
- Deprecated property
name
(string)Device Vendor name
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Deprecated property
name
(string)Device Vendor name
- Deprecated property
GET
/admins/operators/{operatorUid}/deviceProfiles
Retrieve DeviceProfiles
Parameters:
Changed: language-tag
in query
Returns items by using the language-tag.
When this query parameter is not specified in the request or when requested language is not available, items are returned by using the default language of the Operator.
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
vendor
(object)-
Added property
commercialName
(string)Commercial name of the device vendor
-
Added property
commercialDescription
(string)Commercial description of the device vendor
-
Deprecated property
name
(string)Device vendor name
-
-
POST
/admins/operators/{operatorUid}/deviceProfiles
Create Profile
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
vendor
(object)-
Added property
commercialName
(string)Commercial name of the device vendor
-
Added property
commercialDescription
(string)Commercial description of the device vendor
-
Deprecated property
name
(string)Device Vendor name
-
-
GET
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Retrieve Profile
Parameters:
Added: language-tag
in query
Returns items by using the language-tag.
When this query parameter is not specified in the request or when requested language is not available, items are returned by using the default language of the Operator.
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
vendor
(object)-
Added property
commercialName
(string)Commercial name of the device vendor
-
Added property
commercialDescription
(string)Commercial description of the device vendor
-
Deprecated property
name
(string)Device Vendor name
-
-
PUT
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Update Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
vendor
(object)-
Added property
commercialName
(string)Commercial name of the device vendor
-
Added property
commercialDescription
(string)Commercial description of the device vendor
-
Deprecated property
name
(string)Device Vendor name
-
-
Release 5.0.1
General
What's New
GET
/admins/operators/{operatorUid}/baseStationProfiles/catalog
Retrieve Catalog version
POST
/admins/operators/{operatorUid}/baseStationProfiles/catalog
Import Catalog
GET
/admins/operators/{operatorUid}/baseStationProfiles/catalog/selfUpdate
Retrieve latest Catalog version
POST
/admins/operators/{operatorUid}/baseStationProfiles/catalog/selfUpdate
Import Catalog from repository
GET
/admins/operators/{operatorUid}/deviceProfiles/catalog
Retrieve Catalog version
POST
/admins/operators/{operatorUid}/deviceProfiles/catalog
Import Catalog
GET
/admins/operators/{operatorUid}/deviceProfiles/catalog/selfUpdate
Retrieve latest Catalog version
POST
/admins/operators/{operatorUid}/deviceProfiles/catalog/selfUpdate
Import Catalog from repository
GET
/admins/operators/{operatorUid}/partners/{networkPartnerUid}/stationCreditTransactions
Retrieve StationCreditTransactions
What's Changed
GET
/admins/operators/{operatorUid}
Retrieve Operator
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Added property
catalogUpdateMethod
(string)Catalogs update method
- Added property
GET
/admins/operators/{operatorUid}/baseStationProfiles
Retrieve BaseStationProfiles
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Added property
catalogVersion
(string)Current installed version of the base station profiles catalog
- Added property
POST
/admins/operators/{operatorUid}/baseStationProfiles
Create Profile
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Added property
catalogVersion
(string)Current installed version of the base station profiles catalog
- Added property
GET
/admins/operators/{operatorUid}/baseStationProfiles/{profileUid}
Retrieve Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Added property
catalogVersion
(string)Current installed version of the base station profiles catalog
- Added property
PUT
/admins/operators/{operatorUid}/baseStationProfiles/{profileUid}
Update Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Added property
catalogVersion
(string)Current installed version of the base station profiles catalog
- Added property
GET
/admins/operators/{operatorUid}/devices
Retrieve Devices
Parameters:
Added: lorawanDebug
in query
Only return Devices in LoRaWAN debugging mode
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
lorawanDebug
(boolean)TRUE if LoRaWAN debugging is activated
-
Added property
lorawanDebugSince
(string)Last update of LoRaWAN debugging activation status
-
GET
/admins/operators/{operatorUid}/deviceProfiles
Retrieve DeviceProfiles
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)- Added property
catalogVersion
(string)Current installed version of the device profiles catalog
- Added property
POST
/admins/operators/{operatorUid}/deviceProfiles
Create Profile
Request:
-
Changed property
motionModelIndicator
(string)The motion indicator provides an indication on the maximal speed of the node
-
LoRaWAN connectivity
-
Changed property
devNonceCounterBased
(string)Device uses a counter per AppEUI to generate DevNonce. Each time a DevNonce is generated, it is the increment of previous DevNonce generated for the same AppEui. If set to 1, LRC uses this assumption to detect replay attack.
-
Changed property
regionalParameterVersion
(string)Supported revision of LoRaWAN regional parameters: "A" or "B"
-
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
catalogVersion
(string)Current installed version of the device profiles catalog
-
Changed property
motionModelIndicator
(string)The motion indicator provides an indication on the maximal speed of the node
-
LoRaWAN connectivity
-
Changed property
devNonceCounterBased
(string)Device uses a counter per AppEUI to generate DevNonce. Each time a DevNonce is generated, it is the increment of previous DevNonce generated for the same AppEui. If set to 1, LRC uses this assumption to detect replay attack.
-
Changed property
regionalParameterVersion
(string)Supported revision of LoRaWAN regional parameters: "A" or "B"
-
-
GET
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Retrieve Profile
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
catalogVersion
(string)Current installed version of the device profiles catalog
-
Changed property
motionModelIndicator
(string)The motion indicator provides an indication on the maximal speed of the node
-
LoRaWAN connectivity
-
Changed property
devNonceCounterBased
(string)Device uses a counter per AppEUI to generate DevNonce. Each time a DevNonce is generated, it is the increment of previous DevNonce generated for the same AppEui. If set to 1, LRC uses this assumption to detect replay attack.
-
Changed property
regionalParameterVersion
(string)Supported revision of LoRaWAN regional parameters: "A" or "B"
-
-
PUT
/admins/operators/{operatorUid}/deviceProfiles/{profileUid}
Update Profile
Request:
-
Changed property
motionModelIndicator
(string)The motion indicator provides an indication on the maximal speed of the node
-
LoRaWAN connectivity
-
Changed property
devNonceCounterBased
(string)Device uses a counter per AppEUI to generate DevNonce. Each time a DevNonce is generated, it is the increment of previous DevNonce generated for the same AppEui. If set to 1, LRC uses this assumption to detect replay attack.
-
Changed property
regionalParameterVersion
(string)Supported revision of LoRaWAN regional parameters: "A" or "B"
-
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
catalogVersion
(string)Current installed version of the device profiles catalog
-
Changed property
motionModelIndicator
(string)The motion indicator provides an indication on the maximal speed of the node
-
LoRaWAN connectivity
-
Changed property
devNonceCounterBased
(string)Device uses a counter per AppEUI to generate DevNonce. Each time a DevNonce is generated, it is the increment of previous DevNonce generated for the same AppEui. If set to 1, LRC uses this assumption to detect replay attack.
-
Changed property
regionalParameterVersion
(string)Supported revision of LoRaWAN regional parameters: "A" or "B"
-
-
GET
/admins/operators/{operatorUid}/partners
Retrieve Partners
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
totalBaseStationsUsed
(integer)Number of base stations created by the network partner.
-
Added property
delegateBsTagging
(null) -
Added property
totalBaseStationsGranted
(integer)Number of base stations the network partner is allowed to create. If absent or NULL, the partner has no restriction.
-
POST
/admins/operators/{operatorUid}/partners
Create NetworkPartner
Request:
- Added property
delegateBsTagging
(null)
Return Type:
Changed response : 201 Created
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
totalBaseStationsUsed
(integer)Number of base stations created by the network partner.
-
Added property
delegateBsTagging
(null) -
Added property
totalBaseStationsGranted
(integer)Number of base stations the network partner is allowed to create. If absent or NULL, the partner has no restriction.
-
GET
/admins/operators/{operatorUid}/partners/{networkPartnerUid}
Retrieve NetworkPartner
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
totalBaseStationsUsed
(integer)Number of base stations created by the network partner.
-
Added property
delegateBsTagging
(null) -
Added property
totalBaseStationsGranted
(integer)Number of base stations the network partner is allowed to create. If absent or NULL, the partner has no restriction.
-
PUT
/admins/operators/{operatorUid}/partners/{networkPartnerUid}
Update NetworkPartner
Request:
- Added property
delegateBsTagging
(null)
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Added property
totalBaseStationsUsed
(integer)Number of base stations created by the network partner.
-
Added property
delegateBsTagging
(null) -
Added property
totalBaseStationsGranted
(integer)Number of base stations the network partner is allowed to create. If absent or NULL, the partner has no restriction.
-
GET
/admins/operators/{operatorUid}/provqueues
Retrieve Provqueues
Parameters:
Added: subSystem
in query
Provisioning request sub system. When specified, only provisioning requests matching the sub system are returned.
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
subSystem
(string)Type of sub system to provision :
- 'LRC': LRC
- 'SPR': SPR
- 'HSS_SPR': HSS/SPR
- 'PGW': P-GW
-
Changed property
type
(string)Type of the provisioning request:
- DEVICE: Device request (activation, update or deactivation)
- BASE_STATION: Base Station request (activation, update or deactivation)
- ROUTING_PROFILE: AS routing profile (creation, update and deletion)
- SERVICE_PROFILE: Service profile (creation, update and deletion)
- DEVICE_PROFILE: Device profile (creation, update and deletion)
- HSM_GROUP: HSM group (creation, update and deletion)
- BASE_STATION_GROUP: Base Station Group request (creation, update and deletion)
- FLEET: Fleet request (creation, update and deletion)
- NETWORK_CONTEXT: Network Context request (creation, update and deletion)
- ENFORCEMENT_PROFILE: Enforcement Profile request (creation, update and deletion)
- MICROFLOW_PROFILE: Microflow Profile request (creation, update and deletion)
-
GET
/admins/operators/{operatorUid}/provqueues/{eventUid}
Retrieve Event
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
data
(object)-
Changed property
subSystem
(string)Type of sub system to provision :
- 'LRC': LRC
- 'SPR': SPR
- 'HSS_SPR': HSS/SPR
- 'PGW': P-GW
-
Changed property
type
(string)Type of the provisioning request:
- DEVICE: Device request (activation, update or deactivation)
- BASE_STATION: Base Station request (activation, update or deactivation)
- ROUTING_PROFILE: AS routing profile (creation, update and deletion)
- SERVICE_PROFILE: Service profile (creation, update and deletion)
- DEVICE_PROFILE: Device profile (creation, update and deletion)
- HSM_GROUP: HSM group (creation, update and deletion)
- BASE_STATION_GROUP: Base Station Group request (creation, update and deletion)
- FLEET: Fleet request (creation, update and deletion)
- NETWORK_CONTEXT: Network Context request (creation, update and deletion)
- ENFORCEMENT_PROFILE: Enforcement Profile request (creation, update and deletion)
- MICROFLOW_PROFILE: Microflow Profile request (creation, update and deletion)
-
Release 4.3
General
N/A