Passer au contenu principal

device-manager-changelog-tpw-subscriber

Release 8.1​

RDTP-16384​

What's New​

GET /subscriptions/mine/multicastGroups/alarms​

Retrieve alarms of all multicast groups

POST /subscriptions/mine/multicastGroups/alarms/ack​

Ack alarms of all multicast groups

What's Deprecated​

GET /subscriptions/mine/devices/alarms/histories​

Retrieve Alarms History of all Devices

What's Changed​

GET /subscriptions/mine/multicastGroups​

Retrieve Multicast Groups

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • 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

RDTP-18798​

What's Changed​

POST /subscriptions/mine/devices​

Create Device

Request:​

  • Added property tags (array)

    Items (object):

    • Property name (string)

      Tag names associated with the Device

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Added property tags (array)

    Items (object):

    • Property name (string)

      Tag names associated with the Device

POST /subscriptions/mine/devices/import​

Import device operations

Request:​

The CSV file defines the following new columns for device creation and update operations:

  • the column AB contains the list of tag names,
  • the column AC contains the list of domains.
GET /subscriptions/mine/devices/{deviceUid}​

Retrieve Device

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property tags (array)

    Items (object):

    • Property name (string)

      Tag names associated with the Device

PUT /subscriptions/mine/devices/{deviceUid}​

Update Device

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property tags (array)

    Items (object):

    • Property name (string)

      Tag names associated with the Device

RDTP-22222​

What's Changed​

POST /subscriptions/mine/devices/import​

Import device operations

Request:​

The CSV file defines the following new types of operation:

  • UPDATE_ABP: Update a LoRaWAN ABP device.
  • UPDATE_OTAA: Update a LoRaWAN OTAA device.
  • UPDATE_CELLULAR: Update a cellular device.

RDTP-23703​

What's Changed​

POST /subscriptions/mine/devices​
Request:​

  • Deprecated property appKeys (string)

    LoRaWAN AppSKey (ABP) XML document

  • Added property appSKey (string)

    LoRaWAN AppSKey (ABP) in hexadecimal encoding

POST /subscriptions/mine/devices/import​

Import device operations

Parameters:​

Deprecated: forceDevAddrs in query

The default value is now false.

This parameter must no longer be used: the DevAddr of an OTAA device should not be permanently assigned to let the network server allocate a DevAddr in the range of the configured NetID during the join procedure.

Request:​

The CSV file is enhanced:

  • CREATE_ABP operation:
    • The column F can now contain the AppSKey in hexadecimal encoding, the XML document format is DEPRECATED.
    • The columns from AD to AK are used to describe the LoRaWAN® state for a LoRaWAN 1.0 device migrated from another network server.
  • CREATE_OTAA operation:
    • The column Cand the columns from AD to AO are used to describe the LoRaWAN® state for a LoRaWAN 1.0 device migrated from another network server.
PUT /subscriptions/mine/devices/{deviceUid}​
Request:​

  • Deprecated property appKeys (string)

    LoRaWAN AppSKey (ABP) XML document

  • Added property appSKey (string)

    LoRaWAN AppSKey (ABP) in hexadecimal encoding

POST /subscriptions/mine/multicastGroups​
Request:​

  • Deprecated property appKeys (string)

    LoRaWAN AppSKey (ABP) XML document

  • Added property appSKey (string)

    LoRaWAN AppSKey (ABP) in hexadecimal encoding

PUT /subscriptions/mine/multicastGroups/{multicastGroupUid}​
Request:​

  • Deprecated property appKeys (string)

    LoRaWAN AppSKey (ABP) XML document

  • Added property appSKey (string)

    LoRaWAN AppSKey (ABP) in hexadecimal encoding

RDTP-23884​

What's Changed​

GET /subscriptions/mine​

Retrieve Subscription

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property showTagSuggestionsWhenDomainRestrictions (boolean)

    When false, tag suggestions cannot be retrieved by users having domain restrictions for confidentiality purposes.

PUT /subscriptions/mine​

Update Subscription

Request:​
  • Added property showTagSuggestionsWhenDomainRestrictions (boolean)

    When false, tag suggestions cannot be retrieved by users having domain restrictions for confidentiality purposes.

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property showTagSuggestionsWhenDomainRestrictions (boolean)

    When false, tag suggestions cannot be retrieved by users having domain restrictions for confidentiality purposes.

POST /subscriptions/mine/devices/tags​

200 OK is returned if action=UNTAG and the tag does not exist

GET /subscriptions/mine/devices/tags/suggestions​

No results are returned if the authenticated user has domain restrictions and showTagSuggestionsWhenDomainRestrictions is false.

GET /subscriptions/mine/managedCustomerNetwork/bss/tags/suggestions​

No results are returned if the authenticated user has domain restrictions and showTagSuggestionsWhenDomainRestrictions is false.

GET /subscriptions/mine/multicastGroups/bss/tags/suggestions​

No results are returned if the authenticated user has domain restrictions and showTagSuggestionsWhenDomainRestrictions is false.

RDTP-23893​

What's Changed​

POST /subscriptions/mine/devices​
Request:​

  • Changed property alarmsConfiguration (object)

    • Changed property alarm004 (array)

      If alarm004 property is null or not set at device creation, two thresholds are configured:

      1. Trigger the alarm with warning severity after 2 days of no uplink activity
      2. Trigger the alarm with major severity after 4 days of no uplink activity
POST /subscriptions/mine/devices/import​
Request:​

The column O has the following default value:

  • <alarm004><threshold1 status="ENABLE" level="3" duration="P2D"/><threshold2 status="ENABLE" level="5" duration="P4D"/></alarm004>

RDTP-24198​

What's New​

GET /subscriptions/mine/devices/{deviceUid}/relay​

Retrieve the relay configuration of a device

PUT /subscriptions/mine/devices/{deviceUid}/relay​

Update the relay configuration of a device

GET /subscriptions/mine/devices/{deviceUid}/relay/servedDevices​

Retrieve the list of devices served by a relay

What's Changed​

GET /subscriptions/mine/deviceProfiles​

Retrieve DeviceProfiles

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Added property canOperateAsRelay (boolean)

      Indicates if the device can act as a forwarding relay between trusted end-devices and the network.

GET /subscriptions/mine/devices​

Retrieve Devices

Parameters:​

Added: relayEnabled in query

Only return LoRaWAN devices for which the relay activity is enabled or disabled.

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property model (object)

      • Added property canOperateAsRelay (boolean)

        Indicates if the device can act as a forwarding relay between trusted end-devices and the network. Only applicable when connectivity is set to LORAWAN.

    • Added property relay (object)

      • Property enabled (boolean)

        True if the relay activity is enabled for this device. Only applicable when connectivity is set to LORAWAN and model.canOperateAsRelay is set to true.

GET /subscriptions/mine/devices/clusters​

Retrieve Devices clusters

Parameters:​

Added: relayEnabled in query

Only return LoRaWAN devices for which the relay activity is enabled or disabled.

Return Type:​

Changed response : 200 OK

