Skip to main content

device-manager-changelog-tpw-operator

Release 8.0

RDTP-11865

What's Changed


GET /subscriptions/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/asTransportKeys

List AS transport keys

POST /subscriptions/{subscriptionUid}/asTransportKeys

Create an AS transport key

GET /subscriptions/{subscriptionUid}/asTransportKeys/{asTransportKeyID}

Retrieve an AS transport keys

PUT /subscriptions/{subscriptionUid}/asTransportKeys/{asTransportKeyID}

Update an AS transport keys

DELETE /subscriptions/{subscriptionUid}/asTransportKeys/{asTransportKeyID}

Delete an AS transport keys

What's Changed


GET /subscriptions/{subscriptionUid}

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/{subscriptionUid}

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/{subscriptionUid}/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)

POST /subscriptions/{subscriptionUid}/devices

Create Device

Request:

Updated LORAWAN connectivity:

  • Added property asTransportKey (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 lorawanAsTransportKey (object)

    • Property ID (string)

    • Property name (string)

Updated LORAWAN connectivity:

  • Added property asTransportKey (object)

    • Property ID (string)

    • Property name (string)

GET /subscriptions/{subscriptionUid}/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)

PUT /subscriptions/{subscriptionUid}/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)

GET /subscriptions/{subscriptionUid}/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)

POST /subscriptions/{subscriptionUid}/devices/import
Request:

LoRaWAN OTAA device creation:

  • the column W is now the AS transport key ID.
GET /subscriptions/{subscriptionUid}/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

RDTP-14487

What's Changed


GET|PUT /subscriptions/{subscriptionUid}
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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/cellularNetworkContexts

List cellular network contexts

POST /subscriptions/{subscriptionUid}/cellularNetworkContexts

Create a cellular network context

GET /subscriptions/{subscriptionUid}/cellularNetworkContexts/{networkContextID}

Retrieve a cellular network context

PUT /subscriptions/{subscriptionUid}/cellularNetworkContexts/{networkContextID}

Update a cellular network context

DELETE /subscriptions/{subscriptionUid}/cellularNetworkContexts/{networkContextID}

Delete a cellular network context

What's Changed


POST /subscriptions/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}
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/{subscriptionUid}
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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/devices/import
Request:

For cellular device:

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

RDTP-22607

What's Deprecated


GET /subscriptions/{subscriptionUid}/appServersRoutingProfiles

Retrieve AS routing profiles

POST /subscriptions/{subscriptionUid}/appServersRoutingProfiles

Create an AS routing profile

GET /subscriptions/{subscriptionUid}/appServersRoutingProfiles/supplierAppServers

Retrieve supplier application servers

GET /subscriptions/{subscriptionUid}/appServersRoutingProfiles/suppliers

Retrieve application suppliers

GET /subscriptions/{subscriptionUid}/appServersRoutingProfiles/tpkClouds

Retrieve TPX destinations

DELETE /subscriptions/{subscriptionUid}/appServersRoutingProfiles/{appServersRoutingProfileUid}

Delete an AS routing profile

GET /subscriptions/{subscriptionUid}/appServersRoutingProfiles/{appServersRoutingProfileUid}

Retrieve an AS routing profile

PUT /subscriptions/{subscriptionUid}/appServersRoutingProfiles/{appServersRoutingProfileUid}

Update an AS routing profile

GET /subscriptions/{subscriptionUid}/appServersRoutingProfiles/{appServersRoutingProfileUid}/security

Retrieve the security status of an AS routing profile

PUT /subscriptions/{subscriptionUid}/appServersRoutingProfiles/{appServersRoutingProfileUid}/security

Update the security status of an AS routing profile

What's Changed


GET /subscriptions/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/devices/import
Request:

Device creation:

  • the column I is DEPRECATED
GET /subscriptions/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}/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/{subscriptionUid}
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/{subscriptionUid}
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/{subscriptionUid}/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/{subscriptionUid}/appServers/{appServerUid}/security
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/{subscriptionUid}/appServersRoutingProfiles
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 UPDATE or RETRIEVE

  • Deprecated property occContext (object)

    Optimistic Concurrency Control.

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

GET /subscriptions/{subscriptionUid}/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/{subscriptionUid}/appServersRoutingProfiles/{appServersRoutingProfileUid}
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/{subscriptionUid}/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/{subscriptionUid}/appServersRoutingProfiles/{appServersRoutingProfileUid}/security
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/{subscriptionUid}/cellularNetworkContexts
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

Successfull RETRIEVE

  • Deprecated property occContext (object)

    Optimistic Concurrency Control.

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

GET /subscriptions/{subscriptionUid}/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/{subscriptionUid}/cellularNetworkContexts/{networkContextID}
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/{subscriptionUid}/devices
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 UPDATE or RETRIEVE

  • Deprecated property occContext (object)

    Optimistic Concurrency Control.

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

GET /subscriptions/{subscriptionUid}/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/{subscriptionUid}/devices/{deviceUid}
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/{subscriptionUid}/devices/{deviceUid}/restricted
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/{subscriptionUid}/managedCustomerNetwork/bss/tags
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

  • Deprecated property occContext (object)

    Optimistic Concurrency Control.

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

POST /subscriptions/{subscriptionUid}/multicastGroups
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, UPDATE or RETRIEVE

  • Deprecated property occContext (object)

    Optimistic Concurrency Control.

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

GET /subscriptions/{subscriptionUid}/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/{subscriptionUid}/multicastGroups/{multicastGroupUid}
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

RDTP-14093

What's Changed


GET /subscriptions/{subscriptionUid}/deviceProfiles

Retrieve DeviceProfiles

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Added property motionModelIndicator (string)

      The motion indicator provides an indication on the maximal speed of the node

      Enum values:

      • NEAR_STATIC
      • WALKING_SPEED
      • BIKE_SPEED
      • VEHICLE_SPEED
      • RANDOM

RDTP-16536

What's Changed


GET /subscriptions/{subscriptionUid}/devices/frames

Retrieve FramesDevices

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property up (object)

      Uplink indicators for this aggregated time slot.

      Aggregates LoRaWAN uplink frames and cellular uplink frames using message mode.

      • Added property countLost (integer)

        Number of uplink frames lost during this aggregated time slot.

        Only applicable to LoRaWAN devices.

GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/frames/aggregated

Retrieve FramesDeviceAggregation

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property up (object)

      Uplink indicators for this aggregated time slot.

      Aggregates LoRaWAN uplink frames or cellular uplink frames using message mode.

      • Added property countLost (integer)

        Number of uplink frames lost during this aggregated time slot.

        Only applicable to LoRaWAN devices.

RDTP-16775

What's Changed


GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/frames/aggregated

Retrieve FramesDeviceAggregation

Parameters:

Added: lrrID in query

Aggregate only frames received or sent by the base station identified by this lrrID.

When this query parameter is not specified, frames are aggregated without consideration for LRRs.

GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/spreadingFactors/sfDistributions

Retrieve SF Distribution

Parameters:

Changed: duration in query

Size of the window to analyze.

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

Supported duration: PxD (x days), PTxH (between 1…24 hours) and PTxM (between 10…60 minutes)

RDTP-17900

What's Changed


