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
- application servers with the
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
- application servers with the
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 theSUBSCRIPTION
scope)- the identifier (
ID
) of the application server prefixed byid:
(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
- application servers with the
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 theSUBSCRIPTION
scope)- the identifier (
ID
) of the application server prefixed byid:
(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
- application servers with the
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 theSUBSCRIPTION
scope)- the identifier (
ID
) of the application server prefixed byid:
(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 theSUBSCRIPTION
scope)- the identifier (
ID
) of the application server prefixed byid:
(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 theSUBSCRIPTION
scope)- the identifier (
ID
) of the application server prefixed byid:
(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)
- Property
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)
- Property
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
- Added property
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
isPREFIX
:- The name of the resource domain is prefixed with
name
- The name of the resource domain is prefixed with
- Else: (
type
isFULL
)- The name of the resource domain is
name
(exact match)
- The name of the resource domain is
-
Property
type
(string)Type of domain restriction:
FULL
: restriction on full domainPREFIX
: restriction on domain prefix
Enum values:
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
- Property
- The group name of the resource domain is
-
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.
- Deleted property
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