Successful RETRIEVE

  • Changed property clusters (array)

    Changed items (object):

    A group a devices close to each other.

    • Changed property item (object)

      • Changed property model (object)

        • Added property canOperateAsRelay (boolean)

          Indicates if the device can act as a forwarding relay between trusted end-devices and the network. Only applicable when connectivity is set to LORAWAN.

      • Added property relay (object)

        • Property enabled (boolean)

          True if the relay activity is enabled for this device. Only applicable when connectivity is set to LORAWAN and model.canOperateAsRelay is set to true.

POST /subscriptions/mine/devices​

Create Device

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Updated LORAWAN connectivity:

  • Changed property model (object)

    • Added property canOperateAsRelay (boolean)

      Indicates if the device can act as a forwarding relay between trusted end-devices and the network. Only applicable when connectivity is set to LORAWAN.

GET /subscriptions/mine/devices/{deviceUid}​

Retrieve Device

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated LORAWAN connectivity:

  • Changed property model (object)

    • Added property canOperateAsRelay (boolean)

      Indicates if the device can act as a forwarding relay between trusted end-devices and the network. Only applicable when connectivity is set to LORAWAN.

PUT /subscriptions/mine/devices/{deviceUid}​

Update Device

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated LORAWAN connectivity:

  • Changed property model (object)

    • Added property canOperateAsRelay (boolean)

      Indicates if the device can act as a forwarding relay between trusted end-devices and the network. Only applicable when connectivity is set to LORAWAN.

GET /subscriptions/mine/networkSubscriptions/{networkSubscriptionUid}​

Retrieve NetworkSubscription

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property allowActingAsRelay (boolean)

    Allows the device to enable its LoRaWAN relay activity

RDTP-25290​

What's Changed​

GET /subscriptions/mine/devices/alarms​

Retrieve Alarms of all Devices

Parameters:​

Added: pageAfter in query

Returns the page following the provided cursor. Cursor strings typically end with the = character. It must be encoded as %3D. Only supported if sort by alarm Uid is used.

Changed: sort in query

The following sort criteria is added:

  • alarmUid: by alarm Uid
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property cursors (object)

    • Property last (string)

      Cursor of the last item of the current page. This cursor can be used to retrieve the next page using pageAfter query parameter.

      Only returned if sort by alarm Uid is used and a next page exists.

RDTP-3399​

What's Changed​

GET /subscriptions/mine/appServers​

Retrieve AppServers

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Added property rfProbeCount (integer)

      Number of RF probes associated with the Application Server through direct association.

      If the authenticated user has domain restrictions, only RF probes matching the domain restrictions are counted.

POST /subscriptions/mine/appServers​

Create AppServer

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Added property rfProbeCount (integer)

    Number of RF probes associated with the Application Server through direct association.

    If the authenticated user has domain restrictions, only RF probes matching the domain restrictions are counted.

GET /subscriptions/mine/appServers/{appServerUid}​

Retrieve AppServer

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property rfProbeCount (integer)

    Number of RF probes associated with the Application Server through direct association.

    If the authenticated user has domain restrictions, only RF probes matching the domain restrictions are counted.

PUT /subscriptions/mine/appServers/{appServerUid}​

Update AppServer

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property rfProbeCount (integer)

    Number of RF probes associated with the Application Server through direct association.

    If the authenticated user has domain restrictions, only RF probes matching the domain restrictions are counted.

Release 8.0​

RDTP-11865​

What's Changed​

GET /subscriptions/mine/appServers​

Retrieve application servers

Parameters:​

Added: scope in query

Returns application servers matching the scope:

  • SUBSCRIPTION
  • OPERATOR

Multiple scope query parameters can be encoded in the URI (OR operation).

By default, only application servers in the SUBSCRIPTION scope are returned.

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    New required properties:

    • scope

    New optional properties: (not applicable to the OPERATOR scope)

    • baseStationCount
    • state
    • type
    • validationState

    • Added property scope (object)

      Scope of the application server:

      • application servers with the SUBSCRIPTION scope are managed in the scope of this subscription,
      • application servers with the OPERATOR scope are provided by the operator and can't be modified.

      Enum values:

      • SUBSCRIPTION
      • OPERATOR
POST /subscriptions/mine/appServers​

Add an application server

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

New required properties:

  • scope

New optional properties: (not applicable to the OPERATOR scope)

  • baseStationCount
  • contentType
  • downlinkSecurity
  • state
  • type
  • validationState
  • occContext

  • Added property scope (object)

    Scope of the application server:

    • application servers with the SUBSCRIPTION scope are managed in the scope of this subscription,
    • application servers with the OPERATOR scope are provided by the operator and can't be modified.

    Enum values:

    • SUBSCRIPTION
    • OPERATOR
GET /subscriptions/mine/appServers/{appServerUid}​

Retrieve an application server

Parameters:​

Changed: appServerUid in path

Unique identifier of the application server, either

  • the sequential integer (UID) of the application server (only applicable to application servers with the SUBSCRIPTION scope)
  • the identifier (ID) of the application server prefixed by id: (applicable to all application servers)
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

  • scope

New optional properties: (not applicable to the OPERATOR scope)

  • baseStationCount
  • contentType
  • downlinkSecurity
  • state
  • type
  • validationState
  • occContext

  • Added property scope (object)

    Scope of the application server:

    • application servers with the SUBSCRIPTION scope are managed in the scope of this subscription,
    • application servers with the OPERATOR scope are provided by the operator and can't be modified.

    Enum values:

    • SUBSCRIPTION
    • OPERATOR
PUT /subscriptions/mine/appServers/{appServerUid}​

Update an application server

Parameters:​

Changed: appServerUid in path

Unique identifier of the application server, either

  • the sequential integer (UID) of the application server (only applicable to application servers with the SUBSCRIPTION scope)
  • the identifier (ID) of the application server prefixed by id: (applicable to all application servers)
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

  • scope

  • Added property scope (object)

    Scope of the application server:

    • application servers with the SUBSCRIPTION scope are managed in the scope of this subscription,
    • application servers with the OPERATOR scope are provided by the operator and can't be modified.

    Enum values:

    • SUBSCRIPTION
    • OPERATOR
DELETE /subscriptions/mine/appServers/{appServerUid}​

Delete an application server

Parameters:​

Changed: appServerUid in path

Unique identifier of the application server, either

  • the sequential integer (UID) of the application server (only applicable to application servers with the SUBSCRIPTION scope)
  • the identifier (ID) of the application server prefixed by id: (applicable to all application servers)
GET /subscriptions/mine/appServers/{appServerUid}/security​

Retrieve the security status of an application server

Parameters:​

Changed: appServerUid in path

Unique identifier of the application server, either

  • the sequential integer (UID) of the application server (only applicable to application servers with the SUBSCRIPTION scope)
  • the identifier (ID) of the application server prefixed by id: (applicable to all application servers)
PUT /subscriptions/mine/appServers/{appServerUid}/security​

Update the security status of an application server

Parameters:​

Changed: appServerUid in path

