network-manager-changelog-tpw-operator

Release 8.0

RDTP-14487

What's Changed

`GET|PUT` /partners/{partnerUid}

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property partner (object)
- Added property grantedPermissions (array)
  
  Items (string):
  
  Enum values:
  - x
  - a
  - ra
  - rc
  - s1
- Added property domainRestrictions (object)
  User's domain restrictions:
  - If no domain restrictions are defined, the user can access all cross-domain resources and all domain-specific resources
  - Else, the user can access all cross-domain resources and only domain-specific resources matching the domain restrictions
  - Property and (array)
    
    A resource matches if it matches all and items.
    
    Items (object):
    A resource matches if it is associated with a domain satisfying the following requirements:
    - The group name of the resource domain is group.name (exact match)
    - If type is PREFIX:
      
      The name of the resource domain is prefixed with name
    - Else: (type is FULL)
      
      The name of the resource domain is name (exact match)
    - Property type (string)
      Type of domain restriction:
      
      FULL: restriction on full domain
      
      PREFIX: restriction on domain prefix
      Enum values:
      - FULL
      - PREFIX
    - Property name (string)
      
      Name of the full domain or domain prefix
    - Property group (object)
      
      Domain group associated with the domain restriction
      - Property name (string)
        
        Name of the domain group

RDTP-18707

What's Changed

`POST` /partners/{partnerUid}/bss

Request:

Added property alarmsConfiguration (object)
- Property alarm102 (array)
  
  Configuration of the base station connection status alarm (102)
  
  Items (object):
  
  Each item defines a threshold for the triggering of the alarm. If alarm102 property is null or not set at base station creation, 1 threshold is configured by default to trigger the alarm with a CRITICAL severity after 30 seconds of base station disconnection. A maximum of 1 threshold can be configured.
  - Property duration (string)
    
    ISO 8601 duration of the base station disconnection before triggering the alarm for this threshold.
  - Property severity (integer)
    Severity of the alarm for this threshold:
    - 6: CRITICAL
    - 5: MAJOR
    - 4: MINOR
    - 3: WARNING
    - 2: INDETERMINATE
- Property alarm103 (array)
  
  Configuration of the base station no uplink activity alarm (103)
  
  Items (object):
  Each item defines a threshold for the triggering of the alarm. By default, no threshold is configured. A maximum of 2 thresholds can be configured. When 2 thresholds are configured:
  - The duration of the second threshold must be higher than the first one.
  - The severity of the second threshold must be higher than the first one.
  - Property duration (string)
    
    ISO 8601 duration of the base station no uplink activity before triggering the alarm for this threshold.
  - Property severity (integer)
    Severity of the alarm for this threshold:
    - 6: CRITICAL
    - 5: MAJOR
    - 4: MINOR
    - 3: WARNING
    - 2: INDETERMINATE
Deprecated property alarm103 (string)

Return Type:

Changed response : 201 Created

New required property:

alarmsConfiguration

Added property alarmsConfiguration (object)
- Property alarm102 (array)
  
  Configuration of the base station connection status alarm (102)
  
  Items (object):
  
  Each item defines a threshold for the triggering of the alarm. If alarm102 property is null or not set at base station creation, 1 threshold is configured by default to trigger the alarm with a CRITICAL severity after 30 seconds of base station disconnection. A maximum of 1 threshold can be configured.
  - Property duration (string)
    
    ISO 8601 duration of the base station disconnection before triggering the alarm for this threshold.
  - Property severity (integer)
    Severity of the alarm for this threshold:
    - 6: CRITICAL
    - 5: MAJOR
    - 4: MINOR
    - 3: WARNING
    - 2: INDETERMINATE
- Property alarm103 (array)
  
  Configuration of the base station no uplink activity alarm (103)
  
  Items (object):
  Each item defines a threshold for the triggering of the alarm. By default, no threshold is configured. A maximum of 2 thresholds can be configured. When 2 thresholds are configured:
  - The duration of the second threshold must be higher than the first one.
  - The severity of the second threshold must be higher than the first one.
  - Property duration (string)
    
    ISO 8601 duration of the base station no uplink activity before triggering the alarm for this threshold.
  - Property severity (integer)
    Severity of the alarm for this threshold:
    - 6: CRITICAL
    - 5: MAJOR
    - 4: MINOR
    - 3: WARNING
    - 2: INDETERMINATE
Deprecated property alarm103 (string)

`GET` /partners/{partnerUid}/bss/{bsUid}

Return Type:

Changed response : 200 OK

New required property:

alarmsConfiguration

Added property alarmsConfiguration (object)
- Property alarm102 (array)
  
  Configuration of the base station connection status alarm (102)
  
  Items (object):
  
  Each item defines a threshold for the triggering of the alarm. If alarm102 property is null or not set at base station creation, 1 threshold is configured by default to trigger the alarm with a CRITICAL severity after 30 seconds of base station disconnection. A maximum of 1 threshold can be configured.
  - Property duration (string)
    
    ISO 8601 duration of the base station disconnection before triggering the alarm for this threshold.
  - Property severity (integer)
    Severity of the alarm for this threshold:
    - 6: CRITICAL
    - 5: MAJOR
    - 4: MINOR
    - 3: WARNING
    - 2: INDETERMINATE
- Property alarm103 (array)
  
  Configuration of the base station no uplink activity alarm (103)
  
  Items (object):
  Each item defines a threshold for the triggering of the alarm. By default, no threshold is configured. A maximum of 2 thresholds can be configured. When 2 thresholds are configured:
  - The duration of the second threshold must be higher than the first one.
  - The severity of the second threshold must be higher than the first one.
  - Property duration (string)
    
    ISO 8601 duration of the base station no uplink activity before triggering the alarm for this threshold.
  - Property severity (integer)
    Severity of the alarm for this threshold:
    - 6: CRITICAL
    - 5: MAJOR
    - 4: MINOR
    - 3: WARNING
    - 2: INDETERMINATE
Deprecated property alarm103 (string)

`PUT` /partners/{partnerUid}/bss/{bsUid}

Request:

Added property alarmsConfiguration (object)
- Property alarm102 (array)
  
  Configuration of the base station connection status alarm (102)
  
  Items (object):
  
  Each item defines a threshold for the triggering of the alarm. If alarm102 property is null or not set at base station creation, 1 threshold is configured by default to trigger the alarm with a CRITICAL severity after 30 seconds of base station disconnection. A maximum of 1 threshold can be configured.
  - Property duration (string)
    
    ISO 8601 duration of the base station disconnection before triggering the alarm for this threshold.
  - Property severity (integer)
    Severity of the alarm for this threshold:
    - 6: CRITICAL
    - 5: MAJOR
    - 4: MINOR
    - 3: WARNING
    - 2: INDETERMINATE
- Property alarm103 (array)
  
  Configuration of the base station no uplink activity alarm (103)
  
  Items (object):
  Each item defines a threshold for the triggering of the alarm. By default, no threshold is configured. A maximum of 2 thresholds can be configured. When 2 thresholds are configured:
  - The duration of the second threshold must be higher than the first one.
  - The severity of the second threshold must be higher than the first one.
  - Property duration (string)
    
    ISO 8601 duration of the base station no uplink activity before triggering the alarm for this threshold.
  - Property severity (integer)
    Severity of the alarm for this threshold:
    - 6: CRITICAL
    - 5: MAJOR
    - 4: MINOR
    - 3: WARNING
    - 2: INDETERMINATE
Deprecated property alarm103 (string)

Return Type:

Changed response : 200 OK

New required property:

alarmsConfiguration

Added property alarmsConfiguration (object)
- Property alarm102 (array)
  
  Configuration of the base station connection status alarm (102)
  
  Items (object):
  
  Each item defines a threshold for the triggering of the alarm. If alarm102 property is null or not set at base station creation, 1 threshold is configured by default to trigger the alarm with a CRITICAL severity after 30 seconds of base station disconnection. A maximum of 1 threshold can be configured.
  - Property duration (string)
    
    ISO 8601 duration of the base station disconnection before triggering the alarm for this threshold.
  - Property severity (integer)
    Severity of the alarm for this threshold:
    - 6: CRITICAL
    - 5: MAJOR
    - 4: MINOR
    - 3: WARNING
    - 2: INDETERMINATE
- Property alarm103 (array)
  
  Configuration of the base station no uplink activity alarm (103)
  
  Items (object):
  Each item defines a threshold for the triggering of the alarm. By default, no threshold is configured. A maximum of 2 thresholds can be configured. When 2 thresholds are configured:
  - The duration of the second threshold must be higher than the first one.
  - The severity of the second threshold must be higher than the first one.
  - Property duration (string)
    
    ISO 8601 duration of the base station no uplink activity before triggering the alarm for this threshold.
  - Property severity (integer)
    Severity of the alarm for this threshold:
    - 6: CRITICAL
    - 5: MAJOR
    - 4: MINOR
    - 3: WARNING
    - 2: INDETERMINATE
Deprecated property alarm103 (string)

`GET` /partners/{partnerUid}/bss/alarms

`GET` /partners/{partnerUid}/bss/alarms/histories

`GET` /partners/{partnerUid}/bss/{bsUid}/alarms

`GET` /partners/{partnerUid}/bss/{bsUid}/alarms/histories

Return Type:

Changed response : 200 OK

New additional information elements are defined:

Alarm 104: Unusually high level of invalid uplink physical CRC
- addInfo2: percentage of invalid uplink frames during the last 4 hours
Alarm 105: Downlink frame rate exceeds the RF cell capacity
- addInfo2: percentage of dropped downlink frames during the last hour
Alarm 106: Unusually high CPU usage level
- addInfo2: average CPU usage in percentage during the last hour
Alarm 107: Unusually high RAM usage level
- addInfo2: average RAM usage in percentage during the last hour
Alarm 108: Unusually high file system usage level
- addInfo2: average file system usage in percentage during the last hour
Alarm 111: Beacon transmission failure
- addInfo2: percentage of beacon failures on the last hour

Existing additional information elements are deprecated:

Alarm 104: Unusually high level of invalid uplink physical CRC
- addInfo: number of invalid uplink frames during the last 4 hours
Alarm 105: Downlink frame rate exceeds the RF cell capacity
- addInfo: number of dropped downlink frames during the last hour
Alarm 111: Beacon transmission failure
- addInfo: last beacon delivery failure cause

RDTP-22321

What's New

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/changeSupportPassword

Change the support password of a base station

What's Changed

`POST` /partners/{partnerUid}/bss

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Added property supportPassword (object)

The base station support account is used to establish remote sessions. The authentication relies on a password that can be customized for each individual base station.

Only applicable if the base station executes the Actility LRR software (model.softwareType = 'LRR_LINUX')
- Property lastChanged (integer)
  
  Date of the last change of the support password, epoch time in milliseconds. Only returned if the support password has been successfully customized for this base station.

`GET` /partners/{partnerUid}/bss/{bsUid}

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Added property supportPassword (object)

The base station support account is used to establish remote sessions. The authentication relies on a password that can be customized for each individual base station.

Only applicable if the base station executes the Actility LRR software (model.softwareType = 'LRR_LINUX')
- Property lastChanged (integer)
  
  Date of the last change of the support password, epoch time in milliseconds. Only returned if the support password has been successfully customized for this base station.

`PUT` /partners/{partnerUid}/bss/{bsUid}

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Added property supportPassword (object)

The base station support account is used to establish remote sessions. The authentication relies on a password that can be customized for each individual base station.

Only applicable if the base station executes the Actility LRR software (model.softwareType = 'LRR_LINUX')
- Property lastChanged (integer)
  
  Date of the last change of the support password, epoch time in milliseconds. Only returned if the support password has been successfully customized for this base station.

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/lastCmdStatus

Return Type:

Changed response : 200 OK

Successful RETRIEVE

Changed property lastCmdType (string)
Added new command type:
- CHANGE_SUPPORT_PASSWORD: change the support account's password

RDTP-23153

What's Changed

`POST` /partners/{partnerUid}/bss

Request:

New required properties:

lrrUUID

Deleted property lrrID (object)

Base Station LRR ID: 8 hexadecimal characters in upper case.

RDTP-23309

What's Changed

`GET` /partners/{partnerUid}

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`PUT` /partners/{partnerUid}

Parameters:

Deprecated: force in query

This parameter must no longer be used: it is useless and ignored.

Request:

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`POST` /partners/{partnerUid}/bss

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`GET` /partners/{partnerUid}/bss/{bsUid}

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`PUT` /partners/{partnerUid}/bss/{bsUid}

Parameters:

Deprecated: force in query

This parameter must no longer be used: it is useless and ignored.

Request:

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/backup

Parameters:

Deprecated: force in query

This parameter must no longer be used: it is useless and ignored.

Request:

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Return Type:

Changed response : 201 Created

Successful CREATE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/cancelRadioScan

Parameters:

Deprecated: force in query

This parameter must no longer be used: it is useless and ignored.

Request:

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Return Type:

Changed response : 201 Created

Successful CREATE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/closeSsh

Parameters:

Deprecated: force in query

This parameter must no longer be used: it is useless and ignored.

Request:

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Return Type:

Changed response : 201 Created

Successful CREATE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/downloadLrrVersion

Parameters:

Deprecated: force in query

This parameter must no longer be used: it is useless and ignored.

Request:

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Return Type:

Changed response : 201 Created

Successful CREATE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/openSsh

Parameters:

Deprecated: force in query

This parameter must no longer be used: it is useless and ignored.

Request:

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Return Type:

Changed response : 201 Created

Successful CREATE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/openTerminal

Parameters:

Deprecated: force in query

This parameter must no longer be used: it is useless and ignored.

Request:

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Return Type:

Changed response : 201 Created

Successful CREATE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/reboot

Parameters:

Deprecated: force in query

This parameter must no longer be used: it is useless and ignored.

Request:

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Return Type:

Changed response : 201 Created

Successful CREATE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/restart

Parameters:

Deprecated: force in query

This parameter must no longer be used: it is useless and ignored.

Request:

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Return Type:

Changed response : 201 Created

Successful CREATE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/restore

Parameters:

Deprecated: force in query

This parameter must no longer be used: it is useless and ignored.

Request:

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Return Type:

Changed response : 201 Created

Successful CREATE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/rfcDownlinkStop

Parameters:

Deprecated: force in query

This parameter must no longer be used: it is useless and ignored.

Request:

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Return Type:

Changed response : 201 Created

Successful CREATE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/rfcStart

Parameters:

Deprecated: force in query

This parameter must no longer be used: it is useless and ignored.

Request:

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Return Type:

Changed response : 201 Created

Successful CREATE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/rfcStop

Parameters:

Deprecated: force in query

This parameter must no longer be used: it is useless and ignored.

Request:

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Return Type:

Changed response : 201 Created

Successful CREATE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/scanRadio

Parameters:

Deprecated: force in query

This parameter must no longer be used: it is useless and ignored.

Request:

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Return Type:

Changed response : 201 Created

Successful CREATE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`PUT` /partners/{partnerUid}/bss/{bsUid}/admins/settings

Parameters:

Deprecated: force in query

This parameter must no longer be used: it is useless and ignored.

Request:

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/updateAntennasGainAndLoss

Parameters:

Deprecated: force in query

This parameter must no longer be used: it is useless and ignored.

Request:

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Return Type:

Changed response : 201 Created

Successful CREATE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/updateFineTimestampKeys

Parameters:

Deprecated: force in query

This parameter must no longer be used: it is useless and ignored.

Request:

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Return Type:

Changed response : 201 Created

Successful CREATE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/updateLocation

Parameters:

Deprecated: force in query

This parameter must no longer be used: it is useless and ignored.

Request:

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Return Type:

Changed response : 201 Created

Successful CREATE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/updateLog

Parameters:

Deprecated: force in query

This parameter must no longer be used: it is useless and ignored.

Request:

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Return Type:

Changed response : 201 Created

Successful CREATE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/updateRfRegion

Parameters:

Deprecated: force in query

This parameter must no longer be used: it is useless and ignored.

Request:

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Return Type:

Changed response : 201 Created

Successful CREATE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/upgrade

Parameters:

Deprecated: force in query

This parameter must no longer be used: it is useless and ignored.

Request:

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Return Type:

Changed response : 201 Created

Successful CREATE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`GET` /partners/{partnerUid}/bss/{bsUid}/ants/{antUid}

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

`PUT` /partners/{partnerUid}/bss/{bsUid}/ants/{antUid}

Parameters:

Deprecated: force in query

This parameter must no longer be used: it is useless and ignored.

Request:

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Deprecated property occContext (object)

Optimistic Concurrency Control.

This property must no longer be used: it is useless and ignored.

Release 7.3

