Changelog
Release 8.0
RDTP-14487
What's Changed
GET|PUT /partners/mine
Return Type:
Changed response : 200 OK
Successful UPDATE or RETRIEVE
-
Changed property
partner(object)-
Added property
grantedPermissions(array)Items (string):
Enum values:
xararcs1
-
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
anditems.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
typeisPREFIX:- The name of the resource domain is prefixed with
name
- The name of the resource domain is prefixed with
- Else: (
typeisFULL)- The name of the resource domain is
name(exact match)
- The name of the resource domain is
-
Property
type(string)Type of domain restriction:
FULL: restriction on full domainPREFIX: restriction on domain prefix
Enum values:
FULLPREFIX
-
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
- Property
- The group name of the resource domain is
-
RDTP-18707
What's Changed
POST /partners/mine/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
alarm102property 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
durationof the second threshold must be higher than the first one. - The
severityof 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
- The
-
-
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
alarm102property 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
durationof the second threshold must be higher than the first one. - The
severityof 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
- The
-
-
Deprecated property
alarm103(string)
GET /partners/mine/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
alarm102property 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
durationof the second threshold must be higher than the first one. - The
severityof 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
- The
-
-
Deprecated property
alarm103(string)
PUT /partners/mine/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
alarm102property 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
durationof the second threshold must be higher than the first one. - The
severityof 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
- The
-
-
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
alarm102property 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
durationof the second threshold must be higher than the first one. - The
severityof 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
- The
-
-
Deprecated property
alarm103(string)
GET /partners/mine/bss/alarms
GET /partners/mine/bss/alarms/histories
GET /partners/mine/bss/{bsUid}/alarms
GET /partners/mine/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/mine/bss/{bsUid}/admins/changeSupportPassword
Change the support password of a base station
What's Changed
POST /partners/mine/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.
- Property
GET /partners/mine/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.
- Property
PUT /partners/mine/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.
- Property
GET /partners/mine/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/mine/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/mine
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/mine
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/mine/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/mine/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/mine/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/mine/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/mine/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/mine/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/mine/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/mine/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/mine/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/mine/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/mine/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/mine/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/mine/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/mine/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/mine/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/mine/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/mine/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/mine/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/mine/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/mine/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/mine/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/mine/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/mine/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/mine/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/mine/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
Initial release