Unique identifier of the application server, either

  • the sequential integer (UID) of the application server (only applicable to application servers with the SUBSCRIPTION scope)
  • the identifier (ID) of the application server prefixed by id: (applicable to all application servers)
GET /subscriptions/mine/devices​

Retrieve Devices

Parameters:​

Changed: appServerID in query

Only returns Devices associated with the Application Server through direct association or through AS Routing Profile.

Multiple values can be set: in this case Devices 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):

    • Changed property appServersRoutingProfile (object)

      Available when the Device is associated with an AS routing profile

      • Added property appServers (array)

        List of application servers associated with the AS routing profile

        Items (object):

        • Property ID (string)

          Application Server ID

        • Property href (string)

          Application Server href

        • Property name (string)

          Application Server name

POST /subscriptions/mine/devices​

Create Device

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Changed property appServersRoutingProfile (object)

    The AS routing profile must be compatible with the network subscription if any

    Access right: Not available for update with LPWA_MGR::WRITE_NODE

    • Added property appServers (array)

      List of application servers associated with the AS routing profile

      Items (object):

      • Property ID (string)

        Application Server ID

      • Property href (string)

        Application Server href

      • Property name (string)

        Application Server name

GET /subscriptions/mine/devices/clusters​

Retrieve Devices clusters

Parameters:​

Changed: appServerID in query

Only returns Devices associated with the Application Server through direct association or through AS Routing Profile.

Multiple values can be set: in this case Devices 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 devices close to each other.

    • Changed property item (object)

      • Changed property appServersRoutingProfile (object)

        Available when the Device is associated with an AS routing profile

        • Added property appServers (array)

          List of application servers associated with the AS routing profile

          Items (object):

          • Property ID (string)

            Application Server ID

          • Property href (string)

            Application Server href

          • Property name (string)

            Application Server name

GET /subscriptions/mine/devices/{deviceUid}​

Retrieve Device

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property appServersRoutingProfile (object)

    The AS routing profile must be compatible with the network subscription if any

    Access right: Not available for update with LPWA_MGR::WRITE_NODE

    • Added property appServers (array)

      List of application servers associated with the AS routing profile

      Items (object):

      • Property ID (string)

        Application Server ID

      • Property href (string)

        Application Server href

      • Property name (string)

        Application Server name

PUT /subscriptions/mine/devices/{deviceUid}​

Update Device

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property appServersRoutingProfile (object)

    The AS routing profile must be compatible with the network subscription if any

    Access right: Not available for update with LPWA_MGR::WRITE_NODE

    • Added property appServers (array)

      List of application servers associated with the AS routing profile

      Items (object):

      • Property ID (string)

        Application Server ID

      • Property href (string)

        Application Server href

      • Property name (string)

        Application Server name

GET /subscriptions/mine/multicastGroups​

Retrieve Multicast Groups

Parameters:​

Changed: appServerID in query

Only returns Multicast Groups associated with the Application Server through direct association or through AS Routing Profile.

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

Return Type:​

Changed response : 200 OK

Successful RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property appServersRoutingProfile (object)

      Available when the Multicast Group is associated with an AS routing profile

      • Added property appServers (array)

        List of application servers associated with the AS routing profile

        Items (object):

        • Property ID (string)

          Application Server ID

        • Property href (string)

          Application Server href

        • Property name (string)

          Application Server name

POST /subscriptions/mine/multicastGroups​

Create Multicast Group

Return Type:​

Changed response : 201 Created

Successful CREATE, UPDATE or RETRIEVE

  • Changed property appServersRoutingProfile (object)

    The AS routing profile must be compatible with the network subscription if any

    Access right: Not available for update with LPWA_MGR::WRITE_NODE

    • Added property appServers (array)

      List of application servers associated with the AS routing profile

      Items (object):

      • Property ID (string)

        Application Server ID

      • Property href (string)

        Application Server href

      • Property name (string)

        Application Server name

GET /subscriptions/mine/multicastGroups/{multicastGroupUid}​

Retrieve Multicast Group

Return Type:​

Changed response : 200 OK

Successful CREATE, UPDATE or RETRIEVE

  • Changed property appServersRoutingProfile (object)

    The AS routing profile must be compatible with the network subscription if any

    Access right: Not available for update with LPWA_MGR::WRITE_NODE

    • Added property appServers (array)

      List of application servers associated with the AS routing profile

      Items (object):

      • Property ID (string)

        Application Server ID

      • Property href (string)

        Application Server href

      • Property name (string)

        Application Server name

PUT /subscriptions/mine/multicastGroups/{multicastGroupUid}​

Update Multicast Group

Return Type:​

Changed response : 200 OK

Successful CREATE, UPDATE or RETRIEVE

  • Changed property appServersRoutingProfile (object)

    The AS routing profile must be compatible with the network subscription if any

    Access right: Not available for update with LPWA_MGR::WRITE_NODE

    • Added property appServers (array)

      List of application servers associated with the AS routing profile

      Items (object):

      • Property ID (string)

        Application Server ID

      • Property href (string)

        Application Server href

      • Property name (string)

        Application Server name

RDTP-11866​

What's New​

GET /subscriptions/mine/asTransportKeys​

List AS transport keys

POST /subscriptions/mine/asTransportKeys​

Create an AS transport key

GET /subscriptions/mine/asTransportKeys/{asTransportKeyID}​

Retrieve an AS transport keys

PUT /subscriptions/mine/asTransportKeys/{asTransportKeyID}​

Update an AS transport keys

DELETE /subscriptions/mine/asTransportKeys/{asTransportKeyID}​

Delete an AS transport keys

GET /subscriptions/mine/hsmGroups​

Retrieve HSM groups

What's Changed​

GET /subscriptions/mine​

Retrieve Subscription

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property options (object)

    New required properties:

    • hsm

    • Added property hsm (string)

      Hardware Security Module (HSM) option:

      • DEACTIVATED: the root keys of LoRaWAN OTAA devices cannot be protected by an HSM
      • ACTIVATED: the root keys of LoRaWAN OTAA devices can be protected by an HSM

      Enum values:

      • DEACTIVATED
      • ACTIVATED
PUT /subscriptions/mine​

Update Subscription

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property options (object)

    New required properties:

    • hsm

    • Added property hsm (string)

      Hardware Security Module (HSM) option:

      • DEACTIVATED: the root keys of LoRaWAN OTAA devices cannot be protected by an HSM
      • ACTIVATED: the root keys of LoRaWAN OTAA devices can be protected by an HSM

      Enum values:

      • DEACTIVATED
      • ACTIVATED
GET /subscriptions/mine/devices​

Retrieve Devices

Parameters:​

Added: asTransportKeyID in path

Only return LoRaWAN devices attached to the AS transport key having this ID (exact match).

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property appServersRoutingProfile (object)

      Available when the Device is associated with an AS routing profile

      • Added property lorawanAsTransportKey (object)

        • Property ID (string)

        • Property name (string)

    • Updated LORAWAN connectivity:

      • Added property asTransportKey (object)

        • Property ID (string)

        • Property name (string)

      • Added property hsmGroupID (string)