RDTP-10825

What's Changed

`POST` /partners/{partnerUid}/bss

Create Bs

Request:

Deprecated property diskConfig (string)

Mounted filesystems of the base station.

Empty until the configuration is reported by the base station.

This parameter must no longer be used: ignored in requests, the mfs property must be used in responses.
Deprecated property lrcConfig (string)

LRCs used by the base station.

Empty until the configuration is reported by the base station.

This parameter must no longer be used: ignored in requests, the lrcs property must be used in responses.
Deprecated property powerConfig (string)
Power source of the base station:
- MAINS,
- POE (Power over Ethernet),
- WBAT (Wind / Battery),
- SBAT (Solar / Battery)
Empty until the configuration is reported by the base station.

This parameter must no longer be used: ignored in requests, the power property must be used in responses.

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Deprecated property diskConfig (string)

Mounted filesystems of the base station.

Empty until the configuration is reported by the base station.

This parameter must no longer be used: ignored in requests, the mfs property must be used in responses.
Deprecated property lrcConfig (string)

LRCs used by the base station.

Empty until the configuration is reported by the base station.

This parameter must no longer be used: ignored in requests, the lrcs property must be used in responses.
Changed property lrcs (object)
- Changed property lrc (array)
  
  Changed items (object):
  - Added property address (string)
    
    LRC address
  - Added property ID (string)
    
    LRC identifier
Deprecated property powerConfig (string)
Power source of the base station:
- MAINS,
- POE (Power over Ethernet),
- WBAT (Wind / Battery),
- SBAT (Solar / Battery)
Empty until the configuration is reported by the base station.

This parameter must no longer be used: ignored in requests, the power property must be used in responses.

`GET` /partners/{partnerUid}/bss/{bsUid}

Retrieve Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Deprecated property diskConfig (string)

Mounted filesystems of the base station.

Empty until the configuration is reported by the base station.

This parameter must no longer be used: ignored in requests, the mfs property must be used in responses.
Deprecated property lrcConfig (string)

LRCs used by the base station.

Empty until the configuration is reported by the base station.

This parameter must no longer be used: ignored in requests, the lrcs property must be used in responses.
Changed property lrcs (object)
- Changed property lrc (array)
  
  Changed items (object):
  - Added property address (string)
    
    LRC address
  - Added property ID (string)
    
    LRC identifier
Deprecated property powerConfig (string)
Power source of the base station:
- MAINS,
- POE (Power over Ethernet),
- WBAT (Wind / Battery),
- SBAT (Solar / Battery)
Empty until the configuration is reported by the base station.

This parameter must no longer be used: ignored in requests, the power property must be used in responses.

`PUT` /partners/{partnerUid}/bss/{bsUid}

Update Bs

Request:

Deprecated property diskConfig (string)

Mounted filesystems of the base station.

Empty until the configuration is reported by the base station.

This parameter must no longer be used: ignored in requests, the mfs property must be used in responses.
Deprecated property lrcConfig (string)

LRCs used by the base station.

Empty until the configuration is reported by the base station.

This parameter must no longer be used: ignored in requests, the lrcs property must be used in responses.
Deprecated property powerConfig (string)
Power source of the base station:
- MAINS,
- POE (Power over Ethernet),
- WBAT (Wind / Battery),
- SBAT (Solar / Battery)
Empty until the configuration is reported by the base station.

This parameter must no longer be used: ignored in requests, the power property must be used in responses.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Deprecated property diskConfig (string)

Mounted filesystems of the base station.

Empty until the configuration is reported by the base station.

This parameter must no longer be used: ignored in requests, the mfs property must be used in responses.
Deprecated property lrcConfig (string)

LRCs used by the base station.

Empty until the configuration is reported by the base station.

This parameter must no longer be used: ignored in requests, the lrcs property must be used in responses.
Changed property lrcs (object)
- Changed property lrc (array)
  
  Changed items (object):
  - Added property address (string)
    
    LRC address
  - Added property ID (string)
    
    LRC identifier
Deprecated property powerConfig (string)
Power source of the base station:
- MAINS,
- POE (Power over Ethernet),
- WBAT (Wind / Battery),
- SBAT (Solar / Battery)
Empty until the configuration is reported by the base station.

This parameter must no longer be used: ignored in requests, the power property must be used in responses.

RDTP-17900

What's Changed

All paths `/partners/\{partnerUid\}/*`

Parameters:

Changed: partnerUid in path

Unique identifier of the network partner, either

the sequential integer (UID) of the network partner

the identifier (ID) of a subscriber prefixed by id:sub:

the identifier (ID) of a supplier prefixed by id:sup:

the string mine to reference the network partner associated to the authenticated user requesting the API

RDTP-18670

What's Changed

`POST` /partners/{partnerUid}/bss

Request:

Deprecated property adminAltGround (integer)

Altitude above the ground level in meters

This parameter must no longer be used: the altitudeAboveGround property in each antenna description must be used in replacement.

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Deprecated property adminAltGround (integer)

Altitude above the ground level in meters

This parameter must no longer be used: the altitudeAboveGround property in each antenna description must be used in replacement.

`GET` /partners/{partnerUid}/bss/{bsUid}

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Deprecated property adminAltGround (integer)

Altitude above the ground level in meters

This parameter must no longer be used: the altitudeAboveGround property in each antenna description must be used in replacement.

`PUT` /partners/{partnerUid}/bss/{bsUid}

Request:

Deprecated property adminAltGround (integer)

Altitude above the ground level in meters

This parameter must no longer be used: the altitudeAboveGround property in each antenna description must be used in replacement.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Deprecated property adminAltGround (integer)

Altitude above the ground level in meters

This parameter must no longer be used: the altitudeAboveGround property in each antenna description must be used in replacement.

RDTP-18681

What's New

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/basicsStation/remoteShells

List remote shell sessions

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/basicsStation/remoteShells/{remoteShellIdx}

Start the remote shell session

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/basicsStation/remoteShells/{remoteShellIdx}/stop

Stop the remote shell session

RDTP-19834

What's Changed

`GET` /partners/{partnerUid}

Retrieve Partner

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

allowedAdministration
allowedBsTagging
baseStationTagsNamespace
delegateAdministration
delegateBsTagging
delegateBsValidation

`PUT` /partners/{partnerUid}

Update Partner

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

allowedAdministration
allowedBsTagging
baseStationTagsNamespace
delegateAdministration
delegateBsTagging
delegateBsValidation

`GET` /partners/{partnerUid}/bsProfiles

Retrieve BsProfiles

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (array)

Changed items (object):
- Changed property vendor (object)
  
  The following properties are now optional:
  - name

`GET` /partners/{partnerUid}/bsVendors

Retrieve BaseStationVendors

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (array)

Changed items (object):

The following properties are now optional:
- name

`GET` /partners/{partnerUid}/bss

Retrieve Bss

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (array)

Changed items (object):
- Changed property vendor (object)
  
  The following properties are now optional:
  - name

`POST` /partners/{partnerUid}/bss

Create Bs

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

The following properties are now optional:

allowClassB
upgradePolicy

Changed property vendor (object)

The following properties are now optional:
- name

`GET` /partners/{partnerUid}/bss/clusters

Retrieve Base stations Clusters

Return Type:

Changed response : 200 OK

Successful RETRIEVE

Changed property clusters (array)

Changed items (object):

A group a base stations close to each other.
- Changed property item (object)
  - Changed property vendor (object)
    
    The following properties are now optional:
    - name

`POST` /partners/{partnerUid}/bss/tags

Tag Bss

Return Type:

Changed response : 200 OK

Successful CREATE

The following properties are now optional:

managedNetworkVisibility

`GET` /partners/{partnerUid}/bss/{bsUid}

Retrieve Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

allowClassB
upgradePolicy

Changed property vendor (object)

The following properties are now optional:
- name

`PUT` /partners/{partnerUid}/bss/{bsUid}

Update Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

allowClassB
upgradePolicy

Changed property vendor (object)

The following properties are now optional:
- name

`PUT` /partners/{partnerUid}/bss/{bsUid}/admins/settings

Update AdminSettings

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

allowClassB
upgradePolicy

`GET` /partners/{partnerUid}/bss/{bsUid}/tags

Retrieve Tags

Return Type:

Changed response : 200 OK

Successful RETRIEVE

Changed property briefs (array)

Changed items (object):

The following properties are now optional:
- managedNetworkVisibility

`POST` /partners/{partnerUid}/bss/{bsUid}/tags

Add Tag

Return Type:

Changed response : 201 Created

Successful CREATE

The following properties are now optional:

managedNetworkVisibility

`PUT` /partners/{partnerUid}/bss/{bsUid}/tags/{tagUid}

Update Tag

Return Type:

Changed response : 200 OK

Successful CREATE

The following properties are now optional:

managedNetworkVisibility

`PUT` /partners/{partnerUid}/restricted

Update Restricted Settings

Return Type:

Changed response : 200 OK

Successful UPDATE

The following properties are now optional:

baseStationTagsNamespace
delegateAdministration

RDTP-19860

What's New

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/downlinks/statusDistribution

Retrieve Downlink Status Distribution

What's Deprecated

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/downlinks/statusDistributions

Retrieve Downlink Status Distribution

RDTP-20613

What's Changed

`POST` /partners/{partnerUid}/bss

Create Base Station

Request:

Changed property lrrID (string)
Base Station LRR ID: 8 hexadecimal characters / case insensitive but always converted in upper case by the server. The value 00000000 and the prefixes FFFE and FFFF are reserved and forbidden.

Forbidden in Create if LRR UUID is provided:
- The identification mode is set to LRR_UUID
- The LRR ID is automatically allocated and returned in response
Mandatory in Create if LRR UUID is not provided:
- The identification mode is set to LRR_ID
- This case is deprecated and should not be used

RDTP-5254

What's New

`GET` /partners/{partnerUid}/alarmNotificationSettings

Retrieve Alarm Notification Settings

`PUT` /partners/{partnerUid}/alarmNotificationSettings

Update Alarm Notification Settings

What's Changed

`GET` /partners/{partnerUid}/bss

Retrieve Bss

Parameters:

Added: appServerID in query

Only returns Base Stations associated with the Application Server.

Multiple values can be set: in this case Base Stations must be associated with all provided Application Servers.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (array)

Changed items (object):
- Added property appServers (array)
  
  List of application servers associated with the base station for alarms reporting purposes.
  
  Only supported if the partner's type is SUBSCRIBER: associated applications servers must belong to the same subscriber account and must be of type Kafka.
  
  Items (object):
  - Property ID (string)
    
    Application server ID
  - Property href (string)
    
    Application server HREF
  - Property name (string)
    
    Application Server name

`POST` /partners/{partnerUid}/bss

Create Bs

Request:

Added property appServers (array)

List of application servers associated with the base station for alarms reporting purposes.

Only supported if the partner's type is SUBSCRIBER: associated applications servers must belong to the same subscriber account and must be of type Kafka.

Items (object):
- Property ID (string)
  
  Application server ID
- Property href (string)
  
  Application server HREF
- Property name (string)
  
  Application Server name

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Added property appServers (array)

List of application servers associated with the base station for alarms reporting purposes.

Only supported if the partner's type is SUBSCRIBER: associated applications servers must belong to the same subscriber account and must be of type Kafka.

Items (object):
- Property ID (string)
  
  Application server ID
- Property href (string)
  
  Application server HREF
- Property name (string)
  
  Application Server name

`GET` /partners/{partnerUid}/bss/clusters

Retrieve Base stations Clusters

Parameters:

Added: appServerID in query

Only returns Base Stations associated with the Application Server.

Multiple values can be set: in this case Base Stations must be associated with all provided Application Servers.

Return Type:

Changed response : 200 OK

Successful RETRIEVE

Changed property clusters (array)

Changed items (object):

A group a base stations close to each other.
- Changed property item (object)
  - Added property appServers (array)
    
    List of application servers associated with the base station for alarms reporting purposes.
    
    Only supported if the partner's type is SUBSCRIBER: associated applications servers must belong to the same subscriber account and must be of type Kafka.
    
    Items (object):
    - Property ID (string)
      
      Application server ID
    - Property href (string)
      
      Application server HREF
    - Property name (string)
      
      Application Server name

`GET` /partners/{partnerUid}/bss/{bsUid}

Retrieve Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Added property appServers (array)

List of application servers associated with the base station for alarms reporting purposes.

Only supported if the partner's type is SUBSCRIBER: associated applications servers must belong to the same subscriber account and must be of type Kafka.

Items (object):
- Property ID (string)
  
  Application server ID
- Property href (string)
  
  Application server HREF
- Property name (string)
  
  Application Server name

`PUT` /partners/{partnerUid}/bss/{bsUid}

Update Bs

Request:

Added property appServers (array)

List of application servers associated with the base station for alarms reporting purposes.

Only supported if the partner's type is SUBSCRIBER: associated applications servers must belong to the same subscriber account and must be of type Kafka.

Items (object):
- Property ID (string)
  
  Application server ID
- Property href (string)
  
  Application server HREF
- Property name (string)
  
  Application Server name

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Added property appServers (array)

List of application servers associated with the base station for alarms reporting purposes.

Only supported if the partner's type is SUBSCRIBER: associated applications servers must belong to the same subscriber account and must be of type Kafka.

Items (object):
- Property ID (string)
  
  Application server ID
- Property href (string)
  
  Application server HREF
- Property name (string)
  
  Application Server name

Release 7.2

RDTP-17380

What's Changed

`PUT` /partners/{partnerUid}/bss/{bsUid}

Update Bs

Request:

Added property bsSecurity (object)

The base station security defines how the connection to the core network is secured. It only applies when the base station identification mode is LRR_UUID. When the base station identification mode is LRR_ID, the management of the base station security is performed outside the Network Manager API and type is set to DISABLE.
- Property type (string)
  Base Station security type:
  - IPSEC_X509: the connection to the core network is secured using IPsec or TLS (X.509 certificates)
  - DISABLE: the connection to the core network is not secured
  Enum values:
  - IPSEC_X509
  - DISABLE

RDTP-17763

What's Deprecated

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/lcs/{lcUid}/spreadingFactors/sfDistributions

Retrieve SfDistributions

What's Changed

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/lcs/{lcUid}/signalsAndNoises/snDistributions

Retrieve SnDistributions

Parameters:

Deprecated: precision in query

Define the precision of each level (OPTIONAL)

Default value: When this query parameter is not specified a precision of 1 dBm is used for RSSI and ESP, and a precision of 0.2 dB is used for SNR

Supported precision: Between 0.1 ... 1*

This parameter must no longer be used: the default precision must be used.

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/spreadingFactors/sfDistributions

Retrieve SfDistributions

Parameters:

Deprecated: lcs in query

Logical channels considered for SF distribution:

A logical channel (e.g. 255)

A list of logical channels (e.g. 1,2,3)

A range of logical channels (e.g. 0-254)

Default value: When this query parameter is not specified all logical channels are considered.

This parameter must no longer be used: SF distribution should be done on all logical channels.

RDTP-18143

What's Changed

`GET`|`PUT` /partners/{partnerUid}

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property baseStationsNetID (string)

NetID types 1, 2, 4, 5 and 7 are now allowed
Changed property operator (object)
- Changed property baseStationsNetID (string)
  
  NetID types 1, 2, 4, 5 and 7 are now allowed

`PUT` /partners/{partnerUid}/restricted

Request:

Changed property baseStationsNetID (string)

NetID types 1, 2, 4, 5 and 7 are now allowed

Return Type:

Changed response : 200 OK

Successful UPDATE

Changed property baseStationsNetID (string)

NetID types 1, 2, 4, 5 and 7 are now allowed

RDTP-18480

What's New

`GET` /partners/{partnerUid}/usersAlarmsSubscriptions

Retrieve Users Alarms Subscriptions

`GET` /partners/{partnerUid}/users/{thingparkID}/alarmsSubscription

Retrieve User Alarms Subscription

`PUT` /partners/{partnerUid}/users/{thingparkID}/alarmsSubscription

Update User Alarms Subscription

`POST` /partners/{partnerUid}/users/{thingparkID}/alarmsSubscription

Create User Alarms Subscription

`DELETE` /partners/{partnerUid}/users/{thingparkID}/alarmsSubscription

Delete User Alarms Subscription

RDTP-18988

What's Changed

`GET` /partners/{partnerUid}/bss/{bsUid}/frames

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/lcs/{lcId}/dutyCycles/histories

`GET` /partners/{partnerUid}/bss/{bsUid}/sys/cpu/histories

`GET` /partners/{partnerUid}/bss/{bsUid}/sys/disks/{diskIndex}/histories

