RniAPI.json

{
  "openapi": "3.0.0",
  "info": {
    "title": "ETSI GS MEC 012 - Radio Network Information API",
    "version": "2.1.1",
    "description": "The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.",
    "license": {
      "name": "BSD-3-Clause",
      "url": "https://forge.etsi.org/legal-matters"
    }
  },
  "externalDocs": {
    "description": "ETSI GS MEC 012 Radio Network Information API, V2.1.1",
    "url": "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/012/02.01.01_60/gs_mec012v020101p.pdf"
  },
  "servers": [
    {
      "url": "https://{apiRoot}/rni/v2"
    }
  ],
  "paths": {
    "/queries/rab_info": {
      "get": {
        "tags": [
          ""
        ],
        "summary": "Retrieve information on Radio Access Bearers",
        "description": "Queries information about the Radio Access Bearers",
        "operationId": "rab_infoGET",
        "parameters": [
          {
            "$ref": "#/components/parameters/Query.AppInsId"
          },
          {
            "$ref": "#/components/parameters/Query.CellId"
          },
          {
            "$ref": "#/components/parameters/Query.UeIpv4Address"
          },
          {
            "$ref": "#/components/parameters/Query.UeIpv6Address"
          },
          {
            "$ref": "#/components/parameters/Query.NatedIpAddress"
          },
          {
            "$ref": "#/components/parameters/Query.GtpTeid"
          },
          {
            "$ref": "#/components/parameters/Query.ErabId"
          },
          {
            "$ref": "#/components/parameters/Query.Qci"
          },
          {
            "$ref": "#/components/parameters/Query.ErabMbrDl"
          },
          {
            "$ref": "#/components/parameters/Query.ErabMbrUl"
          },
          {
            "$ref": "#/components/parameters/Query.ErabGbrDl"
          },
          {
            "$ref": "#/components/parameters/Query.ErabGbrUl"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response to rab_info request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "rabInfo": {
                      "$ref": "#/components/schemas/RabInfo"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "x-swagger-router-controller": "queries"
      }
    },
    "/queries/plmn_info": {
      "get": {
        "tags": [
          ""
        ],
        "summary": "Retrieve information on the underlying Mobile Network that the MEC application is associated to",
        "description": "Queries information about the Mobile Network",
        "operationId": "plmn_infoGET",
        "parameters": [
          {
            "$ref": "#/components/parameters/Query.AppInsIdArr"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response to plmn_info request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "plmnInfo": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/PlmnInfo"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "x-swagger-router-controller": "queries"
      }
    },
    "/queries/s1_bearer_info": {
      "get": {
        "tags": [
          ""
        ],
        "summary": "Retrieve S1-U bearer information related to specific UE(s)",
        "description": "Queries information about the S1 bearer(s)",
        "operationId": "s1_bearer_infoGET",
        "parameters": [
          {
            "$ref": "#/components/parameters/Query.TempUeId"
          },
          {
            "$ref": "#/components/parameters/Query.UeIpv4Address"
          },
          {
            "$ref": "#/components/parameters/Query.UeIpv6Address"
          },
          {
            "$ref": "#/components/parameters/Query.NatedIpAddress"
          },
          {
            "$ref": "#/components/parameters/Query.GtpTeid"
          },
          {
            "$ref": "#/components/parameters/Query.CellId"
          },
          {
            "$ref": "#/components/parameters/Query.ErabIdArr"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response to s1_bearer_info request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "s1BearerInfo"
                  ],
                  "properties": {
                    "s1BearerInfo": {
                      "$ref": "#/components/schemas/S1BearerInfo"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "x-swagger-router-controller": "queries"
      }
    },
    "/queries/layer2_meas": {
      "get": {
        "tags": [
          ""
        ],
        "summary": "Retrieve information on layer 2 measurements",
        "description": "Queries information about the layer 2 measurements.",
        "operationId": "layer2_meas_infoGET",
        "parameters": [
          {
            "$ref": "#/components/parameters/Query.AppInsId"
          },
          {
            "$ref": "#/components/parameters/Query.CellId"
          },
          {
            "$ref": "#/components/parameters/Query.UeIpv4Address"
          },
          {
            "$ref": "#/components/parameters/Query.UeIpv6Address"
          },
          {
            "$ref": "#/components/parameters/Query.NatedIpAddress"
          },
          {
            "$ref": "#/components/parameters/Query.GtpTeid"
          },
          {
            "$ref": "#/components/parameters/Query.DlGbrPrbUsageCell"
          },
          {
            "$ref": "#/components/parameters/Query.UlGbrPrbUsageCell"
          },
          {
            "$ref": "#/components/parameters/Query.DlNonGbrPrbUsageCell"
          },
          {
            "$ref": "#/components/parameters/Query.UlNonGbrPrbUsageCell"
          },
          {
            "$ref": "#/components/parameters/Query.DlTotalPrbUsageCell"
          },
          {
            "$ref": "#/components/parameters/Query.UlTotalPrbUsageCell"
          },
          {
            "$ref": "#/components/parameters/Query.ReceivedDedicatedPreamblesCell"
          },
          {
            "$ref": "#/components/parameters/Query.ReceivedRandomPreamblesLowRangeCell"
          },
          {
            "$ref": "#/components/parameters/Query.ReceivedRandomPreamblesHighRangeCell"
          },
          {
            "$ref": "#/components/parameters/Query.NumberOfActiveUeDlGbrCell"
          },
          {
            "$ref": "#/components/parameters/Query.NumberOfActiveUeUlGbrCell"
          },
          {
            "$ref": "#/components/parameters/Query.NumberOfActiveUeDlNonGbrCell"
          },
          {
            "$ref": "#/components/parameters/Query.NumberOfActiveUeUlNonGbrCell"
          },
          {
            "$ref": "#/components/parameters/Query.DlGbrPdrCell"
          },
          {
            "$ref": "#/components/parameters/Query.UlGbrPdrCell"
          },
          {
            "$ref": "#/components/parameters/Query.DlNonGbrPdrCell"
          },
          {
            "$ref": "#/components/parameters/Query.UlNonGbrPdrCell"
          },
          {
            "$ref": "#/components/parameters/Query.DlGbrDelayUe"
          },
          {
            "$ref": "#/components/parameters/Query.UlGbrDelayUe"
          },
          {
            "$ref": "#/components/parameters/Query.DlNonGbrDelayUe"
          },
          {
            "$ref": "#/components/parameters/Query.UlNonGbrDelayUe"
          },
          {
            "$ref": "#/components/parameters/Query.DlGbrPdrUe"
          },
          {
            "$ref": "#/components/parameters/Query.UlGbrPdrUe"
          },
          {
            "$ref": "#/components/parameters/Query.DlNonGbrPdrUe"
          },
          {
            "$ref": "#/components/parameters/Query.UlNonGbrPdrUe"
          },
          {
            "$ref": "#/components/parameters/Query.DlGbrThroughputUe"
          },
          {
            "$ref": "#/components/parameters/Query.UlGbrThroughputUe"
          },
          {
            "$ref": "#/components/parameters/Query.DlNonGbrThroughputUe"
          },
          {
            "$ref": "#/components/parameters/Query.UlNonGbrThroughputUe"
          },
          {
            "$ref": "#/components/parameters/Query.DlGbrDataVolumeUe"
          },
          {
            "$ref": "#/components/parameters/Query.UlGbrDataVolumeUe"
          },
          {
            "$ref": "#/components/parameters/Query.DlNonGbrDataVolumeUe"
          },
          {
            "$ref": "#/components/parameters/Query.UlNonGbrDataVolumeUe"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response to layer2 measurements info request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "l2Meas"
                  ],
                  "properties": {
                    "l2Meas": {
                      "$ref": "#/components/schemas/L2Meas"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "414": {
            "$ref": "#/components/responses/414"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "x-swagger-router-controller": "queries"
      }
    },
    "/subscriptions/": {
      "get": {
        "tags": [
          ""
        ],
        "summary": "Retrieve information on subscriptions for notifications",
        "description": "Queries information on subscriptions for notifications",
        "operationId": "subscriptionLinkList_subscriptionsGET",
        "parameters": [
          {
            "$ref": "#/components/parameters/Query.SubscriptionType"
          }
        ],
        "responses": {
          "200": {
            "description": "Response body contains the list of links to requestors subscriptions.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "subscriptionLinkList"
                  ],
                  "properties": {
                    "subscriptionLinkList": {
                      "$ref": "#/components/schemas/SubscriptionLinkList"
                    }
                  }
                },
                "example": {
                  "subscriptionLinkList": {
                    "_links": {
                      "self": {
                        "href": "http://meAppServer.example.com/rni/v2/subscriptions"
                      }
                    },
                    "subscription": [
                      {
                        "_links": {
                          "self": {
                            "href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123"
                          }
                        },
                        "callbackReference": "http://my.callback.com/rni-cell-change/some-id",
                        "subscriptionType": "CellChangeSubscription"
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "x-swagger-router-controller": "subscriptions"
      },
      "post": {
        "tags": [
          ""
        ],
        "summary": "Create a new subscription",
        "description": "Creates a new subscription to Radio Network Information notifications",
        "operationId": "subscriptionsPOST",
        "requestBody": {
          "description": "Subscription to be created",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "notificationSubscription": {
                    "oneOf": [
                      {
                        "$ref": "#/components/schemas/CellChangeSubscription"
                      },
                      {
                        "$ref": "#/components/schemas/RabEstSubscription"
                      },
                      {
                        "$ref": "#/components/schemas/RabModSubscription"
                      },
                      {
                        "$ref": "#/components/schemas/RabRelSubscription"
                      },
                      {
                        "$ref": "#/components/schemas/MeasRepUeSubscription"
                      },
                      {
                        "$ref": "#/components/schemas/NrMeasRepUeSubscription"
                      },
                      {
                        "$ref": "#/components/schemas/MeasTaSubscription"
                      },
                      {
                        "$ref": "#/components/schemas/CaReconfSubscription"
                      },
                      {
                        "$ref": "#/components/schemas/S1BearerSubscription"
                      }
                    ],
                    "discriminator": {
                      "propertyName": "subscriptionType"
                    }
                  }
                },
                "example": {
                  "notificationSubscription": {
                    "subscriptionType": "CellChangeSubscription",
                    "callbackReference": "http://my.callback.com/rni-cell-change/some-id",
                    "filterCriteriaAssocHo": {
                      "appInstanceId": "myApp",
                      "associateId": [
                        {
                          "type": "1",
                          "value": "10.100.0.1"
                        }
                      ],
                      "ecgi": [
                        {
                          "plmn": {
                            "mnc": "01",
                            "mcc": "001"
                          },
                          "cellId": "ACBDEFA"
                        }
                      ],
                      "hoStatus": [
                        "1",
                        "2"
                      ]
                    },
                    "expiryDeadline": {
                      "seconds": 1977836800,
                      "nanoseconds": 0
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Successful subscription",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "notificationSubscription": {
                      "oneOf": [
                        {
                          "$ref": "#/components/schemas/CellChangeSubscription"
                        },
                        {
                          "$ref": "#/components/schemas/RabEstSubscription"
                        },
                        {
                          "$ref": "#/components/schemas/RabModSubscription"
                        },
                        {
                          "$ref": "#/components/schemas/RabRelSubscription"
                        },
                        {
                          "$ref": "#/components/schemas/MeasRepUeSubscription"
                        },
                        {
                          "$ref": "#/components/schemas/NrMeasRepUeSubscription"
                        },
                        {
                          "$ref": "#/components/schemas/MeasTaSubscription"
                        },
                        {
                          "$ref": "#/components/schemas/CaReconfSubscription"
                        },
                        {
                          "$ref": "#/components/schemas/S1BearerSubscription"
                        }
                      ],
                      "discriminator": {
                        "propertyName": "subscriptionType"
                      }
                    }
                  },
                  "example": {
                    "notificationSubscription": {
                      "subscriptionType": "CellChangeSubscription",
                      "callbackReference": "http://my.callback.com/rni-cell-change/some-id",
                      "_links": {
                        "self": {
                          "href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123"
                        }
                      },
                      "filterCriteriaAssocHo": {
                        "appInstanceId": "myApp",
                        "associateId": [
                          {
                            "type": "1",
                            "value": "10.100.0.1"
                          }
                        ],
                        "ecgi": [
                          {
                            "plmn": {
                              "mnc": "01",
                              "mcc": "001"
                            },
                            "cellId": "ACBDEFA"
                          }
                        ],
                        "hoStatus": [
                          "1",
                          "2"
                        ]
                      },
                      "expiryDeadline": {
                        "seconds": 1977836800,
                        "nanoseconds": 0
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "415": {
            "$ref": "#/components/responses/412"
          },
          "422": {
            "$ref": "#/components/responses/422"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "callbacks": {
          "notification": {
            "{$request.body#/notificationSubscription.callbackReference}": {
              "post": {
                "summary": "Callback POST used to send a notification",
                "description": "Notification from RNIS, content based on subscription type",
                "operationId": "notificationPOST",
                "requestBody": {
                  "description": "Subscription notification",
                  "required": true,
                  "content": {
                    "application/json": {
                      "schema": {
                        "type": "object",
                        "properties": {
                          "notification": {
                            "oneOf": [
                              {
                                "$ref": "#/components/schemas/CellChangeNotification"
                              },
                              {
                                "$ref": "#/components/schemas/RabEstNotification"
                              },
                              {
                                "$ref": "#/components/schemas/RabModNotification"
                              },
                              {
                                "$ref": "#/components/schemas/RabRelNotification"
                              },
                              {
                                "$ref": "#/components/schemas/MeasRepUeNotification"
                              },
                              {
                                "$ref": "#/components/schemas/NrMeasRepUeNotification"
                              },
                              {
                                "$ref": "#/components/schemas/MeasTaNotification"
                              },
                              {
                                "$ref": "#/components/schemas/CaReconfNotification"
                              },
                              {
                                "$ref": "#/components/schemas/S1BearerNotification"
                              }
                            ],
                            "discriminator": {
                              "propertyName": "notificationType"
                            }
                          }
                        },
                        "example": {
                          "notification": {
                            "notificationType": "CellChangeNotification",
                            "associateId": [
                              {
                                "type": "1",
                                "value": "10.100.0.1"
                              }
                            ],
                            "hoStatus": "1",
                            "srcEcgi": {
                              "plmn": {
                                "mnc": "01",
                                "mcc": "001"
                              },
                              "cellId": "ACBDEFA"
                            },
                            "tempUeId": {
                              "mmec": 1,
                              "mtmsi": 69967622812
                            },
                            "timeStamp": {
                              "seconds": 1977836800,
                              "nanoseconds": 0
                            },
                            "trgEcgi": {
                              "plmn": {
                                "mnc": "01",
                                "mcc": "001"
                              },
                              "cellId": "FEDCBAA"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "responses": {
                  "204": {
                    "$ref": "#/components/responses/204"
                  }
                }
              }
            }
          }
        },
        "x-swagger-router-controller": "subscriptions"
      }
    },
    "/subscriptions/{subscriptionId}": {
      "get": {
        "tags": [
          ""
        ],
        "summary": "Retrieve information on current specific subscription",
        "description": "Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
        "operationId": "subscriptionsGET",
        "parameters": [
          {
            "$ref": "#/components/parameters/Path.subscrId"
          }
        ],
        "responses": {
          "200": {
            "description": "Subscription information regarding subscription notifications",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "notificationSubscription"
                  ],
                  "properties": {
                    "notificationSubscription": {
                      "oneOf": [
                        {
                          "$ref": "#/components/schemas/CellChangeSubscription"
                        },
                        {
                          "$ref": "#/components/schemas/RabEstSubscription"
                        },
                        {
                          "$ref": "#/components/schemas/RabModSubscription"
                        },
                        {
                          "$ref": "#/components/schemas/RabRelSubscription"
                        },
                        {
                          "$ref": "#/components/schemas/MeasRepUeSubscription"
                        },
                        {
                          "$ref": "#/components/schemas/NrMeasRepUeSubscription"
                        },
                        {
                          "$ref": "#/components/schemas/MeasTaSubscription"
                        },
                        {
                          "$ref": "#/components/schemas/CaReconfSubscription"
                        },
                        {
                          "$ref": "#/components/schemas/S1BearerSubscription"
                        }
                      ],
                      "discriminator": {
                        "propertyName": "subscriptionType"
                      }
                    }
                  },
                  "example": {
                    "notificationSubscription": {
                      "subscriptionType": "CellChangeSubscription",
                      "callbackReference": "http://my.callback.com/rni-cell-change/some-id",
                      "_links": {
                        "self": {
                          "href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123"
                        }
                      },
                      "filterCriteriaAssocHo": {
                        "appInstanceId": "myApp",
                        "associateId": [
                          {
                            "type": "1",
                            "value": "10.100.0.1"
                          }
                        ],
                        "ecgi": [
                          {
                            "plmn": {
                              "mnc": "01",
                              "mcc": "001"
                            },
                            "cellId": "ACBDEFA"
                          }
                        ],
                        "hoStatus": [
                          "1",
                          "2"
                        ]
                      },
                      "expiryDeadline": {
                        "seconds": 1977836800,
                        "nanoseconds": 0
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "x-swagger-router-controller": "subscriptions"
      },
      "put": {
        "tags": [
          ""
        ],
        "summary": "Modify an existing subscription",
        "description": "Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
        "operationId": "subscriptionsPUT",
        "requestBody": {
          "description": "Subscription to be modified",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "notificationSubscription": {
                    "oneOf": [
                      {
                        "$ref": "#/components/schemas/CellChangeSubscription"
                      },
                      {
                        "$ref": "#/components/schemas/RabEstSubscription"
                      },
                      {
                        "$ref": "#/components/schemas/RabModSubscription"
                      },
                      {
                        "$ref": "#/components/schemas/RabRelSubscription"
                      },
                      {
                        "$ref": "#/components/schemas/MeasRepUeSubscription"
                      },
                      {
                        "$ref": "#/components/schemas/NrMeasRepUeSubscription"
                      },
                      {
                        "$ref": "#/components/schemas/MeasTaSubscription"
                      },
                      {
                        "$ref": "#/components/schemas/CaReconfSubscription"
                      },
                      {
                        "$ref": "#/components/schemas/S1BearerSubscription"
                      }
                    ],
                    "discriminator": {
                      "propertyName": "subscriptionType"
                    }
                  }
                },
                "example": {
                  "notificationSubscription": {
                    "subscriptionType": "CellChangeSubscription",
                    "callbackReference": "http://my.callback.com/rni-cell-change/some-id",
                    "_links": {
                      "self": {
                        "href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123"
                      }
                    },
                    "filterCriteriaAssocHo": {
                      "appInstanceId": "myApp",
                      "associateId": [
                        {
                          "type": "1",
                          "value": "10.100.0.1"
                        }
                      ],
                      "ecgi": [
                        {
                          "plmn": {
                            "mnc": "01",
                            "mcc": "001"
                          },
                          "cellId": "ACBDEFA"
                        }
                      ],
                      "hoStatus": [
                        "1",
                        "2"
                      ]
                    },
                    "expiryDeadline": {
                      "seconds": 1977836800,
                      "nanoseconds": 0
                    }
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/Path.subscrId"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful subscription to response to subscription notifications",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "notificationSubscription": {
                      "oneOf": [
                        {
                          "$ref": "#/components/schemas/CellChangeSubscription"
                        },