POST /subscriptions/mine/devices​

Create Device

Request:​

Updated LORAWAN connectivity:

  • Added property asTransportKey (object)

    • Property ID (string)

  • Added property hsmGroupID (string)

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Changed property appServersRoutingProfile (object)

The AS routing profile must be compatible with the network subscription if any

Access right: Not available for update with LPWA_MGR::WRITE_NODE

  • Added property lorawanAsTransportKey (object)

    • Property ID (string)

    • Property name (string)

Updated LORAWAN connectivity:

  • Added property asTransportKey (object)

    • Property ID (string)

    • Property name (string)

  • Added property hsmGroupID (string)

GET /subscriptions/mine/devices/{deviceUid}​

Retrieve Device

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property appServersRoutingProfile (object)

The AS routing profile must be compatible with the network subscription if any

Access right: Not available for update with LPWA_MGR::WRITE_NODE

  • Added property lorawanAsTransportKey (object)

    • Property ID (string)

    • Property name (string)

Updated LORAWAN connectivity:

  • Added property asTransportKey (object)

    • Property ID (string)

    • Property name (string)

  • Added property hsmGroupID (string)

PUT /subscriptions/mine/devices/{deviceUid}​

Update Device

Request:​

Updated LORAWAN connectivity:

  • Added property asTransportKey (object)

    • Property ID (string)
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property appServersRoutingProfile (object)

The AS routing profile must be compatible with the network subscription if any

Access right: Not available for update with LPWA_MGR::WRITE_NODE

  • Added property lorawanAsTransportKey (object)

    • Property ID (string)

    • Property name (string)

Updated LORAWAN connectivity:

  • Added property asTransportKey (object)

    • Property ID (string)

    • Property name (string)

  • Added property hsmGroupID (string)

GET /subscriptions/mine/devices/clusters​

Retrieve Devices clusters

Return Type:​

Changed response : 200 OK

Successful RETRIEVE

  • Changed property clusters (array)

    Changed items (object):

    A group a devices close to each other.

    • Changed property item (object)

      • Changed property appServersRoutingProfile (object)

        Available when the Device is associated with an AS routing profile

        • Added property lorawanAsTransportKey (object)

          • Property ID (string)

          • Property name (string)

      • Updated LORAWAN connectivity:

        • Added property asTransportKey (object)

          • Property ID (string)

          • Property name (string)

        • Added property hsmGroupID (string)

POST /subscriptions/mine/devices/import​
Request:​

LoRaWAN OTAA device creation:

  • the column W is now the AS transport key ID.
GET /subscriptions/mine/networkSubscriptions​
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Added property hsmGroupID (string)

      ID of HSM group associated with the network subscription

GET /subscriptions/mine/networkSubscriptions/{networkSubscriptionUid}​
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated LORAWAN connectivity:

  • Added property hsmGroupID (string)

    ID of HSM group associated with the network subscription

GET /subscriptions/mine/publicExchangeKey​

Retrieve Public Exchange Keys

Parameters:​

Added: hsmGroupID in path

HSM Group ID filtering (exact match)

RDTP-14487​

What's Deprecated​

GET /subscriptions/mine/devices/{deviceUid}/frames​

This endpoint must no longer be used: the endpoint GET /subscriptions/mine/devices/\{deviceUid\}/frames/aggregated must be used in replacement.

GET /subscriptions/mine/multicastGroups/frames​

This endpoint must no longer be used: the endpoint GET /subscriptions/mine/multicastGroups/frames/aggregated must be used in replacement.

GET /subscriptions/mine/multicastGroups/{multicastGroupUid}/frames​

This endpoint must no longer be used: the endpoint GET /subscriptions/mine/multicastGroups/\{multicastGroupUid\}/frames/aggregated must be used in replacement.

What's Changed​

GET|PUT /subscriptions/mine​
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

  • subscription

  • Added property subscription (object)

    • Property grantedPermissions (array)

      Items (string):

      Enum values:

      • x
      • a
      • ra
      • rc
      • s1

    • 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

GET /subscriptions/mine/appServersRoutingProfiles​

Retrieve AppServersRoutingProfiles

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Deleted property isDefault (boolean)

      Only one profile for each type can be flagged as default. When a new profile is flagged as default, the previous one for the same type is automatically unflagged.

      By default the first profile of each type is automatically flagged as default.

      The default AS routing profile is automatically selected at device creation if no AS routing profile is explicitely selected and no application servers list is set. This property must no longer be used and will be removed in ThingPark release 8.0: we strongly recommend to explicitely select the AS routing profile at device creation.

POST /subscriptions/mine/appServersRoutingProfiles​

Create AppServersRoutingProfile

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Deleted property isDefault (boolean)

    Only one profile for each type can be flagged as default. When a new profile is flagged as default, the previous one for the same type is automatically unflagged.

    By default the first profile of each type is automatically flagged as default.

    The default AS routing profile is automatically selected at device creation if no AS routing profile is explicitely selected and no application servers list is set. This property must no longer be used and will be removed in ThingPark release 8.0: we strongly recommend to explicitely select the AS routing profile at device creation.

GET /subscriptions/mine/appServersRoutingProfiles/{appServersRoutingProfileUid}​

Retrieve AppServersRoutingProfile

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Deleted property isDefault (boolean)

    Only one profile for each type can be flagged as default. When a new profile is flagged as default, the previous one for the same type is automatically unflagged.

    By default the first profile of each type is automatically flagged as default.

    The default AS routing profile is automatically selected at device creation if no AS routing profile is explicitely selected and no application servers list is set. This property must no longer be used and will be removed in ThingPark release 8.0: we strongly recommend to explicitely select the AS routing profile at device creation.

PUT /subscriptions/mine/appServersRoutingProfiles/{appServersRoutingProfileUid}​

Update AppServersRoutingProfile

Request:​
  • Deleted property isDefault (boolean)

    Only one profile for each type can be flagged as default. When a new profile is flagged as default, the previous one for the same type is automatically unflagged.

    By default the first profile of each type is automatically flagged as default.

    The default AS routing profile is automatically selected at device creation if no AS routing profile is explicitely selected and no application servers list is set. This property must no longer be used and will be removed in ThingPark release 8.0: we strongly recommend to explicitely select the AS routing profile at device creation.

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Deleted property isDefault (boolean)

    Only one profile for each type can be flagged as default. When a new profile is flagged as default, the previous one for the same type is automatically unflagged.

    By default the first profile of each type is automatically flagged as default.

    The default AS routing profile is automatically selected at device creation if no AS routing profile is explicitely selected and no application servers list is set. This property must no longer be used and will be removed in ThingPark release 8.0: we strongly recommend to explicitely select the AS routing profile at device creation.

RDTP-16140​

What's New​

GET /subscriptions/mine/cellularNetworkContexts​

List cellular network contexts

POST /subscriptions/mine/cellularNetworkContexts​

Create a cellular network context

GET /subscriptions/mine/cellularNetworkContexts/{networkContextID}​