`GET` /partners/{partnerUid}/bss/{bsUid}/sys/ram/histories

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/iecQueues/histories

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/ints/{intUid}/bitrates

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/ints/{intUid}/histories

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/ints/{intUid}/roundTrips

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/lrcs/{lrcUid}/iecPackets

Retrieve IecPackets

Parameters:

Changed: step in query

Aggregation step (OPTIONAL). This parameter is used to determine the size of each time slot.

Default value: When this query parameter is not specified the PT1H duration is used by default.

Supported duration step: PTxH (between 1...24 hours) or P1D (1 day, take into account STD and DST clock shifts when applicable to the selected time zone)

RDTP-19281

What's New

`GET` /partners/{partnerUid}/bss/alarms/histories

Retrieve Alarms History of all Base Stations

What's Changed

`GET` /partners/{partnerUid}/bss/alarms

Retrieve Alarms of all Base Stations

Parameters:

Added: alarmUid in query

Alarm Uid identifying the alarm occurrence

Return Type:

Changed response : 200 OK

Successful RETRIEVE

Changed property briefs (array)

Changed items (object):

New required properties:
- alarmUid
- Added property alarmUid (string)
  
  Alarm Uid identifying the alarm occurrence

`GET` /partners/{partnerUid}/bss/{bsUid}/alarms

Retrieve Alarms of a Base Station

Return Type:

Changed response : 200 OK

Successful RETRIEVE

Changed property briefs (array)

Changed items (object):

New required properties:
- alarmUid
- Added property alarmUid (string)
  
  Alarm Uid identifying the alarm occurrence

`GET` /partners/{partnerUid}/bss/{bsUid}/alarms/histories

Retrieve Alarms History of a Base Station

Return Type:

Changed response : 200 OK

Successful RETRIEVE

Changed property briefs (array)

Changed items (object):

New required properties:
- alarmUid
- Added property alarmUid (string)
  
  Alarm Uid identifying the alarm occurrence

RDTP-19707

What's Changed

`POST` /partners/{partnerUid}/bsProfiles/catalog/selfUpdate

`POST` /partners/{partnerUid}/rfRegions/catalog/selfUpdate

Import Catalog from repository

Access rights:

If the partner's type is SUBSCRIBER and at least one domain group exists in the subscriber account:
- <NetworkPartner>/RA
- <NetworkPartner>/s1: MANAGE_SUBSCRIBER
Else:
- <NetworkPartner>/a

RDTP-7689

What's Changed

`GET` /partners/{partnerUid}/bss

Retrieve Bss

Parameters:

Added: bsSecurityState in query

Only returns base stations for which the state of the security matches the provided value:

EXPIRED: the type of security is IPSEC_X509 and the base station certificate has expired

EXPIRATION_IN_LESS_THAN_1_WEEK: the type of security is IPSEC_X509 and the base station certificate will expire in less than 1 week

EXPIRATION_IN_LESS_THAN_1_MONTH: the type of security is IPSEC_X509 and the base station certificate will expire in less than 1 month

DISABLED: the type of security is DISABLE and the base station identification mode is LRR_UUID

UNKNOWN: the type of security is DISABLE and the base station identification mode is LRR_ID

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (array)

Changed items (object):
- Added property bsSecurity (object)
  - Property expirationDate (integer)
    
    Date of Base Station certificate expiration, epoch time in milliseconds
  - Property generationDate (integer)
    
    Date of Base Station certificate generation, epoch time in milliseconds
  - Property type (string)
    Base Station security type:
    - IPSEC_X509: IPsec or TLS (X.509 certificates)
    - DISABLE
    Enum values:
    - IPSEC_X509
    - DISABLE

`POST` /partners/{partnerUid}/bss

Create Bs

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Changed property bsSecurity (object)
- Added property expirationDate (integer)
  
  Date of Base Station certificate expiration, epoch time in milliseconds

`GET` /partners/{partnerUid}/bss/clusters

Retrieve Base stations Clusters

Parameters:

Added: bsSecurityState in query

Only returns base stations for which the state of the security matches the provided value:

EXPIRED: the type of security is IPSEC_X509 and the base station certificate has expired

EXPIRATION_IN_LESS_THAN_1_WEEK: the type of security is IPSEC_X509 and the base station certificate will expire in less than 1 week

EXPIRATION_IN_LESS_THAN_1_MONTH: the type of security is IPSEC_X509 and the base station certificate will expire in less than 1 month

DISABLED: the type of security is DISABLE

UNKNOWN: the type of security is unknown because the base station identification mode is LRR_ID

`GET` /partners/{partnerUid}/bss/{bsUid}

Retrieve Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property bsSecurity (object)
- Added property expirationDate (integer)
  
  Date of Base Station certificate expiration, epoch time in milliseconds

`PUT` /partners/{partnerUid}/bss/{bsUid}

Update Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property bsSecurity (object)
- Added property expirationDate (integer)
  
  Date of Base Station certificate expiration, epoch time in milliseconds

RDTP-8479

What's New

`POST` /partners/{partnerUid}/bss/domains

Associate Domain with Base Stations

What's Changed

`GET` /partners

Authentication function

Return Type:

Changed response : 200 OK

Successfully authenticated.

The session ID is returned in a cookie named JSESSIONID.

You need to include this cookie in subsequent requests.

Changed property partner (object)
- Added property domainRestrictions (object)
  User's domain restrictions:
  - If no domain restrictions are defined, the user can access all cross-domain resources and all domain-specific resources
  - Else, the user can access all cross-domain resources and only domain-specific resources matching the domain restrictions
  - Property and (array)
    
    A resource matches if it matches all and items.
    
    Items (object):
    A resource matches if it is associated with a domain satisfying the following requirements:
    - The group name of the resource domain is group.name (exact match)
    - If type is PREFIX:
      
      The name of the resource domain is prefixed with name
    - Else: (type is FULL)
      
      The name of the resource domain is name (exact match)
    - Property type (string)
      Type of domain restriction:
      
      FULL: restriction on full domain
      
      PREFIX: restriction on domain prefix
      Enum values:
      - FULL
      - PREFIX
    - Property name (string)
      
      Name of the full domain or domain prefix
    - Property group (object)
      
      Domain group associated with the domain restriction
      - Property name (string)
        
        Name of the domain group
- Changed property grantedPermissions (array)
  
  Changed items (string):
  
  Added enum value:
  - s1

`PUT` /partners/{partnerUid}

Update Partner

Access rights:

If the partner's type is SUBSCRIBER:

<NetworkPartner>/RA
<NetworkPartner>/s1: MANAGE_SUBSCRIBER

Else:

<NetworkPartner>/a

`GET` /partners/{partnerUid}/bss

Retrieve Bss

Access rights:

If the authenticated user has domain restrictions, only base stations matching the domain restrictions can be retrieved.

Parameters:

Added: domain in query

Domain filtering (exact match)

Domain group name and domain name must be provided as follow: domain.group.name:domain.name

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (array)

Changed items (object):
- Added property domains (array)
  
  List of domains associated with the Base Station. The list cannot contain more than one domain for a given group.
  
  Only supported if the partner's type is SUBSCRIBER.
  
  Items (object):
  
  The domain must exist in the subscriber account and must be in ACTIVE state to be used.
  - Property name (string)
    
    Domain name
  - Property group (object)
    - Property name (string)
      
      Domain group name

`POST` /partners/{partnerUid}/bss

Create Bs

Access rights:

If the authenticated user has domain restrictions, the base station must match the domain restrictions.

Request:

Added property domains (array)

List of domains associated with the Base Station. The list cannot contain more than one domain for a given group.

Only supported if the partner's type is SUBSCRIBER.

Items (object):

The domain must exist in the subscriber account and must be in ACTIVE state to be used.
- Property name (string)
  
  Domain name
- Property group (object)
  - Property name (string)
    
    Domain group name

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Added property domains (array)

List of domains associated with the Base Station. The list cannot contain more than one domain for a given group.

Only supported if the partner's type is SUBSCRIBER.

Items (object):

The domain must exist in the subscriber account and must be in ACTIVE state to be used.
- Property name (string)
  
  Domain name
- Property group (object)
  - Property name (string)
    
    Domain group name

`GET` /partners/{partnerUid}/bss/alarms

Retrieve Alarms of all Base Stations

Access rights:

If the authenticated user has domain restrictions, only alarms of base stations matching the domain restrictions can be retrieved.

Parameters:

Added: domain in query

Domain filtering (exact match)

Domain group name and domain name must be provided as follow: domain.group.name:domain.name

Return Type:

Changed response : 200 OK

Successful RETRIEVE

Changed property briefs (array)

Changed items (object):
- Changed property bs (object)
  - Added property domains (array)
    
    Items (object):
    
    The domain must exist in the subscriber account and must be in ACTIVE state to be used.
    - Property name (string)
      
      Domain name
    - Property group (object)
      - Property name (string)
        
        Domain group name

`POST` /partners/{partnerUid}/bss/alarms/ack

Ack Alarms of all Base Stations

Access rights:

If the authenticated user has domain restrictions, only alarms of base stations matching the domain restrictions can be acknowledged.

`GET` /partners/{partnerUid}/bss/alarms/stateDistributions

Retrieve Alarm States Distribution of all Base Stations

Access rights:

If the authenticated user has domain restrictions, only alarms of base stations matching the domain restrictions are counted.

`GET` /partners/{partnerUid}/bss/clusters

Retrieve Base stations Clusters

Access rights:

If the authenticated user has domain restrictions, only base stations matching the domain restrictions can be retrieved.

Parameters:

Added: domain in query

Domain filtering (exact match)

Domain group name and domain name must be provided as follow: domain.group.name:domain.name

Return Type:

Changed response : 200 OK

Successful RETRIEVE

Changed property clusters (array)

Changed items (object):

A group a base stations close to each other.
- Changed property item (object)
  - Added property domains (array)
    
    List of domains associated with the Base Station. The list cannot contain more than one domain for a given group.
    
    Only supported if the partner's type is SUBSCRIBER.
    
    Items (object):
    
    The domain must exist in the subscriber account and must be in ACTIVE state to be used.
    - Property name (string)
      
      Domain name
    - Property group (object)
      - Property name (string)
        
        Domain group name

`GET` /partners/{partnerUid}/bss/counters

Retrieve Counters

Access rights:

If the authenticated user has domain restrictions, only base stations matching the domain restrictions are counted.

`POST` /partners/{partnerUid}/bss/tags

Tag Bss

Access rights:

If the authenticated user has domain restrictions, only base stations matching the domain restrictions can be tagged.

`GET` /partners/{partnerUid}/bss/{bsUid}

Retrieve Bs

Access rights:

If the authenticated user has domain restrictions, the base station must match the domain restrictions.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Added property domains (array)

List of domains associated with the Base Station. The list cannot contain more than one domain for a given group.

Only supported if the partner's type is SUBSCRIBER.

Items (object):

The domain must exist in the subscriber account and must be in ACTIVE state to be used.
- Property name (string)
  
  Domain name
- Property group (object)
  - Property name (string)
    
    Domain group name

`PUT` /partners/{partnerUid}/bss/{bsUid}

Update Bs

Access rights:

If the authenticated user has domain restrictions, the base station must match the domain restrictions before and after the update.

Request:

Added property domains (array)

List of domains associated with the Base Station. The list cannot contain more than one domain for a given group.

Only supported if the partner's type is SUBSCRIBER.

Items (object):

The domain must exist in the subscriber account and must be in ACTIVE state to be used.
- Property name (string)
  
  Domain name
- Property group (object)
  - Property name (string)
    
    Domain group name

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Added property domains (array)

List of domains associated with the Base Station. The list cannot contain more than one domain for a given group.

Only supported if the partner's type is SUBSCRIBER.

Items (object):

The domain must exist in the subscriber account and must be in ACTIVE state to be used.
- Property name (string)
  
  Domain name
- Property group (object)
  - Property name (string)
    
    Domain group name

`DELETE` /partners/{partnerUid}/bss/{bsUid}

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/antennasGainAndLossStatus

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/availableLrrVersions

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/backup

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/backupSwVersion

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/cancelRadioScan

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/closeSsh

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/downloadLrrVersion

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/fineTimestampKeysStatus

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/lastCmdStatus

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/locationStatus

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/logStatus

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/openSsh

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/openTerminal

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/reboot

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/restart

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/restore

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/reverseSshStatus

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/rfRegionStatus

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/rfcDownlinkStop

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/rfcStart

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/rfcStatus

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/rfcStop

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/scanRadio

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/scanRadioStatus

`PUT` /partners/{partnerUid}/bss/{bsUid}/admins/settings

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/softwareUptime

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/swVersion

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/systemUptime

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/updateAntennasGainAndLoss

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/updateFineTimestampKeys

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/updateLocation

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/updateLog

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/updateRfRegion

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/upgrade

`GET` /partners/{partnerUid}/bss/{bsUid}/alarms

`POST` /partners/{partnerUid}/bss/{bsUid}/alarms/ack

`GET` /partners/{partnerUid}/bss/{bsUid}/alarms/histories

`POST` /partners/{partnerUid}/bss/{bsUid}/alarms/{alarmUid}/ack

`GET` /partners/{partnerUid}/bss/{bsUid}/ants

`GET` /partners/{partnerUid}/bss/{bsUid}/ants/{antUid}

`PUT` /partners/{partnerUid}/bss/{bsUid}/ants/{antUid}

`GET` /partners/{partnerUid}/bss/{bsUid}/ants/{antUid}/images

`POST` /partners/{partnerUid}/bss/{bsUid}/ants/{antUid}/images

`GET` /partners/{partnerUid}/bss/{bsUid}/ants/{antUid}/images/{imageUid}

`DELETE` /partners/{partnerUid}/bss/{bsUid}/ants/{antUid}/images/{imageUid}

`GET` /partners/{partnerUid}/bss/{bsUid}/check

`GET` /partners/{partnerUid}/bss/{bsUid}/frames

`POST` /partners/{partnerUid}/bss/{bsUid}/regenerateCertificate

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/devicesScattering

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/downlinks/statusDistributions

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/lcs/{lcUid}/dutyCycles

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/lcs/{lcUid}/dutyCycles/histories

`POST` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/lcs/{lcUid}/dutyCycles/reset

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/lcs/{lcUid}/signalsAndNoises

`POST` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/lcs/{lcUid}/signalsAndNoises/reset

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/lcs/{lcUid}/signalsAndNoises/snDistributions

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/lcs/{lcUid}/spreadingFactors/sfDistributions

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/spreadingFactors/sfDistributions

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/beacons

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/indicators

`POST` /partners/{partnerUid}/bss/{bsUid}/rfcell/indicators/reset

Access rights:

If the authenticated user has domain restrictions, the base station must match the domain restrictions.

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/servedDevices

Retrieve Devices served by the Base Station

Access rights:

If the authenticated user has domain restrictions, the base station must match the domain restrictions.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property devices (array)

List of devices served by the base station

Changed items (object):
- Changed property name (string)
  
  Device name (only returned if the network partner is a subscriber).
  
  If the authenticated user has domain restrictions, only returned if the device matches the domain restrictions.
- Added property href (string)
  
  Device href (only returned if the network partner is a subscriber).
  
  If the authenticated user has domain restrictions, only returned if the device matches the domain restrictions.

`GET` /partners/{partnerUid}/bss/{bsUid}/sys/cpu

`GET` /partners/{partnerUid}/bss/{bsUid}/sys/cpu/histories

`POST` /partners/{partnerUid}/bss/{bsUid}/sys/cpu/reset

`GET` /partners/{partnerUid}/bss/{bsUid}/sys/disks/{diskIndex}

`GET` /partners/{partnerUid}/bss/{bsUid}/sys/disks/{diskIndex}/histories

`POST` /partners/{partnerUid}/bss/{bsUid}/sys/disks/{diskIndex}/reset

`GET` /partners/{partnerUid}/bss/{bsUid}/sys/ram

`GET` /partners/{partnerUid}/bss/{bsUid}/sys/ram/histories

`POST` /partners/{partnerUid}/bss/{bsUid}/sys/ram/reset

`GET` /partners/{partnerUid}/bss/{bsUid}/tags

`POST` /partners/{partnerUid}/bss/{bsUid}/tags

`PUT` /partners/{partnerUid}/bss/{bsUid}/tags/{tagUid}

`DELETE` /partners/{partnerUid}/bss/{bsUid}/tags/{tagUid}

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/iecQueues

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/iecQueues/histories

`POST` /partners/{partnerUid}/bss/{bsUid}/wans/iecQueues/reset

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/indicators

`POST` /partners/{partnerUid}/bss/{bsUid}/wans/indicators/reset

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/ints/{intUid}

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/ints/{intUid}/bitrates

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/ints/{intUid}/histories

