| [/queries/rab_info](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs012-rnis-api/raw/v2.1.1/RniAPI.yaml#/rni/rab_infoGET)<br><br>This resource is queried to retrieve information on Radio Access Bearers | Terminals are identified via UE_IPV4_ADDRESS type in associateId <br><br> Sandbox query input utilizes: <ul><li> cell_id (array): returns RabInfo for all terminals connected within the input cells (RabInfo includes terminal's assoicateId = IP address) </li><li> ue_ipv4_address (array): returns RabInfo for all input terminal's based on IP address (RabInfo includes terminal's connected Cell Id) </li><li> If no parameters are included: returns all RabInfo for all connected terminals in all cells </li><li> Both parameters are considered an "and" </li></ul> All other parameter are ignored, including MEC Application instance ID <br> | Although the MEC Sandbox does not include data paths to terminals, the rab_info query can be used to discover terminals that are connected to 4G cells in the Sandbox. Terminals connected to WiFi or 5G PoA's do not have a RAB. <br><br> As a Sandbox user, I can use this call to learn about all terminals in the network connected to 3GPP 4G PoAs. I do not need to know the Terminal Id or the Cell Id. Input = null. <br><br> As a Sandbox user, if I know a Terminal's Id (IP address), I can use this call to determine if and where that terminal is 4G connected (input = terminal IP address) <br><br> As a Sandbox user, if I know a Cell Id, I can use this call to learn what terminals may be connected in that cell (input = cell id in EGCI format). <br><br> All RABs have a consistent QCI value (e.g. non-GBR, QCI = 80 -- Low latency eMBB applications, TCP/UDP-based).
| [/queries/rab_info](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs012-rnis-api/raw/v2.2.1/RniAPI.yaml#/rni/rab_infoGET)<br><br>This resource is queried to retrieve information on Radio Access Bearers | Terminals are identified via UE_IPV4_ADDRESS type in associateId <br><br> Sandbox query input utilizes: <ul><li> cell_id (array): returns RabInfo for all terminals connected within the input cells (RabInfo includes terminal's associateId = IP address) </li><li> ue_ipv4_address (array): returns RabInfo for all input terminal's based on IP address (RabInfo includes terminal's connected Cell Id) </li><li> If no parameters are included: returns all RabInfo for all connected terminals in all cells </li><li> Both parameters are considered an "and" </li></ul> All other parameter are ignored, including MEC Application instance ID <br> | Although the MEC Sandbox does not include data paths to terminals, the rab_info query can be used to discover terminals that are connected to 4G cells in the Sandbox. Terminals connected to WiFi or 5G PoA's do not have a RAB. <br><br> As a Sandbox user, I can use this call to learn about all terminals in the network connected to 3GPP 4G PoAs. I do not need to know the Terminal Id or the Cell Id. Input = null. <br><br> As a Sandbox user, if I know a Terminal's Id (IP address), I can use this call to determine if and where that terminal is 4G connected (input = terminal IP address) <br><br> As a Sandbox user, if I know a Cell Id, I can use this call to learn what terminals may be connected in that cell (input = cell id in EGCI format). <br><br> All RABs have a consistent QCI value (e.g. non-GBR, QCI = 80 -- Low latency eMBB applications, TCP/UDP-based).
| [/queries/plmn_info](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs012-rnis-api/raw/v2.1.1/RniAPI.yaml#/rni/plmn_infoGET)<br><br>This resource is queried to retrieve information on the underlying Mobile Network (PLMN) that the mobile edge application is associated (i.e. connected). | Returns Sandbox PLMN: <ul><li> MCC = 001 <li> MNC = 001</ul> Application instance identifier is ignored. | As a Sandbox user, I can use this query to learn the PLMN of the Sandbox Network. |
| [/queries/plmn_info](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs012-rnis-api/raw/v2.2.1/RniAPI.yaml#/rni/plmn_infoGET)<br><br>This resource is queried to retrieve information on the underlying Mobile Network (PLMN) that the mobile edge application is associated (i.e. connected). | Returns Sandbox PLMN: <ul><li> MCC = 001 <li> MNC = 001</ul> Application instance identifier is ignored. | As a Sandbox user, I can use this query to learn the PLMN of the Sandbox Network. |
| [/queries/s1_bearer_info](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs012-rnis-api/raw/v2.1.1/RniAPI.yaml#/rni/s1_bearer_infoGET)<br><br>This resource is queried to retrieve S1-U bearer information related to specific UE(s). | _Not supporting - future consideration beyond STF599_ | S1 Bearers are not modeled or emulated in the MEC Sandbox. |
| [/queries/s1_bearer_info](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs012-rnis-api/raw/v2.2.1/RniAPI.yaml#/rni/s1_bearer_infoGET)<br><br>This resource is queried to retrieve S1-U bearer information related to specific UE(s). | _Not supporting - future consideration beyond STF599_ | S1 Bearers are not modeled or emulated in the MEC Sandbox. |
| [/queries/layer2_meas](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs012-rnis-api/raw/v2.1.1/RniAPI.yaml#/rni/layer2_meas_infoGET)<br><br>This resource is queried to obtained detailed 4G cellular measurement information, filtered per UE, per Cell, etc. <br><br>_New STF599_ | Returns 4G L2 measurement information: <ol><li> Cell level information (for each 4G cell in the system): <ul><li> E-UTRAN Cell Global Identifier <li> # of active GBR and non-GBR terminals </li></ul><li> UE level information (for each 4G connected terminal): <ul><li> connected 4G E-UTRAN Cell ID <li> UE assoicated id (IPV4 address) <li> packet delay </ul></ol><br> Input filter parameters include: <ul><li> Cell Id List - results are filtered to include only the input cells </li><li> UE IPv4 address list - results are filtered to include only the input devices </li></ul> | As a MEC Sandbox user or MEC Application, I can use this query to learn how many 4G cells are in the system and how many terminals are connected to them. I can also learn what terminals are connected to 4G cells and which specific cell. <br><br>*Sandbox emulation does not include data traffic to/from emulated terminal devices. As such, active measurements are currently not available in the Sandbox, such as throughput or data volume. However, these may be supported in the future (beyond STF599).* |
| [/queries/layer2_meas](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs012-rnis-api/raw/v2.2.1/RniAPI.yaml#/rni/layer2_meas_infoGET)<br><br>This resource is queried to obtained detailed 4G cellular measurement information, filtered per UE, per Cell, etc. <br><br>_New STF599_ | Returns 4G L2 measurement information: <ol><li> Cell level information (for each 4G cell in the system): <ul><li> E-UTRAN Cell Global Identifier <li> # of active GBR and non-GBR terminals </li></ul><li> UE level information (for each 4G connected terminal): <ul><li> connected 4G E-UTRAN Cell ID <li> UE associated id (IPV4 address) <li> packet delay </ul></ol><br> Input filter parameters include: <ul><li> Cell Id List - results are filtered to include only the input cells </li><li> UE IPv4 address list - results are filtered to include only the input devices </li></ul> | As a MEC Sandbox user or MEC Application, I can use this query to learn how many 4G cells are in the system and how many terminals are connected to them. I can also learn what terminals are connected to 4G cells and which specific cell. <br><br>*Sandbox emulation does not include data traffic to/from emulated terminal devices. As such, active measurements are currently not available in the Sandbox, such as throughput or data volume. However, these may be supported in the future (beyond STF599).* |
### Subscription Endpoints
### Subscription Endpoints
> With RNIS v2.1.1 all subscription types are managed under a single _/subscriptions_ endpoint. For readability, the following table presents each subscription type in a separate listing. However, they are all managed under the GET, POST, PUT, and DELETE methods for _/subscriptions_ and _/subscriptions/{subscriptionId} endpoints._ <br><br> The MEC Sandbox does not support subscription expiry deadlines or notifications.
> With RNIS v2.2.1 all subscription types are managed under a single _/subscriptions_ endpoint. For readability, the following table presents each subscription type in a separate listing. However, they are all managed under the GET, POST, PUT, and DELETE methods for _/subscriptions_ and _/subscriptions/{subscriptionId} endpoints._ <br><br> The MEC Sandbox does not support subscription expiry deadlines or notifications.
| [/subscriptions](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs012-rnis-api/raw/v2.1.1/RniAPI.yaml#/rni/subscriptionLinkList_subscriptionsGET)<br><br> GET method is used to request information about all RNIS the subscriptions for this requestor. Upon success, the response contains entity body with the list of links to the subscriptions in RNIS for the requestor | Return list of all RNIS subscriptions | /subscriptions/{subscriptionId} returns the subscription information for a specific subscription. |
| [/subscriptions](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs012-rnis-api/raw/v2.2.1/RniAPI.yaml#/rni/subscriptionLinkList_subscriptionsGET)<br><br> GET method is used to request information about all RNIS the subscriptions for this requestor. Upon success, the response contains entity body with the list of links to the subscriptions in RNIS for the requestor | Return list of all RNIS subscriptions | /subscriptions/{subscriptionId} returns the subscription information for a specific subscription. |
| [/subscriptions](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs012-rnis-api/raw/v2.1.1/RniAPI.yaml#/rni/subscriptionsPOST)<br><br> POST method is used create a notification subscription instance. Upon success, the response contains entity body of the created subscription (including it's unique subscriptionId). | Utlized to create subscriptions in RNIS. | With the subscriptionId, /subscriptions/{subscriptionId}: <ul><li> PUT method: updates the subscription </li><li> DELETE: removes the subscription </li></ul> |
| [/subscriptions](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs012-rnis-api/raw/v2.2.1/RniAPI.yaml#/rni/subscriptionsPOST)<br><br> POST method is used create a notification subscription instance. Upon success, the response contains entity body of the created subscription (including it's unique subscriptionId). | Utilized to create subscriptions in RNIS. | With the subscriptionId, /subscriptions/{subscriptionId}: <ul><li> PUT method: updates the subscription </li><li> DELETE: removes the subscription </li></ul> |
| /subscriptions/CellChangeSubscription <br><br>_Cell change notifications_ | Notifications report cell changes based on input filters <br><br> Supported filters (filterCriteriaAssocHo) include: <ul><li> associateId: list of terminals based on IP address (if not present, all UEs are considered) <li> plmnId: ignored <li> cellId: list of cells (if not present, all cells are considered) <li> hoStatus: ignored (notifications on COMPLETE handover status only) <li> expiry deadline: ignored </ul> Filters are considered an "and" between types, then an "or" within the list of a type. For example: UEs (1,2,3) + Cells (a,b,c). Notification will trigger if any of the UEs (1,2,3) handover with any of the cells (a,b,c); Otherwise, no notification is triggered. <br><br> Notification returns: <ul><li> associateId: IPv4 address of the terminal <li> srcEgci: handover source cell <li> trgEcgi: handover target cell </ul> | As a MEC Sandbox user or MEC Application, I can set a notification with no filters and I will get all 4G cell change events that occur in the Sandbox. <br><br> As a MEC Sandbox user or MEC Application, I can set a notification for a specific terminal (or set or terminals) and monitor its handover changes across the 4G points of access. <br><br> As a MEC Sandbox user or MEC Application, I can set a notification to monitor a specific 4G cell (or set of 4G cells) and monitor handover events for that cell. <br><br> _A terminal device connecting to a 5G cell or to a WiFi access point is not considered a 4G handover event, according to the 3GPP standards. As such, a device connecting to 5G/WiFi from 4G or to 4G from 5G/WiFi does not trigger a cell change notification in the MEC Sandbox._
| /subscriptions/CellChangeSubscription <br><br>_Cell change notifications_ | Notifications report cell changes based on input filters <br><br> Supported filters (filterCriteriaAssocHo) include: <ul><li> associateId: list of terminals based on IP address (if not present, all UEs are considered) <li> plmnId: ignored <li> cellId: list of cells (if not present, all cells are considered) <li> hoStatus: ignored (notifications on COMPLETE handover status only) <li> expiry deadline: ignored </ul> Filters are considered an "and" between types, then an "or" within the list of a type. For example: UEs (1,2,3) + Cells (a,b,c). Notification will trigger if any of the UEs (1,2,3) handover with any of the cells (a,b,c); Otherwise, no notification is triggered. <br><br> Notification returns: <ul><li> associateId: IPv4 address of the terminal <li> srcEcgi: handover source cell <li> trgEcgi: handover target cell </ul> | As a MEC Sandbox user or MEC Application, I can set a notification with no filters and I will get all 4G cell change events that occur in the Sandbox. <br><br> As a MEC Sandbox user or MEC Application, I can set a notification for a specific terminal (or set or terminals) and monitor its handover changes across the 4G points of access. <br><br> As a MEC Sandbox user or MEC Application, I can set a notification to monitor a specific 4G cell (or set of 4G cells) and monitor handover events for that cell. <br><br> _A terminal device connecting to a 5G cell or to a WiFi access point is not considered a 4G handover event, according to the 3GPP standards. As such, a device connecting to 5G/WiFi from 4G or to 4G from 5G/WiFi does not trigger a cell change notification in the MEC Sandbox._
| /subscriptions/RabEstSubscription <br><br>_RAB establishment notification_ | Notifications report RAB establishments in the MEC Sandbox network, i.e. when a terminal connects to a 4G cell. <br><br> Sandbox examples include: <ul><li> Terminal is added the MEC Sandbox by a user and it initially connects to a 4G macro cell <li> Terminal connects to a 4G PoA after being connected to WiFi or 5G </ul><br>Supported filters (filterCriteriaQci) include: <ul><li> cellId: list of cells (if not present, RAB establishment on any cell) <li> QCI: ignored <li> expiry deadline: ignored </ul><br> Notification returns: <ul><li> associateId: IPv4 address of the terminal <li> erabId: RAB Id for the terminal's bearer </ul> | As a Sandbox User, I can set a notification with no filters and I will get all RAB establishment events on any cell (terminal connection to 4G anywhere in the network). <br><br> As a Sandbox User, I can set a notification for a specific cell (or set of cells) and monitor RAB establishments for those cells. |
| /subscriptions/RabEstSubscription <br><br>_RAB establishment notification_ | Notifications report RAB establishments in the MEC Sandbox network, i.e. when a terminal connects to a 4G cell. <br><br> Sandbox examples include: <ul><li> Terminal is added the MEC Sandbox by a user and it initially connects to a 4G macro cell <li> Terminal connects to a 4G PoA after being connected to WiFi or 5G </ul><br>Supported filters (filterCriteriaQci) include: <ul><li> cellId: list of cells (if not present, RAB establishment on any cell) <li> QCI: ignored <li> expiry deadline: ignored </ul><br> Notification returns: <ul><li> associateId: IPv4 address of the terminal <li> erabId: RAB Id for the terminal's bearer </ul> | As a Sandbox User, I can set a notification with no filters and I will get all RAB establishment events on any cell (terminal connection to 4G anywhere in the network). <br><br> As a Sandbox User, I can set a notification for a specific cell (or set of cells) and monitor RAB establishments for those cells. |
| /subscriptions/RabModSubscription <br><br>_RAB modification notification_ | Not supporting - future consideration beyond STF599 | Within the MEC Sandbox RABs will not change QCR, GBR or MBR. |
| /subscriptions/RabModSubscription <br><br>_RAB modification notification_ | Not supporting - future consideration beyond STF599 | Within the MEC Sandbox RABs will not change QCR, GBR or MBR. |
| /subscriptions/RabRelSubscription <br><br>_RAB release notification_ | Notifications report RAB releases in the network, i.e. when a terminal disconnects from a 4G PoA. Sandbox examples include: <ul><li> Terminal is removed by the user from the Sandbox Scenario when it was connected to a 4G PoA. <li> Terminal disconnects from a 4G PoA and connects to WiFi or 5G (RAB is released consistent with 3GPP standards). </ul><br> Supported filters (filterCriteriaQci) include: <ul><li> erabId: single value (must be included in the request to identify the RAB) <li> cellId: list of cells (filters for specific cells, if not present, RAB release on any cell) <li> QCI: ignored <li> expiry deadline: ignored </ul><br> Notification returns: <ul><li> ecgi: 4G cell Id where the RAB was released <li> erabId: RAB Id for the released terminal's bearer </ul> | <br><br> As a Sandbox User, I can set a RAB release notification for a specific terminal and I will get a notification, if that terminal disconnects from 4G. |
| /subscriptions/RabRelSubscription <br><br>_RAB release notification_ | Notifications report RAB releases in the network, i.e. when a terminal disconnects from a 4G PoA. Sandbox examples include: <ul><li> Terminal is removed by the user from the Sandbox Scenario when it was connected to a 4G PoA. <li> Terminal disconnects from a 4G PoA and connects to WiFi or 5G (RAB is released consistent with 3GPP standards). </ul><br> Supported filters (filterCriteriaQci) include: <ul><li> erabId: single value (must be included in the request to identify the RAB) <li> cellId: list of cells (filters for specific cells, if not present, RAB release on any cell) <li> QCI: ignored <li> expiry deadline: ignored </ul><br> Notification returns: <ul><li> ecgi: 4G cell Id where the RAB was released <li> erabId: RAB Id for the released terminal's bearer </ul> | <br><br> As a Sandbox User, I can set a RAB release notification for a specific terminal and I will get a notification, if that terminal disconnects from 4G. |
@@ -38,5 +38,3 @@ References:
| subscriptions/MeasTaSubscription <br><br>_Notification providing a UE timing advance report_ | _Not supporting - future consideration beyond STF599_ | Timing advanced can be emulated in the MEC Sandbox calculated based on terminal distance from a 4G PoA. |
| subscriptions/MeasTaSubscription <br><br>_Notification providing a UE timing advance report_ | _Not supporting - future consideration beyond STF599_ | Timing advanced can be emulated in the MEC Sandbox calculated based on terminal distance from a 4G PoA. |
| subscriptions/CaReconfSubscription <br><br>_Carrier aggregation reconfiguration notification_ | _Not supporting - future consideration beyond STF599_ | Not supporting carrier aggregation emulation. Too detailed for MEC Sandbox |
| subscriptions/CaReconfSubscription <br><br>_Carrier aggregation reconfiguration notification_ | _Not supporting - future consideration beyond STF599_ | Not supporting carrier aggregation emulation. Too detailed for MEC Sandbox |
| subscriptions/S1BearerSubscription <br><br>_S1 bearer modification notification_ | _Not supporting - future consideration beyond STF599_ | S1 Bearers are not modeled or emulated in the MEC Sandbox. |
| subscriptions/S1BearerSubscription <br><br>_S1 bearer modification notification_ | _Not supporting - future consideration beyond STF599_ | S1 Bearers are not modeled or emulated in the MEC Sandbox. |