Retrieve a cellular network context

PUT /subscriptions/mine/cellularNetworkContexts/{networkContextID}​

Update a cellular network context

DELETE /subscriptions/mine/cellularNetworkContexts/{networkContextID}​

Delete a cellular network context

What's Changed​

POST /subscriptions/mine/appServers​

Add an application server

Request:​

Updated HTTP_CELLULAR type: HTTP_CELLULAR is deprecated and replaced by HTTP. If an Application server is created with the HTTP_CELLULAR type, it is silently replaced by HTTP.

Updated HTTP type:

  • Changed property destinations (array) Changed items (object):

    ports property is now optional with * as default value

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Updated HTTP type:

  • Changed property destinations (array) Changed items (object):

    ports property is now optional with * as default value

GET /subscriptions/mine/appServers/{appServerUid}​

Retrieve an application server

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated HTTP type:

  • Changed property destinations (array) Changed items (object):

    ports property is now optional with * as default value

PUT /subscriptions/mine/appServers/{appServerUid}​

Update an application server

Request:​

Updated HTTP type:

  • Changed property destinations (array) Changed items (object):

    ports property is now optional with * as default value

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated HTTP type:

  • Changed property destinations (array) Changed items (object):

    ports property is now optional with * as default value

GET /subscriptions/mine/devices​

Retrieve Devices

Parameters:​

Added: networkContextID in path

Return devices attached to the cellular network context

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property appServersRoutingProfile (object)

      Available when the Device is associated with an AS routing profile

      • Added property cellularNetworkContext (object)

        • Property ID (string)

        • Property name (string)

    • Updated CELLULAR connectivity:

      • Added property appServers (array)

        List of Application Servers directly associated with the device

        Items (object):

        • Property ID (string)

          Application Server ID

        • Property href (string)

          Application Server href

        • Property name (string)

          Application Server name

      • Added property networkContext (object)

        • Property ID (string)

        • Property name (string)

POST /subscriptions/mine/devices​

Create Device

Request:​

Updated CELLULAR connectivity:

  • Added property appServers (array)

    The Application Servers list must be compatible with the network subscription if any

    Access right: Not available for update with LPWA_MGR::WRITE_NODE

    This attribute is FORBIDDEN if the Device is associated with an AS Routing Profile

    If the authenticated user has domain restrictions, only the following application servers can be associated with a device:

    • Application servers not associated with any domain
    • Application servers associated with domains and matching the domain restrictions

    Items (object):

    • Property ID (string)

      Application Server ID

  • Added property networkContext (object)

    • Property ID (string)
Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Changed property appServersRoutingProfile (object)

The AS routing profile must be compatible with the network subscription if any

Access right: Not available for update with LPWA_MGR::WRITE_NODE

  • Added property cellularNetworkContext (object)

    • Property ID (string)

    • Property name (string)

Updated CELLULAR connectivity:

  • Added property appServers (array)

    The Application Servers list must be compatible with the network subscription if any

    Access right: Not available for update with LPWA_MGR::WRITE_NODE

    This attribute is FORBIDDEN if the Device is associated with an AS Routing Profile

    If the authenticated user has domain restrictions, only the following application servers can be associated with a device:

    • Application servers not associated with any domain
    • Application servers associated with domains and matching the domain restrictions

    Items (object):

    • Property ID (string)

      Application Server ID

    • Property href (string)

      Application Server href

    • Property name (string)

      Application Server name

  • Added property networkContext (object)

    • Property ID (string)

    • Property name (string)

GET /subscriptions/mine/devices/{deviceUid}​

Retrieve Device

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property appServersRoutingProfile (object)

The AS routing profile must be compatible with the network subscription if any

Access right: Not available for update with LPWA_MGR::WRITE_NODE

  • Added property cellularNetworkContext (object)

    • Property ID (string)

    • Property name (string)

Updated CELLULAR connectivity:

  • Added property appServers (array)

    The Application Servers list must be compatible with the network subscription if any

    Access right: Not available for update with LPWA_MGR::WRITE_NODE

    This attribute is FORBIDDEN if the Device is associated with an AS Routing Profile

    If the authenticated user has domain restrictions, only the following application servers can be associated with a device:

    • Application servers not associated with any domain
    • Application servers associated with domains and matching the domain restrictions

    Items (object):

    • Property ID (string)

      Application Server ID

    • Property href (string)

      Application Server href

    • Property name (string)

      Application Server name

  • Added property networkContext (object)

    • Property ID (string)

    • Property name (string)

PUT /subscriptions/mine/devices/{deviceUid}​

Update Device

Request:​

Updated CELLULAR connectivity:

  • Added property appServers (array)

    The Application Servers list must be compatible with the network subscription if any

    Access right: Not available for update with LPWA_MGR::WRITE_NODE

    This attribute is FORBIDDEN if the Device is associated with an AS Routing Profile

    If the authenticated user has domain restrictions, only the following application servers can be associated with a device:

    • Application servers not associated with any domain
    • Application servers associated with domains and matching the domain restrictions

    Items (object):

    • Property ID (string)

      Application Server ID

  • Added property networkContext (object)

    • Property ID (string)
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Changed property appServersRoutingProfile (object)

The AS routing profile must be compatible with the network subscription if any

Access right: Not available for update with LPWA_MGR::WRITE_NODE

  • Added property cellularNetworkContext (object)

    • Property ID (string)

    • Property name (string)

Updated CELLULAR connectivity:

  • Added property appServers (array)

    The Application Servers list must be compatible with the network subscription if any

    Access right: Not available for update with LPWA_MGR::WRITE_NODE

    This attribute is FORBIDDEN if the Device is associated with an AS Routing Profile

    If the authenticated user has domain restrictions, only the following application servers can be associated with a device:

    • Application servers not associated with any domain
    • Application servers associated with domains and matching the domain restrictions

    Items (object):

    • Property ID (string)

      Application Server ID

    • Property href (string)

      Application Server href

    • Property name (string)

      Application Server name

  • Added property networkContext (object)

    • Property ID (string)

    • Property name (string)

GET /subscriptions/mine/devices/clusters​

Retrieve Devices clusters

Return Type:​

Changed response : 200 OK

Successful RETRIEVE

  • Changed property clusters (array)

    Changed items (object):

    A group a devices close to each other.

    • Changed property item (object)

      • Changed property appServersRoutingProfile (object)

        Available when the Device is associated with an AS routing profile

        • Added property cellularNetworkContext (object)

          • Property ID (string)

          • Property name (string)

      • Updated CELLULAR connectivity:

        • Added property appServers (array)

          List of Application Servers directly associated with the device

          Items (object):

          • Property ID (string)

            Application Server ID

          • Property href (string)

            Application Server href

          • Property name (string)

            Application Server name

POST /subscriptions/mine/devices/import​
Request:​

For cellular device:

  • the column T is now Application server IDs,
  • the column W is now Network context ID.

RDTP-16304​

What's Changed​