`POST` /partners/{partnerUid}/bss/{bsUid}/wans/ints/{intUid}/reset

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/ints/{intUid}/roundTrips

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/lrcs/{lrcUid}

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/lrcs/{lrcUid}/iecPackets

`POST` /partners/{partnerUid}/bss/{bsUid}/wans/lrcs/{lrcUid}/reset

Access rights:

If the authenticated user has domain restrictions, the base station must match the domain restrictions.

Release 7.1

RDTP-12570

What's Changed

`GET|PUT` /partners/{partnerUid}

Retrieve Partner

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Deprecated property allowedAdministration (boolean)

This property must no longer be used: always set to true.
Deprecated property allowedBsTagging (boolean)

This property must no longer be used: always set to true.
Deprecated property delegateAdministration (boolean)

This property must no longer be used: always set to true.
Deprecated property delegateBsTagging (boolean)

This property must no longer be used: always set to true.
Deprecated property delegateBsValidation (boolean)

This property must no longer be used: always set to true.

`GET` /partners/{partnerUid}/bss

Retrieve Bss

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (array)

Changed items (object):
- Deprecated value of property state (string)
  Base station admin state:
  - VALIDATING: Waiting operator validation (DEPRECATED).

`POST` /partners/{partnerUid}/bss

Create Bs

Request:

Deprecated value of property state (string)
Base station admin state:
- VALIDATING: Waiting operator validation (DEPRECATED).

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Deprecated value of property state (string)
Base station admin state:
- VALIDATING: Waiting operator validation (DEPRECATED).

`GET` /partners/{partnerUid}/bss/{bsUid}

Retrieve Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Deprecated value of property state (string)
Base station admin state:
- VALIDATING: Waiting operator validation (DEPRECATED).

`PUT` /partners/{partnerUid}/bss/{bsUid}

Update Bs

Request:

Deprecated value of property state (string)
Base station admin state:
- VALIDATING: Waiting operator validation (DEPRECATED).

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Deprecated value of property state (string)
Base station admin state:
- VALIDATING: Waiting operator validation (DEPRECATED).

`GET` /partners/{partnerUid}/bss/{bsUid}/check

Retrieve Check

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Deprecated value of property state (string)
Base station admin state:
- VALIDATING: Waiting operator validation (DEPRECATED).

`PUT` /partners/{partnerUid}/restricted

Update Restricted Settings

Request:

Deprecated property delegateAdministration (boolean)

This property must no longer be used: always set to true.

Return Type:

Changed response : 200 OK

Successful UPDATE

Deprecated property delegateAdministration (boolean)

This property must no longer be used: always set to true.

`POST` /partners/{partnerUid}/bss/tags

`POST` /partners/{partnerUid}/bss/{bsUid}/tags

`DELETE` /partners/{partnerUid}/bss/{bsUid}/tags/{tagUid}

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/antennasGainAndLossStatus

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/backup

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/backupSwVersion

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/cancelRadioScan

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/closeSsh

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/downloadLrrVersion

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/fineTimestampKeysStatus

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/lastCmdStatus

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/locationStatus

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/logStatus

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/openSsh

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/openTerminal

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/reboot

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/restart

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/restore

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/reverseSshStatus

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/rfRegionStatus

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/rfcDownlinkStop

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/rfcStart

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/rfcStatus

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/rfcStop

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/scanRadio

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/scanRadioStatus

`PUT` /partners/{partnerUid}/bss/{bsUid}/admins/settings

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/softwareUptime

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/swVersion

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/systemUptime

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/updateAntennasGainAndLoss

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/updateFineTimestampKeys

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/updateLocation

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/updateLog

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/updateRfRegion

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/upgrade

Changed access rights: <NetworkPartner>/a

RDTP-12573

What's New

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/ints/{intUid}/histories

Retrieve Interface Traffic History

RDTP-12577

What's Changed

`GET` /partners/{partnerUid}/bsProfiles

Retrieve BsProfiles

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (array)

Changed items (object):

New required properties:
- rfHardwareConfig
- Added property rfHardwareConfig (string)
  RF hardware configuration of the base station profile
  - S1_A1_B1: 1 sector, 1 antenna, 1 board (mono-sector 1*8 or 1*16)
  - S1_A2_B1: 1 sector, 2 antennas, 1 board (mono-sector 2*8)
  - S1_A2_B2: 1 sector, 2 antennas, 2 boards (mono-sector 2*16)
  - S1_A1_B4: 1 sector, 1 antennas, 4 boards (mono-sector 1*64)
  - S3_A3_B3: 3 sectors, 3 antennas, 3 boards (tri-sectors 1*8 or 1*16)
  Enum values:
  - S1_A1_B1
  - S1_A2_B1
  - S1_A2_B2
  - S1_A1_B4
  - S3_A3_B3

`POST` /partners/{partnerUid}/bss

Create Bs

Request:

Added property rfHardwareConfig (string)
RF hardware configuration of the BS profile
- S1_A1_B1: 1 sector, 1 antenna, 1 board (mono-sector 1*8 or 1*16)
- S1_A2_B1: 1 sector, 2 antennas, 1 board (mono-sector 2*8)
- S1_A2_B2: 1 sector, 2 antennas, 2 boards (mono-sector 2*16)
- S1_A1_B4: 1 sector, 1 antennas, 4 boards (mono-sector 1*64)
- S3_A3_B3: 3 sectors, 3 antennas, 3 boards (tri-sectors 1*8 or 1*16)
Default: Inherited from the BS profile
Enum values:
- S1_A1_B1
- S1_A2_B1
- S1_A2_B2
- S1_A1_B4
- S3_A3_B3

`GET` /partners/{partnerUid}/bss/{bsUid}/ants

Retrieve Ants

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (array)

Changed items (object):
- Added property cableDelay (number)
  
  Cable delay in nanoseconds

RDTP-12943

What's Changed

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/lcs/{lcUid}/signalsAndNoises/snDistributions

Retrieve SnDistributions

Parameters:

Changed: type in query

Type of the analysis to perform ("RSSI", "SNR" or "ESP")

Default value: When this query parameter is not specified a RSSI analysis is performed.

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/indicators

Retrieve Rfcell Indicators

Following new indicators are supported:

ID	Type	Category	Description
unwf	Integer (w/o max)	Uplink	Number of frames dropped due to network filters
breq	Integer (w/o max)	Beacons	Number of beacon transmissions requested
bsnd	Integer (w/o max)	Beacons	Number of beacons transmitted

RDTP-13438

What's New

`PUT` /partners/{partnerUid}/bss/{bsUid}/tags/{tagUid}

Update Tag

What's Changed

`GET|PUT` /partners/{partnerUid}

Retrieve Partner

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Deprecated property baseStationTagsNamespace (string)

This parameter must no longer be used: always set to OPERATOR if the Network Partner is a SUPPLIER and SUBSCRIBER if the Network Partner is a SUBSCRIBER.

`PUT` /partners/{partnerUid}/restricted

Update Restricted Settings

Request:

Deprecated property baseStationTagsNamespace (string)

This parameter must no longer be used: always set to OPERATOR if the Network Partner is a SUPPLIER and SUBSCRIBER if the Network Partner is a SUBSCRIBER.

Return Type:

Changed response : 200 OK

Successful UPDATE

Deprecated property baseStationTagsNamespace (string)

This parameter must no longer be used: always set to OPERATOR if the Network Partner is a SUPPLIER and SUBSCRIBER if the Network Partner is a SUBSCRIBER.

`GET` /partners/{partnerUid}/bss

Retrieve Bss

Return Type:

Changed response : 200 OK

Successful RETRIEVE

Changed property tags (array)

List of tags associated with the Base Station

Changed items (object):

New required properties:
- multicastVisibility
- Added property multicastVisibility (boolean)
  
  TRUE if the tag is visible for multicast.

`POST` /partners/{partnerUid}/bss/{bsUid}/tags

Add Tag

Request:

Deprecated property managedNetworkVisibility (boolean)

This parameter must no longer be used: it is ignored and always set to false.

Return Type:

Changed response : 200 OK

Successful RETRIEVE

Deprecated property managedNetworkVisibility (boolean)

This parameter must no longer be used: it is ignored and always set to false.

`GET` /partners/{partnerUid}/bss/{bsUid}/tags

Retrieve Tags

Return Type:

Changed response : 200 OK

Successful RETRIEVE

Changed property tags (array)

List of tags associated with the Base Station

Changed items (object):
- Deprecated property managedNetworkVisibility (boolean)
  
  This parameter must no longer be used: it is ignored and always set to false.

RDTP-13613

What's Changed

`POST` /partners/{partnerUid}/bss

Create Bs

Request:

Added property rfCoverageType (string)

Specify if the RF coverage provided by the base station is permanent, or temporary for recovery purposes. In case of temporary RF coverage, the base station may be mobile or stationary. A base station used for temporary RF coverage is not taken into account by adaptive data rate algorithm. Additionally, a mobile base station is never selected for class B/C downlink transmission.

Enum values:
- PERMANENT
- TEMPORARY_MOBILE
- TEMPORARY_STATIONARY

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Added property rfCoverageType (string)

Specify if the RF coverage provided by the base station is permanent, or temporary for recovery purposes. In case of temporary RF coverage, the base station may be mobile or stationary. A base station used for temporary RF coverage is not taken into account by adaptive data rate algorithm. Additionally, a mobile base station is never selected for class B/C downlink transmission.

Enum values:
- PERMANENT
- TEMPORARY_MOBILE
- TEMPORARY_STATIONARY

`GET` /partners/{partnerUid}/bss/{bsUid}

Retrieve Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Added property rfCoverageType (string)

Specify if the RF coverage provided by the base station is permanent, or temporary for recovery purposes. In case of temporary RF coverage, the base station may be mobile or stationary. A base station used for temporary RF coverage is not taken into account by adaptive data rate algorithm. Additionally, a mobile base station is never selected for class B/C downlink transmission.

Enum values:
- PERMANENT
- TEMPORARY_MOBILE
- TEMPORARY_STATIONARY

`PUT` /partners/{partnerUid}/bss/{bsUid}

Update Bs

Request:

Added property rfCoverageType (string)

Specify if the RF coverage provided by the base station is permanent, or temporary for recovery purposes. In case of temporary RF coverage, the base station may be mobile or stationary. A base station used for temporary RF coverage is not taken into account by adaptive data rate algorithm. Additionally, a mobile base station is never selected for class B/C downlink transmission.

Enum values:
- PERMANENT
- TEMPORARY_MOBILE
- TEMPORARY_STATIONARY

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Added property rfCoverageType (string)

Specify if the RF coverage provided by the base station is permanent, or temporary for recovery purposes. In case of temporary RF coverage, the base station may be mobile or stationary. A base station used for temporary RF coverage is not taken into account by adaptive data rate algorithm. Additionally, a mobile base station is never selected for class B/C downlink transmission.

Enum values:
- PERMANENT
- TEMPORARY_MOBILE
- TEMPORARY_STATIONARY

RDTP-13716

What's New

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/servedDevices

Retrieve Devices served by the Base Station

What's Deprecated

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/devicesScattering

Retrieve DevicesScattering

RDTP-14994

What's New

`GET` /partners/{partnerUid}/bss/clusters

Retrieve Base stations Clusters

RDTP-15026

What's Changed

`GET` /partners

Authentication function

Parameters:

Added: ID in query

ID of the Network Partner

Changed: type in query

Type of the Network Partner: SUBSCRIBER or SUPPLIER.

RDTP-18437

What's Changed

`GET` /partners/{partnerUid}/bsProfiles

Retrieve BsProfiles

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (array)