All paths /subscriptions/\{subscriptionUid\}/*
Parameters:

Changed: subscriptionUid in path

Unique identifier of the subscription, either

  • the sequential integer (UID) of the subscription
  • the identifier (ID) of a subscriber prefixed by id:sub:
  • the string mine to reference the subscription of the authenticated user requesting the API

RDTP-19333

What's Changed


GET /subscriptions/{subscriptionUid}/devices/frames
GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/frames/aggregated
Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property dw (object)

      Downlink indicators for this aggregated time slot.

      Aggregates LoRaWAN downlink frames or cellular downlink frames using message mode.

      New required properties:

      • subTypes

      • Added property subTypes (array)

        Indicators per downlink subtypes

        Only applicable to LoRaWAN devices.

        Items (object):

        • Property subType (integer)

          Downlink subtype: only the Join Accept (1004) is implemented for now

          Enum values:

          • 1004
        • Property countSent (integer)

          Number of downlink frames effectively sent for this subtype during this aggregated time slot.

        • Property countFailed (integer)

          Number of downlink frames whose transmission failed for this subtype during this aggregated time slot.

    • Changed property up (object)

      Uplink indicators for this aggregated time slot.

      Aggregates LoRaWAN uplink frames or cellular uplink frames using message mode.

      New required properties:

      • subTypes

      • Added property subTypes (array)

        Indicators per uplink subtypes

        Only applicable to LoRaWAN devices.

        Items (object):

        • Property subType (integer)

          Uplink subtype: only the Join Request (4) is implemented for now

          Enum values:

          • 4
        • Property countOnTime (integer)

          Number of uplink frames received on time for this subtype during this aggregated time slot.

        • Property countLate (integer)

          Number of uplink frames received late for this subtype during this aggregated time slot.

RDTP-19682

What's Changed


GET|PUT /subscriptions/{subscriptionUid}

Retrieve Subscription

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

  • networkSubscriptionsHandling
  • Added property networkSubscriptionsHandling (object)

    • Property mode (string)

      Network subscriptions handling mode:

      • BASIC: Network subscriptions associated with devices and multicast groups are automatically selected without the need to provide their IDs. Supported network subscription settings are described in the supportedNetworkSubscriptions property. Only applicable to ThingPark Enterprise.
      • ADVANCED: Network subscriptions associated with devices and multicast groups are explicitly selected based on their IDs.

      Enum values:

      • BASIC
      • ADVANCED
    • Property supportedNetworkSubscriptions (array)

      List of supported network subscription settings.

      Only returned when mode is BASIC.

      Items (object):

      Supported network subscription settings

      • Property communicationType (string)

        Communication type:

        • UNICAST: Unicast communication
        • MULTICAST: Multicast communication

        Enum values:

        • UNICAST
        • MULTICAST
      • Property connectivity (string)

        Connectivity:

        • LORAWAN: LoRaWAN connectivity
        • CELLULAR: Cellular connectivity

        CELLULAR is only applicable to ThingPark Wireless if the cellular connectivity is enabled by the Operator.

        Enum values:

        • LORAWAN
        • CELLULAR
      • Property maxDestinationPerRoute (boolean)

        Number of allowed Third Party Application Servers.

        Only applicable if communicationType is UNICAST.

      • Property nwGeolocalization (boolean)

        True if network geolocation is enabled.

        Only applicable if communicationType is UNICAST and connectivity is LORAWAN.

      • Property prAllowed (boolean)

        True if passive roaming is allowed.

        Only applicable if communicationType is UNICAST and connectivity is LORAWAN.

GET /subscriptions/{subscriptionUid}/devices

Retrieve Devices

Parameters:

Added: networkSubscriptionID in query

When the string contains a network subscription ID: Only Devices associated with the network subscription are returned.

When the string contains the _unset keyword: Only Devices not associated with a network subscription are returned.

When the string contains the _any keyword: Only Devices attached with a network subscription are returned (without consideration for the network subscription).

Added: nwGeolocalization in query

Only returns Devices associated with a network subscription matching this network geolocation value.

Ignored if networkSubscriptionID query parameter is used.

Only applicable when connectivity is 'LORAWAN'

Added: prAllowed in query

Only returns Devices associated with a network subscription matching this passive roaming value.

Ignored if networkSubscriptionID query parameter is used.

Only applicable when connectivity is 'LORAWAN'

Deprecated: connectivityPlan in query

When the string contains a network subscription ID: Only Devices associated with the network subscription are returned.

When the string contains the _NOCP keyword: Only Devices not associated with a network subscription are returned.

When the string contains the _CP keyword: Only Devices attached with a network subscription are returned (without consideration for the network subscription).

This parameter must no longer be used: the parameter networkSubscriptionID must be used in replacement.

Changed: connectivity in query

Returns Devices matching connectivity:

  • LORAWAN
  • CELLULAR

CELLULAR is only applicable to ThingPark Wireless if the cellular connectivity is enabled by the Operator.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property networkSubscription (object)

      Network subscription associated with the device

      • Added property nwGeolocalization (boolean)

        True if network geolocation is enabled

        Only applicable when connectivity is 'LORAWAN'

      • Added property prAllowed (boolean)

        True if passive roaming is allowed

        Only applicable when connectivity is 'LORAWAN'

POST /subscriptions/{subscriptionUid}/devices

Create Device

Parameters:

Added: networkSubscriptionsHandlingMode in query

Requested network subscriptions handling mode:

  • BASIC: the network subscription is automatically selected without the need to provide its ID. Only applicable to ThingPark Enterprise.
  • ADVANCED: the network subscription is explicitly selected based on its ID.

The default value is the network subscriptions handling mode of the subscription.

Request:
  • Changed property networkSubscription (object)

    Network subscription associated with the device

    The network subscription must be compatible with the AS routing profile associated with the device (if any)

    On device creation or update, the selection of the network subscription depends on networkSubscriptionsHandlingMode query parameter:

    • BASIC: the network subscription is selected based on its nwGeolocalization and prAllowed values. If nwGeolocalization and prAllowed are not provided, the network subscription with nwGeolocalization and prAllowed set to false is selected. If several network subscriptions match, the network subscription with the oldest subscription date is selected. Only applicable to ThingPark Enterprise.
    • ADVANCED: the network subscription is selected based on its ID value. If no ID is provided, the device is not associated with a network subscription and automatically suspended: all its packets are ignored by the network server.

    On device creation, the network subscription is always selected as described above.

    On device update, the network subscription is selected as described above only if the networkSubscription property is provided. Otherwise the current network subscription is kept.

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

    • Added property nwGeolocalization (boolean)

      True if network geolocation is enabled

      Only applicable when connectivity is 'LORAWAN'

    • Added property prAllowed (boolean)

      True if passive roaming is allowed

      Only applicable when connectivity is 'LORAWAN'

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Changed property networkSubscription (object)

    Network subscription associated with the device

    The network subscription must be compatible with the AS routing profile associated with the device (if any)

    On device creation or update, the selection of the network subscription depends on networkSubscriptionsHandlingMode query parameter:

    • BASIC: the network subscription is selected based on its nwGeolocalization and prAllowed values. If nwGeolocalization and prAllowed are not provided, the network subscription with nwGeolocalization and prAllowed set to false is selected. If several network subscriptions match, the network subscription with the oldest subscription date is selected. Only applicable to ThingPark Enterprise.
    • ADVANCED: the network subscription is selected based on its ID value. If no ID is provided, the device is not associated with a network subscription and automatically suspended: all its packets are ignored by the network server.

    On device creation, the network subscription is always selected as described above.

    On device update, the network subscription is selected as described above only if the networkSubscription property is provided. Otherwise the current network subscription is kept.

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

    • Added property nwGeolocalization (boolean)

      True if network geolocation is enabled

      Only applicable when connectivity is 'LORAWAN'

    • Added property prAllowed (boolean)

      True if passive roaming is allowed

      Only applicable when connectivity is 'LORAWAN'

GET /subscriptions/{subscriptionUid}/devices/clusters

Retrieve Devices clusters

Parameters:

Added: networkSubscriptionID in query

When the string contains a network subscription ID: Only Devices associated with the network subscription are returned.

When the string contains the _unset keyword: Only Devices not associated with a network subscription are returned.

When the string contains the _any keyword: Only Devices attached with a network subscription are returned (without consideration for the network subscription).

Added: nwGeolocalization in query

Only returns Devices associated with a network subscription enabling the network geolocation.

Ignored if networkSubscriptionID query parameter is used.

Only applicable when connectivity is 'LORAWAN'

Added: prAllowed in query

Only returns Devices associated with a network subscription enabling the passive roaming.

Ignored if networkSubscriptionID query parameter is used.

Only applicable when connectivity is 'LORAWAN'

Deprecated: connectivityPlan in query

When the string contains a network subscription ID: Only Devices associated with the network subscription are returned.

When the string contains the _NOCP keyword: Only Devices not associated with a network subscription are returned.

When the string contains the _CP keyword: Only Devices attached with a network subscription are returned (without consideration for the network subscription).

This parameter must no longer be used: the parameter networkSubscriptionID must be used in replacement.

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 networkSubscription (object)

        Network subscription associated with the device

        • Added property nwGeolocalization (boolean)

          True if network geolocation is enabled

          Only applicable when connectivity is 'LORAWAN'

        • Added property prAllowed (boolean)

          True if passive roaming is allowed

          Only applicable when connectivity is 'LORAWAN'

POST /subscriptions/{subscriptionUid}/devices/import

Create Import

Parameters:

Added: networkSubscriptionsHandlingMode in query

Requested network subscriptions handling mode:

  • BASIC: the network subscription is automatically selected without the need to provide its ID. Only applicable to ThingPark Enterprise.
  • ADVANCED: the network subscription is explicitly selected based on its ID.

The default value is the network subscriptions handling mode of the subscription.

Deleted: context in query

Specifies the context of the device importation:

  • 'TPW': ThingPark Wireless
  • 'TPE': ThingPark Enterprise By default, ThingPark Wireless is considered.
Request:

The device importation CSV file is updated for LoRaWAN ABP and OTAA activations:

ColumnDefinitionCardinality
H

Network Subscription associated with the device.
The selection of the network subscription depends on networkSubscriptionsHandlingMode query parameter:

  • BASIC: Provide a comma-separated list of features to automatically select the network subscription. Available features are 'NetworkGeolocation' and 'PassiveRoaming'. If empty, the network subscription without 'NetworkGeolocation' and 'PassiveRoaming' features is selected. If several network subscriptions match, the network subscription with the oldest subscription date is selected. Only applicable to ThingPark Enterprise.
  • ADVANCED: Provide the ID of the network subscription. If empty, the device is not associated with a network subscription and is automatically suspended: all its packets are ignored by the network server.
Optional
POST /subscriptions/{subscriptionUid}/devices/tags

Tag Devices

Parameters:

Added: networkSubscriptionID in query

When the string contains a network subscription ID: Only Devices associated with the network subscription are tagged/untagged.

When the string contains the _unset keyword: Only Devices not associated with a network subscription are tagged/untagged.

When the string contains the _any keyword: Only Devices attached with a network subscription are tagged/untagged (without consideration for the network subscription).

Deprecated: connectivityPlan in query

When the string contains a network subscription ID: Only Devices associated with the network subscription are tagged/untagged.

When the string contains the _NOCP keyword: Only Devices not associated with a network subscription are tagged/untagged.

When the string contains the _CP keyword: Only Devices attached with a network subscription are tagged/untagged (without consideration for the network subscription).

This parameter must no longer be used: the parameter networkSubscriptionID must be used in replacement.

Changed: connectivity in query

Only tags/untags devices matching connectivity:

  • LORAWAN
  • CELLULAR

CELLULAR is only applicable to ThingPark Wireless if the cellular connectivity is enabled by the Operator.

GET /subscriptions/{subscriptionUid}/devices/{deviceUid}

Retrieve Device

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property networkSubscription (object)

    Network subscription associated with the device

    The network subscription must be compatible with the AS routing profile associated with the device (if any)

    On device creation or update, the selection of the network subscription depends on networkSubscriptionsHandlingMode query parameter:

    • BASIC: the network subscription is selected based on its nwGeolocalization and prAllowed values. If nwGeolocalization and prAllowed are not provided, the network subscription with nwGeolocalization and prAllowed set to false is selected. If several network subscriptions match, the network subscription with the oldest subscription date is selected. Only applicable to ThingPark Enterprise.
    • ADVANCED: the network subscription is selected based on its ID value. If no ID is provided, the device is not associated with a network subscription and automatically suspended: all its packets are ignored by the network server.

    On device creation, the network subscription is always selected as described above.

    On device update, the network subscription is selected as described above only if the networkSubscription property is provided. Otherwise the current network subscription is kept.

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

    • Added property nwGeolocalization (boolean)

      True if network geolocation is enabled

      Only applicable when connectivity is 'LORAWAN'

    • Added property prAllowed (boolean)

      True if passive roaming is allowed

      Only applicable when connectivity is 'LORAWAN'

PUT /subscriptions/{subscriptionUid}/devices/{deviceUid}

Update Device

Parameters:

Added: networkSubscriptionsHandlingMode in query

Requested network subscriptions handling mode:

  • BASIC: the network subscription is automatically selected without the need to provide its ID. Only applicable to ThingPark Enterprise.
  • ADVANCED: the network subscription is explicitly selected based on its ID.

The default value is the network subscriptions handling mode of the subscription.

Request:
  • Changed property networkSubscription (object)

    Network subscription associated with the device

    The network subscription must be compatible with the AS routing profile associated with the device (if any)

    On device creation or update, the selection of the network subscription depends on networkSubscriptionsHandlingMode query parameter:

    • BASIC: the network subscription is selected based on its nwGeolocalization and prAllowed values. If nwGeolocalization and prAllowed are not provided, the network subscription with nwGeolocalization and prAllowed set to false is selected. If several network subscriptions match, the network subscription with the oldest subscription date is selected. Only applicable to ThingPark Enterprise.
    • ADVANCED: the network subscription is selected based on its ID value. If no ID is provided, the device is not associated with a network subscription and automatically suspended: all its packets are ignored by the network server.

    On device creation, the network subscription is always selected as described above.

    On device update, the network subscription is selected as described above only if the networkSubscription property is provided. Otherwise the current network subscription is kept.

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

    • Added property nwGeolocalization (boolean)

      True if network geolocation is enabled

      Only applicable when connectivity is 'LORAWAN'

    • Added property prAllowed (boolean)

      True if passive roaming is allowed

      Only applicable when connectivity is 'LORAWAN'

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property networkSubscription (object)

    Network subscription associated with the device

    The network subscription must be compatible with the AS routing profile associated with the device (if any)

    On device creation or update, the selection of the network subscription depends on networkSubscriptionsHandlingMode query parameter:

    • BASIC: the network subscription is selected based on its nwGeolocalization and prAllowed values. If nwGeolocalization and prAllowed are not provided, the network subscription with nwGeolocalization and prAllowed set to false is selected. If several network subscriptions match, the network subscription with the oldest subscription date is selected. Only applicable to ThingPark Enterprise.
    • ADVANCED: the network subscription is selected based on its ID value. If no ID is provided, the device is not associated with a network subscription and automatically suspended: all its packets are ignored by the network server.

    On device creation, the network subscription is always selected as described above.

    On device update, the network subscription is selected as described above only if the networkSubscription property is provided. Otherwise the current network subscription is kept.

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

    • Added property nwGeolocalization (boolean)

      True if network geolocation is enabled

      Only applicable when connectivity is 'LORAWAN'

    • Added property prAllowed (boolean)

      True if passive roaming is allowed

      Only applicable when connectivity is 'LORAWAN'

GET /subscriptions/{subscriptionUid}/multicastGroups

Retrieve Multicast Groups

Parameters:

Added: networkSubscriptionID in query

When the string contains a network subscription ID: Only Multicast Groups associated with the network subscription are returned.

When the string contains the _unset keyword: Only Multicast Groups not associated with a network subscription are returned.

When the string contains the _any keyword: Only Multicast Groups attached with a network subscription are returned (without consideration for the network subscription).

Deprecated: connectivityPlan in query

When the string contains a network subscription ID: Only Multicast Groups associated with the network subscription are returned.

When the string contains the _NOCP keyword: Only Multicast Groups not associated with a network subscription are returned.

When the string contains the _CP keyword: Only Multicast Groups attached with a network subscription are returned (without consideration for the network subscription).

This parameter must no longer be used: the parameter networkSubscriptionID must be used in replacement.

POST /subscriptions/{subscriptionUid}/multicastGroups

Create Multicast Group

Parameters:

Added: networkSubscriptionsHandlingMode in query

Requested network subscriptions handling mode:

  • BASIC: the network subscription is automatically selected without the need to provide its ID. Only applicable to ThingPark Enterprise.
  • ADVANCED: the network subscription is explicitly selected based on its ID.

The default value is the network subscriptions handling mode of the subscription.

PUT /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}

Update Multicast Group

Parameters:

Added: networkSubscriptionsHandlingMode in query

Requested network subscriptions handling mode:

  • BASIC: the network subscription is automatically selected without the need to provide its ID. Only applicable to ThingPark Enterprise.
  • ADVANCED: the network subscription is explicitly selected based on its ID.

The default value is the network subscriptions handling mode of the subscription.

GET /subscriptions/{subscriptionUid}/networkSubscriptions

Retrieve NetworkSubscriptions

Parameters:

Added: networkSubscriptionID in query

Return the network subscription matching this ID (exact match).

Deprecated: connectivityPlan in query

Return the network subscription matching this ID (exact match).

This parameter must no longer be used: the parameter networkSubscriptionID must be used in replacement.

GET /subscriptions/{subscriptionUid}/networkSubscriptions/transactions

Retrieve NwSubsTransactions

Parameters:

Added: networkSubscriptionID in query

Network subscription ID filtering. Only transaction associated to this network subscription ID are returned.

Deprecated: connectivityPlan in query

Network subscription ID filtering. Only transaction associated to this network subscription ID are returned.

This parameter must no longer be used: the parameter networkSubscriptionID must be used in replacement.

RDTP-19834

What's Changed


GET /subscriptions/{subscriptionUid}

Retrieve Subscription

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

  • baseStationTagsNamespace
  • Changed property options (object)

    The following properties are now optional:

    • externalJS
PUT /subscriptions/{subscriptionUid}

Update Subscription

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

  • baseStationTagsNamespace
  • Changed property options (object)

    The following properties are now optional:

    • externalJS
GET /subscriptions/{subscriptionUid}/deviceProfiles

Retrieve DeviceProfiles

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property vendor (object)

      The following properties are now optional:

      • name
GET /subscriptions/{subscriptionUid}/deviceVendors

Retrieve DeviceVendors

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    The following properties are now optional:

    • name
GET /subscriptions/{subscriptionUid}/devices

Retrieve Devices

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property vendor (object)

      The following properties are now optional:

      • name
POST /subscriptions/{subscriptionUid}/devices

Create Device

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Changed property networkSubscription (object)

    Network subscription associated with the device

    The network subscription must be compatible with the AS routing profile associated with the device (if any)

    If not set, the device is automatically suspended and all its packets are ignored by the network server

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

    The following properties are now optional:

    • mobility
  • Changed property vendor (object)

    The following properties are now optional:

    • name
GET /subscriptions/{subscriptionUid}/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 vendor (object)

        The following properties are now optional:

        • name
GET /subscriptions/{subscriptionUid}/devices/{deviceUid}

Retrieve Device

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property networkSubscription (object)

    Network subscription associated with the device

    The network subscription must be compatible with the AS routing profile associated with the device (if any)

    If not set, the device is automatically suspended and all its packets are ignored by the network server

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

    The following properties are now optional:

    • mobility
  • Changed property vendor (object)

    The following properties are now optional:

    • name
PUT /subscriptions/{subscriptionUid}/devices/{deviceUid}

Update Device

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property networkSubscription (object)

    Network subscription associated with the device

    The network subscription must be compatible with the AS routing profile associated with the device (if any)

    If not set, the device is automatically suspended and all its packets are ignored by the network server

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

    The following properties are now optional:

    • mobility
  • Changed property vendor (object)

    The following properties are now optional:

    • name
PUT /subscriptions/{subscriptionUid}/restricted

Update Restricted Settings

Return Type:

Changed response : 200 OK

Successful UPDATE

The following properties are now optional:

  • baseStationTagsNamespace

RDTP-20186

What's Changed


POST /subscriptions/{subscriptionUid}/appServersRoutingProfiles

Create AppServersRoutingProfile

Request:

Updated CELLULAR type:

  • Added property appServersReporting (object)

    Define which events are reported to application servers. Message mode uplink IPv4 packets are always reported.

    • Property microflowEvents (boolean)

      True if the microflow events are reported to application servers. Not applicable when mode is MESSAGE.

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Updated CELLULAR type:

  • Added property appServersReporting (object)

    Define which events are reported to application servers. Message mode uplink IPv4 packets are always reported.

    • Property microflowEvents (boolean)

      True if the microflow events are reported to application servers. Not applicable when mode is MESSAGE.

GET /subscriptions/{subscriptionUid}/appServersRoutingProfiles/{appServersRoutingProfileUid}

Retrieve AppServersRoutingProfile

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated CELLULAR type:

  • Added property appServersReporting (object)

    Define which events are reported to application servers. Message mode uplink IPv4 packets are always reported.

    • Property microflowEvents (boolean)

      True if the microflow events are reported to application servers. Not applicable when mode is MESSAGE.

PUT /subscriptions/{subscriptionUid}/appServersRoutingProfiles/{appServersRoutingProfileUid}

Update AppServersRoutingProfile

Request:

Updated CELLULAR type:

  • Added property appServersReporting (object)

    Define which events are reported to application servers. Message mode uplink IPv4 packets and session events are always reported.

    • Property microflowEvents (boolean)

      True if the microflow events are reported to application servers. Not applicable when mode is MESSAGE.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated CELLULAR type:

  • Added property appServersReporting (object)

    Define which events are reported to application servers. Message mode uplink IPv4 packets and session events are always reported.

    • Property microflowEvents (boolean)

      True if the microflow events are reported to application servers. Not applicable when mode is MESSAGE.

RDTP-21113

What's Changed


POST /subscriptions/{subscriptionUid}/devices/{deviceUid}/admins/downlink

Send Downlink

Parameters:

Changed: fPort in query

LoRaWAN target port [1..225]

POST /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/admins/downlink

Send Downlink

Parameters:

Changed: fPort in query

LoRaWAN target port [1..225]

RDTP-21377

What's Changed


GET /subscriptions/{subscriptionUid}/appServers

Retrieve application servers

Access rights:

If the authenticated user has domain restrictions, only the following application servers are returned:

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

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Added property domains (array)

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

      Items (object):

      The domain must exist in the subscriber account and must be in ACTIVE state to be used.

      • Property name (string)

        Domain name

      • Property group (object)

        • Property name (string)

          Domain group name

POST /subscriptions/{subscriptionUid}/appServers

Add an application server

Access rights:

If the authenticated user has domain restrictions, the application server must match the domain restrictions.

Request:
  • Added property domains (array)

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

    Items (object):

    The domain must exist in the subscriber account and must be in ACTIVE state to be used.

    • Property name (string)

      Domain name

    • Property group (object)

      • Property name (string)

        Domain group name

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Added property domains (array)

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

    Items (object):

    The domain must exist in the subscriber account and must be in ACTIVE state to be used.

    • Property name (string)

      Domain name

    • Property group (object)

      • Property name (string)

        Domain group name

GET /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Retrieve an application server

Access rights:

If the authenticated user has domain restrictions, one of the following conditions must be satisfied:

  • The application server is not associated with any domain
  • The application server is associated with at least one domain and matches the domain restrictions
Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property domains (array)

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

    Items (object):

    The domain must exist in the subscriber account and must be in ACTIVE state to be used.

    • Property name (string)

      Domain name

    • Property group (object)

      • Property name (string)

        Domain group name

Updated HTTP and HTTP_CELLULAR types:

  • Changed property customHttpHeaders (array)

    This field is not returned if the authenticated user has domain restrictions but does not have <Subscription>/a access right.

  • Changed property destinations (array)

    This field is not returned if the authenticated user has domain restrictions but does not have <Subscription>/a access right.

PUT /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Update an application server

Access rights:

If the authenticated user has domain restrictions, the application server must match the domain restrictions before and after the update.

Request:
  • Added property domains (array)

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

    Items (object):

    The domain must exist in the subscriber account and must be in ACTIVE state to be used.

    • Property name (string)

      Domain name

    • Property group (object)

      • Property name (string)

        Domain group name

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property domains (array)

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

    Items (object):

    The domain must exist in the subscriber account and must be in ACTIVE state to be used.

    • Property name (string)

      Domain name

    • Property group (object)

      • Property name (string)

        Domain group name

DELETE /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Delete an application server

Access rights:

If the authenticated user has domain restrictions, the application server must match the domain restrictions.

GET /subscriptions/{subscriptionUid}/appServers/{appServerUid}/security

Retrieve the security status of an application server

Access rights:

If the authenticated user has domain restrictions, one of the following conditions must be satisfied:

  • The application server is not associated with any domain
  • The application server is associated with at least one domain and matches the domain restrictions
PUT /subscriptions/{subscriptionUid}/appServers/{appServerUid}/security

Update the security status of an application server

Access rights:

If the authenticated user has domain restrictions, the application server must match the domain restrictions.

POST /subscriptions/{subscriptionUid}/devices
PUT /subscriptions/{subscriptionUid}/devices/{deviceUid}
Request:
  • Changed property appServers (array)

    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
POST /subscriptions/{subscriptionUid}/devices/import
Request:
  • Changed column T for ABP and OTAA activations

    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
POST /subscriptions/{subscriptionUid}/multicastGroups
PUT /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}
Request:
  • Changed property appServers (array)

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

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

RDTP-21427

What's Changed


GET /subscriptions/{subscriptionUid}/devices

Retrieve Devices

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    Updated LORAWAN connectivity:

    • Added property appEUI (string)

      LoRaWAN JoinEUI/AppEUI (16 hexadecimal characters / case insensitive but always converted in upper case by the server)

      Only applicable to OTAA Devices.

      Mandatory if external Join Server is used, optional otherwise.

    • Added property hsmGroupID (string)

      ID of HSM group used to encrypt the AppKey.

      Only applicable to OTAA devices if local Join Server is used.

    • Added property joinServer (string)

      Location of the Join Server used for Device activation:

      • LOCAL: Local Join server with software encryption
      • LOCAL_WITH_HSM: Local Join server with HSM protection
      • EXTERNAL: External Join server

      Only applicable to OTAA devices.

      Enum values:

      • LOCAL
      • LOCAL_WITH_HSM
      • EXTERNAL
    • Added property modelConfig (string)

      ThingPark X IoT Flow matcher tags XML document:

      • The root XML element is modelCfgs
      • The value of each enclosed modelCfg XML element is a flow matcher tag
      • The modelCfg@Port attribute must be incremented for each new flow matcher tag (starting from 1)
    • Added property driverMetadata (object)

      Metadata for Driver selection

      • Property application (string)

        Application metadata for Driver selection. Syntax: <producerId>:<moduleId>:<version>

GET /subscriptions/{subscriptionUid}/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)

      Updated LORAWAN connectivity:

      • Added property appEUI (string)

        LoRaWAN JoinEUI/AppEUI (16 hexadecimal characters / case insensitive but always converted in upper case by the server)

        Only applicable to OTAA Devices.

        Mandatory if external Join Server is used, optional otherwise.

      • Added property hsmGroupID (string)

        ID of HSM group used to encrypt the AppKey.

        Only applicable to OTAA devices if local Join Server is used.

      • Added property joinServer (string)

        Location of the Join Server used for Device activation:

        • LOCAL: Local Join server with software encryption
        • LOCAL_WITH_HSM: Local Join server with HSM protection
        • EXTERNAL: External Join server

        Only applicable to OTAA devices.

        Enum values:

        • LOCAL
        • LOCAL_WITH_HSM
        • EXTERNAL
      • Added property modelConfig (string)

        ThingPark X IoT Flow matcher tags XML document:

        • The root XML element is modelCfgs
        • The value of each enclosed modelCfg XML element is a flow matcher tag
        • The modelCfg@Port attribute must be incremented for each new flow matcher tag (starting from 1)
      • Added property driverMetadata (object)

        Metadata for Driver selection

        • Property application (string)

          Application metadata for Driver selection. Syntax: <producerId>:<moduleId>:<version>

RDTP-2308

What's Changed


GET /subscriptions/{subscriptionUid}/devices

Retrieve Devices

Parameters:

Changed: healthState in query

Health state filtering.

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

  • Added enum value:

    • SUSPENDED
Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property healthState (string)

      Device health state:

      • INIT: The device has been created or resumed after suspension, but has not yet communicated with the network server since then
      • ACTIVE: The device is connected to the network, transmitting and receiving packets
      • RF_CNX_ERROR: The device has lost its network connection
      • SUSPENDED: The device has been suspended, all its packets are ignored by the network server

      Added enum value:

      • SUSPENDED
GET /subscriptions/{subscriptionUid}/devices/clusters

Retrieve Devices clusters

Parameters:

Changed: healthState in query

Health state filtering.

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

  • Added enum value:

    • SUSPENDED
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 healthState (string)

        Device health state:

        • INIT: The device has been created or resumed after suspension, but has not yet communicated with the network server since then
        • ACTIVE: The device is connected to the network, transmitting and receiving packets
        • RF_CNX_ERROR: The device has lost its network connection
        • SUSPENDED: The device has been suspended, all its packets are ignored by the network server

        Added enum value:

        • SUSPENDED
GET /subscriptions/{subscriptionUid}/devices/counters

Retrieve Counters

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property healthState (string)

      Device health state:

      • INIT: The device has been created or resumed after suspension, but has not yet communicated with the network server since then
      • ACTIVE: The device is connected to the network, transmitting and receiving packets
      • RF_CNX_ERROR: The device has lost its network connection
      • SUSPENDED: The device has been suspended, all its packets are ignored by the network server

      Added enum value:

      • SUSPENDED
POST /subscriptions/{subscriptionUid}/devices/tags

Tag Devices

Parameters:

Changed: healthState in query

Only tags/untags devices matching this health state.

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

  • Added enum value:

    • SUSPENDED
POST /subscriptions/{subscriptionUid}/devices

Create Device

Request:
  • Added property suspension (string)

    Device suspension state:

    • NONE: The device is associated with a network subscription and allowed to transmit and receive packets.

    • SUBSCRIBER_SUSPENDED: The device has been suspended by the subscriber, all its packets are ignored by the network server. The device may still be associated with a network subscription.

      When removing the network subscription from a device, the suspension state is automatically set to SUBSCRIBER_SUSPENDED.

      When associating a suspended device with a network subscription, the suspension state is automatically set to NONE.

    Enum values:

    • NONE
    • SUBSCRIBER_SUSPENDED
Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Added property suspension (string)

    Device suspension state:

    • NONE: The device is associated with a network subscription and allowed to transmit and receive packets.

    • SUBSCRIBER_SUSPENDED: The device has been suspended by the subscriber, all its packets are ignored by the network server. The device may still be associated with a network subscription.

      When removing the network subscription from a device, the suspension state is automatically set to SUBSCRIBER_SUSPENDED.

      When associating a suspended device with a network subscription, the suspension state is automatically set to NONE.

    Enum values:

    • NONE
    • SUBSCRIBER_SUSPENDED
  • Changed property healthState (string)

    Device health state:

    • INIT: The device has been created or resumed after suspension, but has not yet communicated with the network server since then
    • ACTIVE: The device is connected to the network, transmitting and receiving packets
    • RF_CNX_ERROR: The device has lost its network connection
    • SUSPENDED: The device has been suspended, all its packets are ignored by the network server

    Added enum value:

    • SUSPENDED
GET /subscriptions/{subscriptionUid}/devices/{deviceUid}

Retrieve Device

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property suspension (string)

    Device suspension state:

    • NONE: The device is associated with a network subscription and allowed to transmit and receive packets.

    • SUBSCRIBER_SUSPENDED: The device has been suspended by the subscriber, all its packets are ignored by the network server. The device may still be associated with a network subscription.

      When removing the network subscription from a device, the suspension state is automatically set to SUBSCRIBER_SUSPENDED.

      When associating a suspended device with a network subscription, the suspension state is automatically set to NONE.

    Enum values:

    • NONE
    • SUBSCRIBER_SUSPENDED
  • Changed property healthState (string)

    Device health state:

    • INIT: The device has been created or resumed after suspension, but has not yet communicated with the network server since then
    • ACTIVE: The device is connected to the network, transmitting and receiving packets
    • RF_CNX_ERROR: The device has lost its network connection
    • SUSPENDED: The device has been suspended, all its packets are ignored by the network server

    Added enum value:

    • SUSPENDED
PUT /subscriptions/{subscriptionUid}/devices/{deviceUid}

Update Device

Request:
  • Added property suspension (string)

    Device suspension state:

    • NONE: The device is associated with a network subscription and allowed to transmit and receive packets.

    • SUBSCRIBER_SUSPENDED: The device has been suspended by the subscriber, all its packets are ignored by the network server. The device may still be associated with a network subscription.

      When removing the network subscription from a device, the suspension state is automatically set to SUBSCRIBER_SUSPENDED.

      When associating a suspended device with a network subscription, the suspension state is automatically set to NONE.

    Enum values:

    • NONE
    • SUBSCRIBER_SUSPENDED
Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property suspension (string)

    Device suspension state:

    • NONE: The device is associated with a network subscription and allowed to transmit and receive packets.

    • SUBSCRIBER_SUSPENDED: The device has been suspended by the subscriber, all its packets are ignored by the network server. The device may still be associated with a network subscription.

      When removing the network subscription from a device, the suspension state is automatically set to SUBSCRIBER_SUSPENDED.

      When associating a suspended device with a network subscription, the suspension state is automatically set to NONE.

    Enum values:

    • NONE
    • SUBSCRIBER_SUSPENDED
  • Changed property healthState (string)

    Device health state:

    • INIT: The device has been created or resumed after suspension, but has not yet communicated with the network server since then
    • ACTIVE: The device is connected to the network, transmitting and receiving packets
    • RF_CNX_ERROR: The device has lost its network connection
    • SUSPENDED: The device has been suspended, all its packets are ignored by the network server

    Added enum value:

    • SUSPENDED

RDTP-5254

What's Changed


GET /subscriptions/{subscriptionUid}/appServers

Retrieve AppServers

Parameters:

Added: baseStationAlarmNotification in query

Returns Kafka Application Servers for which the notification of Base Station alarms is enabled.

By default, all Application Servers are returned.

Added: deviceAlarmNotification in query

Returns Kafka Application Servers for which the notification of Device alarms is enabled.

By default, all Application Servers are returned.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    New required properties:

    • baseStationCount

    • Added property baseStationCount (integer)

      Number of Base Stations associated with the Application Server through direct association.

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

    • Changed property tpxIotFlow (object)

      New required properties:

      • notification

      • Added property notification (object)

        • Property baseStationAlarms (boolean)

          TRUE if the alarms of associated base stations are reported to the associated Connection in TPX IoT Flow

        • Property deviceAlarms (boolean)

          TRUE if the alarms of associated devices are reported to the associated Connection in TPX IoT Flow

POST /subscriptions/{subscriptionUid}/appServers

Create AppServer

Request:

Updated KAFKA type:

  • Changed property tpxIotFlow (object)

    • Added property notification (object)

      • Property baseStationAlarms (boolean)

        TRUE if the alarms of associated base stations are reported to the associated Connection in TPX IoT Flow

      • Property deviceAlarms (boolean)

        TRUE if the alarms of associated devices are reported to the associated Connection in TPX IoT Flow

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Updated KAFKA type:

  • Changed property tpxIotFlow (object)

    • Added property notification (object)

      • Property baseStationAlarms (boolean)

        TRUE if the alarms of associated base stations are reported to the associated Connection in TPX IoT Flow

      • Property deviceAlarms (boolean)

        TRUE if the alarms of associated devices are reported to the associated Connection in TPX IoT Flow

New required properties:

  • baseStationCount
  • Added property baseStationCount (integer)

    Number of Base Stations associated with the Application Server through direct association.

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

GET /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Retrieve AppServer

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated KAFKA type:

  • Changed property tpxIotFlow (object)

    • Added property notification (object)

      • Property baseStationAlarms (boolean)

        TRUE if the alarms of associated base stations are reported to the associated Connection in TPX IoT Flow

      • Property deviceAlarms (boolean)

        TRUE if the alarms of associated devices are reported to the associated Connection in TPX IoT Flow

New required properties:

  • baseStationCount
  • Added property baseStationCount (integer)

    Number of Base Stations associated with the Application Server through direct association.

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

PUT /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Update AppServer

Request:

Updated KAFKA type:

  • Changed property tpxIotFlow (object)

    • Added property notification (object)

      • Property baseStationAlarms (boolean)

        TRUE if the alarms of associated base stations are reported to the associated Connection in TPX IoT Flow

      • Property deviceAlarms (boolean)

        TRUE if the alarms of associated devices are reported to the associated Connection in TPX IoT Flow

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated KAFKA type:

  • Changed property tpxIotFlow (object)

    • Added property notification (object)

      • Property baseStationAlarms (boolean)

        TRUE if the alarms of associated base stations are reported to the associated Connection in TPX IoT Flow

      • Property deviceAlarms (boolean)

        TRUE if the alarms of associated devices are reported to the associated Connection in TPX IoT Flow

New required properties:

  • baseStationCount
  • Added property baseStationCount (integer)

    Number of Base Stations associated with the Application Server through direct association.

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

Release 7.2

RDTP-18143

What's Changed


GET|PUT /subscriptions/{subscriptionUid}
Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property nonRoamingDevicesNetID (string)

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

  • Changed property operator (object)

    • Changed property nonRoamingDevicesNetID (string)

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

    • Changed property roamingDevicesNetID (string)

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

  • Changed property roamingDevicesNetID (string)

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

PUT /subscriptions/{subscriptionUid}/restricted
Request:
  • Changed property nonRoamingDevicesNetID (string)

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

  • Changed property roamingDevicesNetID (string)

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

Return Type:

Changed response : 200 OK

Successful UPDATE

  • Changed property nonRoamingDevicesNetID (string)

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

  • Changed property roamingDevicesNetID (string)

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

RDTP-18480

What's New


GET /subscriptions/{subscriptionUid}/usersAlarmsSubscriptions

Retrieve Users Alarms Subscriptions

GET /subscriptions/{subscriptionUid}/users/{thingparkID}/alarmsSubscription

Retrieve User Alarms Subscription

PUT /subscriptions/{subscriptionUid}/users/{thingparkID}/alarmsSubscription

Update User Alarms Subscription

POST /subscriptions/{subscriptionUid}/users/{thingparkID}/alarmsSubscription

Create User Alarms Subscription

DELETE /subscriptions/{subscriptionUid}/users/{thingparkID}/alarmsSubscription

Delete User Alarms Subscription

RDTP-18955

What's Changed


POST /subscriptions/{subscriptionUid}/appServers
PUT /subscriptions/{subscriptionUid}/appServers/{appServerUid}
DELETE /subscriptions/{subscriptionUid}/appServers/{appServerUid}
PUT /subscriptions/{subscriptionUid}/appServers/{appServerUid}/security
Access rights:
  • If at least one domain group exists in the subscriber account:
    • <Subscription>/RA
    • <Subscription>/s1: MANAGE_SUBSCRIBER
    • LPWA_MGR::WRITE_AS_ROUTING_PROFILE
  • Else:
    • <Subscription>/a
    • LPWA_MGR::WRITE_AS_ROUTING_PROFILE
POST /subscriptions/{subscriptionUid}/generateDxAccessToken
Access rights:
  • If at least one domain group exists in the subscriber account:
    • <Subscription>/RA
    • <Subscription>/s1: MANAGE_SUBSCRIBER
  • Else:
    • <Subscription>/a

RDTP-18988

What's Changed


GET /subscriptions/{subscriptionUid}/devices/frames
GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/frames/aggregated
GET /subscriptions/{subscriptionUid}/multicastGroups/frames/aggregated
GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/frames/aggregated

Retrieve Aggregated Multicast Group Frames

Parameters:

Changed: step in query

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

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

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

RDTP-19281

What's New


GET /subscriptions/{subscriptionUid}/devices/alarms/histories

Retrieve Alarms History of all Devices

What's Changed


GET /subscriptions/{subscriptionUid}/devices/alarms

Retrieve Alarms of all Devices

Parameters:

Added: alarmUid in query

Alarm Uid identifying the alarm occurrence

Return Type:

Changed response : 200 OK

Successful RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    New required properties:

    • alarmUid

    • Added property alarmUid (string)

      Alarm Uid identifying the alarm occurrence

GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/alarms

Retrieve Alarms of a Device

Return Type:

Changed response : 200 OK

Successful RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    New required properties:

    • alarmUid

    • Added property alarmUid (string)

      Alarm Uid identifying the alarm occurrence

GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/alarms/histories

Retrieve Alarms History of a Device

Return Type:

Changed response : 200 OK

Successful RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    New required properties:

    • alarmUid

    • Added property alarmUid (string)

      Alarm Uid identifying the alarm occurrence

GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/alarms

Retrieve Alarms of a Multicast Group

Return Type:

Changed response : 200 OK

Successful RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    New required properties:

    • alarmUid

    • Added property alarmUid (string)

      Alarm Uid identifying the alarm occurrence

GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/alarms/histories

Retrieve Alarms History of a Multicast Group

Return Type:

Changed response : 200 OK

Successful RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    New required properties:

    • alarmUid

    • Added property alarmUid (string)

      Alarm Uid identifying the alarm occurrence

RDTP-19707

What's Changed


POST /subscriptions/{subscriptionUid}/deviceProfiles/catalog/selfUpdate

Import Catalog from repository

Access rights:
  • If at least one domain group exists in the subscriber account:
    • <Subscription>/RA
    • <Subscription>/s1: MANAGE_SUBSCRIBER
  • Else:
    • <Subscription>/a

RDTP-20667

What's Changed


GET /subscriptions/{subscriptionUid}/devices

Retrieve Devices

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property appServers (array)

      List of Application Servers directly associated with the device

      Changed items (object):

      New required properties:

      • ID

      • href

      • Added property ID (string)

        Application Server ID

      • Added property href (string)

        Application Server href

    • Changed property appServersRoutingProfile (object)

      Available when the Device is associated with an AS routing profile

      New required properties:

      • ID

      • Added property ID (string)

        AS routing profile ID

    • Changed property model (object)

      New required properties:

      • ID

      • Added property ID (string)

        Device Profile ID

GET /subscriptions/{subscriptionUid}/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 appServers (array)

        List of Application Servers directly associated with the device

        Changed items (object):

        New required properties:

        • ID

        • href

        • Added property ID (string)

          Application Server ID

        • Added property href (string)

          Application Server href

      • Changed property appServersRoutingProfile (object)

        Available when the Device is associated with an AS routing profile

        New required properties:

        • ID

        • Added property ID (string)

          AS routing profile ID

      • Changed property model (object)

        New required properties:

        • ID

        • Added property ID (string)

          Device Profile ID

GET /subscriptions/{subscriptionUid}/multicastGroups

Retrieve Multicast Groups

Return Type:

Changed response : 200 OK

Successful RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property appServers (array)

      List of Application Servers directly associated with the multicast group

      Changed items (object):

      New required properties:

      • ID

      • href

      • Added property ID (string)

        Application Server ID

      • Added property href (string)

        Application Server href

    • Changed property appServersRoutingProfile (object)

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

      New required properties:

      • ID

      • Added property ID (string)

        AS routing profile ID

RDTP-8479

What's New


POST /subscriptions/{subscriptionUid}/devices/domains

Associate Domain with Devices

POST /subscriptions/{subscriptionUid}/multicastGroups/domains

Associate Domain with Multicast Groups

What's Changed


GET /customers

Login

Return Type:

Changed response : 200 OK

Successfully authenticated.

The session ID is returned in a cookie named JSESSIONID. You need to include this cookie in subsequent requests.

  • Changed property subscription (object)

    • Added property domainRestrictions (object)

      User's domain restrictions:

      • If no domain restrictions are defined, the user can access all cross-domain resources and all domain-specific resources
      • Else, the user can access all cross-domain resources and only domain-specific resources matching the domain restrictions
      • Property and (array)

        A resource matches if it matches all and items.

        Items (object):

        A resource matches if it is associated with a domain satisfying the following requirements:

        • The group name of the resource domain is group.name (exact match)
        • If type is PREFIX:
          • The name of the resource domain is prefixed with name
        • Else: (type is FULL)
          • The name of the resource domain is name (exact match)
        • Property type (string)

          Type of domain restriction:

          • FULL: restriction on full domain
          • PREFIX: restriction on domain prefix

          Enum values:

          • FULL
          • PREFIX
        • Property name (string)

          Name of the full domain or domain prefix

        • Property group (object)

          Domain group associated with the domain restriction

          • Property name (string)

            Name of the domain group

    • Changed property grantedPermissions (array)

      Changed items (string):

      Added enum value:

      • s1
PUT /subscriptions/{subscriptionUid}

Update Subscription

Access rights:
  • <Subscription>/RA
  • <Subscription>/s1: MANAGE_SUBSCRIBER
GET /subscriptions/{subscriptionUid}/appServers

Retrieve AppServers

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property deviceCount (integer)

      Number of Devices associated with the Application Server through direct association.

      Devices associated with the Application Server through AS Routing Profiles are not taken into account.

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

    • Changed property multicastGroupCount (integer)

      Number of Multicast Groups associated with the Application Server through direct association.

      Multicast Groups associated with the Application Server through AS Routing Profiles are not taken into account.

      If the authenticated user has domain restrictions, only multicast groups matching the domain restrictions are counted.

GET|PUT /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Retrieve|Update AppServer

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property deviceCount (integer)

    Number of Devices associated with the Application Server through direct association.

    Devices associated with the Application Server through AS Routing Profiles are not taken into account.

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

  • Changed property multicastGroupCount (integer)

    Number of Multicast Groups associated with the Application Server through direct association.

    Multicast Groups associated with the Application Server through AS Routing Profiles are not taken into account.

    If the authenticated user has domain restrictions, only multicast groups matching the domain restrictions are counted.

GET /subscriptions/{subscriptionUid}/devices

Retrieve Devices

Access rights:

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

Parameters:

Added: domain in query

Domain filtering (exact match)

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

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Added property domains (array)

      Items (object):

      The domain must exist in the subscriber account and must be in ACTIVE state to be used.

      • Property name (string)

        Domain name

      • Property group (object)

        • Property name (string)

          Domain group name

POST /subscriptions/{subscriptionUid}/devices

Create Device

Access rights:

If the authenticated user has domain restrictions, the device must match the domain restrictions.

Request:
  • Added property domains (array)

    Items (object):

    The domain must exist in the subscriber account and must be in ACTIVE state to be used.

    • Property name (string)

      Domain name

    • Property group (object)

      • Property name (string)

        Domain group name

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Added property domains (array)

    Items (object):

    The domain must exist in the subscriber account and must be in ACTIVE state to be used.

    • Property name (string)

      Domain name

    • Property group (object)

      • Property name (string)

        Domain group name

GET /subscriptions/{subscriptionUid}/devices/alarms

Retrieve Alarms of all Devices

Access rights:

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

Parameters:

Added: domain in query

Domain filtering (exact match)

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

Return Type:

Changed response : 200 OK

Successful RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property device (object)

      • Added property domains (array)

        Items (object):

        The domain must exist in the subscriber account and must be in ACTIVE state to be used.

        • Property name (string)

          Domain name

        • Property group (object)

          • Property name (string)

            Domain group name

POST /subscriptions/{subscriptionUid}/devices/alarms/ack

Ack Alarms of all Devices

Access rights:

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

GET /subscriptions/{subscriptionUid}/devices/alarms/stateDistributions

Retrieve Alarm States Distribution of all Devices

Access rights:

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

GET /subscriptions/{subscriptionUid}/devices/clusters

Retrieve Devices clusters

Access rights:

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

Parameters:

Added: domain in query

Domain filtering (exact match)

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

Return Type:

Changed response : 200 OK

Successful RETRIEVE

  • Changed property clusters (array)

    Changed items (object):

    A group a devices close to each other.

    • Changed property item (object)

      • Added property domains (array)

        Items (object):

        The domain must exist in the subscriber account and must be in ACTIVE state to be used.

        • Property name (string)

          Domain name

        • Property group (object)

          • Property name (string)

            Domain group name

GET /subscriptions/{subscriptionUid}/devices/counters

Retrieve Counters

Access rights:

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

GET /subscriptions/{subscriptionUid}/devices/frames

Retrieve FramesDevices

Access rights:

If the authenticated user has domain restrictions, only frames of devices matching the domain restrictions can be retrieved.

POST /subscriptions/{subscriptionUid}/devices/import

Create Import

Access rights:

If the authenticated user has domain restrictions, the import must match the domain restrictions.

Parameters:

Added: domain in query

List of domains associated with the import file:

  • Created devices are associated with the domains after creation
  • Deleted devices must be associated with the domains to be deleted

The list cannot contain more than one domain for a given group.

For each domain, domain group name and domain name must be provided as follow: domain.group.name:domain.name

POST /subscriptions/{subscriptionUid}/devices/tags

Tag Devices

Access rights:

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

GET /subscriptions/{subscriptionUid}/devices/{deviceUid}

Retrieve Device

Access rights:

If the authenticated user has domain restrictions, the device must match the domain restrictions.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property domains (array)

    Items (object):

    The domain must exist in the subscriber account and must be in ACTIVE state to be used.

    • Property name (string)

      Domain name

    • Property group (object)

      • Property name (string)

        Domain group name

PUT /subscriptions/{subscriptionUid}/devices/{deviceUid}

Update Device

Access rights:

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

Request:
  • Added property domains (array)

    Items (object):

    The domain must exist in the subscriber account and must be in ACTIVE state to be used.

    • Property name (string)

      Domain name

    • Property group (object)

      • Property name (string)

        Domain group name

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property domains (array)

    Items (object):

    The domain must exist in the subscriber account and must be in ACTIVE state to be used.

    • Property name (string)

      Domain name

    • Property group (object)

      • Property name (string)

        Domain group name

DELETE /subscriptions/{subscriptionUid}/devices/{deviceUid}
POST /subscriptions/{subscriptionUid}/devices/{deviceUid}/admins/reset
POST /subscriptions/{subscriptionUid}/devices/{deviceUid}/admins/downlink
GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/alarms
POST /subscriptions/{subscriptionUid}/devices/{deviceUid}/alarms/ack
GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/alarms/histories
POST /subscriptions/{subscriptionUid}/devices/{deviceUid}/alarms/{alarmUid}/ack
GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/batLevels
GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/debugLorawanLogs
GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/frames
GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/frames/aggregated
GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/locations
PUT /subscriptions/{subscriptionUid}/devices/{deviceUid}/restricted
GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/spreadingFactors/sfDistributions
GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/tags
POST /subscriptions/{subscriptionUid}/devices/{deviceUid}/tags
DELETE /subscriptions/{subscriptionUid}/devices/{deviceUid}/tags/{tagUid}
Access rights:

If the authenticated user has domain restrictions, the device must match the domain restrictions.

GET /subscriptions/{subscriptionUid}/multicastGroups

Retrieve Multicast Groups

Access rights:

If the authenticated user has domain restrictions, only multicast groups matching the domain restrictions can be retrieved.

Parameters:

Added: domain in query

Domain filtering (exact match)

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

Return Type:

Changed response : 200 OK

Successful RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Added property domains (array)

      Items (object):

      The domain must exist in the subscriber account and must be in ACTIVE state to be used.

      • Property name (string)

        Domain name

      • Property group (object)

        • Property name (string)

          Domain group name

POST /subscriptions/{subscriptionUid}/multicastGroups

Create Multicast Group

Access rights:

If the authenticated user has domain restrictions, the multicast group must match the domain restrictions.

Request:
  • Added property domains (array)

    Items (object):

    The domain must exist in the subscriber account and must be in ACTIVE state to be used.

    • Property name (string)

      Domain name

    • Property group (object)

      • Property name (string)

        Domain group name

Return Type:

Changed response : 201 Created

Successful CREATE, UPDATE or RETRIEVE

  • Added property domains (array)

    Items (object):

    The domain must exist in the subscriber account and must be in ACTIVE state to be used.

    • Property name (string)

      Domain name

    • Property group (object)

      • Property name (string)

        Domain group name

GET /subscriptions/{subscriptionUid}/multicastGroups/frames
GET /subscriptions/{subscriptionUid}/multicastGroups/frames/aggregated
Access rights:

If the authenticated user has domain restrictions, only frames of multicast groups matching the domain restrictions can be retrieved.

GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}

Retrieve Multicast Group

Access rights:

If the authenticated user has domain restrictions, the multicast group must match the domain restrictions.

Return Type:

Changed response : 200 OK

Successful CREATE, UPDATE or RETRIEVE

  • Added property domains (array)

    Items (object):

    The domain must exist in the subscriber account and must be in ACTIVE state to be used.

    • Property name (string)

      Domain name

    • Property group (object)

      • Property name (string)

        Domain group name

PUT /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}

Update Multicast Group

Access rights:

If the authenticated user has domain restrictions, the multicast group must match the domain restrictions before and after the update.

Request:
  • Added property domains (array)

    Items (object):

    The domain must exist in the subscriber account and must be in ACTIVE state to be used.

    • Property name (string)

      Domain name

    • Property group (object)

      • Property name (string)

        Domain group name

Return Type:

Changed response : 200 OK

Successful CREATE, UPDATE or RETRIEVE

  • Added property domains (array)

    Items (object):

    The domain must exist in the subscriber account and must be in ACTIVE state to be used.

    • Property name (string)

      Domain name

    • Property group (object)

      • Property name (string)

        Domain group name

DELETE /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}
POST /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/admins/downlink
GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/alarms
POST /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/alarms/ack
GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/alarms/histories
POST /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/alarms/{alarmUid}/ack
Access rights:

If the authenticated user has domain restrictions, the multicast group must match the domain restrictions.

GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/bss

Retrieve Multicast Group Base Stations

Access rights:

If the authenticated user has domain restrictions, the multicast group must match the domain restrictions.

Return Type:

Changed response : 200 OK

Successful RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Added property href (string)

      Base Station href (only returned if the base station belongs to the subscriber).

      If the authenticated user has domain restrictions, only returned if the base station matches the domain restrictions.

GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/bss/tags
POST /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/bss/tags
DELETE /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/bss/tags/{tagUid}
GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/frames
GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/frames/aggregated
Access rights:

If the authenticated user has domain restrictions, the multicast group must match the domain restrictions.

Release 7.1

RDTP-13438

What's Changed


GET|PUT /subscriptions/{subscriptionUid}

Retrieve Subscription

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property baseStationTagsNamespace (string)

    This parameter must no longer be used: always set to ALL.

    Added enum value:

    • ALL: Base Station tags defined in the Operator Namespace and the Subscriber Namespace are used for Multicast purposes.
GET /subscriptions/{subscriptionUid}/multicastDownlinkSettings

Retrieve Multicast Downlink Settings

Parameters:

Added: bsTagNamespace in query

Base Station Tag namespace:

  • OPERATOR: public tag managed by the Operator
  • SUBSCRIBER: private tag managed by the Subscriber
GET /subscriptions/{subscriptionUid}/multicastGroups

Retrieve Multicast Groups

Return Type:

Changed response : 200 OK

Successful RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property bss (object)

      • Changed property tags (array)

        Base Station tags associated with the multicast group

        Changed items (object):

        New required properties:

        • namespace

        • Added property namespace (string)

          Base Station tag namespace:

          • OPERATOR: public tag managed by the Operator
          • SUBSCRIBER: private tag managed by the Subscriber

          Enum values:

          • OPERATOR
          • SUBSCRIBER
POST /subscriptions/{subscriptionUid}/multicastGroups

Create Multicast Group

Request:
  • Changed property bss (object)

    • Changed property tags (array)

      Base Station tags associated with the multicast group

      Changed items (object):

      • Added property namespace (string)

        Base Station tag namespace:

        • OPERATOR: public tag managed by the Operator
        • SUBSCRIBER: private tag managed by the Subscriber

        Enum values:

        • OPERATOR
        • SUBSCRIBER
Return Type:

Changed response : 201 Created

Successful CREATE, UPDATE or RETRIEVE

  • Changed property bss (object)

    • Changed property tags (array)

      Base Station tags associated with the multicast group

      Changed items (object):

      New required properties:

      • namespace

      • Added property namespace (string)

        Base Station tag namespace:

        • OPERATOR: public tag managed by the Operator
        • SUBSCRIBER: private tag managed by the Subscriber

        Enum values:

        • OPERATOR
        • SUBSCRIBER
GET /subscriptions/{subscriptionUid}/multicastGroups/bss/tags/suggestions

Retrieve Base Station Tag Suggestions

Parameters:

Changed: exclude in query

Syntax: <name>,<namespace>

Excludes any Base Station tag matching the <name> (exact match) in the <namespace>.

<namespace> may be:

  • OPERATOR: public tag managed by the Operator
  • SUBSCRIBER: private tag managed by the Subscriber
Return Type:

Changed response : 200 OK

Successful RETRIEVE

  • Changed property briefs (array)

    List of tags matching the query string

    Changed items (object):

    New required properties:

    • namespace

    • Added property namespace (string)

      Tag namespace:

      • OPERATOR: public tag managed by the Operator
      • SUBSCRIBER: private tag managed by the Subscriber

      Enum values:

      • OPERATOR
      • SUBSCRIBER
GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}

Retrieve Multicast Group

Return Type:

Changed response : 200 OK

Successful CREATE, UPDATE or RETRIEVE

  • Changed property bss (object)

    • Changed property tags (array)

      Base Station tags associated with the multicast group

      Changed items (object):

      New required properties:

      • namespace

      • Added property namespace (string)

        Base Station tag namespace:

        • OPERATOR: public tag managed by the Operator
        • SUBSCRIBER: private tag managed by the Subscriber

        Enum values:

        • OPERATOR
        • SUBSCRIBER
PUT /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}

Update Multicast Group

Request:
  • Changed property bss (object)

    • Changed property tags (array)

      Base Station tags associated with the multicast group

      Changed items (object):

      • Added property namespace (string)

        Base Station tag namespace:

        • OPERATOR: public tag managed by the Operator
        • SUBSCRIBER: private tag managed by the Subscriber

        Enum values:

        • OPERATOR
        • SUBSCRIBER
Return Type:

Changed response : 200 OK

Successful CREATE, UPDATE or RETRIEVE

  • Changed property bss (object)

    • Changed property tags (array)

      Base Station tags associated with the multicast group

      Changed items (object):

      New required properties:

      • namespace

      • Added property namespace (string)

        Base Station tag namespace:

        • OPERATOR: public tag managed by the Operator
        • SUBSCRIBER: private tag managed by the Subscriber

        Enum values:

        • OPERATOR
        • SUBSCRIBER
GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/bss

Retrieve Multicast Group Base Stations

Return Type:

Changed response : 200 OK

Successful RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property tags (array)

      Tags associated with the multicast group and matching the Base Station

      Changed items (object):

      New required properties:

      • namespace

      • Added property namespace (string)

        Base Station tag namespace:

        • OPERATOR: public tag managed by the Operator
        • SUBSCRIBER: private tag managed by the Subscriber

        Enum values:

        • OPERATOR
        • SUBSCRIBER
GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/bss/tags

Retrieve Multicast Group Base Station Tags

Return Type:

Changed response : 200 OK

Successful RETRIEVE

  • Changed property briefs (array)

    Base Station tags associated with the multicast group

    Changed items (object):

    New required properties:

    • namespace

    • Added property namespace (string)

      Base Station tag namespace:

      • OPERATOR: public tag managed by the Operator
      • SUBSCRIBER: private tag managed by the Subscriber

      Enum values:

      • OPERATOR
      • SUBSCRIBER
POST /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/bss/tags

Associate Base Station Tag

Request:
  • Added property namespace (string)

    Base Station tag namespace:

    • OPERATOR: public tag managed by the Operator
    • SUBSCRIBER: private tag managed by the Subscriber

    Enum values:

    • OPERATOR
    • SUBSCRIBER
Return Type:

Changed response : 200 OK

Successful CREATE

New required properties:

  • namespace
  • Added property namespace (string)

    Base Station tag namespace:

    • OPERATOR: public tag managed by the Operator
    • SUBSCRIBER: private tag managed by the Subscriber

    Enum values:

    • OPERATOR
    • SUBSCRIBER
PUT /subscriptions/{subscriptionUid}/restricted

Update Restricted Settings

Request:
  • Changed property baseStationTagsNamespace (string)

    This parameter must no longer be used: always set to ALL.

    Added enum value:

    • ALL: Base Station tags defined in the Operator Namespace and the Subscriber Namespace are used for Multicast purposes.
Return Type:

Changed response : 200 OK

Successful UPDATE

  • Changed property baseStationTagsNamespace (string)

    This parameter must no longer be used: always set to ALL.

    Added enum value:

    • ALL: Base Station tags defined in the Operator Namespace and the Subscriber Namespace are used for Multicast purposes.

What's Deprecated


GET /subscriptions/{subscriptionUid}/managedCustomerNetwork/bss

Retrieve Base Stations

GET /subscriptions/{subscriptionUid}/managedCustomerNetwork/bss/tags

Retrieve Base Station Tags

POST /subscriptions/{subscriptionUid}/managedCustomerNetwork/bss/tags

Associate Base Station Tag

DELETE/subscriptions/{subscriptionUid}/managedCustomerNetwork/bss/tags/{tagUid}

Remove Base Station Tag

GET /subscriptions/{subscriptionUid}/managedCustomerNetwork/bss/tags/suggestions

Retrieve Base Station Tag Suggestions

GET /subscriptions/{subscriptionUid}/managedCustomerNetwork/frames

Retrieve Managed Customer Network Frames

RDTP-14994

What's New


GET /subscriptions/{subscriptionUid}/devices/clusters

Retrieve Devices clusters

RDTP-16248

What's Changed


POST /subscriptions/{subscriptionUid}/devices/import

Create Import

Parameters:

Added: forceDevAddrs in query

When enabled, DevAddr of OTAA devices present in the import file are assigned permanently. When disabled, a different DevAddr is used on join request if it is not part of the DevAddr pool.

Request:

The device importation CSV file is updated for ABP activation:

ColumnDefinitionCardinality
E

LoRaWAN FNwkSIntKey/NwkSKey
Supported encoding modes:

  • Clear text (hexadecimal encoding)
  • Encrypted with TWA Exchange Key (RSA) version specified in column X (base64 encoding)
Mandatory
F

LoRaWAN AppSKeys
Supported encoding modes:

  • Clear text (hexadecimal encoding)
  • Encrypted with TWA Exchange Key (RSA) version specified in column X (base64 encoding)
Optional
U

LoRaWAN SNwkSIntKey
Supported encoding modes:

  • Clear text (hexadecimal encoding)
  • Encrypted with TWA Exchange Key (RSA) version specified in column X (base64 encoding)
Mandatory for LoRaWAN 1.1 device, Forbidden otherwise.
V

LoRaWAN NwkSEncKey
Supported encoding modes:

  • Clear text (hexadecimal encoding)
  • Encrypted with TWA Exchange Key (RSA) version specified in column X (base64 encoding)
Mandatory for LoRaWAN 1.1 device, Forbidden otherwise.
XTWA Exchange Key (RSA) version used to encrypt the FNwkSIntKey/NwkSKey, the AppSKeys, the SNwkSIntKey and the NwkSEncKeyOptional
AADevice stateOptional

The device importation CSV file is updated for OTAA activation:

ColumnDefinitionCardinality
AADevice stateOptional
GET /subscriptions/{subscriptionUid}/publicExchangeKey

Retrieve Public Exchange Keys

Return Type:

Changed response : 200 OK

  • New content type : application/jwk+json

RDTP-16386

What's Changed


GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/bss

Retrieve Multicast Group Base Stations

Return Type:

Changed response : 200 OK

Successful RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    New required properties:

    • healthState

    • Added property healthState (string)

      Base Station health state

      Enum values:

      • INIT
      • ACTIVE
      • BACKHAUL_CNX_ERROR
      • RF_ERROR
      • SUSPENDED

RDTP-18579

What's Changed


GET /subscriptions/{subscriptionUid}/deviceProfiles

Retrieve DeviceProfiles

Parameters:

Changed: vendorID in query

Device Vendor ID filtering (exact match)

RDTP-18668

What's Changed


GET /subscriptions/{subscriptionUid}/networkSubscriptions/{networkSubscriptionUid}

Retrieve NetworkSubscription

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Deprecated property managedCustomerNetwork (boolean)

    Managed Customer Network activation flag

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

RDTP-18737

What's Changed


GET /subscriptions/{subscriptionUid}/devices/frames
GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/frames/aggregated
GET /subscriptions/{subscriptionUid}/multicastGroups/frames/aggregated
GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/frames/aggregated
Parameters:

Added: timezone in query

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

RDTP-18887

What's Changed


GET /subscriptions/{subscriptionUid}/devices

Retrieve Devices

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property networkSubscription (object)

      Network subscription associated with the device

      New required property:

      • ID

      • Added property ID (string)

        ID of the associated connectivity plan

      • Changed property supplier (object)

        New required property:

        • ID

        • Added property ID (string)

          ID of the associated connectivity supplier

GET /subscriptions/{subscriptionUid}/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 networkSubscription (object)

        Network subscription associated with the device

        New required property:

        • ID

        • Added property ID (string)

          ID of the associated connectivity plan

        • Changed property supplier (object)

          New required property:

          • ID

          • Added property ID (string)

            ID of the associated connectivity supplier

GET /subscriptions/{subscriptionUid}/multicastGroups

Retrieve Multicast Groups

Return Type:

Changed response : 200 OK

Successful RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property networkSubscription (object)

      Network subscription associated with the multicast group

      New required property:

      • ID

      • Added property ID (string)

        ID of the associated connectivity plan

      • Changed property supplier (object)

        New required property:

        • ID

        • Added property ID (string)

          ID of the associated connectivity supplier

RDTP-7558

What's Changed


POST /subscriptions/{subscriptionUid}/appServers

Create AppServer

Request:

Updated HTTP_CELLULAR type:

  • Added property customHttpHeaders (array)

    A list of HTTP headers to be added in HTTP requests sent to the application. Accept, Host, User-Agent, Content-Length and Content-Type headers cannot be customized. A given HTTP header name can be configured only once (case insensitive).

    Items (object):

    • Property name (string)

      Custom HTTP header name

    • Property value (string)

      Custom HTTP header value

Updated HTTP type:

  • Added property customHttpHeaders (array)

    A list of HTTP headers to be added in HTTP requests sent to the application. Accept, Host, User-Agent, Content-Length and Content-Type headers cannot be customized. A given HTTP header name can be configured only once (case insensitive).

    Items (object):

    • Property name (string)

      Custom HTTP header name

    • Property value (string)

      Custom HTTP header value

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Updated HTTP_CELLULAR type:

  • Added property customHttpHeaders (array)

    A list of HTTP headers to be added in HTTP requests sent to the application. Accept, Host, User-Agent, Content-Length and Content-Type headers cannot be customized. A given HTTP header name can be configured only once (case insensitive).

    Items (object):

    • Property name (string)

      Custom HTTP header name

    • Property value (string)

      Custom HTTP header value

Updated HTTP type:

  • Added property customHttpHeaders (array)

    A list of HTTP headers to be added in HTTP requests sent to the application. Accept, Host, User-Agent, Content-Length and Content-Type headers cannot be customized. A given HTTP header name can be configured only once (case insensitive).

    Items (object):

    • Property name (string)

      Custom HTTP header name

    • Property value (string)

      Custom HTTP header value

GET /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Retrieve AppServer

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated HTTP_CELLULAR type:

  • Added property customHttpHeaders (array)

    A list of HTTP headers to be added in HTTP requests sent to the application. Accept, Host, User-Agent, Content-Length and Content-Type headers cannot be customized. A given HTTP header name can be configured only once (case insensitive).

    Items (object):

    • Property name (string)

      Custom HTTP header name

    • Property value (string)

      Custom HTTP header value

Updated HTTP type:

  • Added property customHttpHeaders (array)

    A list of HTTP headers to be added in HTTP requests sent to the application. Accept, Host, User-Agent, Content-Length and Content-Type headers cannot be customized. A given HTTP header name can be configured only once (case insensitive).

    Items (object):

    • Property name (string)

      Custom HTTP header name

    • Property value (string)

      Custom HTTP header value

PUT /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Update AppServer

Request:

Updated HTTP_CELLULAR type:

  • Added property customHttpHeaders (array)

    A list of HTTP headers to be added in HTTP requests sent to the application. Accept, Host, User-Agent, Content-Length and Content-Type headers cannot be customized. A given HTTP header name can be configured only once (case insensitive).

    Items (object):

    • Property name (string)

      Custom HTTP header name

    • Property value (string)

      Custom HTTP header value

Updated HTTP type:

  • Added property customHttpHeaders (array)

    A list of HTTP headers to be added in HTTP requests sent to the application. Accept, Host, User-Agent, Content-Length and Content-Type headers cannot be customized. A given HTTP header name can be configured only once (case insensitive).

    Items (object):

    • Property name (string)

      Custom HTTP header name

    • Property value (string)

      Custom HTTP header value

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated HTTP_CELLULAR type:

  • Added property customHttpHeaders (array)

    A list of HTTP headers to be added in HTTP requests sent to the application. Accept, Host, User-Agent, Content-Length and Content-Type headers cannot be customized. A given HTTP header name can be configured only once (case insensitive).

    Items (object):

    • Property name (string)

      Custom HTTP header name

    • Property value (string)

      Custom HTTP header value

Updated HTTP type:

  • Added property customHttpHeaders (array)

    A list of HTTP headers to be added in HTTP requests sent to the application. Accept, Host, User-Agent, Content-Length and Content-Type headers cannot be customized. A given HTTP header name can be configured only once (case insensitive).

    Items (object):

    • Property name (string)

      Custom HTTP header name

    • Property value (string)

      Custom HTTP header value

RDTP-8978

What's Changed


GET /subscriptions/{subscriptionUid}/appServersRoutingProfiles

Retrieve AppServersRoutingProfiles

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property hsmSecurity (object)

      • Added property asKeyLabel (string)

        Label of the generated AS Transport Key.

POST /subscriptions/{subscriptionUid}/appServersRoutingProfiles

Create AppServersRoutingProfile

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Changed property hsmSecurity (object)

    • Added property asKeyLabel (string)

      Label of the generated AS Transport Key.

GET /subscriptions/{subscriptionUid}/appServersRoutingProfiles/{appServersRoutingProfileUid}

Retrieve AppServersRoutingProfile

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property hsmSecurity (object)

    • Added property asKeyLabel (string)

      Label of the generated AS Transport Key.

PUT /subscriptions/{subscriptionUid}/appServersRoutingProfiles/{appServersRoutingProfileUid}

Update AppServersRoutingProfile

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property hsmSecurity (object)

    • Added property asKeyLabel (string)

      Label of the generated AS Transport Key.

GET /subscriptions/{subscriptionUid}/appServersRoutingProfiles/{appServersRoutingProfileUid}/security

Retrieve SecurityAppServersRoutingProfile

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property hsmSecurity (object)

    • Added property asKeyLabel (string)

      Label of the generated AS Transport Key.

PUT /subscriptions/{subscriptionUid}/appServersRoutingProfiles/{appServersRoutingProfileUid}/security

Update SecurityAppServersRoutingProfile

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property hsmSecurity (object)

    • Added property asKeyLabel (string)

      Label of the generated AS Transport Key.

Release 7.0

RDTP-10309

What's Changed


GET /subscriptions/{subscriptionUid}/appServersRoutingProfiles

Retrieve AppServersRoutingProfiles

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Added property hsmSecurity (object)

      • Property hsmGroupID (string)

        ID of HSM group used to generate the AS Key.

      • Property status (string)

        HSM security status

        Enum values:

        • HSM_AS_KEY
        • NONE
GET /subscriptions/{subscriptionUid}/devices

Retrieve Devices

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    Updated LORAWAN connectivity:

    • Added property payloadEncryption (boolean)

      TRUE when payloads are reported encrypted to Application Servers

POST /subscriptions/{subscriptionUid}/devices

Create Device

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Updated LORAWAN connectivity:

  • Added property payloadEncryption (boolean)

    TRUE when payloads are reported encrypted to Application Servers

GET /subscriptions/{subscriptionUid}/devices/{deviceUid}

Retrieve Device

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated LORAWAN connectivity:

  • Added property payloadEncryption (boolean)

    TRUE when payloads are reported encrypted to Application Servers

PUT /subscriptions/{subscriptionUid}/devices/{deviceUid}

Update Device

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated LORAWAN connectivity:

  • Added property payloadEncryption (boolean)

    TRUE when payloads are reported encrypted to Application Servers

RDTP-11832

What's Changed


GET /subscriptions/{subscriptionUid}/devices

Retrieve Devices

Parameters:

Changed: sort in query

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

The following attributes are supported:

  • 'name': by name
  • 'avgSNR': by average SNR
  • 'avgESP': by average ESP
  • 'lastSF': by spreading factor of the last uplink frame
  • 'lastUpTimestamp': by timestamp of the last downlink frame
  • 'lastDwTimestamp': by timestamp of the last uplink frame
  • 'lastBatLevel': by battery level
  • 'creationDate': by date of creation of the device
  • 'lastMeanPER': by last mean PER without consideration for LRRs
  • 'EUI': by DevEUI/IMEI

The following orders are supported:

  • 'asc': ascending order
  • 'desc': descending order

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

Changed: tag in query

Tag name filtering (exact match)

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

  • count
  • Added property count (integer)

    Total number of matching devices

  • 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

POST /subscriptions/{subscriptionUid}/devices/tags

Tag Devices

Parameters:

Added: sort in query

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

Following attributes are supported:

  • 'name': by name
  • 'avgSNR': by average SNR
  • 'avgESP': by average ESP
  • 'lastSF': by spreading factor of the last uplink frame
  • 'lastUpTimestamp': by timestamp of the last downlink frame
  • 'lastDwTimestamp': by timestamp of the last uplink frame
  • 'lastBatLevel': by battery level
  • 'creationDate': by date of creation of the device
  • 'lastMeanPER': by last mean PER without consideration for LRRs

Following orders are supported:

  • 'asc': ascending order
  • 'desc': descending order

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

Changed: tag in query

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

GET /subscriptions/{subscriptionUid}/multicastGroups

Retrieve Multicast Groups

Parameters:

Added: query in query

Search multicast groups with a devEUI or a name containing the provided term. (prefix match)

Added: sort in query

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

Following attributes are supported:

  • 'name': by name
  • 'lastDwTimestamp': by timestamp of the last uplink frame
  • 'creationDate': by date of creation of the multicast group

Following orders are supported:

  • 'asc': ascending order
  • 'desc': descending order

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

Changed: bsTag in query

Base Station Tag name filtering (exact match)

Return Type:

Changed response : 200 OK

Successful RETRIEVE

New required properties:

  • count
  • Added property count (integer)

    Total number of matching multicast groups

RDTP-12468

What's Changed


GET /subscriptions/{subscriptionUid}/devices

Retrieve Devices

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    Updated LORAWAN connectivity:

    • Added property activation (string)

      Type of activation associated to the device:

      • ABP: Activation By Personalization
      • OTAA: Over The Air Activation

      Enum values:

      • ABP
      • OTAA
    • Added property currentClass (string)

      LoRaWAN class currently used by the Device

      Enum values:

      • A
      • B
      • C
    • Added property lastBatLevelTimestamp (integer)

    • Added property lastNbTrans (number)

      Last number of transmissions

    • Added property lastTxPower (number)

      Last TX Power in dBm

    • Added property customerAdminData (string)

      Free administrative data associated to the device (e.g. floor number, building, addresss...).

    • Added property firstUpTimestamp (integer)

      First contact timestamp with the ThingPark Infrastructure, epoch time in milliseconds.

    • Added property motionIndicator (string)

      Motion indicator of the device:

      • NEAR_STATIC
      • WALKING_SPEED
      • BIKE_SPEED
      • VEHICLE_SPEED
      • RANDOM

      Enum values:

      • NEAR_STATIC
      • WALKING_SPEED
      • BIKE_SPEED
      • VEHICLE_SPEED
      • RANDOM
    • Added property occContext (object)

      • Property lastUpdate (integer)

        Timestamp of last device update, epoch time in milliseconds.

      • Property who (string)

        Name of last device updater.

POST /subscriptions/{subscriptionUid}/devices

Create Device

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Updated LORAWAN connectivity:

  • Added property lastNbTrans (number)

    Last number of transmissions

  • Added property lastTxPower (number)

    Last TX Power in dBm

GET /subscriptions/{subscriptionUid}/devices/{deviceUid}

Retrieve Device

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated LORAWAN connectivity:

  • Added property lastNbTrans (number)

    Last number of transmissions

  • Added property lastTxPower (number)

    Last TX Power in dBm

PUT /subscriptions/{subscriptionUid}/devices/{deviceUid}

Update Device

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated LORAWAN connectivity:

  • Added property lastNbTrans (number)

    Last number of transmissions

  • Added property lastTxPower (number)

    Last TX Power in dBm

RDTP-12749

What's New


POST /subscriptions/{subscriptionUid}/devices/readOnboardingTag

Read Onboarding Tag

What's Changed


POST /subscriptions/{subscriptionUid}/devices/import

Create Import

Request:

The device importation CSV file is updated for OTAA activation:

ColumnDefinitionCardinality
BLoRaWAN DevEUI or onboarding tagMandatory

RDTP-12789

What's Changed


GET /subscriptions/{subscriptionUid}

Retrieve Subscription

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property options (object)

    New required properties:

    • license

    • Added property license (string)

      License option:

      • DEACTIVATED
      • ACTIVATED

      Enum values:

      • DEACTIVATED
      • ACTIVATED
PUT /subscriptions/{subscriptionUid}

Update Subscription

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property options (object)

    New required properties:

    • license

    • Added property license (string)

      License option:

      • DEACTIVATED
      • ACTIVATED

      Enum values:

      • DEACTIVATED
      • ACTIVATED
GET /subscriptions/{subscriptionUid}/appServers

Retrieve AppServers

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Added property validationState (string)

      Application Server validation state:

      • VALIDATED: The application server is available for activation.
      • SUSPENDED: The application server is suspended because of long time license expiration. Uplink frames from the associated devices are not forwarded to the application server and the application server is not able to send downlink payloads.

      Enum values:

      • VALIDATED
      • SUSPENDED
POST /subscriptions/{subscriptionUid}/appServers

Create AppServer

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

New required properties:

  • validationState
  • Added property validationState (object)

    Enum values:

    • VALIDATED
    • SUSPENDED
GET /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Retrieve AppServer

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

  • validationState
  • Added property validationState (object)

    Enum values:

    • VALIDATED
    • SUSPENDED
PUT /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Update AppServer

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

  • validationState
  • Added property validationState (object)

    Enum values:

    • VALIDATED
    • SUSPENDED
POST /subscriptions/{subscriptionUid}/appServersRoutingProfiles

Create AppServersRoutingProfile

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Changed property appServers (array)

    Changed items (object):

    • Added property validationState (object)

      Enum values:

      • VALIDATED
      • SUSPENDED
GET /subscriptions/{subscriptionUid}/appServersRoutingProfiles/{appServersRoutingProfileUid}

Retrieve AppServersRoutingProfile

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property appServers (array)

    Changed items (object):

    • Added property validationState (object)

      Enum values:

      • VALIDATED
      • SUSPENDED
PUT /subscriptions/{subscriptionUid}/appServersRoutingProfiles/{appServersRoutingProfileUid}

Update AppServersRoutingProfile

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property appServers (array)

    Changed items (object):

    • Added property validationState (object)

      Enum values:

      • VALIDATED
      • SUSPENDED

RDTP-12952

What's Changed


GET /subscriptions/{subscriptionUid}/appServers

Retrieve AppServers

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Added required property healthState (string)

      Application server health state:

      • ACTIVE: the application is up and running
      • INIT: the application server is in a transient state, for example connection is being established
      • ERROR: the application server is unreachable
      • DEACTIVATED: the application server is deactivated

      Enum values:

      • ACTIVE
      • INIT
      • ERROR
      • DEACTIVATED
    • Changed property iotFlowConnector (object)

      • Added required property state (nullable string)

        IoT Flow Connector state:

        • OPENED: the connection is up and running
        • OPENING: the connection is currently opening
        • CLOSED: the connection is closed
        • CLOSING: the connection is currently closing
        • AUTHENTICATING: the connection is currently authenticating
        • AUTHENTICATION_FAILED: failed to authenticate on the remote server with provided credentials
        • UNREACHABLE: the remote server is unreachable and therefore the connection will be retried
        • DEACTIVATED: the connection is deactivated

        The state may be null (unknown) if IoT Flow is unreachable.

        Enum values:

        • OPENED
        • OPENING
        • CLOSED
        • CLOSING
        • AUTHENTICATING
        • AUTHENTICATION_FAILED
        • UNREACHABLE
        • DEACTIVATED
POST /subscriptions/{subscriptionUid}/appServers, GET|PUT /subscriptions/{subscriptionUid}/appServers/{appServerUid}
Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added required property healthState (string)

    Application server health state:

    • ACTIVE: the application is up and running
    • INIT: the application server is in a transient state, for example connection is being established
    • ERROR: the application server is unreachable
    • DEACTIVATED: the application server is deactivated

    Enum values:

    • ACTIVE
    • INIT
    • ERROR
    • DEACTIVATED

RDTP-13010

What's Changed


POST /subscriptions/{subscriptionUid}/multicastGroups

Create Multicast Group

Parameters:

Added: async in query

Triggers the asynchronous behavior. When not set, the synchronous behavior is triggered.

Return Type:

New response : 202 Accepted

Asynchronous task is successfully created. Task href is returned in Location HTTP header.

DELETE /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}

Delete Multicast Group

Parameters:

Added: async in query

Triggers the asynchronous behavior. When not set, the synchronous behavior is triggered.

Return Type:

New response : 202 Accepted

Asynchronous task is successfully created. Task href is returned in Location HTTP header.

RDTP-13941

What's Changed


GET /subscriptions/{subscription}/appServers

Retrieve AppServers

Parameters:

Changed: iotFlowConnectorId in query

Returns Application Servers matching IoT Flow Connector ID.

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

By default, all Application Servers are returned.

Added enum value:

  • actility-thingpark-location-iot
Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property iotFlowConnector (object)

      • Changed property connectorId (string)

        IoT Flow Connector ID:

        • actility-aws-iot: Amazon AWS IoT
        • actility-azure-iot: Azure IoT Hub
        • actility-mqtt-iot: MQTT
        • actility-thingpark-location-iot: ThingPark Location
        • actility-thingworx-iot: ThingWorx
        • actility-watson-iot: IBM Watson IoT

        Added enum value:

        • actility-thingpark-location-iot
POST /subscriptions/{subscription}/appServers

Create AppServer

Request:

Updated KAFKA type:

  • Changed property iotFlowConnector (object)

    Added 'actility-thingpark-location-iot' connectorId:

    • Property configuration (object)

      • Property accountId (string)

        ID of the ThingPark Location account.

      • Property apiKey (string)

        API key of the ThingPark Location account.

    • Changed property connectorId (string)

      IoT Flow Connector ID:

      • actility-aws-iot: Amazon AWS IoT
      • actility-azure-iot: Azure IoT Hub
      • actility-mqtt-iot: MQTT
      • actility-thingpark-location-iot: ThingPark Location
      • actility-thingworx-iot: ThingWorx
      • actility-watson-iot: IBM Watson IoT

      Added enum value:

      • actility-thingpark-location-iot
Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Updated KAFKA type:

  • Changed property iotFlowConnector (object)

    Added 'actility-thingpark-location-iot' connectorId:

    • Property configuration (object)

      • Property accountId (string)

        ID of the ThingPark Location account.

      • Property apiKey (string)

        API key of the ThingPark Location account.

    • Changed property connectorId (string)

      IoT Flow Connector ID:

      • actility-aws-iot: Amazon AWS IoT
      • actility-azure-iot: Azure IoT Hub
      • actility-mqtt-iot: MQTT
      • actility-thingpark-location-iot: ThingPark Location
      • actility-thingworx-iot: ThingWorx
      • actility-watson-iot: IBM Watson IoT

      Added enum value:

      • actility-thingpark-location-iot
GET /subscriptions/{subscription}/appServers/{appServer}

Retrieve AppServer

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated KAFKA type:

  • Changed property iotFlowConnector (object)

    Added 'actility-thingpark-location-iot' connectorId:

    • Property configuration (object)

      • Property accountId (string)

        ID of the ThingPark Location account.

      • Property apiKey (string)

        API key of the ThingPark Location account.

    • Changed property connectorId (string)

      IoT Flow Connector ID:

      • actility-aws-iot: Amazon AWS IoT
      • actility-azure-iot: Azure IoT Hub
      • actility-mqtt-iot: MQTT
      • actility-thingpark-location-iot: ThingPark Location
      • actility-thingworx-iot: ThingWorx
      • actility-watson-iot: IBM Watson IoT

      Added enum value:

      • actility-thingpark-location-iot
PUT /subscriptions/{subscription}/appServers/{appServer}

Update AppServer

Request:

Updated KAFKA type:

  • Changed property iotFlowConnector (object)

    Added 'actility-thingpark-location-iot' connectorId:

    • Property configuration (object)

      • Property accountId (string)

        ID of the ThingPark Location account.

      • Property apiKey (string)

        API key of the ThingPark Location account.

    • Changed property connectorId (string)

      IoT Flow Connector ID:

      • actility-aws-iot: Amazon AWS IoT
      • actility-azure-iot: Azure IoT Hub
      • actility-mqtt-iot: MQTT
      • actility-thingpark-location-iot: ThingPark Location
      • actility-thingworx-iot: ThingWorx
      • actility-watson-iot: IBM Watson IoT

      Added enum value:

      • actility-thingpark-location-iot
Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated KAFKA type:

  • Changed property iotFlowConnector (object)

    Added 'actility-thingpark-location-iot' connectorId:

    • Property configuration (object)

      • Property accountId (string)

        ID of the ThingPark Location account.

      • Property apiKey (string)

        API key of the ThingPark Location account.

    • Changed property connectorId (string)

      IoT Flow Connector ID:

      • actility-aws-iot: Amazon AWS IoT
      • actility-azure-iot: Azure IoT Hub
      • actility-mqtt-iot: MQTT
      • actility-thingpark-location-iot: ThingPark Location
      • actility-thingworx-iot: ThingWorx
      • actility-watson-iot: IBM Watson IoT

      Added enum value:

      • actility-thingpark-location-iot

RDTP-15489

What's Changed


GET /subscriptions/{subscriptionUid}/appServers

Retrieve AppServers

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property tpxIotFlow (object)

      • Added property state (string)

        State of the associated Connection in TPX IoT Flow

RDTP-15745

What's Changed


GET /subscriptions/{subscriptionUid}/networkSubscriptions

Retrieve NetworkSubscriptions

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    New required properties:

    • maxDestinationPerRoute

    • Added property maxDestinationPerRoute (integer)

      Maximal number of destinations for a route.

RDTP-16525

What's Changed


GET /subscriptions/{subscriptionUid}/appServers

Retrieve AppServers

Parameters:

Deleted: iotFlowConnectorId in query

Returns Application Servers matching IoT Flow Connector ID.

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

By default, all Application Servers are returned.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Deleted property iotFlowConnector (object)
POST /subscriptions/{subscriptionUid}/appServers

Create AppServer

Request:

Updated KAFKA type:

  • Deleted property iotFlowConnector (object)
Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Updated KAFKA type:

  • Deleted property iotFlowConnector (object)
GET /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Retrieve AppServer

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated KAFKA type:

  • Deleted property iotFlowConnector (object)
PUT /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Update AppServer

Request:

Updated KAFKA type:

  • Deleted property iotFlowConnector (object)
Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated KAFKA type:

  • Deleted property iotFlowConnector (object)

RDTP-2274

What's New


POST /subscriptions/{subscriptionUid}/devices/tags

Tag Devices

GET /subscriptions/{subscriptionUid}/devices/tags/suggestions

Retrieve Device Tag Suggestions

GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/tags

Retrieve Tags

POST /subscriptions/{subscriptionUid}/devices/{deviceUid}/tags

Add Tag

DELETE /subscriptions/{subscriptionUid}/devices/{deviceUid}/tags/{tagUid}

Remove Tag

PUT /subscriptions/{subscriptionUid}/restricted

Update Restricted Settings

What's Changed


GET /subscriptions/{subscriptionUid}

Retrieve Subscription

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

  • baseStationTagsNamespace
  • Added property baseStationTagsNamespace (string)

    Base Station Tags Namespace:

    • When set to OPERATOR, Base Station tags defined in the Operator Namespace are used for Multicast and Managed Customer Network purposes.
    • When set to SUBSCRIBER, Base Station tags defined in the Subscriber Namespace are used for Multicast and Managed Customer Network purposes.

    Enum values:

    • OPERATOR
    • SUBSCRIBER
PUT /subscriptions/{subscriptionUid}

Update Subscription

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

  • baseStationTagsNamespace
  • Added property baseStationTagsNamespace (string)

    Base Station Tags Namespace:

    • When set to OPERATOR, Base Station tags defined in the Operator Namespace are used for Multicast and Managed Customer Network purposes.
    • When set to SUBSCRIBER, Base Station tags defined in the Subscriber Namespace are used for Multicast and Managed Customer Network purposes.

    Enum values:

    • OPERATOR
    • SUBSCRIBER
GET /subscriptions/{subscriptionUid}/devices

Retrieve Devices

Parameters:

Added: tag in query

Tag name filtering (exact match)

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    New required properties:

    • tags

    • Added property tags (array)

      Items (object):

      • Property name (string)

        Tag names associated with the Device

GET /subscriptions/{subscriptionUid}/multicastGroups/bss/tags/suggestions

Retrieve Base Station Tag Suggestions

Parameters:

Added: exclude in query

Excludes any tag name matching this value (exact match)

RDTP-3381

What's Changed


POST /subscriptions/{subscriptionUid}/devices

Create Device

Request:

Updated LORAWAN connectivity:

  • Added property ownerToken (string)

    Owner token proving the ownership of the device

    ABP: FORBIDDEN

    OTAA: OPTIONAL if External Join Server is used, FORBIDDEN otherwise

POST /subscriptions/{subscriptionUid}/devices/import

Create Import

Request:

The device importation CSV file is updated for OTAA activation:

ColumnDefinitionCardinality
YOwner TokenOptional if External Join Server is used, Forbidden otherwise.

RDTP-4710

What's Changed


GET /subscriptions/{subscriptionUid}

Retrieve Subscription

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

  • operator
  • Added property nonRoamingDevicesNetID (string)

    NetID used for non-roaming Devices at Subscription level. NetID defined at Operator level is used if not set.

  • Added property nsID (string)

    NSID at Subscription level. NSID defined at Operator level is used if not set.

  • Added property operator (object)

    • Property nonRoamingDevicesNetID (string)

      NetID used for non-roaming Devices at Operator level.

    • Property nsID (string)

      NSID at Operator level.

    • Property roamingDevicesNetID (string)

      NetID used for roaming Devices at Operator level.

  • Added property roamingDevicesNetID (string)

    NetID used for roaming Devices at Subscription level. NetID defined at Operator level is used if not set.

  • Added property segregationID (string)

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

PUT /subscriptions/{subscriptionUid}

Update Subscription

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

  • operator
  • Added property nonRoamingDevicesNetID (string)

    NetID used for non-roaming Devices at Subscription level. NetID defined at Operator level is used if not set.

  • Added property nsID (string)

    NSID at Subscription level. NSID defined at Operator level is used if not set.

  • Added property operator (object)

    • Property nonRoamingDevicesNetID (string)

      NetID used for non-roaming Devices at Operator level.

    • Property nsID (string)

      NSID at Operator level.

    • Property roamingDevicesNetID (string)

      NetID used for roaming Devices at Operator level.

  • Added property roamingDevicesNetID (string)

    NetID used for roaming Devices at Subscription level. NetID defined at Operator level is used if not set.

  • Added property segregationID (string)

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

GET /subscriptions/{subscriptionUid}/networkSubscriptions

Retrieve NetworkSubscriptions

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Added property prAllowed (boolean)

      True if passive roaming is allowed.

PUT /subscriptions/{subscriptionUid}/restricted

Update Restricted Settings

Request:
  • Added property nonRoamingDevicesNetID (string)

    NetID used for non-roaming Devices at Subscription level.

  • Added property nsID (string)

    NSID at Subscription level.

  • Added property roamingDevicesNetID (string)

    NetID used for roaming Devices at Subscription level.

  • Added property segregationID (string)

    Segregation ID used for Devices.

Return Type:

Changed response : 200 OK

Successful UPDATE

  • Added property nonRoamingDevicesNetID (string)

    NetID used for non-roaming Devices at Subscription level.

  • Added property nsID (string)

    NSID at Subscription level.

  • Added property roamingDevicesNetID (string)

    NetID used for roaming Devices at Subscription level.

  • Added property segregationID (string)

    Segregation ID used for Devices.

RDTP-8481

What's New


GET /subscriptions/{subscriptionUid}/deviceProfiles/export

Export DeviceProfiles

RDTP-9648

What's New


POST /subscriptions/{subscriptionUid}/devices/alarms/ack

Ack Alarms of all Devices

What's Changed


GET /subscriptions/{subscriptionUid}/devices/alarms

Retrieve Alarms of all Devices

Parameters:

Added: pageSize in query

Size of the expected page result.

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

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

Added: devEUI in query

DevEUI filtering (prefix match)

Return Type:

Changed response : 200 OK

Successful RETRIEVE

New required properties:

  • count
  • Added property count (integer)

    Total number of matching alarms

  • Changed property briefs (array)

    Changed items (object):

    New required properties:

    • alarmUid

    • Added property alarmUid (string)

      Alarm Uid identifying the alarm occurrence

RDTP-9925

What's New


GET /subscriptions/{subscriptionUid}/multicastDownlinkSettings

Retrieve Multicast Downlink Settings

GET /subscriptions/{subscriptionUid}/multicastGroups/frames

Retrieve Multicast Groups Frames

GET /subscriptions/{subscriptionUid}/multicastGroups/frames/aggregated

Retrieve Aggregated Multicast Groups Frames

POST /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/admins/downlink

Send Downlink

GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/frames/aggregated

Retrieve Aggregated Multicast Group Frames

What's Changed


POST /subscriptions/{subscriptionUid}/multicastGroups

Create Multicast Group

Request:
  • Added property bss (object)

    • Property tags (array)

      Items (object):

      • Property name (string)

        Base Station tag names associated with the multicast group

Return Type:

Changed response : 201 Created

Successful CREATE, UPDATE or RETRIEVE

  • Added property bss (object)

    • Property tags (array)

      Items (object):

      • Property name (string)

        Base Station tag names associated with the multicast group

GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}

Retrieve Multicast Group

Return Type:

Changed response : 200 OK

Successful CREATE, UPDATE or RETRIEVE

  • Added property bss (object)

    • Property tags (array)

      Items (object):

      • Property name (string)

        Base Station tag names associated with the multicast group

PUT /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}

Update Multicast Group

Return Type:

Changed response : 200 OK

Successful CREATE, UPDATE or RETRIEVE

  • Added property bss (object)

    • Property tags (array)

      Items (object):

      • Property name (string)

        Base Station tag names associated with the multicast group

GET /subscriptions/{subscriptionUid}/appServers

Retrieve AppServers

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    New required properties:

    • multicastGroupCount

    • Added property multicastGroupCount (integer)

      Number of Multicast Groups associated with the Application Server through direct association.

      Multicast Groups associated with the Application Server through AS Routing Profiles are not taken into account.

POST /subscriptions/{subscriptionUid}/appServers

Create AppServer

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

New required properties:

  • multicastGroupCount
  • Added property multicastGroupCount (integer)

    Number of Multicast Groups associated with the Application Server through direct association.

    Multicast Groups associated with the Application Server through AS Routing Profiles are not taken into account.

GET /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Retrieve AppServer

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

  • multicastGroupCount
  • Added property multicastGroupCount (integer)

    Number of Multicast Groups associated with the Application Server through direct association.

    Multicast Groups associated with the Application Server through AS Routing Profiles are not taken into account.

PUT /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Update AppServer

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

New required properties:

  • multicastGroupCount
  • Added property multicastGroupCount (integer)

    Number of Multicast Groups associated with the Application Server through direct association.

    Multicast Groups associated with the Application Server through AS Routing Profiles are not taken into account.

Release 6.1

RDTP-11016

What's New


GET /subscriptions/{subscriptionUid}/appServers/{appServerUid}/iotFlowConnector/metrics

Retrieve IoT Flow Connector Metrics

What's Changed


GET /subscriptions/{subscriptionUid}/appServers

Retrieve AppServers

Parameters:

Added: iotFlowConnectorId in query

Returns Application Servers matching IoT Flow Connector ID.

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

By default, all Application Servers are returned.

Deleted: dxBridgeType in query

Returns Application Servers matching DX Bridge dataflow type.

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

By default, all Application Servers are returned.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Added property iotFlowConnector (object)

      • Property connectorId (string)

        IoT Flow Connector ID:

        • actility-aws-iot: Amazon AWS IoT
        • actility-azure-iot: Azure IoT Hub
        • actility-mqtt-iot: MQTT
        • actility-thingworx-iot: ThingWorx
        • actility-watson-iot: IBM Watson IoT

        Enum values:

        • actility-aws-iot
        • actility-azure-iot
        • actility-mqtt-iot
        • actility-thingworx-iot
        • actility-watson-iot
    • Deleted property dxBridge (object)

POST /subscriptions/{subscriptionUid}/appServers

Create AppServer

Request:

Updated KAFKA type:

  • Added property flowMatcherTags (array)

    IoT Flow matcher tags defined at Application Server level. When defined at both Device level and Application Server level, the Device level information has precedence over Application Server level information.

    Items (string):

    IoT Flow matcher tag

  • Added property iotFlowConnector (object)

    • Property connectorId (string)

      IoT Flow Connector ID:

      • actility-aws-iot: Amazon AWS IoT
      • actility-azure-iot: Azure IoT Hub
      • actility-mqtt-iot: MQTT
      • actility-thingworx-iot: ThingWorx
      • actility-watson-iot: IBM Watson IoT

      Enum values:

      • actility-aws-iot
      • actility-azure-iot
      • actility-mqtt-iot
      • actility-thingworx-iot
      • actility-watson-iot
    • Property configuration (object)

      IoT Flow Connector configuration

      One of:

      • actility-aws-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property uplinkTopicPattern (string)

          Defines a pattern of topic for the uplink.

        • Property downlinkTopicPattern (string)

          Defines a pattern of topic for the downlink.

        • Property deviceType (string)

          AWS IoT device type to be associated with the devices processed by the connector.

        • Property region (string)

          Region of the AWS IoT account.

        • Property accountPrefix (string)

          Account prefix of the AWS IoT account.

        • Property secretAccessKey (string)

          Secret access key for accessing the AWS IoT account.

        • Property accessKeyId (string)

          Id of the access key for accessing the AWS IoT account.

        • Property protocol (string)

          Protocol to be used for the connection with AWS IoT account, possible values are ‘SSL’ (MQTT with SSL certificates) or 'WSS’ (MQTT over secure Web Sockets).

          Enum values:

          • SSL
          • WSS
        • Property certificateId (string)

          Id of the certificate registered in the AWS IoT account. Only required when using the 'SSL’ protocol.

        • Property certificate (string)

          Contents of the certificate file registered in the AWS IoT account. Only required when using the 'SSL’ protocol.

        • Property privateKey (string)

          Contents of the private key file registered in the AWS IoT account. Only required when using the 'SSL’ protocol.

        • Property downlinkPort (string)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

        • Property topics (array)

          Messages related to uplink FPorts in that list will be pushed to the corresponding topic.

          Items (object):

          • Property fPort (integer)

            Uplink FPort

          • Property uplinkTopicPattern (string)

            Defines a pattern of topic for the uplink.

          • Property downlinkTopicPattern (string)

            Defines a pattern of topic for the downlink.

      • actility-azure-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property hostName (string)

          Host name for the Azure IoT Hub account.

        • Property sharedAccessKeyName (string)

          Shared access policy/strategy name within the Azure IoT Hub account, e.g. 'iothubowner’.

        • Property sharedAccessKey (string)

          Valid key (either primary or secondary) for the selected access policy/strategy within the Azure IoT Hub account.

        • Property iotHubTier (string)

          The selected IoT Hub Tier in the Azure IoT Hub account:

          • F1: Free
          • B1: Basic level 1
          • B2: Basic level 2
          • B3: Basic level 3
          • S1: Standard level 1
          • S2: Standard level 2
          • S3: Standard level 3

          Enum values:

          • F1
          • B1
          • B2
          • B3
          • S1
          • S2
          • S3
        • Property iotHubUnits (integer)

          The number of units associated with your Azure IoT Hub account. The Free IoT Hub Tier can have only 1 unit. A level 1 or 2 IoT Hub Tier can have up to 200 units. A level 3 IoT Hub Tier can have up to 10 units.

        • Property downlinkPort (string)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

      • actility-mqtt-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property uplinkTopicPattern (string)

          Defines a pattern of topic for the uplink.

        • Property downlinkTopicPattern (string)

          Defines a pattern of topic for the downlink.

        • Property hostName (boolean)

          Hostname/IP and port of your MQTT server.

        • Property protocol (string)

          Protocol to be used for the connection with your MQTT server, possible values are ‘SSL’ (MQTT over SSL), 'WSS’ (MQTT over secure Web Sockets) or 'TCP’ (MQTT over TCP without encryption).

          Enum values:

          • SSL
          • WSS
          • TCP
        • Property username (string)

          Username to access your MQTT server.

        • Property password (string)

          Password to access your MQTT server.

        • Property certificate (string)

          Contents of the client certificate file (X.509 with .crt format only) used to connect to your MQTT server. Only required when you are using double factor authentication (login/password + client certificate).

        • Property privateKey (string)

          Contents of the client private key file (PKCS#8 format only) used to connect to your MQTT server. Only required when you are using double factor authentication (login/password + client certificate).

        • Property downlinkPort (string)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

        • Property topics (array)

          Messages related to uplink FPorts in that list will be pushed to the corresponding topic.

          Items (object):

          • Property fPort (integer)

            Uplink FPort

          • Property uplinkTopicPattern (string)

            Defines a pattern of topic for the uplink.

          • Property downlinkTopicPattern (string)

            Defines a pattern of topic for the downlink.

      • actility-thingworx-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property hostName (string)

          Defines the host:port of the ThingWorx Platform to use.

        • Property applicationKey (string)

          Secret access key for accessing the ThingWorx Platform.

        • Property thingTemplateName (string)

          ThingWorx ThingTemplate to be associated with the Things processed by the connector.

        • Property downlinkPort (string)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

      • actility-watson-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property orgId (string)

          Organization id of the Watson IoT account.

        • Property deviceType (string)

          Watson IoT device type to be associated with the devices processed by the connector.

        • Property gatewayId (string)

          Id of the Watson IoT gateway used by the connector.

        • Property gatewayType (string)

          Watson IoT gateway type of the Watson IoT gateway used by the connector.

        • Property gatewayToken (string)

          Authentication token of the Watson IoT gateway used by the connector.

        • Property apiKey (string)

          API Key of the Watson IoT application to be associated with the connector.

        • Property apiToken (string)

          Authentication Token of the Watson IoT application to be associated with the connector.

        • Property downlinkPort (string)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

        • Property topics (array)

          Messages related to uplink FPorts in that list will be pushed to the corresponding topic.

          Items (object):

          • Property fPort (integer)

            Uplink FPort

          • Property uplinkTopicPattern (string)

            Defines a pattern of topic for the uplink.

          • Property downlinkTopicPattern (string)

            Defines a pattern of topic for the downlink.

  • Added property contentType (string)

    Content Type of messages sent by LRC on tunneling interface.

  • Added property destinations (array)

  • Added property downlinkSecurity (object)

    • Property asID (string)

      AS ID for uplink/downlink security. If status is set to DOWNLINK_AS_KEY at creation but asID is not provided: asID is initialized to the AS ID automatically generated by the server.

    • Property downlinkAsKey (string)

      AS Transport Key

    • Property maxTimestampDeviation (string)

      Downlink maximal timestamp deviation in seconds. 0 means no maximal timestamp deviation.

    • Property status (string)

      When set to DOWNLINK_AS_KEY: asID and downlinkAsKey are mandatory, maxTimestampDeviation is optional. When set to NONE: asID, downlinkAsKey and maxTimestampDeviation are forbidden.

  • Deleted property dxBridge (object)

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Updated KAFKA type:

  • Added property flowMatcherTags (array)

    IoT Flow matcher tags defined at Application Server level. When defined at both Device level and Application Server level, the Device level information has precedence over Application Server level information.

    Items (string):

    IoT Flow matcher tag

  • Added property iotFlowConnector (object)

    • Property connectorId (string)

      IoT Flow Connector ID:

      • actility-aws-iot: Amazon AWS IoT
      • actility-azure-iot: Azure IoT Hub
      • actility-mqtt-iot: MQTT
      • actility-thingworx-iot: ThingWorx
      • actility-watson-iot: IBM Watson IoT

      Enum values:

      • actility-aws-iot
      • actility-azure-iot
      • actility-mqtt-iot
      • actility-thingworx-iot
      • actility-watson-iot
    • Property configuration (object)

      IoT Flow Connector configuration

      One of:

      • actility-aws-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property uplinkTopicPattern (string)

          Defines a pattern of topic for the uplink.

        • Property downlinkTopicPattern (string)

          Defines a pattern of topic for the downlink.

        • Property deviceType (string)

          AWS IoT device type to be associated with the devices processed by the connector.

        • Property region (string)

          Region of the AWS IoT account.

        • Property accountPrefix (string)

          Account prefix of the AWS IoT account.

        • Property secretAccessKey (string)

          Secret access key for accessing the AWS IoT account.

        • Property accessKeyId (string)

          Id of the access key for accessing the AWS IoT account.

        • Property protocol (string)

          Protocol to be used for the connection with AWS IoT account, possible values are ‘SSL’ (MQTT with SSL certificates) or 'WSS’ (MQTT over secure Web Sockets).

          Enum values:

          • SSL
          • WSS
        • Property certificateId (string)

          Id of the certificate registered in the AWS IoT account. Only required when using the 'SSL’ protocol.

        • Property certificate (string)

          Contents of the certificate file registered in the AWS IoT account. Only required when using the 'SSL’ protocol.

        • Property privateKey (string)

          Contents of the private key file registered in the AWS IoT account. Only required when using the 'SSL’ protocol.

        • Property downlinkPort (integer)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

        • Property topics (array)

          Messages related to uplink FPorts in that list will be pushed to the corresponding topic.

          Items (object):

          • Property fPort (integer)

            Uplink FPort

          • Property uplinkTopicPattern (string)

            Defines a pattern of topic for the uplink.

          • Property downlinkTopicPattern (string)

            Defines a pattern of topic for the downlink.

      • actility-azure-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property hostName (boolean)

          Host name for the Azure IoT Hub account.

        • Property sharedAccessKeyName (string)

          Shared access policy/strategy name within the Azure IoT Hub account, e.g. 'iothubowner’.

        • Property sharedAccessKey (string)

          Valid key (either primary or secondary) for the selected access policy/strategy within the Azure IoT Hub account.

        • Property iotHubTier (string)

          The selected IoT Hub Tier in the Azure IoT Hub account:

          • F1: Free
          • B1: Basic level 1
          • B2: Basic level 2
          • B3: Basic level 3
          • S1: Standard level 1
          • S2: Standard level 2
          • S3: Standard level 3

          Enum values:

          • F1
          • B1
          • B2
          • B3
          • S1
          • S2
          • S3
        • Property iotHubUnits (integer)

          The number of units associated with your Azure IoT Hub account. The Free IoT Hub Tier can have only 1 unit. A level 1 or 2 IoT Hub Tier can have up to 200 units. A level 3 IoT Hub Tier can have up to 10 units.

        • Property downlinkPort (integer)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 2243.

      • actility-mqtt-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property uplinkTopicPattern (string)

          Defines a pattern of topic for the uplink.

        • Property downlinkTopicPattern (string)

          Defines a pattern of topic for the downlink.

        • Property hostName (boolean)

          Hostname/IP and port of your MQTT server.

        • Property protocol (string)

          Protocol to be used for the connection with your MQTT server, possible values are ‘SSL’ (MQTT over SSL), 'WSS’ (MQTT over secure Web Sockets) or 'TCP’ (MQTT over TCP without encryption).

          Enum values:

          • SSL
          • WSS
          • TCP
        • Property username (string)

          Username to access your MQTT server.

        • Property password (string)

          Password to access your MQTT server.

        • Property certificate (string)

          Contents of the client certificate file (X.509 with .crt format only) used to connect to your MQTT server. Only required when you are using double factor authentication (login/password + client certificate).

        • Property privateKey (string)

          Contents of the client private key file (PKCS#8 format only) used to connect to your MQTT server. Only required when you are using double factor authentication (login/password + client certificate).

        • Property downlinkPort (integer)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

        • Property topics (array)

          Messages related to uplink FPorts in that list will be pushed to the corresponding topic.

          Items (object):

          • Property fPort (integer)

            Uplink FPort

          • Property uplinkTopicPattern (string)

            Defines a pattern of topic for the uplink.

          • Property downlinkTopicPattern (string)

            Defines a pattern of topic for the downlink.

      • actility-thingworx-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property hostName (string)

          Defines the host:port of the ThingWorx Platform to use.

        • Property applicationKey (string)

          Secret access key for accessing the ThingWorx Platform.

        • Property thingTemplateName (string)

          ThingWorx ThingTemplate to be associated with the Things processed by the connector.

        • Property downlinkPort (integer)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

      • actility-watson-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property orgId (string)

          Organization id of the Watson IoT account.

        • Property deviceType (string)

          Watson IoT device type to be associated with the devices processed by the connector.

        • Property gatewayId (string)

          Id of the Watson IoT gateway used by the connector.

        • Property gatewayType (string)

          Watson IoT gateway type of the Watson IoT gateway used by the connector.

        • Property gatewayToken (string)

          Authentication token of the Watson IoT gateway used by the connector.

        • Property apiKey (string)

          API Key of the Watson IoT application to be associated with the connector.

        • Property apiToken (string)

          Authentication Token of the Watson IoT application to be associated with the connector.

        • Property downlinkPort (integer)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

        • Property topics (array)

          Messages related to uplink FPorts in that list will be pushed to the corresponding topic.

          Items (object):

          • Property fPort (integer)

            Uplink FPort

          • Property uplinkTopicPattern (string)

            Defines a pattern of topic for the uplink.

          • Property downlinkTopicPattern (string)

            Defines a pattern of topic for the downlink.

    • Property state (string)

      IoT Flow Connector state:

      • OPENED: the connection is up and running
      • OPENING: the connection is currently opening
      • CLOSED: the connection is closed
      • CLOSING: the connection is currently closing
      • AUTHENTICATING: the connection is currently authenticating
      • AUTHENTICATION_FAILED: failed to authenticate on the remote server with provided credentials
      • UNREACHABLE: the remote server is unreachable and therefore the connection will be retried
      • DEACTIVATED: the connection is deactivated

      Enum values:

      • OPENED
      • OPENING
      • CLOSED
      • CLOSING
      • AUTHENTICATING
      • AUTHENTICATION_FAILED
      • UNREACHABLE
      • DEACTIVATED
  • Deleted property dxBridge (object)

GET /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Retrieve AppServer

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated KAFKA type:

  • Added property flowMatcherTags (array)

    IoT Flow matcher tags defined at Application Server level. When defined at both Device level and Application Server level, the Device level information has precedence over Application Server level information.

    Items (string):

    IoT Flow matcher tag

  • Added property iotFlowConnector (object)

    • Property connectorId (string)

      IoT Flow Connector ID:

      • actility-aws-iot: Amazon AWS IoT
      • actility-azure-iot: Azure IoT Hub
      • actility-mqtt-iot: MQTT
      • actility-thingworx-iot: ThingWorx
      • actility-watson-iot: IBM Watson IoT

      Enum values:

      • actility-aws-iot
      • actility-azure-iot
      • actility-mqtt-iot
      • actility-thingworx-iot
      • actility-watson-iot
    • Property configuration (object)

      IoT Flow Connector configuration

      One of:

      • actility-aws-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property uplinkTopicPattern (string)

          Defines a pattern of topic for the uplink.

        • Property downlinkTopicPattern (string)

          Defines a pattern of topic for the downlink.

        • Property deviceType (string)

          AWS IoT device type to be associated with the devices processed by the connector.

        • Property region (string)

          Region of the AWS IoT account.

        • Property accountPrefix (string)

          Account prefix of the AWS IoT account.

        • Property secretAccessKey (string)

          Secret access key for accessing the AWS IoT account.

        • Property accessKeyId (string)

          Id of the access key for accessing the AWS IoT account.

        • Property protocol (string)

          Protocol to be used for the connection with AWS IoT account, possible values are ‘SSL’ (MQTT with SSL certificates) or 'WSS’ (MQTT over secure Web Sockets).

          Enum values:

          • SSL
          • WSS
        • Property certificateId (string)

          Id of the certificate registered in the AWS IoT account. Only required when using the 'SSL’ protocol.

        • Property certificate (string)

          Contents of the certificate file registered in the AWS IoT account. Only required when using the 'SSL’ protocol.

        • Property privateKey (string)

          Contents of the private key file registered in the AWS IoT account. Only required when using the 'SSL’ protocol.

        • Property downlinkPort (integer)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

        • Property topics (array)

          Messages related to uplink FPorts in that list will be pushed to the corresponding topic.

          Items (object):

          • Property fPort (integer)

            Uplink FPort

          • Property uplinkTopicPattern (string)

            Defines a pattern of topic for the uplink.

          • Property downlinkTopicPattern (string)

            Defines a pattern of topic for the downlink.

      • actility-azure-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property hostName (boolean)

          Host name for the Azure IoT Hub account.

        • Property sharedAccessKeyName (string)

          Shared access policy/strategy name within the Azure IoT Hub account, e.g. 'iothubowner’.

        • Property sharedAccessKey (string)

          Valid key (either primary or secondary) for the selected access policy/strategy within the Azure IoT Hub account.

        • Property iotHubTier (string)

          The selected IoT Hub Tier in the Azure IoT Hub account:

          • F1: Free
          • B1: Basic level 1
          • B2: Basic level 2
          • B3: Basic level 3
          • S1: Standard level 1
          • S2: Standard level 2
          • S3: Standard level 3

          Enum values:

          • F1
          • B1
          • B2
          • B3
          • S1
          • S2
          • S3
        • Property iotHubUnits (integer)

          The number of units associated with your Azure IoT Hub account. The Free IoT Hub Tier can have only 1 unit. A level 1 or 2 IoT Hub Tier can have up to 200 units. A level 3 IoT Hub Tier can have up to 10 units.

        • Property downlinkPort (integer)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

      • actility-mqtt-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property uplinkTopicPattern (string)

          Defines a pattern of topic for the uplink.

        • Property downlinkTopicPattern (string)

          Defines a pattern of topic for the downlink.

        • Property hostName (boolean)

          Hostname/IP and port of your MQTT server.

        • Property protocol (string)

          Protocol to be used for the connection with your MQTT server, possible values are ‘SSL’ (MQTT over SSL), 'WSS’ (MQTT over secure Web Sockets) or 'TCP’ (MQTT over TCP without encryption).

          Enum values:

          • SSL
          • WSS
          • TCP
        • Property username (string)

          Username to access your MQTT server.

        • Property password (string)

          Password to access your MQTT server.

        • Property certificate (string)

          Contents of the client certificate file (X.509 with .crt format only) used to connect to your MQTT server. Only required when you are using double factor authentication (login/password + client certificate).

        • Property privateKey (string)

          Contents of the client private key file (PKCS#8 format only) used to connect to your MQTT server. Only required when you are using double factor authentication (login/password + client certificate).

        • Property downlinkPort (integer)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

        • Property topics (array)

          Messages related to uplink FPorts in that list will be pushed to the corresponding topic.

          Items (object):

          • Property fPort (integer)

            Uplink FPort

          • Property uplinkTopicPattern (string)

            Defines a pattern of topic for the uplink.

          • Property downlinkTopicPattern (string)

            Defines a pattern of topic for the downlink.

      • actility-thingworx-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property hostName (string)

          Defines the host:port of the ThingWorx Platform to use.

        • Property applicationKey (string)

          Secret access key for accessing the ThingWorx Platform.

        • Property thingTemplateName (string)

          ThingWorx ThingTemplate to be associated with the Things processed by the connector.

        • Property downlinkPort (integer)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

      • actility-watson-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property orgId (string)

          Organization id of the Watson IoT account.

        • Property deviceType (string)

          Watson IoT device type to be associated with the devices processed by the connector.

        • Property gatewayId (string)

          Id of the Watson IoT gateway used by the connector.

        • Property gatewayType (string)

          Watson IoT gateway type of the Watson IoT gateway used by the connector.

        • Property gatewayToken (string)

          Authentication token of the Watson IoT gateway used by the connector.

        • Property apiKey (string)

          API Key of the Watson IoT application to be associated with the connector.

        • Property apiToken (string)

          Authentication Token of the Watson IoT application to be associated with the connector.

        • Property downlinkPort (integer)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

        • Property topics (array)

          Messages related to uplink FPorts in that list will be pushed to the corresponding topic.

          Items (object):

          • Property fPort (integer)

            Uplink FPort

          • Property uplinkTopicPattern (string)

            Defines a pattern of topic for the uplink.

          • Property downlinkTopicPattern (string)

            Defines a pattern of topic for the downlink.

    • Property state (string)

      IoT Flow Connector state:

      • OPENED: the connection is up and running
      • OPENING: the connection is currently opening
      • CLOSED: the connection is closed
      • CLOSING: the connection is currently closing
      • AUTHENTICATING: the connection is currently authenticating
      • AUTHENTICATION_FAILED: failed to authenticate on the remote server with provided credentials
      • UNREACHABLE: the remote server is unreachable and therefore the connection will be retried
      • DEACTIVATED: the connection is deactivated

      Enum values:

      • OPENED
      • OPENING
      • CLOSED
      • CLOSING
      • AUTHENTICATING
      • AUTHENTICATION_FAILED
      • UNREACHABLE
      • DEACTIVATED
  • Deleted property dxBridge (object)

PUT /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Update AppServer

Request:

Updated KAFKA type:

  • Added property flowMatcherTags (array)

    IoT Flow matcher tags defined at Application Server level. When defined at both Device level and Application Server level, the Device level information has precedence over Application Server level information.

    Items (string):

    IoT Flow matcher tag

  • Added property iotFlowConnector (object)

    • Property connectorId (string)

      IoT Flow Connector ID:

      • actility-aws-iot: Amazon AWS IoT
      • actility-azure-iot: Azure IoT Hub
      • actility-mqtt-iot: MQTT
      • actility-thingworx-iot: ThingWorx
      • actility-watson-iot: IBM Watson IoT

      Enum values:

      • actility-aws-iot
      • actility-azure-iot
      • actility-mqtt-iot
      • actility-thingworx-iot
      • actility-watson-iot
    • Property configuration (object)

      IoT Flow Connector configuration

      One of:

      • actility-aws-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property uplinkTopicPattern (string)

          Defines a pattern of topic for the uplink.

        • Property downlinkTopicPattern (string)

          Defines a pattern of topic for the downlink.

        • Property deviceType (string)

          AWS IoT device type to be associated with the devices processed by the connector.

        • Property region (string)

          Region of the AWS IoT account.

        • Property accountPrefix (string)

          Account prefix of the AWS IoT account.

        • Property secretAccessKey (string)

          Secret access key for accessing the AWS IoT account.

        • Property accessKeyId (string)

          Id of the access key for accessing the AWS IoT account.

        • Property protocol (string)

          Protocol to be used for the connection with AWS IoT account, possible values are ‘SSL’ (MQTT with SSL certificates) or 'WSS’ (MQTT over secure Web Sockets).

          Enum values:

          • SSL
          • WSS
        • Property certificateId (string)

          Id of the certificate registered in the AWS IoT account. Only required when using the 'SSL’ protocol.

        • Property certificate (string)

          Contents of the certificate file registered in the AWS IoT account. Only required when using the 'SSL’ protocol.

        • Property privateKey (string)

          Contents of the private key file registered in the AWS IoT account. Only required when using the 'SSL’ protocol.

        • Property downlinkPort (integer)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

        • Property topics (array)

          Messages related to uplink FPorts in that list will be pushed to the corresponding topic.

          Items (object):

          • Property fPort (integer)

            Uplink FPort

          • Property uplinkTopicPattern (string)

            Defines a pattern of topic for the uplink.

          • Property downlinkTopicPattern (string)

            Defines a pattern of topic for the downlink.

      • actility-azure-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property hostName (boolean)

          Host name for the Azure IoT Hub account.

        • Property sharedAccessKeyName (string)

          Shared access policy/strategy name within the Azure IoT Hub account, e.g. 'iothubowner’.

        • Property sharedAccessKey (string)

          Valid key (either primary or secondary) for the selected access policy/strategy within the Azure IoT Hub account.

        • Property iotHubTier (string)

          The selected IoT Hub Tier in the Azure IoT Hub account:

          • F1: Free
          • B1: Basic level 1
          • B2: Basic level 2
          • B3: Basic level 3
          • S1: Standard level 1
          • S2: Standard level 2
          • S3: Standard level 3

          Enum values:

          • F1
          • B1
          • B2
          • B3
          • S1
          • S2
          • S3
        • Property iotHubUnits (integer)

          The number of units associated with your Azure IoT Hub account. The Free IoT Hub Tier can have only 1 unit. A level 1 or 2 IoT Hub Tier can have up to 200 units. A level 3 IoT Hub Tier can have up to 10 units.

        • Property downlinkPort (integer)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

      • actility-mqtt-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property uplinkTopicPattern (string)

          Defines a pattern of topic for the uplink.

        • Property downlinkTopicPattern (string)

          Defines a pattern of topic for the downlink.

        • Property hostName (boolean)

          Hostname/IP and port of your MQTT server.

        • Property protocol (string)

          Protocol to be used for the connection with your MQTT server, possible values are ‘SSL’ (MQTT over SSL), 'WSS’ (MQTT over secure Web Sockets) or 'TCP’ (MQTT over TCP without encryption).

          Enum values:

          • SSL
          • WSS
          • TCP
        • Property username (string)

          Username to access your MQTT server.

        • Property password (string)

          Password to access your MQTT server.

        • Property certificate (string)

          Contents of the client certificate file (X.509 with .crt format only) used to connect to your MQTT server. Only required when you are using double factor authentication (login/password + client certificate).

        • Property privateKey (string)

          Contents of the client private key file (PKCS#8 format only) used to connect to your MQTT server. Only required when you are using double factor authentication (login/password + client certificate).

        • Property downlinkPort (integer)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

        • Property topics (array)

          Messages related to uplink FPorts in that list will be pushed to the corresponding topic.

          Items (object):

          • Property fPort (integer)

            Uplink FPort

          • Property uplinkTopicPattern (string)

            Defines a pattern of topic for the uplink.

          • Property downlinkTopicPattern (string)

            Defines a pattern of topic for the downlink.

      • actility-thingworx-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property hostName (string)

          Defines the host:port of the ThingWorx Platform to use.

        • Property applicationKey (string)

          Secret access key for accessing the ThingWorx Platform.

        • Property thingTemplateName (string)

          ThingWorx ThingTemplate to be associated with the Things processed by the connector.

        • Property downlinkPort (integer)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

      • actility-watson-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property orgId (string)

          Organization id of the Watson IoT account.

        • Property deviceType (string)

          Watson IoT device type to be associated with the devices processed by the connector.

        • Property gatewayId (string)

          Id of the Watson IoT gateway used by the connector.

        • Property gatewayType (string)

          Watson IoT gateway type of the Watson IoT gateway used by the connector.

        • Property gatewayToken (string)

          Authentication token of the Watson IoT gateway used by the connector.

        • Property apiKey (string)

          API Key of the Watson IoT application to be associated with the connector.

        • Property apiToken (string)

          Authentication Token of the Watson IoT application to be associated with the connector.

        • Property downlinkPort (integer)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

        • Property topics (array)

          Messages related to uplink FPorts in that list will be pushed to the corresponding topic.

          Items (object):

          • Property fPort (integer)

            Uplink FPort

          • Property uplinkTopicPattern (string)

            Defines a pattern of topic for the uplink.

          • Property downlinkTopicPattern (string)

            Defines a pattern of topic for the downlink.

  • Added property downlinkSecurity (object)

    • Property asID (string)

      AS ID for uplink/downlink security

    • Property downlinkAsKey (string)

      AS Transport Key

    • Property maxTimestampDeviation (string)

      Downlink maximal timestamp deviation in seconds. 0 means no maximal timestamp deviation.

    • Property status (string)

      When set to DOWNLINK_AS_KEY: asID and downlinkAsKey are mandatory, maxTimestampDeviation is optional. When set to NONE: asID, downlinkAsKey and maxTimestampDeviation are forbidden.

  • Deleted property dxBridge (object)

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated KAFKA type:

  • Added property flowMatcherTags (array)

    IoT Flow matcher tags defined at Application Server level. When defined at both Device level and Application Server level, the Device level information has precedence over Application Server level information.

    Items (string):

    IoT Flow matcher tag

  • Added property iotFlowConnector (object)

    • Property connectorId (string)

      IoT Flow Connector ID:

      • actility-aws-iot: Amazon AWS IoT
      • actility-azure-iot: Azure IoT Hub
      • actility-mqtt-iot: MQTT
      • actility-thingworx-iot: ThingWorx
      • actility-watson-iot: IBM Watson IoT

      Enum values:

      • actility-aws-iot
      • actility-azure-iot
      • actility-mqtt-iot
      • actility-thingworx-iot
      • actility-watson-iot
    • Property configuration (object)

      IoT Flow Connector configuration

      One of:

      • actility-aws-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property uplinkTopicPattern (string)

          Defines a pattern of topic for the uplink.

        • Property downlinkTopicPattern (string)

          Defines a pattern of topic for the downlink.

        • Property deviceType (string)

          AWS IoT device type to be associated with the devices processed by the connector.

        • Property region (string)

          Region of the AWS IoT account.

        • Property accountPrefix (string)

          Account prefix of the AWS IoT account.

        • Property secretAccessKey (string)

          Secret access key for accessing the AWS IoT account.

        • Property accessKeyId (string)

          Id of the access key for accessing the AWS IoT account.

        • Property protocol (string)

          Protocol to be used for the connection with AWS IoT account, possible values are ‘SSL’ (MQTT with SSL certificates) or 'WSS’ (MQTT over secure Web Sockets).

          Enum values:

          • SSL
          • WSS
        • Property certificateId (string)

          Id of the certificate registered in the AWS IoT account. Only required when using the 'SSL’ protocol.

        • Property certificate (string)

          Contents of the certificate file registered in the AWS IoT account. Only required when using the 'SSL’ protocol.

        • Property privateKey (string)

          Contents of the private key file registered in the AWS IoT account. Only required when using the 'SSL’ protocol.

        • Property downlinkPort (integer)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

        • Property topics (array)

          Messages related to uplink FPorts in that list will be pushed to the corresponding topic.

          Items (object):

          • Property fPort (integer)

            Uplink FPort

          • Property uplinkTopicPattern (string)

            Defines a pattern of topic for the uplink.

          • Property downlinkTopicPattern (string)

            Defines a pattern of topic for the downlink.

      • actility-azure-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property hostName (boolean)

          Host name for the Azure IoT Hub account.

        • Property sharedAccessKeyName (string)

          Shared access policy/strategy name within the Azure IoT Hub account, e.g. 'iothubowner’.

        • Property sharedAccessKey (string)

          Valid key (either primary or secondary) for the selected access policy/strategy within the Azure IoT Hub account.

        • Property iotHubTier (string)

          The selected IoT Hub Tier in the Azure IoT Hub account:

          • F1: Free
          • B1: Basic level 1
          • B2: Basic level 2
          • B3: Basic level 3
          • S1: Standard level 1
          • S2: Standard level 2
          • S3: Standard level 3

          Enum values:

          • F1
          • B1
          • B2
          • B3
          • S1
          • S2
          • S3
        • Property iotHubUnits (integer)

          The number of units associated with your Azure IoT Hub account. The Free IoT Hub Tier can have only 1 unit. A level 1 or 2 IoT Hub Tier can have up to 200 units. A level 3 IoT Hub Tier can have up to 10 units.

        • Property downlinkPort (integer)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

      • actility-mqtt-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property uplinkTopicPattern (string)

          Defines a pattern of topic for the uplink.

        • Property downlinkTopicPattern (string)

          Defines a pattern of topic for the downlink.

        • Property hostName (boolean)

          Hostname/IP and port of your MQTT server.

        • Property protocol (string)

          Protocol to be used for the connection with your MQTT server, possible values are ‘SSL’ (MQTT over SSL), 'WSS’ (MQTT over secure Web Sockets) or 'TCP’ (MQTT over TCP without encryption).

          Enum values:

          • SSL
          • WSS
          • TCP
        • Property username (string)

          Username to access your MQTT server.

        • Property password (string)

          Password to access your MQTT server.

        • Property certificate (string)

          Contents of the client certificate file (X.509 with .crt format only) used to connect to your MQTT server. Only required when you are using double factor authentication (login/password + client certificate).

        • Property privateKey (string)

          Contents of the client private key file (PKCS#8 format only) used to connect to your MQTT server. Only required when you are using double factor authentication (login/password + client certificate).

        • Property downlinkPort (integer)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

        • Property topics (array)

          Messages related to uplink FPorts in that list will be pushed to the corresponding topic.

          Items (object):

          • Property fPort (integer)

            Uplink FPort

          • Property uplinkTopicPattern (string)

            Defines a pattern of topic for the uplink.

          • Property downlinkTopicPattern (string)

            Defines a pattern of topic for the downlink.

      • actility-thingworx-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property hostName (string)

          Defines the host:port of the ThingWorx Platform to use.

        • Property applicationKey (string)

          Secret access key for accessing the ThingWorx Platform.

        • Property thingTemplateName (string)

          ThingWorx ThingTemplate to be associated with the Things processed by the connector.

        • Property downlinkPort (integer)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

      • actility-watson-iot properties:

        • Property sendMetadata (boolean)

          Indicates if the uplink metadata needs to be sent along the payload to the target cloud.

        • Property orgId (string)

          Organization id of the Watson IoT account.

        • Property deviceType (string)

          Watson IoT device type to be associated with the devices processed by the connector.

        • Property gatewayId (string)

          Id of the Watson IoT gateway used by the connector.

        • Property gatewayType (string)

          Watson IoT gateway type of the Watson IoT gateway used by the connector.

        • Property gatewayToken (string)

          Authentication token of the Watson IoT gateway used by the connector.

        • Property apiKey (string)

          API Key of the Watson IoT application to be associated with the connector.

        • Property apiToken (string)

          Authentication Token of the Watson IoT application to be associated with the connector.

        • Property downlinkPort (integer)

          If downlink is supported and enabled, indicates which LoRa port should be used to send the downlink to the device. Value must be between 1 and 224.

        • Property topics (array)

          Messages related to uplink FPorts in that list will be pushed to the corresponding topic.

          Items (object):

          • Property fPort (integer)

            Uplink FPort

          • Property uplinkTopicPattern (string)

            Defines a pattern of topic for the uplink.

          • Property downlinkTopicPattern (string)

            Defines a pattern of topic for the downlink.

    • Property state (string)

      IoT Flow Connector state:

      • OPENED: the connection is up and running
      • OPENING: the connection is currently opening
      • CLOSED: the connection is closed
      • CLOSING: the connection is currently closing
      • AUTHENTICATING: the connection is currently authenticating
      • AUTHENTICATION_FAILED: failed to authenticate on the remote server with provided credentials
      • UNREACHABLE: the remote server is unreachable and therefore the connection will be retried
      • DEACTIVATED: the connection is deactivated

      Enum values:

      • OPENED
      • OPENING
      • CLOSED
      • CLOSING
      • AUTHENTICATING
      • AUTHENTICATION_FAILED
      • UNREACHABLE
      • DEACTIVATED
  • Deleted property dxBridge (object)

POST /subscriptions/{subscriptionUid}/devices

Create Device

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Added property flowMatcherTags (array)

    IoT Flow matcher tags defined at Device level. When defined at both Device level and Application Server level, the Device level information has precedence over Application Server level information.

    Items (string):

    IoT Flow matcher tag

GET /subscriptions/{subscriptionUid}/devices/{deviceUid}

Retrieve Device

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property flowMatcherTags (array)

    IoT Flow matcher tags defined at Device level. When defined at both Device level and Application Server level, the Device level information has precedence over Application Server level information.

    Items (string):

    IoT Flow matcher tag

PUT /subscriptions/{subscriptionUid}/devices/{deviceUid}

Update Device

Request:
  • Added property flowMatcherTags (array)

    IoT Flow matcher tags defined at Device level. When defined at both Device level and Application Server level, the Device level information has precedence over Application Server level information.

    Items (string):

    IoT Flow matcher tag

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property flowMatcherTags (array)

    IoT Flow matcher tags defined at Device level. When defined at both Device level and Application Server level, the Device level information has precedence over Application Server level information.

    Items (string):

    IoT Flow matcher tag

RDTP-13260

What's Changed


GET /subscriptions/{subscriptionUid}/deviceVendors

Retrieve DeviceVendors

Parameters:

Added: connectivity in query

Only return Device Vendors having at least one Device Profile supporting this connectivity (exact match).

RDTP-15164

What's New


GET /subscriptions/{subscriptionUid}/drivers

Retrieve Drivers

What's Changed


POST /subscriptions/{subscriptionUid}/devices

Create Device

Request:
  • Added property driverMetadata (object)

    Metadata for Driver selection

    • Property application (string)

      Application metadata for Driver selection Syntax: <producerId>:<moduleId>:<version>

POST /subscriptions/{subscriptionUid}/devices/import

Create Import

Request:

The device importation CSV file is updated for LoRaWAN devices:

ColumnDefinitionCardinality
ZProtocol IdentifierOptional. The default Protocol Identifier defined in Device Profile will be used when no Protocol Identifier is specified at the creation.

RDTP-15489

What's New


POST /subscriptions/{subscriptionUid}/generateDxAccessToken

Generate and retrieve a DX Access Token

What's Changed


GET /subscriptions/{subscriptionUid}/appServers

Retrieve AppServers

Parameters:

Added: tpxIotFlowConnectorId in query

Returns Application Servers matching TPX IoT Flow Connector ID.

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

By default, all Application Servers are returned.

Added: tpxIotFlowConnectionId in query

Returns Application Server matching TPX IoT Flow Connection ID.

By default, all Application Servers are returned.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Added property tpxIotFlow (object)

      • Property connectionId (string)

        ID of the associated Connection in TPX IoT Flow

      • Property connectorId (string)

        ID of the associated Connector in TPX IoT Flow

      • Property flowId (string)

        ID of the associated Flow in TPX IoT Flow

POST /subscriptions/{subscriptionUid}/appServers

Create AppServer

Request:

Updated KAFKA type:

  • Added property tpxIotFlow (object)

    • Property connectionId (string)

      ID of the associated Connection in TPX IoT Flow

    • Property connectorId (string)

      ID of the associated Connector in TPX IoT Flow

    • Property flowId (string)

      ID of the associated Flow in TPX IoT Flow

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Updated KAFKA type:

  • Added property tpxIotFlow (object)

    • Property connectionId (string)

      ID of the associated Connection in TPX IoT Flow

    • Property state (string)

      IoT Flow Connection state:

      • OPENED: the connection is up and running
      • OPENING: the connection is currently opening
      • CLOSED: the connection is closed
      • CLOSING: the connection is currently closing
      • AUTHENTICATING: the connection is currently authenticating
      • AUTHENTICATION_FAILED: does it mean the authentication failed
      • UNREACHABLE: the remote server is unreachable and therefore the connection will be retried
      • DEACTIVATED: the connection is deactivated

      Enum values:

      • OPENED
      • OPENING
      • CLOSED
      • CLOSING
      • AUTHENTICATING
      • AUTHENTICATION_FAILED
      • UNREACHABLE
      • DEACTIVATED
    • Property connectorId (string)

      ID of the associated Connector in TPX IoT Flow

    • Property flowId (string)

      ID of the associated Flow in TPX IoT Flow

GET /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Retrieve AppServer

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated KAFKA type:

  • Added property tpxIotFlow (object)

    • Property connectionId (string)

      ID of the associated Connection in TPX IoT Flow

    • Property state (string)

      IoT Flow Connection state:

      • OPENED: the connection is up and running
      • OPENING: the connection is currently opening
      • CLOSED: the connection is closed
      • CLOSING: the connection is currently closing
      • AUTHENTICATING: the connection is currently authenticating
      • AUTHENTICATION_FAILED: does it mean the authentication failed
      • UNREACHABLE: the remote server is unreachable and therefore the connection will be retried
      • DEACTIVATED: the connection is deactivated

      Enum values:

      • OPENED
      • OPENING
      • CLOSED
      • CLOSING
      • AUTHENTICATING
      • AUTHENTICATION_FAILED
      • UNREACHABLE
      • DEACTIVATED
    • Property connectorId (string)

      ID of the associated Connector in TPX IoT Flow

    • Property flowId (string)

      ID of the associated Flow in TPX IoT Flow

PUT /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Update AppServer

Request:

Updated KAFKA type:

  • Added property tpxIotFlow (object)

    • Property connectionId (string)

      ID of the associated Connection in TPX IoT Flow

    • Property connectorId (string)

      ID of the associated Connector in TPX IoT Flow

    • Property flowId (string)

      ID of the associated Flow in TPX IoT Flow

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated KAFKA type:

  • Added property tpxIotFlow (object)

    • Property connectionId (string)

      ID of the associated Connection in TPX IoT Flow

    • Property state (string)

      IoT Flow Connection state:

      • OPENED: the connection is up and running
      • OPENING: the connection is currently opening
      • CLOSED: the connection is closed
      • CLOSING: the connection is currently closing
      • AUTHENTICATING: the connection is currently authenticating
      • AUTHENTICATION_FAILED: does it mean the authentication failed
      • UNREACHABLE: the remote server is unreachable and therefore the connection will be retried
      • DEACTIVATED: the connection is deactivated

      Enum values:

      • OPENED
      • OPENING
      • CLOSED
      • CLOSING
      • AUTHENTICATING
      • AUTHENTICATION_FAILED
      • UNREACHABLE
      • DEACTIVATED
    • Property connectorId (string)

      ID of the associated Connector in TPX IoT Flow

    • Property flowId (string)

      ID of the associated Flow in TPX IoT Flow

RDTP-15979

What's Changed


GET /subscriptions/{subscriptionUid}

Retrieve Subscription

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property defaultIsmBand (object)

    • Changed property ID (string)

      ISM band ID

      Added enum value:

      • ww2g4
    • Changed property name (string)

      ISM band name

      Added enum value:

      • WW2400
  • Changed property defaultIsmBands (array)

    Changed items (object):

    • Changed property ID (string)

      ISM band ID

      Added enum value:

      • ww2g4
    • Changed property name (string)

      ISM band name

      Added enum value:

      • WW2400
PUT /subscriptions/{subscriptionUid}

Update Subscription

Request:
  • Changed property defaultIsmBand (object)

    • Changed property ID (string)

      ISM band ID

      Added enum value:

      • ww2g4
  • Changed property defaultIsmBands (array)

    Changed items (object):

    • Changed property ID (string)

      ISM band ID

      Added enum value:

      • ww2g4
Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property defaultIsmBand (object)

    • Changed property ID (string)

      ISM band ID

      Added enum value:

      • ww2g4
    • Changed property name (string)

      ISM band name

      Added enum value:

      • WW2400
  • Changed property defaultIsmBands (array)

    Changed items (object):

    • Changed property ID (string)

      ISM band ID

      Added enum value:

      • ww2g4
    • Changed property name (string)

      ISM band name

      Added enum value:

      • WW2400
GET /subscriptions/{subscriptionUid}/deviceProfiles

Retrieve DeviceProfiles

Parameters:

Changed: ismBandID in query

ISM band ID filtering (exact match)

If multiple ismBandID, return Device Profiles supporting any of ISM Band

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property defaultIsmBands (array)

      List of ISM bands supported by the device profile. If the list of device profiles is filtered by ISM bands, this list is an intersection between requested ISM bands and supported ISM bands.

      Changed items (object):

      • Changed property ID (string)

        ISM band ID

        Added enum value:

        • ww2g4
      • Changed property name (string)

        ISM band name

        Added enum value:

        • WW2400
GET /subscriptions/{subscriptionUid}/deviceVendors

Retrieve DeviceVendors

Parameters:

Changed: ismBandID in query

ISM band ID filtering (exact match)

Only return Device Vendors having at least one Device Profile supporting this ISM band If multiple ismBandID, return Device Vendors having at least one Device Profile supporting any of ISM Band

GET /subscriptions/{subscriptionUid}/ismBands

Retrieve IsmBands

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Changed property ID (string)

      ISM band ID

      Added enum value:

      • ww2g4
    • Changed property name (string)

      ISM band name

      Added enum value:

      • WW2400

RDTP-17098

What's Changed


GET /subscriptions/{subscriptionUid}/devices

Retrieve 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 DevEUI/IMEI is used.

Added: sort in query

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

The following attributes are supported:

  • 'creationDate': by date of creation of the device
  • 'EUI': by DevEUI/IMEI

The following orders are supported:

  • 'asc': ascending order

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

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 DevEUI/IMEI is used and a next page exists.

RDTP-2248

What's Changed


GET /subscriptions/{subscriptionUid}

Retrieve Subscription

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property options (object)

    • Deprecated property externalJS (string)

      External Join Server option:

      • DEACTIVATED
      • ACTIVATED

      This option is now DEPRECATED: always set to DEACTIVATED

PUT /subscriptions/{subscriptionUid}

Update Subscription

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property options (object)

    • Deprecated property externalJS (string)

      External Join Server option:

      • DEACTIVATED
      • ACTIVATED

      This option is now DEPRECATED: always set to DEACTIVATED

POST /subscriptions/{subscriptionUid}/devices

Create Device

Request:

Updated LORAWAN connectivity: appKey property is used to determine if Local Join Server is used or not

  • Updated property appEUI (string)

    LoRaWAN JoinEUI/AppEUI (OTAA)

    ABP: FORBIDDEN

    OTAA: OPTIONAL if Local Join Server is used, MANDATORY otherwise

  • Updated property appKey (string)

    LoRaWAN AppKey (OTAA)

    ABP: FORBIDDEN

    OTAA: Local Join Server is used when provided, External Join Server is used otherwise

  • Updated property hsmGroupID (string)

    ID of HSM group used to encrypt the AppKey

    ABP: FORBIDDEN

    OTAA: OPTIONAL if Local Join Server is used, FORBIDDEN otherwise

  • Updated property nwkKey (string)

    LoRaWAN NwkKey (OTAA)

    ABP: FORBIDDEN

    OTAA: MANDATORY if LoRaWAN version is 1.1 and Local Join Server is used, FORBIDDEN otherwise

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Updated LORAWAN connectivity:

  • Added property joinServer (string)

    Location of the Join Server used for Device activation:

    • LOCAL: Local Join server with software encryption
    • LOCAL_WITH_HSM: Local Join server with HSM protection
    • EXTERNAL: External Join server

    Only applicable to OTAA devices.

    Enum values:

    • LOCAL
    • LOCAL_WITH_HSM
    • EXTERNAL
GET /subscriptions/{subscriptionUid}/devices/{deviceUid}

Retrieve Device

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated LORAWAN connectivity:

  • Added property joinServer (string)

    Location of the Join Server used for Device activation:

    • LOCAL: Local Join server with software encryption
    • LOCAL_WITH_HSM: Local Join server with HSM protection
    • EXTERNAL: External Join server

    Only applicable to OTAA devices.

    Enum values:

    • LOCAL
    • LOCAL_WITH_HSM
    • EXTERNAL
PUT /subscriptions/{subscriptionUid}/devices/{deviceUid}

Update Device

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated LORAWAN connectivity:

  • Added property joinServer (string)

    Location of the Join Server used for Device activation:

    • LOCAL: Local Join server with software encryption
    • LOCAL_WITH_HSM: Local Join server with HSM protection
    • EXTERNAL: External Join server

    Only applicable to OTAA devices.

    Enum values:

    • LOCAL
    • LOCAL_WITH_HSM
    • EXTERNAL
POST /subscriptions/{subscriptionUid}/devices/import

Create Import

Request:

The device importation CSV file is updated for OTAA activation: the column F is used to determine if Local Join Server is used or not

ColumnDefinitionCardinality
ELoRaWAN JoinEUI/AppEUIOptional if Local Join Server is used, Mandatory otherwise.
FLoRaWAN AppKeyLocal Join Server is used when provided, External Join Server is used otherwise.
RHSM group IDOptional if Local Join Server is used, Forbidden otherwise.
SHSM Application Key versionOptional if Local Join Server is used, Forbidden otherwise.
ULoRaWAN NwkKeyMandatory for LoRaWAN 1.1 device if Local Join Server is used, Forbidden otherwise.
VHSM Network Key versionOptional for LoRaWAN 1.1 device if Local Join Server is used, Forbidden otherwise.
XHSM Exchange Key (RSA) version or TWA Exchange Key (RSA) version used to encrypt AppKey/NwkKeyOptional if Local Join Server is used, Forbidden otherwise.

RDTP-5843

What's New


GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/alarms/histories

Retrieve Alarms History

GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/alarms/histories

Retrieve Alarms History

RDTP-7366

What's Changed


GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/locations

Retrieve Locations

Parameters:

Added: pageIndex in query

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

Added: pageSize in query

Size of the expected page result.

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

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

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property more (boolean)

    TRUE when more briefs can be retrieved with an upper page index.

  • Changed property briefs (array)

    Changed items (object):

    • Added property velocity (object)

      • Property speed (number)

        Deplacement speed in m/s

      • Property direction (number)

        Deplacement direction in °. North is 0°, east is 90°, south is 180° and west is 270°.

GET /subscriptions/{subscriptionUid}/networkSubscriptions

Retrieve NetworkSubscriptions

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    New required properties:

    • nwGeolocalization

    • Added property nwGeolocalization (boolean)

      True if network geolocation is enabled

RDTP-7383

What's Changed


GET /subscriptions/{subscriptionUid}/devices/{deviceUid}
PUT /subscriptions/{subscriptionUid}/devices/{deviceUid}
DELETE /subscriptions/{subscriptionUid}/devices/{deviceUid}
POST /subscriptions/{subscriptionUid}/devices/{deviceUid}/admins/reset
POST /subscriptions/{subscriptionUid}/devices/{deviceUid}/admins/downlink
GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/alarms
POST /subscriptions/{subscriptionUid}/devices/{deviceUid}/alarms/ack
POST /subscriptions/{subscriptionUid}/devices/{deviceUid}/alarms/{alarmUid}/ack
GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/batLevels
GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/debugLorawanLogs
GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/frames
GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/locations
PUT /subscriptions/{subscriptionUid}/devices/{deviceUid}/restricted
GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/spreadingFactors/sfDistributions
Parameters:

Changed: device in path

Unique identifier of the device, either

  • the sequential integer (UID) assigned to the device at creation
  • the EUI in uppercase prefixed with the e letter in downcase
GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}
PUT /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}
DELETE /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}
GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/alarms
POST /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/alarms/ack
POST /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/alarms/{alarmUid}/ack
GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/bss
GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/bss/tags
POST /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/bss/tags
DELETE /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/bss/tags/{tagUid}
GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/frames
Parameters:

Changed: multicastGroup in path

Unique identifier of the Multicast Group, either

  • the sequential integer (UID) assigned to the Multicast Group at creation (for example 123)
  • the EUI in uppercase prefixed with the e letter in downcase (for example e000000000522D8EB)

RDTP-9170

What's Changed


POST /subscriptions/{subscriptionUid}/devices

Create Device

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Added property driverMetadata (object)

    Metadata for Driver selection

    • Property model (string)

      Model metadata for Driver selection. Syntax: <producerId>:<moduleId>:<version>

    • Property application (string)

      Application metadata for Driver selection Syntax: <producerId>:<moduleId>:<version>

    • Property supportedApplications (array)

      List of supported Applications metadata for Driver selection. Used to allow override of the application metadata at Device level.

      Items (string):

      Application metadata for Driver selection Syntax: <producerId>:<moduleId>:<version>

GET /subscriptions/{subscriptionUid}/devices/{deviceUid}

Retrieve Device

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property driverMetadata (object)

    Metadata for Driver selection

    • Property model (string)

      Model metadata for Driver selection. Syntax: <producerId>:<moduleId>:<version>

    • Property application (string)

      Application metadata for Driver selection Syntax: <producerId>:<moduleId>:<version>

    • Property supportedApplications (array)

      List of supported Applications metadata for Driver selection. Used to allow override of the application metadata at Device level.

      Items (string):

      Application metadata for Driver selection Syntax: <producerId>:<moduleId>:<version>

PUT /subscriptions/{subscriptionUid}/devices/{deviceUid}

Update Device

Request:
  • Added property driverMetadata (object)

    Metadata for Driver selection

    • Property application (string)

      Application metadata for Driver selection Syntax: <producerId>:<moduleId>:<version>

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property driverMetadata (object)

    Metadata for Driver selection

    • Property model (string)

      Model metadata for Driver selection. Syntax: <producerId>:<moduleId>:<version>

    • Property application (string)

      Application metadata for Driver selection Syntax: <producerId>:<moduleId>:<version>

    • Property supportedApplications (array)

      List of supported Applications metadata for Driver selection. Used to allow override of the application metadata at Device level.

      Items (string):

      Application metadata for Driver selection Syntax: <producerId>:<moduleId>:<version>

Release 6.0

RDTP-2210

What's Changed


POST /subscriptions/{subscriptionUid}/devices

Create Device

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Updated LORAWAN connectivity:

  • Added property currentClass (string)

    LoRaWAN class currently used by the Device

    Enum values:

    • A
    • B
    • C
  • Added property pingSlotPeriod (integer)

    Class B ping-slot period in seconds

GET /subscriptions/{subscriptionUid}/devices/{deviceUid}

Retrieve Device

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated LORAWAN connectivity:

  • Added property currentClass (string)

    LoRaWAN class currently used by the Device

    Enum values:

    • A
    • B
    • C
  • Added property pingSlotPeriod (integer)

    Class B ping-slot period in seconds

PUT /subscriptions/{subscriptionUid}/devices/{deviceUid}

Update Device

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated LORAWAN connectivity:

  • Added property currentClass (string)

    LoRaWAN class currently used by the Device

    Enum values:

    • A
    • B
    • C
  • Added property pingSlotPeriod (integer)

    Class B ping-slot period in seconds

RDTP-2277

What's Changed


GET /subscriptions/{subscriptionUid}/devices/alarms

Retrieve Alarms

Return Type:

Changed response : 200 OK

Successful RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Added property level (integer)

      Alarm level

GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/alarms

Retrieve Alarms

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Added property level (integer)

      Alarm level

GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/alarms

Retrieve Alarms

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Added property level (integer)

      Alarm level

RDTP-2488

What's Changed


GET /customers

Login

Return Type:

Changed response : 200 OK

Successfully authenticated.

The session ID is returned in a cookie named JSESSIONID. You need to include this cookie in subsequent requests.

  • Changed property subscription (object)

    New required properties:

    • grantedPermissions

    • Added property grantedPermissions (array)

      Items (string):

      Enum values:

      • x
      • a
      • ra
      • rc

RDTP-5061

What's Changed


POST /subscriptions/{subscriptionUid}/devices

Create Device

Parameters:

Added: async in query

Triggers the asynchronous behavior. When not set, the synchronous behavior is triggered.

Return Type:

New response : 202 Accepted

Asynchronous task is successfully created. Task href is returned in Location HTTP header.

POST /subscriptions/{subscriptionUid}/devices/import

Create Import

Parameters:

Added: async in query

Triggers the asynchronous behavior. When not set, the synchronous behavior is triggered.

Added: context in query

Specifies the context of the device importation:

  • 'TPW': ThingPark Wireless
  • 'TPE': ThingPark Enterprise By default, ThingPark Wireless is considered.
Return Type:

New response : 202 Accepted

Asynchronous task is successfully created. Task href is returned in Location HTTP header.

DELETE /subscriptions/{subscriptionUid}/devices/{deviceUid}

Delete Device

Parameters:

Added: async in query

Triggers the asynchronous behavior. When not set, the synchronous behavior is triggered.

Return Type:

New response : 202 Accepted

Asynchronous task is successfully created. Task href is returned in Location HTTP header.

RDTP-2217

What's Changed


GET /subscriptions/{subscriptionUid}/deviceProfiles

Retrieve DeviceProfiles

Parameters:

Added: ID in query

Returns Device Profiles matching any of ID.

GET /subscriptions/{subscriptionUid}/deviceVendors

Retrieve DeviceVendors

Parameters:

Changed: ID in query

Device Vendor ID filtering (exact match)

GET /subscriptions/{subscriptionUid}/devices

Retrieve Devices

Parameters:

Changed: devEUI in query

Device EUI filtering (prefix match)

Release 5.2.2

RDTP-2411-2764

What's New


GET /subscriptions/{subscriptionUid}/publicExchangeKey

Retrieve Public Exchange Keys

What's Changed


GET /subscriptions/{subscriptionUid}

Retrieve Subscription

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property twaExchangeKeyVersion (string)

    TWA Exchange Key (RSA) version used to encrypt keys when HSM is not used

PUT /subscriptions/{subscriptionUid}

Update Subscription

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property twaExchangeKeyVersion (string)

    TWA Exchange Key (RSA) version used to encrypt keys when HSM is not used

POST /subscriptions/{subscriptionUid}/devices

Create Device

Request:
  • Added property exchangeKeyVersion (string)

    LoRaWAN device (OTAA)

    If the device is associated with an HSM group:

    • HSM Exchange Key (RSA) version used to encrypt AppKey/NwkKey

    Else:

    • TWA Exchange Key (RSA) version used to encrypt AppKey/NwkKey

    Cellular device

    TWA Exchange Key (RSA) version used to encrypt Ki

PUT /subscriptions/{subscriptionUid}/devices/{deviceUid}

Update Device

Request:
  • Added property exchangeKeyVersion (string)

    LoRaWAN device (OTAA)

    If the device is associated with an HSM group:

    • HSM Exchange Key (RSA) version used to encrypt AppKey/NwkKey

    Else:

    • TWA Exchange Key (RSA) version used to encrypt AppKey/NwkKey

    Cellular device

    TWA Exchange Key (RSA) version used to encrypt Ki

POST /subscriptions/{subscriptionUid}/devices/import

Create Import

Request:

The device importation CSV file defines the following new columns for ABP activation:

ColumnDefinitionCardinality
Wn/a
Xn/a

The following columns changed in device importation CSV file for OTAA activation:

ColumnDefinitionCardinality
F

LoRaWAN AppKey
Supported encoding modes:

  • Clear text (hexadecimal encoding)
  • Encrypted with HSM Application Key (AES) version specified in column S (hexadecimal encoding)
  • Encrypted with Exchange Key (RSA) version specified in column X (base64 encoding)
Mandatory if External Join Server option is DEACTIVATED, Forbidden otherwise.
U

LoRaWAN NwkKey
Supported encoding modes:

  • Clear text (hexadecimal encoding)
  • Encrypted with HSM Network Key (AES) version specified in column V (hexadecimal encoding)
  • Encrypted with Exchange Key (RSA) version specified in column X (base64 encoding)
Mandatory for LoRaWAN 1.1 device if External Join Server option is DEACTIVATED, Forbidden otherwise.

The device importation CSV file defines the following new columns for OTAA activation:

ColumnDefinitionCardinality
Wn/a
XHSM Exchange Key (RSA) version or TWA Exchange Key (RSA) version used to encrypt AppKey/NwkKeyOptional if External Join Server option is DEACTIVATED, Forbidden otherwise.

The following columns changed in device importation CSV file for Cellular activation:

ColumnDefinitionCardinality
E

Secret key of the SIM card (Ki)
Supported encoding modes:

  • Clear text (hexadecimal encoding)
  • Encrypted with TWA Exchange Key (RSA) version specified in column X (base64 encoding)
Optional if HSS provisioning is activated in Operator settings, Forbidden otherwise.

The device importation CSV file defines the following new columns for Cellular Device:

ColumnDefinitionCardinality
Wn/a
XTWA Exchange Key (RSA) version used to encrypt KiOptional if HSS provisioning is activated in Operator settings, Forbidden otherwise.
GET /subscriptions/{subscriptionUid}/hsmGroups

Retrieve HsmGroups

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Added property hsmExchangeKeyVersion (string)

      HSM Exchange Key version

RDTP-2818

What's Changed


GET /subscriptions/{subscriptionUid}/networkSubscriptions/{networkSubscriptionUid}

Retrieve NetworkSubscription

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated LORAWAN connectivity:

  • Added property npAccessControlType (string)

    Network Partner access control type:

    • 'NONE': no access control
    • 'WHITELIST': Whitelist access control
    • 'BLACKLIST': Blacklist access control

    Enum values:

    • NONE
    • WHITELIST
    • BLACKLIST
  • Added property npAccessControlList (array)

    List of whitelisted or blacklisted Network Partners:

    • If npAccessControlType is 'WHITELIST': List of whitelisted Network Partners
    • If npAccessControlType is 'BLACKLIST': List of blacklisted Network Partners

    Items (object):

    • Property ID (string)

      Network Partner ID

RDTP-6529

What's Changed


GET /subscriptions/{subscriptionUid}/devices

Retrieve Devices

Parameters:

Added: pageSize in query

Size of the expected page result.

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

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

What's Changed


GET /subscriptions/{subscriptionUid}/appServers

Retrieve AppServers

Parameters:

Added: dxBridgeType in query

Returns Application Servers matching DX Bridge dataflow type.

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

By default, all Application Servers are returned.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Changed property dxBridge (object)

      • Changed property type (string)

        Type of the DX Bridge dataflow

        Added enum value:

        • MQTT
POST /subscriptions/{subscriptionUid}/appServers

Create AppServer

Request:
  • Changed property dxBridge (object)

    • Changed property type (string)

      Type of the DX Bridge dataflow

      Added enum value:

      • MQTT
Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Changed property dxBridge (object)

    • Changed property type (string)

      Type of the DX Bridge dataflow

      Added enum value:

      • MQTT
GET /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Retrieve AppServer

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property dxBridge (object)

    • Changed property type (string)

      Type of the DX Bridge dataflow

      Added enum value:

      • MQTT
PUT /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Update AppServer

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property dxBridge (object)

    • Changed property type (string)

      Type of the DX Bridge dataflow

      Added enum value:

      • MQTT

RDTP-4265 / RDTP-5105

What's Changed


POST /subscriptions/{subscriptionUid}/multicastGroups

Create Multicast Group

Request:
  • Added property downlinkDataRate (integer)

    LoRaWAN data rate (integer between 0 and 15) used to transmit multicast downlink packets. When not set, Connectivity Plan or RF Region settings apply.

  • Added property downlinkFrequency (number)

    Frequency in MHz used to transmit multicast downlink packets. When not set, RF Region settings apply.

Return Type:

Changed response : 201 Created

Successful CREATE, UPDATE or RETRIEVE

  • Added property downlinkDataRate (integer)

    LoRaWAN data rate (integer between 0 and 15) used to transmit multicast downlink packets. When not set, Connectivity Plan or RF Region settings apply.

  • Added property lastFCntDn (integer)

    FCntDn of the last downlink frame

  • Added property downlinkFrequency (number)

    Frequency in MHz used to transmit multicast downlink packets. When not set, RF Region settings apply.

GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}

Retrieve Multicast Group

Return Type:

Changed response : 200 OK

Successful CREATE, UPDATE or RETRIEVE

  • Added property downlinkDataRate (integer)

    LoRaWAN data rate (integer between 0 and 15) used to transmit multicast downlink packets. When not set, Connectivity Plan or RF Region settings apply.

  • Added property lastFCntDn (integer)

    FCntDn of the last downlink frame

  • Added property downlinkFrequency (number)

    Frequency in MHz used to transmit multicast downlink packets. When not set, RF Region settings apply.

PUT /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}

Update Multicast Group

Request:
  • Added property downlinkDataRate (integer)

    LoRaWAN data rate (integer between 0 and 15) used to transmit multicast downlink packets. When not set, Connectivity Plan or RF Region settings apply.

  • Added property downlinkFrequency (number)

    Frequency in MHz used to transmit multicast downlink packets. When not set, RF Region settings apply.

Return Type:

Changed response : 200 OK

Successful CREATE, UPDATE or RETRIEVE

  • Added property downlinkDataRate (integer)

    LoRaWAN data rate (integer between 0 and 15) used to transmit multicast downlink packets. When not set, Connectivity Plan or RF Region settings apply.

  • Added property lastFCntDn (integer)

    FCntDn of the last downlink frame

  • Added property downlinkFrequency (number)

    Frequency in MHz used to transmit multicast downlink packets. When not set, RF Region settings apply.

GET /subscriptions/{subscriptionUid}/networkSubscriptions/{networkSubscriptionUid}

Retrieve NetworkSubscription

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Deprecated property multicastRetransmitTimer (integer)

    Delay between two multicast retransmissions burst (in seconds)

Release 5.1

RDTP-7528

What's Changed


POST /subscriptions/{subscriptionUid}/appServers

Create AppServer

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Changed property dxBridge (object)

    • Changed property state (string)

      DX Bridge dataflow status:

      • AWAITING_VALIDATION: waiting to be validated for deployment
      • AWAITING_UPDATE: waiting for the execution instance to be updated
      • READY: deployed and ready to be used
      • DEPLOY_ERROR: could not be deployed due to an error
      • FLOW_ERROR: an error occurred during packets processing

      Added enum value:

      • FLOW_ERROR
GET /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Retrieve AppServer

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property dxBridge (object)

    • Changed property state (string)

      DX Bridge dataflow status:

      • AWAITING_VALIDATION: waiting to be validated for deployment
      • AWAITING_UPDATE: waiting for the execution instance to be updated
      • READY: deployed and ready to be used
      • DEPLOY_ERROR: could not be deployed due to an error
      • FLOW_ERROR: an error occurred during packets processing

      Added enum value:

      • FLOW_ERROR
PUT /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Update AppServer

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property dxBridge (object)

    • Changed property state (string)

      DX Bridge dataflow status:

      • AWAITING_VALIDATION: waiting to be validated for deployment
      • AWAITING_UPDATE: waiting for the execution instance to be updated
      • READY: deployed and ready to be used
      • DEPLOY_ERROR: could not be deployed due to an error
      • FLOW_ERROR: an error occurred during packets processing

      Added enum value:

      • FLOW_ERROR

RDTP-2213-3250-4160

What's New


POST /subscriptions/{subscriptionUid}/nwkKeyGen

Create NwkKeys

What's Changed


GET /subscriptions/{subscriptionUid}/deviceProfiles

Retrieve DeviceProfiles

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (array)

    Changed items (object):

    • Added property macMinorVersion (integer)

      LoRaWAN minor MAC version

    • Added property macMajorVersion (integer)

      LoRaWAN major MAC version

POST /subscriptions/{subscriptionUid}/devices

Create Device

Request:

Updated LORAWAN connectivity:

  • Added property sNwkSIntKey (string)

    LoRaWAN SNwkSIntKey (ABP)

    ABP: OPTIONAL

    Mandatory when the type MAC is set to LoRaMAC or WattecoMAC_3.2 and LoRaWAN version is 1.1, Not used otherwise.

    OTAA: FORBIDDEN

  • Added property hsmNwkKeyVersion (string)

    HSM Network Key version used to encrypt NwkKey

    ABP: FORBIDDEN

    OTAA: OPTIONAL

  • Added property nwkSEncKey (string)

    LoRaWAN NwkSEncKey (ABP)

    ABP: OPTIONAL

    Mandatory when the type MAC is set to LoRaMAC or WattecoMAC_3.2 and LoRaWAN version is 1.1, Not used otherwise.

    OTAA: FORBIDDEN

  • Added property nwkKey (string)

    LoRaWAN NwkKey (OTAA)

    ABP: FORBIDDEN

    OTAA: MANDATORY if LoRaWAN version is 1.1 and External Join Server option is DEACTIVATED, FORBIDDEN otherwise

  • Changed property nwKey (string)

    LoRaWAN FNwkSIntKey/NwkSKey (ABP)

    ABP: OPTIONAL

    Mandatory when the type MAC is set to LoRaMAC or WattecoMAC_3.2 Not used otherwise.

    OTAA: FORBIDDEN

  • Deprecated property appKeyEncryptionMode (string)

    Mode used to encrypt the AppKey: LRC_CLUSTER_KEY or HSM_APP_KEY

    ABP: FORBIDDEN

    OTAA: OPTIONAL if External Join Server option is DEACTIVATED (default value is LRC_CLUSTER_KEY), FORBIDDEN otherwise

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

Updated LORAWAN connectivity:

  • Removed property nwKey (string)

    LoRaWAN FNwkSIntKey/NwkSKey (ABP)

    ABP: OPTIONAL

    Mandatory when the type MAC is set to LoRaMAC or WattecoMAC_3.2 Not used otherwise.

    OTAA: FORBIDDEN

  • Removed property appKey (string)

    LoRaWAN AppKey (OTAA)

    ABP: FORBIDDEN

    OTAA: MANDATORY if External Join Server option is DEACTIVATED, FORBIDDEN otherwise

  • Deprecated property appKeyEncryptionMode (string)

    Mode used to encrypt the AppKey: LRC_CLUSTER_KEY or HSM_APP_KEY

    ABP: FORBIDDEN

    OTAA: OPTIONAL if External Join Server option is DEACTIVATED (default value is LRC_CLUSTER_KEY), FORBIDDEN otherwise

  • Changed property model (object)

    • Added property macMinorVersion (integer)

      LoRaWAN minor MAC version

    • Added property macMajorVersion (integer)

      LoRaWAN major MAC version

  • Removed property appKeys (string)

    LoRaWAN AppSKey (ABP) XML document

    ABP: MANDATORY

    Optional when the type MAC is set to LoRaMAC (port 1 to 255) or WattecoMAC_3.2 (only port 6).

    Not used otherwise.

    OTAA: FORBIDDEN

GET /subscriptions/{subscriptionUid}/devices/{deviceUid}

Retrieve Device

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated LORAWAN connectivity:

  • Removed property nwKey (string)

    LoRaWAN FNwkSIntKey/NwkSKey (ABP)

    ABP: OPTIONAL

    Mandatory when the type MAC is set to LoRaMAC or WattecoMAC_3.2 Not used otherwise.

    OTAA: FORBIDDEN

  • Removed property appKey (string)

    LoRaWAN AppKey (OTAA)

    ABP: FORBIDDEN

    OTAA: MANDATORY if External Join Server option is DEACTIVATED, FORBIDDEN otherwise

  • Deprecated property appKeyEncryptionMode (string)

    Mode used to encrypt the AppKey: LRC_CLUSTER_KEY or HSM_APP_KEY

    ABP: FORBIDDEN

    OTAA: OPTIONAL if External Join Server option is DEACTIVATED (default value is LRC_CLUSTER_KEY), FORBIDDEN otherwise

  • Changed property model (object)

    • Added property macMinorVersion (integer)

      LoRaWAN minor MAC version

    • Added property macMajorVersion (integer)

      LoRaWAN major MAC version

  • Removed property appKeys (string)

    LoRaWAN AppSKey (ABP) XML document

    ABP: MANDATORY

    Optional when the type MAC is set to LoRaMAC (port 1 to 255) or WattecoMAC_3.2 (only port 6).

    Not used otherwise.

    OTAA: FORBIDDEN

PUT /subscriptions/{subscriptionUid}/devices/{deviceUid}

Update Device

Request:

Updated LORAWAN connectivity:

  • Added property sNwkSIntKey (string)

    LoRaWAN SNwkSIntKey (ABP)

    ABP: OPTIONAL

    Mandatory when the type MAC is set to LoRaMAC or WattecoMAC_3.2 and LoRaWAN version is 1.1, Not used otherwise.

    OTAA: FORBIDDEN

  • Added property hsmNwkKeyVersion (string)

    HSM Network Key version used to encrypt NwkKey

    ABP: FORBIDDEN

    OTAA: OPTIONAL

  • Added property nwkSEncKey (string)

    LoRaWAN NwkSEncKey (ABP)

    ABP: OPTIONAL

    Mandatory when the type MAC is set to LoRaMAC or WattecoMAC_3.2 and LoRaWAN version is 1.1, Not used otherwise.

    OTAA: FORBIDDEN

  • Added property nwkKey (string)

    LoRaWAN NwkKey (OTAA)

    ABP: FORBIDDEN

    OTAA: MANDATORY if LoRaWAN version is 1.1 and External Join Server option is DEACTIVATED, FORBIDDEN otherwise

  • Changed property nwKey (string)

    LoRaWAN FNwkSIntKey/NwkSKey (ABP)

    ABP: OPTIONAL

    Mandatory when the type MAC is set to LoRaMAC or WattecoMAC_3.2 Not used otherwise.

    OTAA: FORBIDDEN

  • Deprecated property appKeyEncryptionMode (string)

    Mode used to encrypt the AppKey: LRC_CLUSTER_KEY or HSM_APP_KEY

    ABP: FORBIDDEN

    OTAA: OPTIONAL if External Join Server option is DEACTIVATED (default value is LRC_CLUSTER_KEY), FORBIDDEN otherwise

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

Updated LORAWAN connectivity:

  • Removed property nwKey (string)

    LoRaWAN FNwkSIntKey/NwkSKey (ABP)

    ABP: OPTIONAL

    Mandatory when the type MAC is set to LoRaMAC or WattecoMAC_3.2 Not used otherwise.

    OTAA: FORBIDDEN

  • Removed property appKey (string)

    LoRaWAN AppKey (OTAA)

    ABP: FORBIDDEN

    OTAA: MANDATORY if External Join Server option is DEACTIVATED, FORBIDDEN otherwise

  • Deprecated property appKeyEncryptionMode (string)

    Mode used to encrypt the AppKey: LRC_CLUSTER_KEY or HSM_APP_KEY

    ABP: FORBIDDEN

    OTAA: OPTIONAL if External Join Server option is DEACTIVATED (default value is LRC_CLUSTER_KEY), FORBIDDEN otherwise

  • Changed property model (object)

    • Added property macMinorVersion (integer)

      LoRaWAN minor MAC version

    • Added property macMajorVersion (integer)

      LoRaWAN major MAC version

  • Removed property appKeys (string)

    LoRaWAN AppSKey (ABP) XML document

    ABP: MANDATORY

    Optional when the type MAC is set to LoRaMAC (port 1 to 255) or WattecoMAC_3.2 (only port 6).

    Not used otherwise.

    OTAA: FORBIDDEN

POST /subscriptions/{subscriptionUid}/devices/import

Create Import

Request:

The device importation CSV file defines the following new columns for ABP activation:

ColumnDefinitionCardinality
ULoRaWAN SNwkSIntKeyMandatory for LoRaWAN 1.1 device, Forbidden otherwise.
VLoRaWAN NwkSEncKeyMandatory for LoRaWAN 1.1 device, Forbidden otherwise.

The device importation CSV file defines the following new columns for OTAA activation:

ColumnDefinitionCardinality
ULoRaWAN NwkKeyMandatory for LoRaWAN 1.1 device if External Join Server option is DEACTIVATED, Forbidden otherwise.
VHSM Network Key versionOptional for LoRaWAN 1.1 device if External Join Server option is DEACTIVATED, Forbidden otherwise.

The device importation CSV file defines the following new columns for Cellular Device:

ColumnDefinitionCardinality
Un/a
Vn/a
POST /subscriptions/{subscriptionUid}/multicastGroups

Create Multicast Group

Request:
  • Added property sNwkSIntKey (string)

    LoRaWAN SNwkSIntKey

    Mandatory when the LoRaWAN version is 1.1, Not used otherwise.

  • Added property nwkSEncKey (string)

    LoRaWAN NwkSEncKey

    Mandatory when the LoRaWAN version is 1.1, Not used otherwise.

  • Changed property nwKey (string)

    LoRaWAN FNwkSIntKey/NwkSKey

Return Type:

Changed response : 201 Created

Successful CREATE, UPDATE or RETRIEVE

  • Removed property nwKey (string)

    LoRaWAN FNwkSIntKey/NwkSKey

  • Removed property appKeys (string)

    LoRaWAN AppSKey XML document

GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}

Retrieve Multicast Group

Return Type:

Changed response : 200 OK

Successful CREATE, UPDATE or RETRIEVE

  • Removed property nwKey (string)

    LoRaWAN FNwkSIntKey/NwkSKey

  • Removed property appKeys (string)

    LoRaWAN AppSKey XML document

PUT /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}

Update Multicast Group

Request:
  • Added property sNwkSIntKey (string)

    LoRaWAN SNwkSIntKey

    Mandatory when the LoRaWAN version is 1.1, Not used otherwise.

  • Added property nwkSEncKey (string)

    LoRaWAN NwkSEncKey

    Mandatory when the LoRaWAN version is 1.1, Not used otherwise.

  • Changed property nwKey (string)

    LoRaWAN FNwkSIntKey/NwkSKey

Return Type:

Changed response : 200 OK

Successful CREATE, UPDATE or RETRIEVE

  • Removed property nwKey (string)

    LoRaWAN FNwkSIntKey/NwkSKey

  • Removed property appKeys (string)

    LoRaWAN AppSKey XML document

RDTP-2228-2229

What's Changed


POST /subscriptions/{subscriptionUid}/devices/{deviceUid}/admins/downlink

Send Downlink

Parameters:

Added: aFCntDn in query

The LoRaWAN Applicative Downlink Counter value is used to encrypt the payload. This query parameter is needed only if the the payload is provided encrypted. If present, aFCntDn will be copied in the LoRaWAN header field FCnt, and the encrypted payload will be copied as-is to the LoRaWAN downlink frame by the LRC. Only applicable to LoRaWAN 1.1

Changed: payload in query

Hexadecimal payload. The hexadecimal payload will be encrypted by the LRC if the fCntDn query parameter and the aFCntDn query parameter are absent, and if the LRC has been configured with an AppSKey for the specified LoRaWAN port. Otherwise the payload must be provided encrypted according to the LoRaWAN specification, and the fCntDn query parameter or the aFCntDn query parameter must be present. The encryption uses the downlink counter, which is why the fCntDn query parameter or the aFCntDn query parameter is required in this case.

Changed: fCntDn in query

The LoRaWAN Downlink Counter value is used to encrypt the payload. This query parameter is needed only if the payload is provided encrypted. If present, fCntDn will be copied in the LoRaWAN header field FCnt, and the encrypted payload will be copied as-is to the LoRaWAN downlink frame by the LRC. Only applicable to LoRaWAN 1.0

RDTP-3366

What's Changed


GET /subscriptions/{subscriptionUid}/deviceProfiles

Retrieve DeviceProfiles

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Changed property vendor (object)

      • Added property commercialName (string)

        Commercial name of the device vendor

      • Added property commercialDescription (string)

        Commercial description of the device vendor

      • Deprecated property name (string)

        Name of the device vendor

GET /subscriptions/{subscriptionUid}/deviceVendors

Retrieve DeviceVendors

Parameters:

Deprecated: name in query

Device Vendor name filtering (prefix match)

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Added property commecialName (string)

      Commercial name of the device vendor

    • Added property commercialDescription (string)

      Commercial description of the device vendor

    • Deprecated property name (string)

      Name of the device vendor

GET /subscriptions/{subscriptionUid}/devices

Retrieve Devices

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Changed property vendor (object)

      • Added property commercialName (string)

        Device vendor commercial name

      • Added property commercialDescription (string)

        Device vendor commercial description

      • Deprecated property name (string)

        Device vendor name

POST /subscriptions/{subscriptionUid}/devices

Create Device

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Changed property vendor (object)

    • Added property commercialName (string)

      Device vendor commercial name

    • Added property commercialDescription (string)

      Device vendor commercial description

    • Deprecated property name (string)

      Device vendor name

GET /subscriptions/{subscriptionUid}/devices/{deviceUid}

Retrieve Device

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property vendor (object)

    • Added property commercialName (string)

      Device vendor commercial name

    • Added property commercialDescription (string)

      Device vendor commercial description

    • Changed property name (string)

      Device vendor name

PUT /subscriptions/{subscriptionUid}/devices/{deviceUid}

Update Device

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property vendor (object)

    • Added property commercialName (string)

      Device vendor commercial name

    • Added property commercialDescription (string)

      Device vendor commercial description

    • Deprecated property name (string)

      Device vendor name

RDTP-3385

What's Changed


GET /subscriptions/{subscriptionUid}/devices

Retrieve Devices

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs

    • LoRaWan device

      • Added property avgESP (number)

        Average ESP

      • Added property lastESP (number)

        Last ESP

POST /subscriptions/{subscriptionUid}/devices

Create Device

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • LoRaWan device

    • Added property avgESP (number)

      Average ESP

    • Added property lastESP (number)

      Last ESP

    • Changed property LRRs

      • Added property ESP (number)
GET /subscriptions/{subscriptionUid}/devices/frames/aggregated

Retrieve FramesDeviceAggregation

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs

    • Added property espMean (number)

      Mean of ESP on the best LRR for this aggregated time slot.

GET /subscriptions/{subscriptionUid}/devices/{deviceUid}

Retrieve Device

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • LoRaWan device

    • Added property avgESP (number)

      Average ESP

    • Added property lastESP (number)

      Last ESP

    • Changed property LRRs

      • Added property ESP (number)
PUT /subscriptions/{subscriptionUid}/devices/{deviceUid}
Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • LoRaWan device

    • Added property avgESP (number)

      Average ESP

    • Added property lastESP (number)

      Last ESP

    • Changed property LRRs

      • Added property ESP (number)
GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/frames

Retrieve FramesDevice

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs

    • Added property esp (number)

      When lrrID query parameter is no specified: ESP on the best LRR

      When lrrID query parameter is specified: ESP on the requested LRR

      Only applies to uplink frames (type=0)

RDTP-3386

What's Changed


POST /subscriptions/{subscriptionUid}/devices/import

Import devices

Request:

The following column is added to the device importation CSV file for ABP and OTAA

ColumnDefinitionCardinality
TApplication server IDsOptional
Forbidden if AS routing profile ID (I) is provided.
Multiple application server IDs may be provided, separated by a comma

This column is not applicable for Cellular devices.

RDTP-3442

What's New


GET /subscriptions/{subscriptionUid}/devices/alarms

Retrieve Alarms

GET /subscriptions/{subscriptionUid}/devices/alarms/stateDistributions

Retrieve Alarms State Distributions

RDTP-4471

What's Changed


GET /subscriptions/{subscriptionUid}/appServers

Retrieve AppServers

Parameters:

Added: sort in query

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

Following attributes are supported:

  • 'ID': results are sorted by ID
  • 'name': results are sorted by name

Following orders are supported:

  • 'asc': ascending order
  • 'desc': descending order

By default, results are sorted by ID

POST /subscriptions/{subscriptionUid}/appServersRoutingProfiles

Create AppServersRoutingProfile

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Changed property appServers (object)

    • Added property name (string)

      Application Server name

    • Added property state (string)

      Application Server state

      Enum values:

      • ACTIVE
      • DEACTIVATED
GET /subscriptions/{subscriptionUid}/appServersRoutingProfiles/{appServersRoutingProfileUid}

Retrieve AppServersRoutingProfile

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property appServers (object)

    • Added property name (string)

      Application Server name

    • Added property state (string)

      Application Server state

      Enum values:

      • ACTIVE
      • DEACTIVATED
PUT /subscriptions/{subscriptionUid}/appServersRoutingProfiles/{appServersRoutingProfileUid}

Update AppServersRoutingProfile

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property appServers (object)

    • Added property name (string)

      Application Server name

    • Added property state (string)

      Application Server state

      Enum values:

      • ACTIVE
      • DEACTIVATED

RDTP-4575

What's Changed


POST /subscriptions/{subscriptionUid}/devices/import

Create Import

Request:

The device importation CSV file defines the following new column for ABP activation, OTAA activation and Cellular Device.

ColumnDefinitionCardinality
Wn/a

Release 5.0.1

General

What's New


POST /subscriptions/{subscriptionUid}/appKeyGen

Request the generation of a list of AppKeys

GET /subscriptions/{subscriptionUid}/deviceProfiles/catalog

Retrieve Catalog version

GET /subscriptions/{subscriptionUid}/deviceProfiles/catalog/selfUpdate

Retrieve latest Catalog version

POST /subscriptions/{subscriptionUid}/deviceProfiles/catalog/selfUpdate

Import Catalog from repository

POST /subscriptions/{subscriptionUid}/devices/{deviceUid}/admins/downlink

Send Downlink

GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/debugLorawanLogs

Download Device LoRaWAN Logs

PUT /subscriptions/{subscriptionUid}/devices/{deviceUid}/restricted

Update Restricted Settings

GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/spreadingFactors/sfDistributions

Retrieve SF Distribution

GET /subscriptions/{subscriptionUid}/managedCustomerNetwork/bss

Retrieve Base Stations

GET /subscriptions/{subscriptionUid}/managedCustomerNetwork/bss/tags

Retrieve Base Station Tags

POST /subscriptions/{subscriptionUid}/managedCustomerNetwork/bss/tags

Associate Base Station Tag

DELETE /subscriptions/{subscriptionUid}/managedCustomerNetwork/bss/tags/{tagUid}

Remove Base Station Tag

GET /subscriptions/{subscriptionUid}/managedCustomerNetwork/bss/tags/suggestions

Retrieve Base Station Tag Suggestions

GET /subscriptions/{subscriptionUid}/managedCustomerNetwork/frames

Retrieve Managed Customer Network Frames

GET /subscriptions/{subscriptionUid}/multicastGroups

Retrieve Multicast Groups

POST /subscriptions/{subscriptionUid}/multicastGroups

Create Multicast Group

GET /subscriptions/{subscriptionUid}/multicastGroups/bss/tags/suggestions

Retrieve Base Station Tag Suggestions

GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}

Retrieve Multicast Group

PUT /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}

Update Multicast Group

DELETE /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}

Delete Multicast Group

GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/alarms

Retrieve Alarms

POST /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/alarms/ack

Ack all alarms

POST /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/alarms/{alarmUid}/ack

Ack the alarm

GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/bss

Retrieve Multicast Group Base Stations

GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/bss/tags

Retrieve Multicast Group Base Station Tags

POST /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/bss/tags

Associate Base Station Tag

DELETE /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/bss/tags/{tagUid}

Remove Base Station Tag

GET /subscriptions/{subscriptionUid}/multicastGroups/{multicastGroupUid}/frames

Retrieve Multicast Group Frames

What's Changed


GET /subscriptions/{subscriptionUid}/appServers

Retrieve AppServers

Parameters:

Added: query in query

Search appServers with an ID or a name containing the provided term. (prefix match)

Added: name in query

App server name filtering (prefix match)

Added: ID in query

App server ID filtering (prefix match)

Added: type in query

Returns Application Servers matching type:

  • 'HTTP'
  • 'HTTP_CELLULAR'
  • 'KAFKA'

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

By default, all Application Servers are returned.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Added property state (string)

      Application Server state

    • Changed property type (string)

      AS type (HTTP, HTTP_CELLULAR or KAFKA)

POST /subscriptions/{subscriptionUid}/appServers

Create AppServer

New type of App Server: HTTP Cellular

Request:
  • Changed property type (string)

    AS type (HTTP, HTTP_CELLULAR or KAFKA)

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Added property state (string)

    Application Server state

  • Changed property type (string)

    AS type (HTTP, HTTP_CELLULAR or KAFKA)

  • Changed property contentType (string)

    Content Type of messages sent by LRC on tunneling interface.

GET /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Retrieve AppServer

New type of App Server: HTTP Cellular

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property state (string)

    Application Server state

  • Changed property type (string)

    AS type (HTTP, HTTP_CELLULAR or KAFKA)

  • Changed property contentType (string)

    Content Type of messages sent by LRC on tunneling interface.

PUT /subscriptions/{subscriptionUid}/appServers/{appServerUid}

Update AppServer

New type of App Server: HTTP Cellular

Request:
  • Added property state (string)

    Application Server state

  • Changed property contentType (string)

    Content Type of messages sent by LRC on tunneling interface.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property state (string)

    Application Server state

  • Changed property type (string)

    AS type (HTTP, HTTP_CELLULAR or KAFKA)

  • Changed property contentType (string)

    Content Type of messages sent by LRC on tunneling interface.

GET /subscriptions/{subscriptionUid}/appServersRoutingProfiles

Retrieve AppServersRoutingProfiles

Parameters:

Added: type in query

Returns AS Routing Profiles matching type:

  • 'LORAWAN'
  • 'CELLULAR'
Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Added property type (string)

      AS routing profile type (LORAWAN or CELLULAR)

POST /subscriptions/{subscriptionUid}/appServersRoutingProfiles

Create AppServersRoutingProfile

New type of App Server Routing Profile: Cellular

Request:
  • Added property type (string)

    AS routing profile type (LORAWAN or CELLULAR)

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Added property type (string)

    AS routing profile type (LORAWAN or CELLULAR)

  • Changed 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.

GET /subscriptions/{subscriptionUid}/appServersRoutingProfiles/{appServersRoutingProfileUid}

Retrieve AppServersRoutingProfile

New type of App Server Routing Profile: Cellular

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property type (string)

    AS routing profile type (LORAWAN or CELLULAR)

  • Changed 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.

PUT /subscriptions/{subscriptionUid}/appServersRoutingProfiles/{appServersRoutingProfileUid}

Update AppServersRoutingProfile

New type of App Server Routing Profile: Cellular

Request:
  • Changed 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.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property type (string)

    AS routing profile type (LORAWAN or CELLULAR)

  • Changed 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.

GET /subscriptions/{subscriptionUid}/devices

Retrieve Devices

Parameters:

Added: query in query

Search devices with a devEUI or a name containing the provided term. (prefix match)

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Cellular connectivity

      • Added property lastMicroflowTimestamp (string)

        Timestamp of the last microflow event

      • Added property historyMicroflowDaily (object)

        List of last cumulated microflow events per 2h period for a 24h duration before the lastMicroflowTimestamp.

POST /subscriptions/{subscriptionUid}/devices

Create Device

Request:
  • Changed property motionIndicator (string)

    Motion indicator of the device:

    • NEAR_STATIC
    • WALKING_SPEED
    • BIKE_SPEED
    • VEHICLE_SPEED
    • RANDOM

    When not set, the motion indicator of the device profile is used.

  • LoRaWAN connectivity

    • Added property hsmAppKeyVersion (string)

      HSM application key version used to encrypt AppKey

      ABP: FORBIDDEN

      OTAA: OPTIONAL

  • Cellular connectivity

    • Changed property imsi (string)

      IMSI of the SIM card (10-15 digits)

      Mandatory for cellular device

Return Type:

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Changed property motionIndicator (string)

    Motion indicator of the device:

    • NEAR_STATIC
    • WALKING_SPEED
    • BIKE_SPEED
    • VEHICLE_SPEED
    • RANDOM

    When not set, the motion indicator of the device profile is used.

  • Changed property networkSubscription (object)

    • Added property allowDirectIPMode (boolean)

      True when the Device is associated with a Connectivity Plan where the direct IP mode feature flag is activated.

      False otherwise.

      Only applicable when connectivity is 'CELLULAR'

    • Added property allowMessageMode (boolean)

      True when the Device is associated with a Connectivity Plan where the message mode feature flag is activated.

      False otherwise.

      Only applicable when connectivity is 'CELLULAR'

  • LoRaWan connectivity

    • Changed property debug (object)

      • Added property allowed (boolean)

        TRUE if user is allowed to access device debug feature

      • Added property lorawan (boolean)

        TRUE if LoRaWAN debugging is activated

      • Added property lorawanSince (string)

        Last update of LoRaWAN debugging mode

  • Cellular connectivity

    • Changed property imsi (string)

      IMSI of the SIM card (10-15 digits)

      Mandatory for cellular device

    • Added property lastMicroflowTimestamp (string)

      Timestamp of the last microflow event

    • Added property historyMicroflowDaily (object)

      List of last cumulated microflow events per 2h period for a 24h duration before the lastMicroflowTimestamp.

GET /subscriptions/{subscriptionUid}/devices/{deviceUid}

Retrieve Device

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property motionIndicator (string)

    Motion indicator of the device:

    • NEAR_STATIC
    • WALKING_SPEED
    • BIKE_SPEED
    • VEHICLE_SPEED
    • RANDOM

    When not set, the motion indicator of the device profile is used.

  • Changed property networkSubscription (object)

    • Added property allowDirectIPMode (boolean)

      True when the Device is associated with a Connectivity Plan where the direct IP mode feature flag is activated.

      False otherwise.

      Only applicable when connectivity is 'CELLULAR'

    • Added property allowMessageMode (boolean)

      True when the Device is associated with a Connectivity Plan where the message mode feature flag is activated.

      False otherwise.

      Only applicable when connectivity is 'CELLULAR'

  • LoRaWan connectivity

    • Changed property debug (object)

      • Added property allowed (boolean)

        TRUE if user is allowed to access device debug feature

      • Added property lorawan (boolean)

        TRUE if LoRaWAN debugging is activated

      • Added property lorawanSince (string)

        Last update of LoRaWAN debugging mode

  • Cellular connectivity

    • Changed property imsi (string)

      IMSI of the SIM card (10-15 digits)

      Mandatory for cellular device

    • Added property lastMicroflowTimestamp (string)

      Timestamp of the last microflow event

    • Added property historyMicroflowDaily (object)

      List of last cumulated microflow events per 2h period for a 24h duration before the lastMicroflowTimestamp.

PUT /subscriptions/{subscriptionUid}/devices/{deviceUid}

Update Device

Request:
  • Changed property motionIndicator (string)

    Motion indicator of the device:

    • NEAR_STATIC
    • WALKING_SPEED
    • BIKE_SPEED
    • VEHICLE_SPEED
    • RANDOM

    When not set, the motion indicator of the device profile is used.

  • LoRaWAN connectivity

    • Added property hsmAppKeyVersion (string)

      HSM application key version used to encrypt AppKey

      ABP: FORBIDDEN

      OTAA: OPTIONAL

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Deleted property appServers (array)

  • Changed property motionIndicator (string)

    Motion indicator of the device:

    • NEAR_STATIC
    • WALKING_SPEED
    • BIKE_SPEED
    • VEHICLE_SPEED
    • RANDOM

    When not set, the motion indicator of the device profile is used.

  • Changed property networkSubscription (object)

    • Added property allowDirectIPMode (boolean)

      True when the Device is associated with a Connectivity Plan where the direct IP mode feature flag is activated.

      False otherwise.

      Only applicable when connectivity is 'CELLULAR'

    • Added property allowMessageMode (boolean)

      True when the Device is associated with a Connectivity Plan where the message mode feature flag is activated.

      False otherwise.

      Only applicable when connectivity is 'CELLULAR'

  • LoRaWan connectivity

    • Changed property debug (object)

      • Added property allowed (boolean)

        TRUE if user is allowed to access device debug feature

      • Added property lorawan (boolean)

        TRUE if LoRaWAN debugging is activated

      • Added property lorawanSince (string)

        Last update of LoRaWAN debugging mode

  • Cellular connectivity

    • Changed property imsi (string)

      IMSI of the SIM card (10-15 digits)

      Mandatory for cellular device

    • Added property lastMicroflowTimestamp (string)

      Timestamp of the last microflow event

    • Added property historyMicroflowDaily (object)

      List of last cumulated microflow events per 2h period for a 24h duration before the lastMicroflowTimestamp.

GET /subscriptions/{subscriptionUid}/devices/frames

Retrieve FramesDevices

Parameters:

Added: type in query

Type of the frames to consider:

  • 0: Uplink
  • 1: downlink
  • 4: Microflow event frame indicator.

Multiple type query parameters can be encoded in the URI: all specified frames are considered.

By default all frames are considered.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Added property mf (object)
GET /subscriptions/{subscriptionUid}/devices/frames/aggregated

Retrieve FramesDeviceAggregation

Parameters:

Added: type in query

Type of the frames to consider:

  • 0: Uplink
  • 1: downlink
  • 4: Microflow event frame indicator.

Multiple type query parameters can be encoded in the URI: all specified frames are considered.

By default all frames are considered.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Added property mf (object)
POST /subscriptions/{subscriptionUid}/devices/import

Create Import

Request:

The device importation CSV file defines new column:

ABP activation:

ColumnDefinitionCardinality
Sn/a

OTAA activation:

ColumnDefinitionCardinality
SHSM application key versionHSM application key version used to encrypt AppKey. Optional if External Join Server option is DEACTIVATED, Forbidden otherwise.

Cellular Device:

ColumnDefinitionCardinality
Sn/a

The following device importation CSV file column changed:

Cellular Device:

ColumnDefinitionCardinality
CIMSI of the SIM cardMandatory
POST /subscriptions/{subscriptionUid}/devices/{deviceUid}/alarms/ack

Ack all alarms

Parameters:

Deprecated: algo in query

Algorithm used to generate the KPI:

  • mapReduce: MongoDB map/reduce is used
  • aggregation: MongoDB aggregation is used

Default value: When this query parameter is not specified the aggregation algorithm is used by default.

GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/frames

Retrieve FramesDevice

Parameters:

Added: type in query

Type of the frames to consider:

  • 0: Uplink
  • 1: downlink
  • 4: Microflow event frame indicator.

Multiple type query parameters can be encoded in the URI: all specified frames are considered.

By default all frames are considered.

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Changed property type (integer)

      Type of the frame: Uplink (0), downlink (1) or Microflow event (4) frame indicator

    • Changed property bitrate (number)

      Bitrate associated to the frame

      Only applies to uplink frames (type=0) and downlink frames (type=1)

    • Changed property size (integer)

      Size of the payload for uplink frames (type=0) and downlinkframes (type=1)

      Sum of uplink bytes and downlink bytes for microflow events (type=4)

    • Changed property sf (integer)

      Spreading factor

      Only applies to uplink frames (type=0) and downlink frames (type=1)

    • Changed property overflow (boolean)

      Network subscription overflow indicator

      Only applies to uplink frames (type=0) and downlink frames (type=1)

    • Added property duration (integer)

      Microflow duration in seconds

      Only applies to microflow events (type=4)

    • Added property sizeUp (integer)

      Microflow uplink bytes

      Only applies to microflow events (type=4)

    • Added property cellID (string)

      Microflow Cell-ID

      Only applies to microflow events (type=4)

    • Added property sizeDown (integer)

      Microflow downlink bytes

      Only applies to microflow events (type=4)

GET /subscriptions/{subscriptionUid}/devices/{deviceUid}/locations

Retrieve Locations

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Added property FCntUp (integer)

      Associated FCntUp (when applicable)

    • Added property eVelocity (number)

      Aggregated east velocity(m/s)

    • Added property nVelocity (number)

      Aggregated north velocity (m/s)

GET /subscriptions/{subscriptionUid}/networkSubscriptions

Retrieve NetworkSubscriptions

Parameters:

Added: communicationType in query

Returns Network Subscriptions matching communication type (exact match).

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Added property communicationType (string)

      Communication type of Connectivity Plan:

      • 'UNICAST': Unicast communication
      • 'MULTICAST': Multicast communication
GET /subscriptions/{subscriptionUid}/networkSubscriptions/{networkSubscriptionUid}

Retrieve NetworkSubscription

Return Type:

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property communicationType (string)

    Communication type of Connectivity Plan:

    • 'UNICAST': Unicast communication
    • 'MULTICAST': Multicast communication
  • Added property managedCustomerNetwork (boolean)

    Managed Customer Network activation flag

  • LoRaWan connectivity

    • Added property multicastCollisionAvoidanceDistance (integer)

      Minimum distance between two LRRs to avoid transmission collision (in meters)

    • Added property multicastInterDelay (integer)

      Transmission delay between different LRRs (in seconds)

    • Added property multicastMaxLrrCells (integer)

      Maximum number of LRRs associated with the multicast group (absolute maximum is 1000)

    • Added property multicastMaxTransmit (integer)

      Maximum number of times the LRC will attempts to transmit frames to LRRs which could not broadcast it

    • Added property multicastRetransmitTimer (integer)

      Delay between two multicast retransmissions burst (in seconds)

  • Cellular connectivity

    • Added property allowMessageMode (boolean)

      Enable the Device to send message mode packets

    • Added property allowDirectIPMode (boolean)

      Enable the Device to send direct IP mode traffic

    • Added property maximumBandwidthUp (integer)

      Maximum allowed bandwidth in kbps for the direct IP mode traffic sent by the Device

    • Added property maximumBandwidthDown (integer)

      Maximum allowed bandwidth in kbps for the direct IP mode traffic received by the Device

    • Added property microflowMinimalDuration (integer)

      Minimal duration of a microflow event in seconds. Acceptable range is from 10 seconds to 1 minute

    • Added property microflowMaximalDuration (integer)

      Maximal duration of a microflow event in seconds. Acceptable range is from 1 minute to 1 hour

    • Added property microflowMaximalVolume (integer)

      Maximal volume of the uplink and downlink direct IP mode traffic in KB to close a microflow event. Acceptable range is from 50 KB to 10 MB

Release 4.3.1

RDTP-2796

Following web services are updated:

  • RU /subscriptions/\{subscriptionUid\}/appServers/\{appServerUid\}
Attribute nameXSD typeCreateUpdateResp.Description
dxBridge/state → NEWenumerateODX Bridge dataflow status:- AWAITING_VALIDATION: waiting to be validated for deployment- AWAITING_UPDATE: waiting for the execution instance to be updated- READY: deployed and ready to be used- DEPLOY_ERROR: could not be deployed due to an error

RDTP-7324

Following web services are updated:

  • R /subscriptions/\{subscriptionUid\}/devices

Query parameters

from → NEWdateTimeOnly returns Devices created on or after this timestamp. Syntax: ISO 8601 timestamp with time zone designator.O
to → NEWdateTimeOnly returns Devices created on or before this timestamp. Syntax: ISO 8601 timestamp with time zone designator.O

Release 4.3

NFR691

Following web services are updated:

Attribute nameXSD typeUpdateResp.Description
options/cellularSupport → NEWenumerateMSupport of cellular devices:- 'DEACTIVATED': cellular devices cannot be created- 'SPR': cellular devices can be created, only SPR data must be provided- 'HSS_SPR': cellular devices can be created, HSS and SPR data must be provided
Attribute nameXSD typeResp.Description
briefs/brief[]/connectivity → NEWstringMDevice Profile connectivityEnumerate:- 'LORAWAN': LoRaWAN connectivity- 'CELLULAR': Cellular connectivity

Query parameters

connectivity → NEWStringReturns Device Profiles matching connectivity (exact match).O
Attribute nameXSD typeResp.Description
briefs/brief[]/connectivity → NEWstringMType of Connectivity PlanEnumerate:- 'LORAWAN': LoRaWAN connectivity- 'CELLULAR': Cellular connectivity

Query parameters

connectivityStringReturns Network Subscriptions matching connectivity (exact match).O
Attribute nameXSD typeResp.Description
connectivity → NEWstringMType of Connectivity PlanEnumerate:- 'LORAWAN': LoRaWAN connectivity- 'CELLULAR': Cellular connectivity

Split LORAWAN specific attributes

Attribute nameXSD typeResp.Description
briefs/brief[]/model/connectivity → NEWstringMDevice connectivityEnumerate:- 'LORAWAN': LoRaWAN connectivity- 'CELLULAR': Cellular connectivity
briefs/brief[]/EUI → EXISTINGstringMLoRaWAN device: DevEUICellular device: IMEI terminal identifier (14 digits)
briefs/brief[]/nwAddress → EXISTINGstringOLoRaWAN device: DevAddr (Mandatory for ABP / Optional for OTAA)Cellular device: Device IP address

Query parameters

connectivityStringReturns Devices matching connectivity:- 'LORAWAN'- 'CELLULAR'O

The device importation CSV file defines the following column for Cellular Device:

ColumnDefinitionCardinality
AProcessing directive (# for comments)
BIMEI terminal identifier (15 or 14 digits)Mandatory
CIMSI of the SIM cardOptional
DDevice profile IDMandatory
ESecret key of the SIM card (Ki)Optional
Fn/a
Gn/a
HConnectivity plan IDOptional
IAS routing profile IDOptional
JMaker IDOptional. The default maker will be used when no marker are specified at the creation.
KDevice nameOptional. The name is generated when not provided at the creation.
LAdmin LATOptional. When provided at the creation, the manual location is automatically activated, otherwise the network location is activated by default.
MAdmin LON
NOther admin infoOptional
OAlarm 004 configurationOptional
Pn/a
QMotion indicatorOptional. The motion indicator of the device profile will be used when no motion indicator is specified at the creation.
Rn/a

New supported processing directive:

  • CREATE_CELLULAR: Create a cellular device.
Attribute nameXSD typeCreateUpdateResp.Description
connectivity → NEWstringOMDevice connectivityEnumerate:- 'LORAWAN': LoRaWAN connectivity- 'CELLULAR': Cellular connectivityDefault value: 'LORAWAN'
EUI → EXISTINGstringMMLoRaWAN device
DevEUI (16 hexa digits)
Cellular device
IMEI terminal identifier (15 or 14 digits for the creation / always 14 digits when the device is retrieved)
NOTE: The Luhn checksum is validate by TWA when the creation is done with 15 digits. After validation, the Control digits is stripped (i.e. not store in TWA).
nwAddress → EXISTINGstringOOLoRaWAN device
DevAddr (Mandatory for ABP / Optional for OTAA)
Cellular device
Device IP address (Forbidden on Create)

Cellular parameters: only applicable when connectivity is 'CELLULAR'

Attribute nameXSD typeCreateUpdateResp.Description
imsi → NEWstringOOIMSI of the SIM card (10-15 digits)Forbidden if HSS provisioning is not activated in operator settings
ki → NEWstringOOSecret key of the SIM card (32 hexa digits)Forbidden if HSS provisioning is not activated in operator settings
lastRAT → NEWstringOLast Radio Access Type
lastCellID → NEWstringOLast Cell ID
lastCellMCCMNC → NEWstringOLast Cell MCC/MNC
lastCellTrackingAreaNumber → NEWstringOLast Cell Tracking Area Number
lastServingNetworkMCCMNC → NEWstringOLast Serving Network MCC/MNC

NFR731

Following web services are added:

  • C /subscriptions/\{subscriptionUid\}/devices/\{deviceUid\}/admins/reset

Release 4.2

NFR724

Following web services are updated:

  • RU /subscriptions/\{subscriptionUid\}
Attribute nameXSD typeCreateUpdateResp.Description
defaultIsmBand/ID → NEWstringOODefault ISM band ID
defaultIsmBand/name → NEWstringODefault ISM band name
installationID → NEWstringOInstallation ID
  • R /subscriptions/\{subscriptionUid\}/deviceProfiles
Attribute nameXSD typeCreateUpdateResp.Description
briefs/brief[]/vendor/name → NEWstringMName of the device vendor
briefs/brief[]/vendor/ID → NEWstringMID of the device vendor

Query parameters

vendorID → NEWstringDevice Vendor ID filtering (prefix match)O
ismBandID → NEWstringISM band ID filtering (exact match)O
  • R /subscriptions/\{subscriptionUid\}/devices
Attribute nameXSD typeCreateUpdateResp.Description
briefs/brief[]/healthState → NEWenumerateMHealth state:. INIT, ACTIVE, RF_CNX_ERROR
briefs/brief[]/vendor/name → NEWstringMDevice vendor name
briefs/brief[]/vendor/logo → NEWstringMDevice vendor logo HREF
briefs/brief[]/bestLRR/ID → NEWstringOBest LRR ID
briefs/brief[]/appServers/appServer[]/ name → NEWstringOApplication Server name

Query parameters

healthState → NEWenumerateHealth state filtering ("INIT", "ACTIVE" or "RF_CNX_ERROR").Multiple values can be set. If not provided, all Devices are returned.O
appServerID → NEWstringOnly returns Devices associated with the Application Server through direct association. Association through AS Routing Profile is not taken into account.Multiple values can be set: in this case Devices must be associated with all provided Application Servers.O
  • C /subscriptions/\{subscriptionUid\}/devices
  • RUD /subscriptions/\{subscriptionUid\}/devices/\{deviceUid\}
Attribute nameXSD typeCreateUpdateResp.Description
healthState → NEWenumerateMHealth state: INIT, ACTIVE, RF_CNX_ERROR
vendor/name → NEWstringMBS vendor name
vendor/logo → NEWstringMBS vendor logo HREF
appServers/appServer[]/name → NEWstringOM
appServers/appServer[]/ID → NEWstringOOMControl: When the AS list is updated the WS must check that the AS list is 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
appServers/appServer[]/href → NEWstringM
  • R /subscriptions/\{subscriptionUid\}/appServers
Attribute nameXSD typeCreateUpdateResp.Description
briefs/brief[]/deviceCount → NEWunsignedIntMNumber of Devices associated with the Application Server through direct association.
Devices associated with the Application Server through AS Routing Profiles are not taken into account.
briefs/brief[]/dxBridge/type → NEWenumerateOType of the DX Bridge dataflow:- MY_DEVICES- HTTP_GENERIC- AZURE- AWS- WATSON
  • CR /subscriptions/\{subscriptionUid\}/appServers/\{appServerUid\}
Attribute nameXSD typeCreateUpdateResp.Description
description → NEWstringOOApplication Server description
deviceCount → NEWunsignedIntMNumber of Devices associated with the Application Server through direct association.
Devices associated with the Application Server through AS Routing Profiles are not taken into account.
dxBridge/type → NEWenumerateOOType of the DX Bridge dataflow: MY_DEVICES, HTTP_GENERIC, AZURE, AWS, WATSON.
dxBridge/properties → NEWstringOOProperties of the DX Bridge dataflow connector (JSON document)
  • U /subscriptions/\{subscriptionUid\}/appServers/\{appServerUid\}/security
Attribute nameXSD typeCreateUpdateResp.Description
downlinkSecurity/asID → UPDATEDstringOOAS ID for downlink securityAllowed characters: alphanumeric, dash (-), dot (.) and underscore (_)

Following web services are added:

  • R /subscriptions/\{subscriptionUid\}/ismBands
  • R /subscriptions/\{subscriptionUid\}/deviceVendors
  • R /subscriptions/\{subscriptionUid\}/devices/counters
  • R /subscriptions/\{subscriptionUid\}/devices/frames

NFR880

Following web services are updated:

  • R /subscriptions/\{subscriptionUid\}/networkSubscriptions/\{networkSubscriptionUid\}
Attribute nameXSD typeCreateUpdateResp.Description
minRx1Delay → NEWunsignedIntOOptional minimal RX1 delay. When defined, the value has precedence on the RX1 value defined in the RF Region.

Release 4.1.2

NFR635 / NFR653

Following web services are updated:

  • U /subscriptions/\{subscriptionUid\}/devices/\{deviceUid\}
Attribute nameXSD typeCreateUpdateResp.Description
model/ID → UPDATEDstringMOM
  • R /subscriptions/\{subscriptionUid\}/deviceProfiles

Query parameters

typeMAC → NEWStringReturns Device Profiles matching typeMAC (exact match).O

NFR826

Following web services are updated:

  • C /subscriptions/\{subscriptionUid\}/devices/\{deviceUid\}/alarms/ack

Query parameter

algo → NEWstringAlgorithm used to generate the KPI:
  • mapReduce: MongoDB map/reduce is used
  • aggregation: MongoDB aggregation is used
Default value: When this query parameter is not specified the aggregation algorithm is used by default.
O

NFR883

Following web services are updated:

  • R /subscriptions/\{subscriptionUid\}/networkSubscriptions/\{networkSubscriptionUid\}
Attribute nameXSD typeCreateUpdateResp.Description
forceChannelMask → UPDATEDstringOForce channel mask (16 bits, 64 bits, 72 bits or 96 bits channel mask).

Release 4.1.1

NFR809

Following web services are updated:

  • R /subscriptions/\{subscriptionUid\}/networkSubscriptions/\{networkSubscriptionUid\}
Attribute nameXSD typeCreateUpdateResp.Description
raAllowed → NEWbooleanMRoaming activation allowed.
prAllowed → NEWbooleanMPassive roaming allowed.
hrAllowed → NEWbooleanMHandover roaming allowed.

Release 4.1

NFR274

Following web services are updated:

  • C /subscriptions/\{subscriptionUid\}/devices
  • RU /subscriptions/\{subscriptionUid\}/devices/\{deviceUid\}
Attribute nameXSD typeCreateUpdateResp.Description
appKeyEncryptionMode → NEWstringOOOMode used to encrypt the AppKey: LRC_CLUSTER\_KEY or HSM_APP_KEY
ABP : FORBIDDEN
OTAA : OPTIONAL (default value is LRC_CLUSTER_KEY)
hsmGroupID → NEWstringOOOID of HSM group used to encrypt the AppKeyOnly applicable when appKeyEncryptionMode is HSM_APP_KEY
ABP : FORBIDDEN
OTAA : OPTIONAL
  • C /subscriptions/\{subscriptionUid\}/devices/import

The device importation CSV file for OTAA activation is updated.

ColumnDefinitionCardinality
RHSM group IDOptional

The device importation CSV file for ABP activation is updated as well for compatibility purpose.

ColumnDefinitionCardinality
Rn/a
  • CRU /subscriptions/\{subscriptionUid\}/appServersRoutingProfiles/\{appServersRoutingProfileUid\}
Attribute nameXSD typeUpdateResp.Description
hsmSecurity/status → NEWstring (enumerate)MHSM security status: HSM_AS_KEY, NONE
hsmSecurity/hsmGroupID → NEWstringOID of HSM group used to generate the AS Key.
  • R /subscriptions/\{subscriptionUid\}/networkSubscriptions/\{networkSubscriptionUid\}
Attribute nameXSD typeCreateUpdateResp.Description
hsmGroupID → NEWstringOID of HSM group associated with the Connectivity Plan

Following web services are added:

  • R /subscriptions/\{subscriptionUid\}/hsmGroups
  • RU /subscriptions/\{subscriptionUid\}/appServersRoutingProfiles/\{appServersRoutingProfileUid\}/security

NFR725

Following web services are updated:

  • R /subscriptions/\{subscriptionUid\}/appServers
Attribute nameXSD typeCreateUpdateResp.Description
briefs/brief[]/type → UPDATEDenumerateMAS type (HTTP or KAFKA)
  • C /subscriptions/\{subscriptionUid\}/appServers

  • UR /subscriptions/\{subscriptionUid\}/appServers/\{appServerUid\}

Attribute nameXSD typeCreateUpdateResp.Description
type → UPDATEDstringOMAS type (HTTP or KAFKA)
Default: HTTP
destinations/destination[]/brokerID → NEWstringOOKafka Broker ID.
Note: Only applicable for Kafka AS
Note: Only one destination can be defined for a Kafka AS.
destinations/destination[]/topicName → NEWstringOOKafka Topic name
Note: Only applicable for Kafka AS
Note: Only one destination can be defined for a Kafka AS.
  • R /subscriptions/\{subscriptionUid\}/appServersRoutingProfiles/tpkClouds

cloudConfig may return ThingPark X <cloud> pointing out a HTTP destination, and <cloud> pointing out a KAFKA destination.

  • R /subscriptions/\{subscriptionUid\}/networkSubscriptions/\{networkSubscriptionUid\}
Attribute nameXSD typeCreateUpdateResp.Description
thingParkKafkaRouting → NEWbooleanMFeature flag

NFR743

Following web services are updated:

  • C /subscriptions/\{subscriptionUid\}/devices
  • RU /subscriptions/\{subscriptionUid\}/devices/\{deviceUid\}
Attribute nameXSD typeCreateUpdateResp.Description
model/type → UPDATEDstringMType of DeviceEnumerate:
  • 'A': Class A (Bi-directional end-devices with RIT)
  • 'B': Class B (Bi-directional end-devices with synchronized receive slots)
  • 'C': Class C (Bi-directional end-devices with maximal receive slots)
classBState → NEWunsignedIntOClass B state: Active (1), Inactive (0)
Only returned when model type is class B
  • R /subscriptions/\{subscriptionUid\}/networkSubscriptions/\{networkSubscriptionUid\}
Attribute nameXSD typeCreateUpdateResp.Description
allowClassB → NEWbooleanMFlag to signal that the network will honor requests to switch to LoraWAN class B.

NFR760 / NFR761

Following web services are updated:

  • R /subscriptions/\{subscriptionUid\}
Attribute nameXSD typeUpdateResp.Description
options/externalJS → NEWenumerateMExternal Join Server option:
  • DEACTIVATED
  • ACTIVATED
  • C /subscriptions/\{subscriptionUid\}/devices
  • RU /subscriptions/\{subscriptionUid\}/devices/\{deviceUid\}

Following attributes are FORBIDDEN if options/externalJS='ACTIVATED':

  • activation=ABP (only activation=OTAA is allowed)

  • appKey

  • appKeyEncryptionMode

  • hsmGroupID

  • C /subscriptions/\{subscriptionUid\}/devices/import

Following columns are FORBIDDEN in CSV file if options/externalJS='ACTIVATED':

  • A (Processing directive): only CREATE_OTAA and DELETE directives are allowed

  • F (Application Key)

  • R (HSM Group ID)

  • U /subscriptions/\{subscriptionUid\}/appServersRoutingProfiles/\{appServersRoutingProfileUid\}/security

The attribute hsmSecurity/status cannot be set to 'HSM_AS_KEY' if options/externalJS='ACTIVATED'.

NFR792

Following web services are updated:

  • R /subscriptions/\{subscriptionUid\}/networkSubscriptions/\{networkSubscriptionUid\}
Attribute nameXSD typeCreateUpdateResp.Description
adrVersion → NEWfloatMADR algorithm version: SNR based ADR optimization algorithm (2), PER based ADR optimization algorithm (3)