GET /subscriptions/mine​
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property options (object)

    • Deprecated property devAddrValidation (string)

      DevAddr validation option:

      • DEACTIVATED
      • ADM-VC (ADM verification code validation)

      This property must no longer be used: the associated feature is no more available in the product.

    • Deprecated property devEUIValidation (string)

      DevEUI validation option:

      • DEACTIVATED
      • ADM-VC (ADM verification code validation)

      This property must no longer be used: the associated feature is no more available in the product.

PUT /subscriptions/mine​
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property options (object)

    • Deprecated property devAddrValidation (string)

      DevAddr validation option:

      • DEACTIVATED
      • ADM-VC (ADM verification code validation)

      This property must no longer be used: the associated feature is no more available in the product.

    • Deprecated property devEUIValidation (string)

      DevEUI validation option:

      • DEACTIVATED
      • ADM-VC (ADM verification code validation)

      This property must no longer be used: the associated feature is no more available in the product.

POST /subscriptions/mine/devices/import​
Request:​

ABP LoRaWAN device creation:

  • the column F can only contain one AppSKey,
  • the column J is DEPRECATED,
  • if the column K is empty, the device name is automatically set to the DevEUI,
  • the column P is DEPRECATED

OTAA LoRaWAN device creation:

  • the column C is DEPRECATED,
  • the column J is DEPRECATED,
  • if the column K is empty, the device name is automatically set to the DevEUI,
  • the column P is DEPRECATED

Cellular device creation:

  • the column J is DEPRECATED,
  • if the column K is empty, the device name is automatically set to the DevEUI
POST /subscriptions/mine/devices​
Request:​

  • Changed property appKeys (string)

    LoRaWAN AppSKey XML document:

    • The root XML element is AppSKeys
    • The enclosed AppSKey XML element contains the AppSKey value (hexadecimal encoding)
    • The AppSKey@Port attribute must be set to *

  • Deprecated property markerID (integer)

    Google map marker ID.

    The default maker will be used when no marker are specified at the creation.

    This property must no longer be used: it is no more used in ThingPark UI.

  • Changed property name (string)

    The device name is automatically set to the DevEUI when not provided at creation.

  • Changed property nwAddress (string)

    Optional for OTAA on Create but DEPRECATED: the DevAddr of an OTAA device should not be provided on create to let the network server allocate a DevAddr in the range of the configured NetID during the join procedure.

  • Deprecated property verificationCode (string)

    Verification code associated to the DevAddr/DevEUI pair (ABP device) or DevEUI (OTAA device) when the ADM validation code has been activated.

    This property must no longer be used: the associated feature is no more available in the product.

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Deprecated property markerID (integer)

    Google map marker ID.

    The default maker will be used when no marker are specified at the creation.

    This property must no longer be used: it is no more used in ThingPark UI.

  • Changed property name (string)

    The device name is automatically set to the DevEUI when not provided at creation.

GET /subscriptions/mine/devices/{deviceUid}​
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Deprecated property markerID (integer)

    Google map marker ID.

    The default maker will be used when no marker are specified at the creation.

    This property must no longer be used: it is no more used in ThingPark UI.

  • Changed property name (string)

    The device name is automatically set to the DevEUI when not provided at creation.

PUT /subscriptions/mine/devices/{deviceUid}​
Request:​

  • Changed property appKeys (string)

    LoRaWAN AppSKey XML document:

    • The root XML element is AppSKeys
    • The enclosed AppSKey XML element contains the AppSKey value (hexadecimal encoding)
    • The AppSKey@Port attribute must be set to *

  • Deprecated property markerID (integer)

    Google map marker ID.

    The default maker will be used when no marker are specified at the creation.

    This property must no longer be used: it is no more used in ThingPark UI.

  • Changed property name (string)

    The device name is automatically set to the DevEUI when not provided at creation.

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Deprecated property markerID (integer)

    Google map marker ID.

    The default maker will be used when no marker are specified at the creation.

    This property must no longer be used: it is no more used in ThingPark UI.

  • Changed property name (string)

    The device name is automatically set to the DevEUI when not provided at creation.

POST /subscriptions/mine/multicastGroups​
Request:​

  • Changed property appKeys (string)

    LoRaWAN AppSKey XML document:

    • The root XML element is AppSKeys
    • The enclosed AppSKey XML element contains the AppSKey value (hexadecimal encoding)
    • The AppSKey@Port attribute must be set to *

  • Changed property name (string)

    The multicast group name is automatically set to the DevEUI when not provided at creation.

  • Deprecated property verificationCode (string)

    Verification code associated to the DevAddr/DevEUI pair when the ADM validation code has been activated.

    This property must no longer be used: the associated feature is no more available in the product.

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Changed property name (string)

    The multicast group name is automatically set to the DevEUI when not provided at creation.

GET /subscriptions/mine/multicastGroups/{multicastGroupUid}​
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property name (string)

    The multicast group name is automatically set to the DevEUI when not provided at creation.

PUT /subscriptions/mine/multicastGroups/{multicastGroupUid}​
Request:​

  • Changed property appKeys (string)

    LoRaWAN AppSKey XML document:

    • The root XML element is AppSKeys
    • The enclosed AppSKey XML element contains the AppSKey value (hexadecimal encoding)
    • The AppSKey@Port attribute must be set to *

  • Changed property name (string)

    The multicast group name is automatically set to the DevEUI when not provided at creation.

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property name (string)

    The multicast group name is automatically set to the DevEUI when not provided at creation.

GET /subscriptions/mine/networkSubscriptions​
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Changed property thingParkCloudRouting (boolean)

      Allow ThingPark X connections

    • Changed property thingParkKafkaRouting (boolean)

      Allow Basic Kafka connections

    • Changed property thirdPartyAppServersRouting (boolean)

      Allow Basic HTTPS connections

RDTP-18707​

What's Changed​

POST /subscriptions/mine/devices​
Request:​

  • Added property alarmsConfiguration (object)

    • Property alarm004 (array)

      Configuration of the device no uplink activity alarm (004)

      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 device 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 alarm004 (string)

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Added property alarmsConfiguration (object)

    • Property alarm004 (array)

      Configuration of the device no uplink activity alarm (004)

      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 device 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 alarm004 (string)

GET /subscriptions/mine/devices/{deviceUid}​
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property alarmsConfiguration (object)

    • Property alarm004 (array)

      Configuration of the device no uplink activity alarm (004)

      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 device 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 alarm004 (string)

PUT /subscriptions/mine/devices/{deviceUid}​
Request:​

  • Added property alarmsConfiguration (object)

    • Property alarm004 (array)

      Configuration of the device no uplink activity alarm (004)

      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 device 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 alarm004 (string)

Return Type:​

  • Added property alarmsConfiguration (object)

    • Property alarm004 (array)

      Configuration of the device no uplink activity alarm (004)

      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 device 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 alarm004 (string)

RDTP-19476​

What's Changed​

GET /subscriptions/mine/devices​
Parameters:​

Added: simID in query

Only return cellular devices attached to a SIM card having this ID (prefix match). The SIM ID may be an IMSI, ICCID or eID.

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated CELLULAR connectivity:

New required properties:

  • sim
  • Added property sim (object)
POST /subscriptions/mine/devices​
Request:​

Updated CELLULAR connectivity:

  • Added property sim (object)

  • Deleted property ki (string)

    Secret key of the SIM card

    Supported encoding modes:

    • Clear text (hexadecimal encoding)

    • Encrypted with Exchange Key (RSA) version specified in exchangeKeyVersion attribute (base64 encoding)

    Forbidden if HSS provisioning is not activated in operator settings

  • Deleted property exchangeKeyVersion (string)

    TWA Exchange Key (RSA) version used to encrypt Ki

  • Deprecated property imsi (string)

    Replaced by sim.ID.

    IMSI of the SIM card (10-15 digits). This property is returned only if the device is attached to a SINGLE_IMSI SIM card.

    Forbidden if HSS provisioning is not activated in operator settings

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Updated CELLULAR connectivity:

  • Added property sim (object)

  • Deleted property ki (string)

    Secret key of the SIM card

    Supported encoding modes:

    • Clear text (hexadecimal encoding)

    • Encrypted with Exchange Key (RSA) version specified in exchangeKeyVersion attribute (base64 encoding)

    Forbidden if HSS provisioning is not activated in operator settings

  • Deprecated property imsi (string)

    Replaced by sim.ID.

    IMSI of the SIM card (10-15 digits). This property is returned only if the device is attached to a SINGLE_IMSI SIM card.

    Forbidden if HSS provisioning is not activated in operator settings

GET /subscriptions/mine/devices/{deviceUid}​
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated CELLULAR connectivity:

  • Added property sim (object)

  • Deleted property ki (string)

    Secret key of the SIM card

    Supported encoding modes:

    • Clear text (hexadecimal encoding)

    • Encrypted with Exchange Key (RSA) version specified in exchangeKeyVersion attribute (base64 encoding)

    Forbidden if HSS provisioning is not activated in operator settings

  • Deprecated property imsi (string)

    Replaced by sim.ID.

    IMSI of the SIM card (10-15 digits). This property is returned only if the device is attached to a SINGLE_IMSI SIM card.

    Forbidden if HSS provisioning is not activated in operator settings

PUT /subscriptions/mine/devices/{deviceUid}​
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated CELLULAR connectivity:

  • Added property sim (object)

  • Deleted property ki (string)

    Secret key of the SIM card

    Supported encoding modes:

    • Clear text (hexadecimal encoding)

    • Encrypted with Exchange Key (RSA) version specified in exchangeKeyVersion attribute (base64 encoding)

    Forbidden if HSS provisioning is not activated in operator settings

  • Deprecated property imsi (string)

    Replaced by sim.ID.

    IMSI of the SIM card (10-15 digits). This property is returned only if the device is attached to a SINGLE_IMSI SIM card.

    Forbidden if HSS provisioning is not activated in operator settings

POST /subscriptions/mine/devices/import​
Request:​

For cellular device:

  • the column C is now the ID of the SIM card,
  • the column E is now not applicable (was SIM Ki),
  • the column X is now not applicable (was TWA Exchange Key (RSA) version used to encrypt the SIM Ki)

RDTP-20333​

What's Changed​

GET /subscriptions/mine/devices/clusters​
Return Type:​

Changed response : 200 OK

Successful RETRIEVE

  • Changed property clusters (array)

    Changed items (object):

    A group a devices close to each other.

    • Changed property item (object)

      • Added property lastIMEI (string)

        IMEI of the last received message mode packet or microflow. The 15 digits are returned.

      • Added property lastIMSI (string)

        IMSI of the last received message mode packet or microflow.

      • Added property lastMSISDN (string)

        MSISDN of the last received message mode packet or microflow.

      • Changed property EUI (string)

        DevEUI (16 hexadecimal characters / always converted in upper case by the server)

GET /subscriptions/mine/devices​
Parameters:​

Added: imei in query

Only return cellular devices with a matching lastIMEI.

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Added property lastIMEI (string)

      IMEI of the last received message mode packet or microflow. The 15 digits are returned.

    • Added property lastIMSI (string)

      IMSI of the last received message mode packet or microflow.

    • Added property lastMSISDN (string)

      MSISDN of the last received message mode packet or microflow.

    • Changed property EUI (string)

      DevEUI (16 hexadecimal characters / always converted in upper case by the server)

POST /subscriptions/mine/devices​
Request:​

Changed content type : application/json

Updated CELLULAR connectivity:

  • Added property enforcedIMEI (string)

    IMEI terminal identifier (15 digits). If not blank, the traffic of this device is accepted only for the provided IMEI.

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Updated CELLULAR connectivity:

  • Added property enforcedIMEI (string)

    IMEI terminal identifier (15 digits). If not blank, the traffic of this device is accepted only for the provided IMEI.

  • Added property lastIMEI (string)

    IMEI of the last received message mode packet or microflow. The 15 digits are returned.

  • Added property lastIMSI (string)

    IMSI of the last received message mode packet or microflow.

  • Added property lastMSISDN (string)

    MSISDN of the last received message mode packet or microflow.

GET /subscriptions/mine/devices/{deviceUid}​
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated CELLULAR connectivity:

  • Added property enforcedIMEI (string)

    IMEI terminal identifier (15 digits). If not blank, the traffic of this device is accepted only for the provided IMEI.

  • Added property lastIMEI (string)

    IMEI of the last received message mode packet or microflow. The 15 digits are returned.

  • Added property lastIMSI (string)

    IMSI of the last received message mode packet or microflow.

  • Added property lastMSISDN (string)

    MSISDN of the last received message mode packet or microflow.

PUT /subscriptions/mine/devices/{deviceUid}​
Request:​

Changed content type : application/json

Updated CELLULAR connectivity:

  • Added property enforcedIMEI (string)

    IMEI terminal identifier (15 digits). If not blank, the traffic of this device is accepted only for the provided IMEI.

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated CELLULAR connectivity:

  • Added property enforcedIMEI (string)

    IMEI terminal identifier (15 digits). If not blank, the traffic of this device is accepted only for the provided IMEI.

  • Added property lastIMEI (string)

    IMEI of the last received message mode packet or microflow. The 15 digits are returned.

  • Added property lastIMSI (string)

    IMSI of the last received message mode packet or microflow.

  • Added property lastMSISDN (string)

    MSISDN of the last received message mode packet or microflow.

POST /subscriptions/mine/devices/import​
Request:​

For cellular device:

  • the column B is now Enforced IMEI (15 digits) and optional

RDTP-22607​

What's Deprecated​

GET /subscriptions/mine/appServersRoutingProfiles​

Retrieve AS routing profiles

POST /subscriptions/mine/appServersRoutingProfiles​

Create an AS routing profile

GET /subscriptions/mine/appServersRoutingProfiles/supplierAppServers​

Retrieve supplier application servers

GET /subscriptions/mine/appServersRoutingProfiles/suppliers​

Retrieve application suppliers

GET /subscriptions/mine/appServersRoutingProfiles/tpkClouds​

Retrieve TPX destinations

DELETE /subscriptions/mine/appServersRoutingProfiles/{appServersRoutingProfileUid}​

Delete an AS routing profile

GET /subscriptions/mine/appServersRoutingProfiles/{appServersRoutingProfileUid}​

Retrieve an AS routing profile

PUT /subscriptions/mine/appServersRoutingProfiles/{appServersRoutingProfileUid}​

Update an AS routing profile

GET /subscriptions/mine/appServersRoutingProfiles/{appServersRoutingProfileUid}/security​

Retrieve the security status of an AS routing profile

PUT /subscriptions/mine/appServersRoutingProfiles/{appServersRoutingProfileUid}/security​

Update the security status of an AS routing profile

What's Changed​

GET /subscriptions/mine/devices​
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Deprecated property appServersRoutingProfile (object)

      The AS routing profile must be compatible with the network subscription if any.

      Access right: Not available for update with LPWA_MGR::WRITE_NODE

      This property must no longer be used: the properties appServers and networkContext must be used in replacement.

POST /subscriptions/mine/devices​
Request:​
  • Deprecated property appServersRoutingProfile (object)

    The AS routing profile must be compatible with the network subscription if any.

    Access right: Not available for update with LPWA_MGR::WRITE_NODE

    This property must no longer be used: the properties appServers and networkContext must be used in replacement.

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Deprecated property appServersRoutingProfile (object)

    The AS routing profile must be compatible with the network subscription if any.

    Access right: Not available for update with LPWA_MGR::WRITE_NODE

    This property must no longer be used: the properties appServers and networkContext must be used in replacement.

POST /subscriptions/mine/devices/import​
Request:​

Device creation:

  • the column I is DEPRECATED
GET /subscriptions/mine/devices/{deviceUid}​
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Deprecated property appServersRoutingProfile (object)

    The AS routing profile must be compatible with the network subscription if any.

    Access right: Not available for update with LPWA_MGR::WRITE_NODE

    This property must no longer be used: the properties appServers and networkContext must be used in replacement.

PUT /subscriptions/mine/devices/{deviceUid}​
Request:​
  • Deprecated property appServersRoutingProfile (object)

    The AS routing profile must be compatible with the network subscription if any.

    Access right: Not available for update with LPWA_MGR::WRITE_NODE

    This property must no longer be used: the properties appServers and networkContext must be used in replacement.

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Deprecated property appServersRoutingProfile (object)

    The AS routing profile must be compatible with the network subscription if any.

    Access right: Not available for update with LPWA_MGR::WRITE_NODE

    This property must no longer be used: the properties appServers and networkContext must be used in replacement.

POST /subscriptions/mine/multicastGroups​
Request:​
  • Deprecated property appServersRoutingProfile (object)

    The AS routing profile must be compatible with the network subscription if any

    Access right: Not available for update with LPWA_MGR::WRITE_NODE

    This property must no longer be used: the properties appServers and networkContext must be used in replacement.

Return Type:​

Changed response : 201 Created

Successful CREATE, UPDATE or RETRIEVE

  • Deprecated property appServersRoutingProfile (object)

    The AS routing profile must be compatible with the network subscription if any

    Access right: Not available for update with LPWA_MGR::WRITE_NODE

    This property must no longer be used: the properties appServers and networkContext must be used in replacement.

GET /subscriptions/mine/multicastGroups/{multicastGroupUid}​
Return Type:​

Changed response : 200 OK

Successful CREATE, UPDATE or RETRIEVE

  • Deprecated property appServersRoutingProfile (object)

    The AS routing profile must be compatible with the network subscription if any

    Access right: Not available for update with LPWA_MGR::WRITE_NODE

    This property must no longer be used: the properties appServers and networkContext must be used in replacement.

PUT /subscriptions/mine/multicastGroups/{multicastGroupUid}​
Request:​
  • Deprecated property appServersRoutingProfile (object)

    The AS routing profile must be compatible with the network subscription if any

    Access right: Not available for update with LPWA_MGR::WRITE_NODE

    This property must no longer be used: the properties appServers and networkContext must be used in replacement.

Return Type:​

Changed response : 200 OK

Successful CREATE, UPDATE or RETRIEVE

  • Deprecated property appServersRoutingProfile (object)

    The AS routing profile must be compatible with the network subscription if any

    Access right: Not available for update with LPWA_MGR::WRITE_NODE

    This property must no longer be used: the properties appServers and networkContext must be used in replacement.

RDTP-23309​

What's Changed​

GET /subscriptions/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 /subscriptions/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.

GET /subscriptions/mine/appServers/{appServerUid}/security​
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 /subscriptions/mine/appServers/{appServerUid}/security​
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 /subscriptions/mine/appServersRoutingProfiles​
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 /subscriptions/mine/appServersRoutingProfiles/{appServersRoutingProfileUid}​
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 /subscriptions/mine/appServersRoutingProfiles/{appServersRoutingProfileUid}​
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.

GET /subscriptions/mine/appServersRoutingProfiles/{appServersRoutingProfileUid}/security​
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 /subscriptions/mine/appServersRoutingProfiles/{appServersRoutingProfileUid}/security​
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 /subscriptions/mine/cellularNetworkContexts​
Return Type:​

Changed response : 201 Created

Successfull RETRIEVE

  • Deprecated property occContext (object)

    Optimistic Concurrency Control.

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

GET /subscriptions/mine/cellularNetworkContexts/{networkContextID}​
Return Type:​

Changed response : 200 OK

Successfull RETRIEVE

  • Deprecated property occContext (object)

    Optimistic Concurrency Control.

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

PUT /subscriptions/mine/cellularNetworkContexts/{networkContextID}​
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

Successfull RETRIEVE

  • Deprecated property occContext (object)

    Optimistic Concurrency Control.

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

POST /subscriptions/mine/devices​
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 /subscriptions/mine/devices/{deviceUid}​
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 /subscriptions/mine/devices/{deviceUid}​
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.

PUT /subscriptions/mine/devices/{deviceUid}/restricted​
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

  • Deprecated property occContext (object)

    Optimistic Concurrency Control.

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

POST /subscriptions/mine/managedCustomerNetwork/bss/tags​
Return Type:​

Changed response : 200 OK

Successful CREATE

  • Deprecated property occContext (object)

    Optimistic Concurrency Control.

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

POST /subscriptions/mine/multicastGroups​
Return Type:​

Changed response : 201 Created

Successful CREATE, UPDATE or RETRIEVE

  • Deprecated property occContext (object)

    Optimistic Concurrency Control.

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

GET /subscriptions/mine/multicastGroups/{multicastGroupUid}​
Return Type:​

Changed response : 200 OK

Successful CREATE, UPDATE or RETRIEVE

  • Deprecated property occContext (object)

    Optimistic Concurrency Control.

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

PUT /subscriptions/mine/multicastGroups/{multicastGroupUid}​
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 CREATE, 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

Dernière mise à jour sur
Copyright © 2025 Actility
Sur cette page