Changed items (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

`POST` /partners/{partnerUid}/bss

Create Bs

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Changed property model (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` /partners/{partnerUid}/bss/{bsUid}

Retrieve Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property model (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` /partners/{partnerUid}/bss/{bsUid}

Update Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property model (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

RDTP-18449

What's Changed

`GET` /partners/{partnerUid}/bss

Retrieve Bss

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (array)

Changed items (object):
- Deprecated property allowClassB (boolean)
  
  Allow Class B
  
  Note: Null is returned after the upgrade to ThingPark 7.0 until the base station transmit one configuration report.
  
  This parameter must no longer be used: it is ignored and always set to true.

`POST` /partners/{partnerUid}/bss

Create Bs

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Deprecated property allowClassB (boolean)

Allow Class B

This parameter must no longer be used: it is ignored and always set to true.

`GET` /partners/{partnerUid}/bss/clusters

Retrieve Base stations Clusters

Return Type:

Changed response : 200 OK

Successful RETRIEVE

Changed property clusters (array)

Changed items (object):

A group a base stations close to each other.
- Changed property item (object)
  - Deprecated property allowClassB (boolean)
    
    Allow Class B
    
    Note: Null is returned after the upgrade to ThingPark 7.0 until the base station transmit one configuration report.
    
    This parameter must no longer be used: it is ignored and always set to true.

`GET` /partners/{partnerUid}/bss/{bsUid}

Retrieve Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Deprecated property allowClassB (boolean)

Allow Class B

This parameter must no longer be used: it is ignored and always set to true.

`PUT` /partners/{partnerUid}/bss/{bsUid}

Update Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Deprecated property allowClassB (boolean)

Allow Class B

This parameter must no longer be used: it is ignored and always set to true.

`PUT` /partners/{partnerUid}/bss/{bsUid}/admins/settings

Update AdminSettings

Request:

Deprecated property allowClassB (boolean)

Allow Class B

This parameter must no longer be used: it is ignored and always set to true.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Deprecated property allowClassB (boolean)

Allow Class B

This parameter must no longer be used: it is ignored and always set to true.

RDTP-18579

What's Changed

`GET` /partners/{partnerUid}/bsProfiles

Retrieve BsProfiles

Parameters:

Changed: vendorID in query

Base Station Vendor ID filtering (exact match)

RDTP-18665

What's Changed

`GET` /partners/{partnerUid}/bss

Retrieve Bss

Parameters:

Changed: healthState in query

Health state filtering.

Multiple values can be set. If not provided, all Base Stations are returned.

Added enum value:
- SUSPENDED

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (array)

Changed items (object):
- Changed property healthState (string)
  Base Station health state:
  - INIT: The base station has been created, but has never communicated with the network server
  - ACTIVE: The base station is connected to the network, transmitting and receiving packets
  - BACKHAUL_CNX_ERROR: The base station has backhaul connection issues, and cannot communicate with the network server
  - RF_ERROR: The base station has radio transmission issues, and cannot send or receive LoRaWAN packets to or from a device
  - SUSPENDED: The base station has been administratively suspended and is no more connected to the network server
  Added enum value:
  - SUSPENDED

`POST` /partners/{partnerUid}/bss

Create Bs

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Changed property healthState (string)
Base Station health state:
- INIT: The base station has been created, but has never communicated with the network server
- ACTIVE: The base station is connected to the network, transmitting and receiving packets
- BACKHAUL_CNX_ERROR: The base station has backhaul connection issues, and cannot communicate with the network server
- RF_ERROR: The base station has radio transmission issues, and cannot send or receive LoRaWAN packets to or from a device
- SUSPENDED: The base station has been administratively suspended and is no more connected to the network server
Added enum value:
- SUSPENDED

`GET` /partners/{partnerUid}/bss/clusters

Retrieve Base stations Clusters

Parameters:

Changed: healthState in query

Health state filtering.

Multiple values can be set. If not provided, all Base Stations are returned.

Added enum value:
- SUSPENDED

Return Type:

Changed response : 200 OK

Successful RETRIEVE

Changed property clusters (array)

Changed items (object):

A group a base stations close to each other.
- Changed property item (object)
  - Changed property healthState (string)
    Base Station health state:
    - INIT: The base station has been created, but has never communicated with the network server
    - ACTIVE: The base station is connected to the network, transmitting and receiving packets
    - BACKHAUL_CNX_ERROR: The base station has backhaul connection issues, and cannot communicate with the network server
    - RF_ERROR: The base station has radio transmission issues, and cannot send or receive LoRaWAN packets to or from a device
    - SUSPENDED: The base station has been administratively suspended and is no more connected to the network server
    Added enum value:
    - SUSPENDED

`GET` /partners/{partnerUid}/bss/counters

Retrieve Counters

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (array)

Changed items (object):
- Changed property healthState (string)
  Base Station health state:
  - INIT: The base station has been created, but has never communicated with the network server
  - ACTIVE: The base station is connected to the network, transmitting and receiving packets
  - BACKHAUL_CNX_ERROR: The base station has backhaul connection issues, and cannot communicate with the network server
  - RF_ERROR: The base station has radio transmission issues, and cannot send or receive LoRaWAN packets to or from a device
  - SUSPENDED: The base station has been administratively suspended and is no more connected to the network server
  Added enum value:
  - SUSPENDED

`POST` /partners/{partnerUid}/bss/tags

Tag Bss

Parameters:

Changed: healthState in query

Only tags/untags base stations matching this health state.

Multiple values can be set. If not provided, all Base Stations are tagged/untagged.

Added enum value:
- SUSPENDED

`GET` /partners/{partnerUid}/bss/{bsUid}

Retrieve Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property healthState (string)
Base Station health state:
- INIT: The base station has been created, but has never communicated with the network server
- ACTIVE: The base station is connected to the network, transmitting and receiving packets
- BACKHAUL_CNX_ERROR: The base station has backhaul connection issues, and cannot communicate with the network server
- RF_ERROR: The base station has radio transmission issues, and cannot send or receive LoRaWAN packets to or from a device
- SUSPENDED: The base station has been administratively suspended and is no more connected to the network server
Added enum value:
- SUSPENDED

`PUT` /partners/{partnerUid}/bss/{bsUid}

Update Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property healthState (string)
Base Station health state:
- INIT: The base station has been created, but has never communicated with the network server
- ACTIVE: The base station is connected to the network, transmitting and receiving packets
- BACKHAUL_CNX_ERROR: The base station has backhaul connection issues, and cannot communicate with the network server
- RF_ERROR: The base station has radio transmission issues, and cannot send or receive LoRaWAN packets to or from a device
- SUSPENDED: The base station has been administratively suspended and is no more connected to the network server
Added enum value:
- SUSPENDED

RDTP-18737

What's Changed

`GET` /partners/{partnerUid}/bss/{bsUid}/frames

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/lcs/{lcId}/dutyCycles/histories

`GET` /partners/{partnerUid}/bss/{bsUid}/sys/cpu/histories

`GET` /partners/{partnerUid}/bss/{bsUid}/sys/disks/{diskIndex}/histories

`GET` /partners/{partnerUid}/bss/{bsUid}/sys/ram/histories

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/iecQueues/histories

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/ints/{intUid}/bitrates

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/ints/{intUid}/histories

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/ints/{intUid}/roundTrips

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/lrcs/{lrcUid}/iecPackets

Parameters:

Added: timezone in query

Time zone used to compute the beginning of aggregation time slots. Time slots are aligned to January 1, 1970 at midnight in the specified timezone. The time zone must be a valid name from the IANA time zone database

Release 7.0

RDTP-11832

What's Changed

`GET` /partners/{partnerUid}/bss

Retrieve Bss

Parameters:

Added: sort in query

Defines how results are sorted (<attribute>,<order>).

Following attributes are supported:

'name': by name

'lastUpFrameDate': by timestamp of the last downlink frame

'lastDwFrameDate': by timestamp of the last uplink frame

'version': by software version of the BS

'lastReboot': by last reboot timestamp of the BS (software uptime)

'creationDate': by date of creation of the BS

Following orders are supported:

'asc': ascending order

'desc': descending order

By default, results are sorted by creation date ascending order.

Added: rfRegionID in query

RF Region provisioning ID (exact match)

Changed: tag in query

Tag name filtering (exact match)

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

count

Added property count (integer)

Total number of matching base stations
Changed property briefs (array)

Changed items (object):

New required properties:
- alarm1
- alarm2
- alarm3
- alarm4
- alarm5
- alarm6
- Added property alarm1 (integer)
  
  Number of CLEARED alarms not ACKED
- Added property alarm2 (integer)
  
  Number of INDETERMINATE alarms not ACKED
- Added property alarm3 (integer)
  
  Number of WARNING alarms not ACKED
- Added property alarm4 (integer)
  
  Number of MINOR alarms not ACKED
- Added property alarm5 (integer)
  
  Number of MAJOR alarms not ACKED
- Added property alarm6 (integer)
  
  Number of CRITICAL alarms not ACKED
- Added property rfRegionID (string)
  
  RF Region provisioning ID

`POST` /partners/{partnerUid}/bss/tags

Tag Bss

Parameters:

Added: sort in query

Defines how results are sorted (<attribute>,<order>).

Following attributes are supported:

'name': by name

'lastUpFrameDate': by timestamp of the last downlink frame

'lastDwFrameDate': by timestamp of the last uplink frame

'version': by software version of the BS

'lastReboot': by last reboot timestamp of the BS (software uptime)

'creationDate': by date of creation of the BS

Following orders are supported:

'asc': ascending order

'desc': descending order

By default, results are sorted by creation date ascending order.

Added: rfRegionID in query

RF Region provisioning ID (exact match)

Changed: tag in query

Only tags/untags base stations matching this tag name (exact match)

RDTP-12468

What's Changed

`GET` /partners/{partnerUid}/bss

Retrieve Bss

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (array)

Changed items (object):
- Added property activateBeaconTransmission (boolean)
  
  Activate beacon transmission
- Added property activateRX2Optimization (integer)
  
  Active RX2 optimization
- Added property allowClassB (boolean)
  
  Allow Class B
- Added property ants (object)
  - Property ant (array)
    
    Items (object):
    - Property cableLoss (number)
      
      Cable loss in dB
    - Property gain (number)
      
      Antenna gain in dBi
- Added property beacons (object)
  - Property lastDeliveryCause (string)
    Specify the delivery cause of the last beacon transmission:
    - 0x: Success
    - Ax: Transmission slot busy
    - Bx: Too late for beacon slot
    - Dx: DC constraint on beacon slot
  - Property lastDeliveryFailedCause (string)
    Specify the delivery cause of the last beacon transmission failure:
    - 0x: Success
    - Ax: Transmission slot busy
    - Bx: Too late for beacon slot
    - Dx: DC constraint on beacon slot
  - Property lastDeliveryFailedCauseDate (integer)
    
    Last beacon transmission failure report date, epoch time in milliseconds.
- Added property classBState (integer)
  Class B state:
  - Not supported (0)
  - Supported but not operational (1)
  - Supported and operational (2)
- Added property cpu (integer)
  
  CPU usage (%)
- Added property customerAdminData (string)
  
  BS administrative info
- Added property gpsReceiverConfig (string)
  GSP receiver configuration:
  - PRESENT (i.e. Present and used)
  - ABSENT (i.e. Absent or not used)
  Enum values:
  - PRESENT
  - ABSENT
- Added property gpsSync (integer)
  - GPS receiver synchronization status: Locking/No signal (0)
  - Locked (1)
- Added property ismBand (string)
  
  When known, the ISM band associated with the BS.
- Added property lastReport (integer)
  
  Last report timestamp, epoch time in milliseconds
- Added property locationType (integer)
  
  Type of location currently activated (Unknown:0 or Administrative:1 or GPS:2)
- Added property mfs (object)
  - Property mfs (array)
    
    Items (object):
    - Property name (string)
      
      File system name
    - Property used (integer)
      
      File system current usage (%)
- Added property ram (integer)
  
  RAM usage (%)
- Added property rfHardwareConfig (string)
  RF hardware configuration
  - S1_A1_B1: 1 sector, 1 antenna, 1 board (mono-sector 1*8 or 1*16)
  - S1_A2_B1: 1 sector, 2 antennas, 1 board (mono-sector 2*8)
  - S1_A2_B2: 1 sector, 2 antennas, 2 boards (mono-sector 2*16)
  - S1_A1_B4: 1 sector, 1 antennas, 4 boards (mono-sector 1*64)
  - S3_A3_B3: 3 sectors, 3 antennas, 3 boards (tri-sectors 1*8 or 1*16)
  Enum values:
  - S1_A1_B1
  - S1_A2_B1
  - S1_A2_B2
  - S1_A1_B4
  - S3_A3_B3
- Added property timeSync (integer)
  Time synchronization status:
  - Local / Not synchronized (0)
  - NTP (1)
  - NTP sync with GPS (2)
  - Radio sync with GPS (3)
- Changed property ints (object)
  - Changed property int (array)
    
    Changed items (object):
    - Added property avgRoundTrip (integer)
      
      Interface average round trip in ms
    - Added property ip (string)
      
      Interface IP address
- Changed property model (object)
  
  New required properties:
  - ID
  - Added property ID (string)
    
    BS profile ID

RDTP-12789

What's Changed

`GET` /partners/{partnerUid}

Retrieve Partner

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

options

Added property options (object)
- Property license (string)
  License option:
  - DEACTIVATED
  - ACTIVATED
  Enum values:
  - DEACTIVATED
  - ACTIVATED

`PUT` /partners/{partnerUid}

Update Partner

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

options

Added property options (object)
- Property license (string)
  License option:
  - DEACTIVATED
  - ACTIVATED
  Enum values:
  - DEACTIVATED
  - ACTIVATED

`GET` /partners/{partnerUid}/licenses

Retrieve Licenses

Return Type:

Changed response : 200 OK

Successful CREATE

Changed property status (string)

License status:
- MISSING: License is missing. API access is read only until a new valid license file is uploaded.
- VALID: License is valid. No restrictions apply.
- EXPIRED: License has expired. API access is read only until a new valid license file is uploaded.
- LONG_TIME_EXPIRED: License has expired since more than 6 months. API access is read only and application servers are suspended until a new valid license file is uploaded.
Added enum value:
- LONG_TIME_EXPIRED

`POST` /partners/{partnerUid}/licenses

Create Licenses

Return Type:

Changed response : 201 Created

Successful CREATE

Changed property status (string)

License status:
- MISSING: License is missing. API access is read only until a new valid license file is uploaded.
- VALID: License is valid. No restrictions apply.
- EXPIRED: License has expired. API access is read only until a new valid license file is uploaded.
- LONG_TIME_EXPIRED: License has expired since more than 6 months. API access is read only and application servers are suspended until a new valid license file is uploaded.
Added enum value:
- LONG_TIME_EXPIRED

RDTP-16927

What's Changed

`GET` /partners/{partnerUid}/bsProfiles

Retrieve BsProfiles

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (array)

Changed items (object):

New required properties:
- softwareType
- 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

`POST` /partners/{partnerUid}/bss

Create Bs

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Changed property model (object)

New required properties:
- softwareType
- 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` /partners/{partnerUid}/bss/{bsUid}

Retrieve Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property model (object)

New required properties:
- softwareType
- 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` /partners/{partnerUid}/bss/{bsUid}

Update Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property model (object)

New required properties:
- softwareType
- 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-2274

What's Changed

`GET` /partners/{partnerUid}

Retrieve Partner

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

allowedBsTagging
baseStationTagsNamespace

Added property allowedBsTagging (boolean)

True when the logged user is allowed to tag BS (for instance the logged user is an Operator, or the logged user is the owner of the account and the tagging of BS has been activated for this account).

Note: To be TRUE, the BS tags namespace must be SUBSCRIBER, or the logged user must have the RA permission, or the logged user must have the A permission and the BS tagging must be delegated.
Added property baseStationTagsNamespace (string)
Base Station Tags Namespace:
- When set to OPERATOR, Base Station tags are defined in the Operator Namespace.
- When set to SUBSCRIBER, Base Station tags are defined in the Subscriber Namespace.
Enum values:
- OPERATOR
- SUBSCRIBER

`PUT` /partners/{partnerUid}

Update Partner

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

allowedBsTagging
baseStationTagsNamespace

Added property allowedBsTagging (boolean)

True when the logged user is allowed to tag BS (for instance the logged user is an Operator, or the logged user is the owner of the account and the tagging of BS has been activated for this account).

Note: To be TRUE, the BS tags namespace must be SUBSCRIBER, or the logged user must have the RA permission, or the logged user must have the A permission and the BS tagging must be delegated.
Added property baseStationTagsNamespace (string)
Base Station Tags Namespace:
- When set to OPERATOR, Base Station tags are defined in the Operator Namespace.
- When set to SUBSCRIBER, Base Station tags are defined in the Subscriber Namespace.
Enum values:
- OPERATOR
- SUBSCRIBER

`GET` /partners/{partnerUid}/bss

Retrieve Bss

Parameters:

Changed: LRRID in query

LRR ID filtering (prefix match)

`POST` /partners/{partnerUid}/bss/tags

Tag Bss

Parameters:

Added: pageIndex in query

Returns the requested page index (1...n). The default system wide page size is used. The maximum number of pages is limited (system-wide).

Added: pageSize in query

Size of the expected page result.

If not specified or lower than the minimum page size (system-wide configuration), the minimum page size is used.

If greater than the maximum page size (system-wide configuration), the maximum page size is used.

Added: query in query

Only tags/untags base stations with a LRR ID or LRR UUID or name containing the provided term. (prefix match)

Added: tag in query

Only tags/untags base stations matching this tag name (exact match)

Added: action in query

Action to perform:

TAG: tag all base stations matching the criteria

UNTAG: untag all base stations matching the criteria

Changed: LRRID in query

Only tags/untags base stations matching this LRR ID (prefix match)

Request:

Added property LRRIDs (string array)

Only tags/untags base stations matching these LRR IDs (prefix match). Overwrite LRR IDs provided in URL.

`GET` /partners/{partnerUid}/bss/tags/suggestions

Retrieve Base Station Tag Suggestions

Parameters:

Added: exclude in query

Excludes any tag name matching this value (exact match)

`PUT` /partners/{partnerUid}/restricted

Update Restricted Settings

Request:

Added property baseStationTagsNamespace (string)
Base Station Tags Namespace:
- When set to OPERATOR, Base Station tags are defined in the Operator Namespace.
- When set to SUBSCRIBER, Base Station tags are defined in the Subscriber Namespace.
Enum values:
- OPERATOR
- SUBSCRIBER

Return Type:

Changed response : 200 OK

Successful UPDATE

Added property baseStationTagsNamespace (string)
Base Station Tags Namespace:
- When set to OPERATOR, Base Station tags are defined in the Operator Namespace.
- When set to SUBSCRIBER, Base Station tags are defined in the Subscriber Namespace.
Enum values:
- OPERATOR
- SUBSCRIBER

RDTP-2420 / RDTP-12898

What's Changed

`GET` /partners/{partnerUid}/bss

Retrieve Bss

Return Type:

Changed response : 200 OK

Successful RETRIEVE

Changed property briefs (array)

Changed items (object):
- Changed property ints (object)
  - Changed property int (array)
    
    Changed items (object):
    - Deleted property signal (integer)
      
      Interface signal strength
    - Changed property type (string)
      
      Interface type
      
      Added enum value:
      - WLAN
  - GPRS properties:
    - Added property connectionType (string)
      
      Cellular connection type
      
      Enum values:
      - 3G
      - 4G
    - Added property iccid (string)
      
      ICCID of the SIM card
    - Added property imei (string)
      
      IMEI of the Base Station
    - Added property imsi (string)
      
      IMSI of the SIM card
    - Added property networkOperator (string)
      
      Cellular network operator
    - Added property rssi (float)
      
      Cellular RSSI in dBm
    - 3G properties:
      - Added property rscp (float)
        
        Cellular 3G RSCP in dBm
      - Added property ecIo (float)
        
        Cellular 3G Ec/Io in dB
    - 4G properties:
      - Added property rsrp (float)
        
        Cellular 4G RSRP in dBm
      - Added property rsrq (float)
        
        Cellular 4G RSRQ in dBm
      - Added property sinr (float)
        
        Cellular 4G SINR in dB
  - WLAN properties:
    - Added property rssi (float)
      
      WLAN RSSI in dBm
    - Added property ssid (string)
      
      SSID of WLAN network

`POST` /partners/{partnerUid}/bss, `PUT` /partners/{partnerUid}/bss/{bsUid}

Request:

Deprecated property wanConfig (string)

WAN backhaul interfaces of the base station.

Empty until the configuration is reported by the base station.

Only the imei, imsi and iccid attributes of a GPRS interface can be updated.

This parameter must no longer be used: the ints property must be used in responses (IMEI, IMSI and ICCID are now reported by the base station).

Return Type:

Changed response : 201 Created | 200 OK

Successful CREATE, RETRIEVE or UPDATE

Changed property ints (object)
- Changed property int (array)
  
  Changed items (object):
  - Changed property type (string)
    
    Interface type
    
    Added enum value:
    - WLAN
  - GPRS properties:
    - Deleted property signalStrength (integer)
      
      Interface RSSI (between 0 and 5)
    - Added property connectionType (string)
      
      Cellular connection type
      
      Enum values:
      - 3G
      - 4G
    - Added property iccid (string)
      
      ICCID of the SIM card
    - Added property imei (string)
      
      IMEI of the Base Station
    - Added property imsi (string)
      
      IMSI of the SIM card
    - Added property networkOperator (string)
      
      Cellular network operator
    - Added property rssi (float)
      
      Cellular RSSI in dBm
    - 3G properties:
      - Added property rscp (float)
        
        Cellular 3G RSCP in dBm
      - Added property ecIo (float)
        
        Cellular 3G Ec/Io in dB
    - 4G properties:
      - Added property rsrp (float)
        
        Cellular 4G RSRP in dBm
      - Added property rsrq (float)
        
        Cellular 4G RSRQ in dBm
      - Added property sinr (float)
        
        Cellular 4G SINR in dB
  - WLAN properties:
    - Added property rssi (float)
      
      WLAN RSSI in dBm
    - Added property ssid (string)
      
      SSID of WLAN network
Deprecated property wanConfig (string)

WAN backhaul interfaces of the base station.

Empty until the configuration is reported by the base station.

Only the imei, imsi and iccid attributes of a GPRS interface can be updated.

This parameter must no longer be used: the ints property must be used in responses (IMEI, IMSI and ICCID are now reported by the base station).

`GET` /partners/{partnerUid}/bss/{bsUid}

Return Type:

Changed response : 200 OK

Successful CREATE, RETRIEVE or UPDATE

Changed property ints (object)
- Changed property int (array)
  
  Changed items (object):
  - Changed property type (string)
    
    Interface type
    
    Added enum value:
    - WLAN
  - GPRS properties:
    - Deleted property signalStrength (integer)
      
      Interface RSSI (between 0 and 5)
    - Added property connectionType (string)
      
      Cellular connection type
      
      Enum values:
      - 3G
      - 4G
    - Added property iccid (string)
      
      ICCID of the SIM card
    - Added property imei (string)
      
      IMEI of the Base Station
    - Added property imsi (string)
      
      IMSI of the SIM card
    - Added property networkOperator (string)
      
      Cellular network operator
    - Added property rssi (float)
      
      Cellular RSSI in dBm
    - 3G properties:
      - Added property rscp (float)
        
        Cellular 3G RSCP in dBm
      - Added property ecIo (float)
        
        Cellular 3G Ec/Io in dB
    - 4G properties:
      - Added property rsrp (float)
        
        Cellular 4G RSRP in dBm
      - Added property rsrq (float)
        
        Cellular 4G RSRQ in dBm
      - Added property sinr (float)
        
        Cellular 4G SINR in dB
  - WLAN properties:
    - Added property rssi (float)
      
      WLAN RSSI in dBm
    - Added property ssid (string)
      
      SSID of WLAN network
Deprecated property wanConfig (string)

WAN backhaul interfaces of the base station.

Empty until the configuration is reported by the base station.

Only the imei, imsi and iccid attributes of a GPRS interface can be updated.

This parameter must no longer be used: the ints property must be used in responses (IMEI, IMSI and ICCID are now reported by the base station).

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/ints/{intUid}

Retrieve Int

Return Type:

Changed response : 200 OK

Successful RETRIEVE

GPRS properties:
- Deleted property minCellSignal (object)
  
  MIN Cell RSSI
- Deleted property operatorCell (string)
  
  Cellular network operator
- Added property connectionType (string)
  
  Cellular connection type
  
  Enum values:
  - 3G
  - 4G
- Added property iccid (string)
  
  ICCID of the SIM card
- Added property imei (string)
  
  IMEI of the Base Station
- Added property imsi (string)
  
  IMSI of the SIM card
- Added property networkOperator (string)
  
  Cellular network operator
- Added property rssi (float)
  
  Cellular RSSI in dBm
- 3G properties:
  - Added property rscp (float)
    
    Cellular 3G RSCP in dBm
  - Added property ecIo (float)
    
    Cellular 3G Ec/Io in dB
- 4G properties:
  - Added property rsrp (float)
    
    Cellular 4G RSRP in dBm
  - Added property rsrq (float)
    
    Cellular 4G RSRQ in dBm
  - Added property sinr (float)
    
    Cellular 4G SINR in dB
WLAN properties:
- Added property rssi (float)
  
  WLAN RSSI in dBm
- Added property ssid (string)
  
  SSID of WLAN network

RDTP-4710

What's Changed

`GET` /partners/{partnerUid}

Retrieve Partner

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

operator

Added property baseStationsNetID (string)

NetID used for Base Stations at Network Partner level. NetID defined at Operator level is used if not set.
Added property operator (object)
- Property baseStationsNetID (string)
  
  NetID used for Base Stations at Operator level.
Added property segregationID (string)

Segregation ID used for Base Stations. When not set, the segregation ID is automatically generated based on network traffic segregation defined at Operator level.

`PUT` /partners/{partnerUid}

Update Partner

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

operator

Added property baseStationsNetID (string)

NetID used for Base Stations at Network Partner level. NetID defined at Operator level is used if not set.
Added property operator (object)
- Property baseStationsNetID (string)
  
  NetID used for Base Stations at Operator level.
Added property segregationID (string)

Segregation ID used for Base Stations. When not set, the segregation ID is automatically generated based on network traffic segregation defined at Operator level.

`PUT` /partners/{partnerUid}/restricted

Update Restricted Settings

Request:

Added property baseStationsNetID (string)

NetID used for Base Stations at Network Partner level.
Added property segregationID (string)

Segregation ID used for Base Stations.

Return Type:

Changed response : 200 OK

Successful UPDATE

Added property baseStationsNetID (string)

NetID used for Base Stations at Network Partner level.
Added property segregationID (string)

Segregation ID used for Base Stations.

RDTP-9648

What's New

`POST` /partners/{partnerUid}/bss/alarms/ack

Ack Alarms of all Base Stations

What's Changed

`GET` /partners/{partnerUid}/bss/alarms

Retrieve Alarms of all Base Stations

Parameters:

Added: pageSize in query

Size of the expected page result.

If not specified or lower than the minimum page size (system-wide configuration), the minimum page size is used.

If greater than the maximum page size (system-wide configuration), the maximum page size is used.

Added: lrrID in query

LRR ID filtering (prefix match)

Return Type:

Changed response : 200 OK

Successful RETRIEVE

New required properties:

count

Added property count (integer)

Total number of matching alarms
Changed property briefs (array)

Changed items (object):

New required properties:
- alarmUid
- Added property alarmUid (string)
  
  Alarm Uid identifying the alarm occurrence

Release 6.1

RDTP-15979

What's Changed

`GET` /partners/{partnerUid}

Retrieve Partner

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property defaultIsmBand (object)
- Changed property ID (string)
  
  ISM band ID
  
  Added enum value:
  - ww2g4
- Changed property name (string)
  
  ISM band name
  
  Added enum value:
  - WW2400
Changed property defaultIsmBands (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` /partners/{partnerUid}

Update Partner

Request:

Changed property defaultIsmBand (object)
- Changed property ID (string)
  
  ISM band ID
  
  Added enum value:
  - ww2g4
- Changed property name (string)
  
  ISM band name
  
  Added enum value:
  - WW2400
Changed property defaultIsmBands (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 defaultIsmBand (object)
- Changed property ID (string)
  
  ISM band ID
  
  Added enum value:
  - ww2g4
- Changed property name (string)
  
  ISM band name
  
  Added enum value:
  - WW2400
Changed property defaultIsmBands (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` /partners/{partnerUid}/bsProfiles

Retrieve BsProfiles

Parameters:

Changed: ismBandID in query

ISM band ID filtering (exact match) If multiple ismBandID, return Base Station Profiles supporting any of ISM Band

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (array)

Changed items (object):
- Changed property defaultIsmBands (array)
  
  List of ISM bands supported by the base station profile. If the list of base station profiles is filtered by ISM bands, this list is an intersection between requested ISM bands and supported ISM bands.
  
  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` /partners/{partnerUid}/bsVendors

Retrieve BaseStationVendors

Parameters:

Changed: ismBandID in query

ISM band ID filtering (exact match)

Only return Base Station Vendors having at least one Base Station Profile supporting this IMS band

`POST` /partners/{partnerUid}/bss

Create Bs

Request:

Changed property model (object)
- Changed property ismBands (array)
  
  List of IMS band IDs associated with the BS profile. If default ISM bands are defined for the network partner, the list is filtered to only keep ISM bands matching the default ones.
  
  Changed items (object):
  - Changed property ID (string)
    
    ISM band ID
    
    Added enum value:
    - ww2g4

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Changed property model (object)
- Changed property ismBands (array)
  
  List of IMS band IDs associated with the BS profile. If default ISM bands are defined for the network partner, the list is filtered to only keep ISM bands matching the default ones.
  
  Changed items (object):
  - Changed property ID (string)
    
    ISM band ID
    
    Added enum value:
    - ww2g4

`GET` /partners/{partnerUid}/bss/{bsUid}

Retrieve Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property model (object)
- Changed property ismBands (array)
  
  List of IMS band IDs associated with the BS profile. If default ISM bands are defined for the network partner, the list is filtered to only keep ISM bands matching the default ones.
  
  Changed items (object):
  - Changed property ID (string)
    
    ISM band ID
    
    Added enum value:
    - ww2g4

`PUT` /partners/{partnerUid}/bss/{bsUid}

Update Bs

Request:

Changed property model (object)
- Changed property ismBands (array)
  
  List of IMS band IDs associated with the BS profile. If default ISM bands are defined for the network partner, the list is filtered to only keep ISM bands matching the default ones.
  
  Changed items (object):
  - Changed property ID (string)
    
    ISM band ID
    
    Added enum value:
    - ww2g4

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property model (object)
- Changed property ismBands (array)
  
  List of IMS band IDs associated with the BS profile. If default ISM bands are defined for the network partner, the list is filtered to only keep ISM bands matching the default ones.
  
  Changed items (object):
  - Changed property ID (string)
    
    ISM band ID
    
    Added enum value:
    - ww2g4

`GET` /partners/{partnerUid}/ismBands

Retrieve IsmBands

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (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` /partners/{partnerUid}/rfRegions

Retrieve RF Regions

Parameters:

Changed: ismBandID in query

ISM band ID filtering (exact match) If multiple ismBandID, return RF Regions supporting any of ISM Band

RDTP-5843

What's New

`GET` /partners/{partnerUid}/bss/{bsUid}/alarms/histories

Retrieve Alarms History

RDTP-7383

What's Changed

`GET` /partners/{partnerUid}/bss/{bsUid}

Retrieve Bs

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`PUT` /partners/{partnerUid}/bss/{bsUid}

Update Bs

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`DELETE` /partners/{partnerUid}/bss/{bsUid}

Delete Bs

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/antennasGainAndLossStatus

Retrieve AntennasGainAndLossStatus

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/availableLrrVersions

Retrieve AvailableLrrVersions

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/backup

Create Backup

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/backupSwVersion

Retrieve BackupSwVersion

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/cancelRadioScan

Create CancelRadioScan

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/closeSsh

Create CloseSsh

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/downloadLrrVersion

Download LRR software

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/fineTimestampKeysStatus

Retrieve FineTimestampKeysStatus

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/lastCmdStatus

Retrieve LastCmdStatus

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/locationStatus

Retrieve LocationStatus

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/logStatus

Retrieve LogStatus

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/openSsh

Create OpenSsh

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/openTerminal

Open SSH Terminal

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/reboot

Create Reboot

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/restart

Create Restart

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/restore

Create Restore

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/reverseSshStatus

Retrieve ReverseSshStatus

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/rfRegionStatus

Retrieve RfRegionStatus

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/rfcDownlinkStop

Create RfcDownlinkStop

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/rfcStart

Create RfcStart

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/rfcStatus

Retrieve RfcStatus

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/rfcStop

Create RfcStop

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/scanRadio

Create ScanRadio

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/scanRadioStatus

Retrieve ScanRadioStatus

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`PUT` /partners/{partnerUid}/bss/{bsUid}/admins/settings

Update AdminSettings

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/softwareUptime

Retrieve SoftwareUptime

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/swVersion

Retrieve SwVersion

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/systemUptime

Retrieve SystemUptime

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/updateAntennasGainAndLoss

Create UpdateAntennasGainAndLoss

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/updateFineTimestampKeys

Create UpdateFineTimestampKeys

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/updateLocation

Create UpdateLocation

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/updateLog

Create UpdateLog

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/updateRfRegion

Create UpdateRfRegion

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/upgrade

Create Upgrade

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/alarms

Retrieve Alarms

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/alarms/ack

Ack all alarms

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/alarms/{alarmUid}/ack

Ack alarm

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/ants

Retrieve Ants

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/ants/{antUid}

Retrieve Ant

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`PUT` /partners/{partnerUid}/bss/{bsUid}/ants/{antUid}

Update Ant

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/ants/{antUid}/images

Retrieve Images

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/ants/{antUid}/images

Create Image

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/ants/{antUid}/images/{imageUid}

Retrieve Image

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`DELETE` /partners/{partnerUid}/bss/{bsUid}/ants/{antUid}/images/{imageUid}

Delete Image

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/check

Retrieve Check

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/frames

Retrieve Frames

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/regenerateCertificate

Create RegenerateCertificate

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/devicesScattering

Retrieve DevicesScattering

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/downlinks/statusDistributions

Retrieve StatusDistributions

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/lcs/{lcUid}/dutyCycles

Retrieve DutyCycles

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/lcs/{lcUid}/dutyCycles/histories

Retrieve DutyCycles Histories

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/lcs/{lcUid}/dutyCycles/reset

Create Reset

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/lcs/{lcUid}/signalsAndNoises

Retrieve SignalsAndNoises

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/lcs/{lcUid}/signalsAndNoises/reset

Create Reset

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/lcs/{lcUid}/signalsAndNoises/snDistributions

Retrieve SnDistributions

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/lcs/{lcUid}/spreadingFactors/sfDistributions

Retrieve SfDistributions

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/spreadingFactors/sfDistributions

Retrieve SfDistributions

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/beacons

Retrieve Beacons

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/indicators

Retrieve Rfcell Indicators

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/rfcell/indicators/reset

Create Reset

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/sys/cpu

Retrieve Cpu

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/sys/cpu/histories

Retrieve CPU Histories

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/sys/cpu/reset

Create Reset

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/sys/disks/{diskIndex}

Retrieve Disk

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/sys/disks/{diskIndex}/histories

Retrieve disck Histories

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/sys/disks/{diskIndex}/reset

Create Reset

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/sys/ram

Retrieve Ram

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/sys/ram/histories

Retrieve RAM Histories

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/sys/ram/reset

Create Reset

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/tags

Retrieve Tags

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/tags

Add Tag

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`DELETE` /partners/{partnerUid}/bss/{bsUid}/tags/{tagUid}

Remove Tag

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/iecQueues

Retrieve IecQueues

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/iecQueues/histories

Retrieve IEC queue Histories

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/wans/iecQueues/reset

Create Reset

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/indicators

Retrieve WAN Indicators

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/wans/indicators/reset

Create Reset

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/ints/{intUid}

Retrieve Int

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/ints/{intUid}/bitrates

Retrieve Bitrates

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/wans/ints/{intUid}/reset

Create Reset

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/ints/{intUid}/roundTrips

Retrieve RoundTrips

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/lrcs/{lrcUid}

Retrieve Lrc

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/lrcs/{lrcUid}/iecPackets

Retrieve IecPackets

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

`POST` /partners/{partnerUid}/bss/{bsUid}/wans/lrcs/{lrcUid}/reset

Create Reset

Parameters:

Changed: bs in path

Unique identifier of the base station, either

the sequential integer (UID) assigned to the base station at creation

the lrrID in uppercase prefixed with the i letter in downcase

the lrrUUID in uppercase prefixed with the u letter in downcase

Release 6.0

RDTP-2277

What's Changed

`GET` /partners/{partnerUid}/bss/alarms

Retrieve Alarms

Return Type:

Changed response : 200 OK

Successful RETRIEVE

Changed property briefs (array)

Changed items (object):
- Added property level (integer)
  
  Alarm level

`GET` /partners/{partnerUid}/bss/{bsUid}/alarms

Retrieve Alarms

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (array)

Changed items (object):
- Added property level (integer)
  
  Alarm level

RDTP-2467

What's Changed

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/scanRadio

Create ScanRadio

Request:

Added property frequency (object)

Frequency vector to scan.
- Property start (number)
  
  First scanned frequency in MHz
- Property stop (number)
  
  Last scanned frequency in MHz
- Property step (number)
  
  Step width in KHz

Return Type:

Changed response : 201 Created

Successful CREATE

Added property frequency (object)

Frequency vector to scan.
- Property start (number)
  
  First scanned frequency in MHz
- Property stop (number)
  
  Last scanned frequency in MHz
- Property step (number)
  
  Step width in KHz

`GET` /partners/{partnerUid}/ismBands

Retrieve IsmBands

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (array)

Changed items (object):

New required properties:
- defaultScan
- Added property defaultScan (object)
  
  Default scan frequency
  - Property start (number)
    
    First scanned frequency in MHz
  - Property stop (number)
    
    Last scanned frequency in MHz
  - Property step (number)
    
    Step width in KHz

RDTP-2488

What's Changed

`GET` /partners

Authentication function

Return Type:

Changed response : 200 OK

Successfully authenticated.

The session ID is returned in a cookie named JSESSIONID.

You need to include this cookie in subsequent requests.

Changed property partner (object)

New required properties:
- grantedPermissions
- Added property grantedPermissions (array)
  
  Items (string):
  
  Enum values:
  - x
  - a
  - ra
  - rc

RDTP-2543

What's New

`GET` /partners/{partnerUid}/rfRegions/{rfRegionUid}

Retrieve RF Region

`GET` /partners/{partnerUid}/rfRegions/{rfRegionUid}/lcs

Retrieve RF Region Logical Channels

What's Changed

`POST` /partners/{partnerUid}/bss

Create Bs

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Added property rfRegionHref (string)

RF Region href

`GET` /partners/{partnerUid}/bss/{bsUid}

Retrieve Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Added property rfRegionHref (string)

RF Region href

`PUT` /partners/{partnerUid}/bss/{bsUid}

Update Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Added property rfRegionHref (string)

RF Region href

`GET` /partners/{partnerUid}/rfRegions

Retrieve RF Regions

Return Type:

Changed response : 200 OK

Successful RETRIEVE

Changed property briefs (array)

Changed items (object):

New required properties:
- href
- Added property href (string)
  
  HREF of the RF Region

RDTP-6639

What's Changed

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/openTerminal

Open SSH Terminal

Changed description :

The following rule no more applies:

Current version must be > 1.4.12 (this is the first LRR version where HTTP commands are working)

Release 5.2.2

RDTP-2208, RDTP-2343

What's Changed

`POST` /partners/{partnerUid}/bss

Create Bs

Request:

Changed property bsSecurity (object)
- Changed property type (string)
  Base Station security type:
  - IPSEC_X509: IPsec or TLS (X.509 certificates)
  - DISABLE

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Changed property ints (array)

Changed items (object):
- Changed property ip (string)
  
  Interface IP address
  
  Can be either an IPv4 or an IPv6.
Changed property bsSecurity (object)
- Changed property type (string)
  Base Station security type:
  - IPSEC_X509: IPsec or TLS (X.509 certificates)
  - DISABLE

`GET` /partners/{partnerUid}/bss/{bsUid}

Retrieve Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property ints (array)

Changed items (object):
- Changed property ip (string)
  
  Interface IP address
  
  Can be either an IPv4 or an IPv6.
Changed property bsSecurity (object)
- Changed property type (string)
  Base Station security type:
  - IPSEC_X509: IPsec or TLS (X.509 certificates)
  - DISABLE

`PUT` /partners/{partnerUid}/bss/{bsUid}

Update Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property ints (array)

Changed items (object):
- Changed property ip (string)
  
  Interface IP address
  
  Can be either an IPv4 or an IPv6.
Changed property bsSecurity (object)
- Changed property type (string)
  Base Station security type:
  - IPSEC_X509: IPsec or TLS (X.509 certificates)
  - DISABLE

RDTP-4777

What's New

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/downloadLrrVersion

Download LRR software

What's Changed

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/availableLrrVersions

Retrieve AvailableLrrVersions

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (array)

Changed items (object):
- Added property package (string)
  
  Package name

RDTP-6529

What's Changed

`GET` /partners/{partnerUid}/bss

Retrieve Bss

Parameters:

Added: pageSize in query

Size of the expected page result.

If not specified or lower than the minimum page size (system-wide configuration), the minimum page size is used.

If greater than the maximum page size (system-wide configuration), the maximum page size is used.

RDTP-7582

What's Changed

`GET` /partners/{partnerUid}

Retrieve Partner

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Added property keyInstallerPubkeyAuthentication (string)

Public key authentication mode to connect to Key installer.

Enum values:
- DISABLED
- ENFORCED
- OPTIONAL_DISABLED_BY_DEFAULT
- OPTIONAL_ENABLED_BY_DEFAUL

`PUT` /partners/{partnerUid}

Update Partner

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Added property keyInstallerPubkeyAuthentication (string)

Public key authentication mode to connect to Key installer.

Enum values:
- DISABLED
- ENFORCED
- OPTIONAL_DISABLED_BY_DEFAULT
- OPTIONAL_ENABLED_BY_DEFAUL

`POST` /partners/{partnerUid}/bss

Create Bs

Request:

Added property publicKey (string)

SSH public key used by the base station to authenticate to the Key installer. This property is relevant only if bsSecurity is IPSEC_X509. The public key must be provided in PEM PKCS8 format.

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Added property publicKey (string)

SSH public key used by the base station to authenticate to the Key installer. This property is relevant only if bsSecurity is IPSEC_X509. The public key must be provided in PEM PKCS8 format.

`GET` /partners/{partnerUid}/bss/{bsUid}

Retrieve Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Added property publicKey (string)

SSH public key used by the base station to authenticate to the Key installer. This property is relevant only if bsSecurity is IPSEC_X509. The public key must be provided in PEM PKCS8 format.

`PUT` /partners/{partnerUid}/bss/{bsUid}

Update Bs

Request:

Added property publicKey (string)

SSH public key used by the base station to authenticate to the Key installer. This property is relevant only if bsSecurity is IPSEC_X509. The public key must be provided in PEM PKCS8 format.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Added property publicKey (string)

SSH public key used by the base station to authenticate to the Key installer. This property is relevant only if bsSecurity is IPSEC_X509. The public key must be provided in PEM PKCS8 format.

RDTP-7849

What's Changed

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/availableLrrVersions

Retrieve AvailableLrrVersions

Definition:

Returned LRR software versions must match the additional rule:

LRR software version must be compatible with the firmware version and the FPGA version currently installed on the Base Station (only applicable if firmware version and FPGA version has been reported by the Base Station).

Release 5.1

RDTP-3365

What's New

`GET` /partners/{partnerUid}/rfRegions

Retrieve RF Regions

`GET` /partners/{partnerUid}/rfRegions/catalog

Retrieve Catalog version

`GET` /partners/{partnerUid}/rfRegions/catalog/selfUpdate

Retrieve latest Catalog version

`POST` /partners/{partnerUid}/rfRegions/catalog/selfUpdate

Import Catalog from repository

What's Changed

`POST` /partners/{partnerUid}/bss

Create Bs

Request:

Changed property model (object)
- Added property ismBands (array)
  
  Items (object):
  - Property ID (string)
    
    List of IMS band IDs associated with the BS profile

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Added property rfRegionName (string)

RF Region name
Changed property model (object)
- Added property ismBands (array)
  
  Items (object):
  - Property ID (string)
    
    List of IMS band IDs associated with the BS profile

`GET` /partners/{partnerUid}/bss/{bsUid}

Retrieve Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Added property rfRegionName (string)

RF Region name
Changed property model (object)
- Added property ismBands (array)
  
  Items (object):
  - Property ID (string)
    
    List of IMS band IDs associated with the BS profile

`PUT` /partners/{partnerUid}/bss/{bsUid}

Update Bs

Request:

Changed property model (object)
- Added property ismBands (array)
  
  Items (object):
  - Property ID (string)
    
    List of IMS band IDs associated with the BS profile

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Added property rfRegionName (string)

RF Region name
Changed property model (object)
- Added property ismBands (array)
  
  Items (object):
  - Property ID (string)
    
    List of IMS band IDs associated with the BS profile

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/rfRegionStatus

Retrieve RfRegionStatus

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property rfRegion (object)
- Added property name (string)
  
  RF Region name

RDTP-3366

What's Changed

`GET` /partners/{partnerUid}/bsProfiles

Retrieve BsProfiles

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (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)
    
    Name of the base station vendor

`GET` /partners/{partnerUid}/bsVendors

Retrieve BaseStationVendors

Parameters:

Deprecated: name in query

Base Station Vendor name filtering (prefix match)

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (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)
  
  Name of the base station vendor

`GET` /partners/{partnerUid}/bss

Retrieve Bss

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (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` /partners/{partnerUid}/bss

Create Bs

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

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` /partners/{partnerUid}/bss/{bsUid}

Retrieve Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

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` /partners/{partnerUid}/bss/{bsUid}

Update Bs

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

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
- Changed property name (string)
  
  BS vendor name

RDTP-3442

What's New

`GET` /partners/{partnerUid}/bss/alarms

Retrieve Alarms

`GET` /partners/{partnerUid}/bss/alarms/stateDistributions

Retrieve Alarms State Distributions

RDTP-3755

What's Changed

`GET` /partners/{partnerUid}

Retrieve Partner

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Added property defaultIsmBands (array)

Items (object) :
- Property ID (string)
  
  Default ISM band ID
- Property name (string)
  
  Default ISM band name
Changed property defaultIsmBand (object)

`PUT` /partners/{partnerUid}

Update Partner

Request:

Added property defaultIsmBands (array)

Items (object) :
- Property ID (string)
  
  Default ISM band ID
- Property name (string)
  
  Default ISM band name
Changed property defaultIsmBand (object)

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Added property defaultIsmBands (array)

Items (object) :
- Property ID (string)
  
  Default ISM band ID
- Property name (string)
  
  Default ISM band name
Changed property defaultIsmBand (object)

`GET` /partners/{partnerUid}/bsProfiles

Retrieve BsProfiles

Parameters:

Changed: ismBandID in query

ISM band ID filtering (exact match) If multiple ismBandID, return Base Station Profiles supporting any of ISM Band

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (object)
- Added property ismBands (array)
  
  Items (object) :
  - Property ID (string)
    
    List of IMS band IDs associated with the BS profile
  - Property name (string)
    
    List of ISM band names associated with the BS profile

`GET` /partners/{partnerUid}/bsVendors

Retrieve BaseStationVendors

Parameters:

Changed: ismBandID in query

ISM band ID filtering (exact match)

Only return Base Station Vendors having at least one Base Station Profile supporting this IMS band

Release 5.0.1

General

What's New

`GET` /partners/{partnerUid}/bsProfiles/catalog

Retrieve Catalog version

`GET` /partners/{partnerUid}/bsProfiles/catalog/selfUpdate

Retrieve latest Catalog version

`POST` /partners/{partnerUid}/bsProfiles/catalog/selfUpdate

Import Catalog from repository

`POST` /partners/{partnerUid}/bss/tags

Tag Bss

`GET` /partners/{partnerUid}/bss/tags/suggestions

Retrieve Base Station Tag Suggestions

`GET` /partners/{partnerUid}/bss/{bsUid}/tags

Retrieve Tags

`POST` /partners/{partnerUid}/bss/{bsUid}/tags

Add Tag

`DELETE` /partners/{partnerUid}/bss/{bsUid}/tags/{tagUid}

Remove Tag

What's Changed

`GET` /partners/{partnerUid}

Retrieve Partner

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Added property totalBaseStationsUsed (integer)

Number of base stations created by the network partner.
Added property delegateBsTagging (boolean)

True when the Base Stations tagging is delegated to the owner of the account.
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` /partners/{partnerUid}

Update Partner

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Added property totalBaseStationsUsed (integer)

Number of base stations created by the network partner.
Added property delegateBsTagging (boolean)

True when the Base Stations tagging is delegated to the owner of the account.
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` /partners/{partnerUid}/bss

Retrieve Bss

Parameters:

Added: query in query

Search base stations with a LRR ID or LRR UUID or name containing the provided term. (prefix match)

Added: tag in query

Tag names associated with the Base Station

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property briefs (object)
- Added property tags (array)

`POST` /partners/{partnerUid}/bss/{bsUid}/alarms/ack

Ack all alarms

Parameters:

Deprecated: algo in query

Algorithm used to generate the KPI:

mapReduce: MongoDB map/reduce is used

aggregation: MongoDB aggregation is used

Default value: When this query parameter is not specified the aggregation algorithm is used by default.

`GET` /partners/{partnerUid}/bss/{bsUid}/frames

Retrieve Frames

Parameters:

Deprecated: algo in query

Algorithm used to generate the KPI:

mapReduce: MongoDB map/reduce is used

aggregation: MongoDB aggregation is used

Default value: When this query parameter is not specified the aggregation algorithm is used by default.

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/downlinks/statusDistributions

Retrieve StatusDistributions

Parameters:

Deprecated: algo in query

Algorithm used to generate the KPI:

mapReduce: MongoDB map/reduce is used

aggregation: MongoDB aggregation is used

Default value: When this query parameter is not specified the aggregation algorithm is used by default.

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/lcs/{lcId}/dutyCycles/histories

Retrieve DutyCycles Histories

Parameters:

Deprecated: algo in query

Algorithm used to generate the KPI:

mapReduce: MongoDB map/reduce is used

aggregation: MongoDB aggregation is used

Default value: When this query parameter is not specified the aggregation algorithm is used by default.

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/lcs/{lcId}/signalsAndNoises/snDistributions

Retrieve SnDistributions

Parameters:

Deprecated: algo in query

Algorithm used to generate the KPI:

mapReduce: MongoDB map/reduce is used

aggregation: MongoDB aggregation is used

Default value: When this query parameter is not specified the aggregation algorithm is used by default.

`GET` /partners/{partnerUid}/bss/{bsUid}/rfcell/ants/{antUid}/lcs/{lcId}/spreadingFactors/sfDistributions

Retrieve SfDistributions

Parameters:

Deprecated: algo in query

Algorithm used to generate the KPI:

mapReduce: MongoDB map/reduce is used

aggregation: MongoDB aggregation is used

Default value: When this query parameter is not specified the aggregation algorithm is used by default.

`GET` /partners/{partnerUid}/bss/{bsUid}/sys/cpu/histories

Retrieve CPU Histories

Parameters:

Deprecated: algo in query

Algorithm used to generate the KPI:

mapReduce: MongoDB map/reduce is used

aggregation: MongoDB aggregation is used

Default value: When this query parameter is not specified the aggregation algorithm is used by default.

`GET` /partners/{partnerUid}/bss/{bsUid}/sys/disks/{diskIndex}/histories

Retrieve disck Histories

Parameters:

Deprecated: algo in query

Algorithm used to generate the KPI:

mapReduce: MongoDB map/reduce is used

aggregation: MongoDB aggregation is used

Default value: When this query parameter is not specified the aggregation algorithm is used by default.

`GET` /partners/{partnerUid}/bss/{bsUid}/sys/ram/histories

Retrieve RAM Histories

Parameters:

Deprecated: algo in query

Algorithm used to generate the KPI:

mapReduce: MongoDB map/reduce is used

aggregation: MongoDB aggregation is used

Default value: When this query parameter is not specified the aggregation algorithm is used by default.

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/iecQueues/histories

Retrieve IEC queue Histories

Parameters:

Deprecated: algo in query

Algorithm used to generate the KPI:

mapReduce: MongoDB map/reduce is used

aggregation: MongoDB aggregation is used

Default value: When this query parameter is not specified the aggregation algorithm is used by default.

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/ints/{intUid}/bitrates

Retrieve Bitrates

Parameters:

Deprecated: algo in query

Algorithm used to generate the KPI:

mapReduce: MongoDB map/reduce is used

aggregation: MongoDB aggregation is used

Default value: When this query parameter is not specified the aggregation algorithm is used by default.

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/ints/{intUid}/roundTrips

Retrieve RoundTrips

Parameters:

Deprecated: algo in query

Algorithm used to generate the KPI:

mapReduce: MongoDB map/reduce is used

aggregation: MongoDB aggregation is used

Default value: When this query parameter is not specified the aggregation algorithm is used by default.

`GET` /partners/{partnerUid}/bss/{bsUid}/wans/lrcs/{lrcUid}/iecPackets

Retrieve IecPackets

Parameters:

Deprecated: algo in query

Algorithm used to generate the KPI:

mapReduce: MongoDB map/reduce is used

aggregation: MongoDB aggregation is used

Default value: When this query parameter is not specified the aggregation algorithm is used by default.

Release 4.2

NFR684

Following web services are updated:

C /partners/\{partnerUid\}/bss
RU /partners/\{partnerUid\}/bss/\{bsUid\}

Attribute name	XSD type	Create	Update	Resp.	Description
lrrID → UPDATED	string	O		M	BS LRR ID: 32 bits hexadecimal string (8 characters) Mandatory in Create if LRR UUID is not provided Forbidden in Create if LRR UUID is provided
smn → UPDATED	string	O	O	O	BS serial marketing number
lrrUUID → NEW	string	O	O	O	BS LRR UUID: `<LRR-OUI>-<LRR-GID>` Where: `<LRR-OUI>` is the IEEE OUI of the Base Station vendor (6 hexadecimal characters) `<LRR-GID>` is the Base Station identifier relatively to the vendor (minimum 2 and maximum 48 hexadecimal characters) Mandatory in Create if LRR ID is not provided Forbidden in Create if LRR ID is provided Forbidden in Update if BS identification mode is LRR UUID
identificationMode → NEW	enumerate			M	BS identification mode: `LRR_ID`: BS is identified by its LRR ID, LRR UUID can be updated `LRR_UUID`: BS is identified by its LRR UUID, LRR UUID cannot be updated

NFR724

Following web services are updated:

RU /partners/\{partnerUid\}

Attribute name	XSD type	Update	Resp.	Description
defaultIsmBand/ID → NEW	string	O	O	Default ISM band ID
defaultIsmBand/name → NEW	string		O	Default ISM band name
defaultBsSecurity → NEW	enumerate		M	Default Base Station security: `IPSEC_X509` `DISABLE`
installationID → NEW	string		O	Installation ID

R /partners/\{partnerUid\}/bsProfiles

Attribute name	XSD type			Resp.	Description
briefs/brief[]/vendor/name → NEW	string			M	Name of the base station vendor
briefs/brief[]/vendor/ID → NEW	string			M	ID of the base station vendor

Optional query parameters


vendorID → NEW	string	Base Station Vendor ID filtering (prefix match)
ismBandID → NEW	string	ISM band ID filtering (exact match)

R /partners/\{partnerUid\}/bss

Attribute name	XSD type	Resp.	Description
briefs/brief[]/healthState → NEW	enumerate	M	Health state: `INIT` `ACTIVE` `BACKHAUL_CNX_ERROR` `RF_ERROR`
briefs/brief[]/lrrUUID → NEW	string	O	BS LRR UUID: `<LRR-OUI>-<LRR-GID>` Where: `<LRR-OUI>` is the IEEE OUI of the Base Station vendor (6 hexadecimal characters) `<LRR-GID>` is the Base Station identifier relatively to the vendor (minimum 2 and maximum 48 hexadecimal characters)
briefs/brief[]/ints/int[]/name → NEW	string	M	Interface name
briefs/brief[]/ints/int[]/type → NEW	enumerate	O	Interface type: `ETHERNET` `GPRS`
briefs/brief[]/ints/int[]/state → NEW	unsignedInt	O	State for an ETHERNET interface: Down / No started (5) Up / Link down (4) Up / No IP / No DHCP lease (3) Up / Network down (2) Up and running (1) Up / running and used (0) State for a GPRS interface: Down / No started (5) Up / Nw. reg. failed / No sig. (4) Up / No IP / No PDP context (3) Up / Network down (2) Up and running (1) Up / running and used (0)
briefs/brief[]/vendor/name → NEW	string	M	BS vendor name
briefs/brief[]/vendor/logo → NEW	string	M	BS vendor logo HREF

Query parameters


LRRUUID	string	LRR UUID filtering (prefix match)
healthState	enumerate	Health state filtering ("`INIT`", "`ACTIVE`", "`BACKHAUL_CNX_ERROR`" or "`RF_ERROR`"). Multiple values can be set. If not provided, all Base Stations are returned.

C /partners/\{partnerUid\}/bss
RUD /partners/\{partnerUid\}/bss/\{bsUid\}

Attribute name	XSD type	Create	Resp.	Description
healthState → NEW	enumerate		M	Health state: `INIT` `ACTIVE` `BACKHAUL_CNX_ERROR` `RF_ERROR`
vendor/name → NEW	string		M	BS vendor name
vendor/ID → NEW	string		M	BS vendor ID
vendor/logo → NEW	string		M	BS vendor logo HREF
ints/int[]/type → NEW	enumerate		O	Interface type: `ETHERNET` `GPRS`
bsSecurity/type → NEW	enumerate	O	M	Base Station security type: `IPSEC_X509` `DISABLE`
bsSecurity/generationDate → NEW	dateTime		O	Date of Base Station security generation

Following web services are added:

R /partners/\{partnerUid\}/ismBands
R /partners/\{partnerUid\}/bsVendors
CR /partners/\{partnerUid\}/licenses
R /partners/\{partnerUid\}/bss/counters
C /partners/\{partnerUid\}/bss/\{bsUid\}/regenerateCertificate
R /partners/\{partnerUid\}/bss/\{bsUid\}/rfcell/ants/\{antUid\}/spreadingFactors/sfDistributions

NFR758

Following web services are updated:

C /partners/\{partnerUid\}/bss
RU /partners/\{partnerUid\}/bss/\{bsUid\}

Attribute name	XSD type	Resp.	Description
log/traceLevel → NEW	unsignedInt	O	LRR trace level (0..3). 0 means no trace.
log/traceSince → NEW	dateTime	O	LRR trace activated (1..3) or deactivated (0) since timestamp.
log/ramDirUsed → NEW	boolean	O	TRUE when RAM disk is used for logging

R /partners/\{partnerUid\}/bss/\{bsUid\}/admins/lastCmdStatus

Attribute name	XSD type	Create	Update	Resp.	Description
lastCmdType → UPDATED	enumerate			O	Last command type: `UPGRADE`, `RF_START`, `RF_STOP`, `RF_DWSTOP`, `REBOOT`, `RESTART`, `SSH_OPEN`, `SSH_CLOSE`, `BACKUP`, `RESTORE`, `LOCATION_ADMIN`, `LOCATION_GPS`, `UPDATE_RF_REGION`, `UPDATE_ANTENNA_GAIN_AND_LOSS`, `UPDATE_LOG`

Following web services are added:

C /partners/\{partnerUid\}/bss/\{bsUid\}/admins/updateLog
R /partners/\{partnerUid\}/bss/\{bsUid\}/admins/logStatus

FIX4897

Following web services are updated:

C /partners/\{partnerUid\}/bss
RU /partners/\{partnerUid\}/bss/\{bsUid\}

Attribute name	XSD type	Resp.	Description
ismBand → NEW	enumerate	O	When known, the ISM band associated the BS. The following value are supported: "`eu868`", "`eu433`", "`cn779`", "`as923`", "`kr920`", "`sg920`", "`tw920`", "`us915`", "`au915`", "`cn470`"
logicalChannels/upDown[]/from → NEW	string	O	The attribute returns the list of LC indexes, as DECIMAL ranges, sort by: Symmetric uplink/downlink channels, Asymmetric downlink channels, And RX2 channel. For eu868, eu433, cn779, as923, kr920, sg920, tw920: <logicalChannels> <upDown> <from>1</from> <to>16</to> </upDown> <downAsym> <from>127</from> <to>142</to> </downAsym> <rx2>255</rx2> </logicalChannels> For us915, au915: <logicalChannels> <upDown> <from>0</from> <to>71</to> </upDown> <downAsym> <from>127</from> <to>134</to> </downAsym> <rx2>255</rx2> </logicalChannels> For cn470: <logicalChannels> <upDown> <from>0</from> <to>95</to> </upDown> <downAsym> <from>127</from> <to>174</to> </downAsym> <rx2>255</rx2> </logicalChannels> NOTE: When the ISBM band is unknown (i.e. not yet reported by the LRR), the WS returns a default list of LC indexes.
logicalChannels/upDown[]/to → NEW	string	O
logicalChannels/downAsym[]/from → NEW	string	O
logicalChannels/downAsym[]/to → NEW	string	O
logicalChannels/rx2 → NEW	string	O

Release 4.1.2

NFR826

Following web services are updated:

R /partners/\{partnerUid\}/bss/\{bsUid\}/frames
R /partners/\{partnerUid\}/bss/\{bsUid\}/sys/cpu/histories
R /partners/\{partnerUid\}/bss/\{bsUid\}/sys/ram/histories
R /partners/\{partnerUid\}/bss/\{bsUid\}/sys/disks/\{diskIndex\}/histories
R /partners/\{partnerUid\}/bss/\{bsUid\}/rfcell/ants/\{antUid\}/downlinks/statusDistributions
R /partners/\{partnerUid\}/bss/\{bsUid\}/rfcell/ants/\{antUid\}/lcs/\{lcId\}/dutyCycles/histories
R /partners/\{partnerUid\}/bss/\{bsUid\}/rfcell/ants/\{antUid\}/lcs/\{lcId\}/spreadingFactors/sfDistributions
R /partners/\{partnerUid\}/bss/\{bsUid\}/rfcell/ants/\{antUid\}/lcs/\{lcId\}/signalsAndNoises/snDistributions
R /partners/\{partnerUid\}/bss/\{bsUid\}/wans/lrcs/\{lrcUid\}/iecPackets
R /partners/\{partnerUid\}/bss/\{bsUid\}/wans/ints/\{intUid\}/bitrates
R /partners/\{partnerUid\}/bss/\{bsUid\}/wans/ints/\{intUid\}/roundTrips
R /partners/\{partnerUid\}/bss/\{bsUid\}/wans/iecQueues/histories
C /partners/\{partnerUid\}/bss/\{bsUid\}/alarms/ack

Query parameter


algo → NEW	string	Algorithm used to generate the KPI: `mapReduce`: MongoDB map/reduce is used `aggregation`: MongoDB aggregation is used Default value: When this query parameter is not specified the aggregation algorithm is used by default.	O

Release 4.1

NFR590

Following web services are updated:

CR /partners/\{partnerUid\}/bss

Attribute name	XSD type			Resp.	Description
briefs/brief[]/customs/version[] → NEW	string			O	Optional custom version fields returns as <key>=<value> pair. e.g. hardware_version=1.0.0

Optional query parameters


customVersion → NEW	string	Custom version field filtering (exact match)

RU /partners/\{partnerUid\}/bss/\{bsUid\}

Attribute name	XSD type			Resp.	Description
customs/version[] → NEW	string			O	Optional custom version fields returns as <key>=<value> pair. e.g. hardware_version=1.0.0

NFR743

Following web services are updated:

C /partners/\{partnerUid\}/bss
RU /partners/\{partnerUid\}/bss/\{bsUid\}

Attribute name	XSD type	Resp.	Description
classBState → NEW	unsignedInt	O	Class B state: Not supported (0), Supported but not operational (1), Supported and operational (2)
activateBeaconTransmission → NEW	boolean	M	Activate beacon transmission
allowClassB → NEW	boolean	M	Allow Class B

U /partners/\{partnerUid\}/bss/\{bsUid\}/admins/settings

Attribute name	XSD type		Update	Resp.	Description
activateBeaconTransmission → NEW	boolean		O	M	Activate beacon transmission
allowClassB → NEW	boolean		O	M	Allow Class B

R /partners/\{partnerUid\}/bss/\{bsUid\}/rfcell/ants/\{antUid\}/downlinks/statusDistributions

Attribute name	XSD type			Resp.	Description
pingFailures/class/value→ NEW	enumerate			M	Delivery Failed Cause on ping slot.Value choices: A: Class B: Transmission slot busy B: Class B: Too late for ping slot D: Class B: DC constraint on ping slot
pingFailures/class/count → NEW	unsignedInt			M	Number of downlink frames with this Delivery Failed Cause on ping slot.

Following web services are added:

R /partners/\{partnerUid\}/bss/\{bsUid\}/rfcell/beacons

FIX4507

Following web services are updated:

RU /partners/\{partnerUid\}/bss/\{bsUid\}

Attribute name	XSD type	Create	Update	Resp.	Description
model/rfHardwareConfig → NEW	string (enumerate)			M	RF hardware configuration of the BS profile. `S1_A1_B1`: 1 sector, 1 antenna, 1 board (mono-sector 18 or 116) `S1_A2_B1`: 1 sector, 2 antennas, 1 board (mono-sector 28) `S1_A2_B2`: 1 sector, 2 antennas, 2 boards (mono-sector 216) `S1_A1_B4`: 1 sector, 1 antennas, 4 boards (mono-sector 164) `S3_A3_B3`: 3 sectors, 3 antennas, 3 boards (tri-sectors 18 or 1*16)

Release 8.0​

RDTP-14487​

What's Changed​

GET|PUT /partners/{partnerUid}​

Return Type:​

RDTP-18707​

What's Changed​

POST /partners/{partnerUid}/bss​

Request:​

Return Type:​

GET /partners/{partnerUid}/bss/{bsUid}​

Return Type:​

PUT /partners/{partnerUid}/bss/{bsUid}​

Request:​

Return Type:​

GET /partners/{partnerUid}/bss/alarms​

GET /partners/{partnerUid}/bss/alarms/histories​

GET /partners/{partnerUid}/bss/{bsUid}/alarms​

GET /partners/{partnerUid}/bss/{bsUid}/alarms/histories​

Return Type:​

RDTP-22321​

What's New​

POST /partners/{partnerUid}/bss/{bsUid}/admins/changeSupportPassword​

What's Changed​

POST /partners/{partnerUid}/bss​

Return Type:​

GET /partners/{partnerUid}/bss/{bsUid}​

Return Type:​

PUT /partners/{partnerUid}/bss/{bsUid}​

Return Type:​

GET /partners/{partnerUid}/bss/{bsUid}/admins/lastCmdStatus​

Return Type:​

RDTP-23153​

What's Changed​

POST /partners/{partnerUid}/bss​

Request:​

RDTP-23309​

What's Changed​

GET /partners/{partnerUid}​

Return Type:​

PUT /partners/{partnerUid}​

Parameters:​

Request:​

Return Type:​

POST /partners/{partnerUid}/bss​

Return Type:​

GET /partners/{partnerUid}/bss/{bsUid}​

Return Type:​

PUT /partners/{partnerUid}/bss/{bsUid}​

Parameters:​

Request:​

Return Type:​

POST /partners/{partnerUid}/bss/{bsUid}/admins/backup​

Parameters:​

Request:​

Return Type:​

POST /partners/{partnerUid}/bss/{bsUid}/admins/cancelRadioScan​

Parameters:​

Request:​

Return Type:​

POST /partners/{partnerUid}/bss/{bsUid}/admins/closeSsh​

Parameters:​

Request:​

Return Type:​

POST /partners/{partnerUid}/bss/{bsUid}/admins/downloadLrrVersion​

Parameters:​

Request:​

Return Type:​

POST /partners/{partnerUid}/bss/{bsUid}/admins/openSsh​

Parameters:​

Request:​

Return Type:​

POST /partners/{partnerUid}/bss/{bsUid}/admins/openTerminal​

Parameters:​

Request:​

Return Type:​

POST /partners/{partnerUid}/bss/{bsUid}/admins/reboot​

Parameters:​

Request:​

Return Type:​

Release 8.0

RDTP-14487

What's Changed

`GET|PUT` /partners/{partnerUid}

Return Type:

RDTP-18707

What's Changed

`POST` /partners/{partnerUid}/bss

Request:

Return Type:

`GET` /partners/{partnerUid}/bss/{bsUid}

Return Type:

`PUT` /partners/{partnerUid}/bss/{bsUid}

Request:

Return Type:

`GET` /partners/{partnerUid}/bss/alarms

`GET` /partners/{partnerUid}/bss/alarms/histories

`GET` /partners/{partnerUid}/bss/{bsUid}/alarms

`GET` /partners/{partnerUid}/bss/{bsUid}/alarms/histories

Return Type:

RDTP-22321

What's New

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/changeSupportPassword

What's Changed

`POST` /partners/{partnerUid}/bss

Return Type:

`GET` /partners/{partnerUid}/bss/{bsUid}

Return Type:

`PUT` /partners/{partnerUid}/bss/{bsUid}

Return Type:

`GET` /partners/{partnerUid}/bss/{bsUid}/admins/lastCmdStatus

Return Type:

RDTP-23153

What's Changed

`POST` /partners/{partnerUid}/bss

Request:

RDTP-23309

What's Changed

`GET` /partners/{partnerUid}

Return Type:

`PUT` /partners/{partnerUid}

Parameters:

Request:

Return Type:

`POST` /partners/{partnerUid}/bss

Return Type:

`GET` /partners/{partnerUid}/bss/{bsUid}

Return Type:

`PUT` /partners/{partnerUid}/bss/{bsUid}

Parameters:

Request:

Return Type:

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/backup

Parameters:

Request:

Return Type:

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/cancelRadioScan

Parameters:

Request:

Return Type:

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/closeSsh

Parameters:

Request:

Return Type:

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/downloadLrrVersion

Parameters:

Request:

Return Type:

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/openSsh

Parameters:

Request:

Return Type:

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/openTerminal

Parameters:

Request:

Return Type:

`POST` /partners/{partnerUid}/bss/{bsUid}/admins/reboot

Parameters:

Request:

Return Type: