RniAPI.json 153 KB
Newer Older
            "contentEncoding": "int32"
          },
          "nrNCellRsrq": {
            "type": "integer",
            "description": "Reference Signal Received Quality measurement according to mapping table in ETSI TS 138.133 [i.14].",
            "contentEncoding": "int32"
          },
          "nrNCellRssi": {
            "type": "integer",
            "description": "Reference signal SINR measurement according to mapping table in ETSI TS 138.133 [i.14].",
            "contentEncoding": "int32"
          "rsIndexResults": {
            "$ref": "#/components/schemas/RsIndexResults"
          }
        }
      },
      "NrBNCellInfo": {
        "title": "NrBNCellInfo",
        "type": "object",
        "properties": {
          "nrBNCellGId": {
Michel Roy's avatar
Michel Roy committed
            "type": "string",
            "description": "String representing the NR Cell Identity. Encoded as a bit string (size (36)) as defined in ETSI TS 138 423 [i.17]."
          "nrBNCellPlmn": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Plmn"
            "description": "Public land mobile network identities"
        }
      },
      "NrBNCs": {
        "title": "NrBNCs",
Michel Roy's avatar
Michel Roy committed
        "required": [
          "nrBNCellInfo"
Michel Roy's avatar
Michel Roy committed
        ],
        "type": "object",
        "properties": {
          "nrBNCellInfo": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/NrBNCellInfo"
            },
            "description": "Best neighbours of the secondary serving cell(s) info"
          },
          "nrBNCellRsrp": {
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
            "description": "Reference Signal Received Power measurement according to mapping table in ETSI TS 138.133 [i.14].",
            "contentEncoding": "int32"
          "nrBNCellRsrq": {
            "type": "integer",
            "description": "Reference Signal Received Quality measurement according to mapping table in ETSI TS 138.133 [i.14].",
            "contentEncoding": "int32"
          },
          "nrBNCellRssi": {
            "type": "integer",
            "description": "Reference signal SINR measurement according to mapping table in ETSI TS 138.133 [i.14].",
            "contentEncoding": "int32"
        "description": "Measurement quantities concerning the best neighbours of the secondary serving cells"
      "NrNCellInfo": {
        "title": "NrNCellInfo",
        "type": "object",
Michel Roy's avatar
Michel Roy committed
        "properties": {
          "nrNCellGId": {
            "type": "string",
            "description": "String representing the NR Cell Identity. Encoded as a bit string (size (36)) as defined in ETSI TS 138 423 [i.17]."
          },
          "nrNCellPlmn": {
            "minItems": 1,
            "type": "array",
Michel Roy's avatar
Michel Roy committed
            "items": {
              "$ref": "#/components/schemas/Plmn"
            "description": "Public land mobile network identities."
      "NrNeighCellMeasInfo": {
        "title": "NrNeighCellMeasInfo",
        "type": "object",
Michel Roy's avatar
Michel Roy committed
        "properties": {
          "measQuantityResultsCsiRsCell": {
            "$ref": "#/components/schemas/MeasQuantityResultsNr"
          "measQuantityResultsSsbCell": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/schemas/MeasQuantityResultsNr"
          },
          "nrcgi": {
            "type": "string",
            "description": "String representing the NR Cell Identity. Encoded as a bit string (size (36)) as defined in ETSI TS 138 423 [i.17]."
          },
          "rsIndexResults": {
            "$ref": "#/components/schemas/RsIndexResults"
      "NrSCellInfo": {
        "title": "NrSCellInfo",
        "type": "object",
Michel Roy's avatar
Michel Roy committed
        "properties": {
          "nrSCellGId": {
            "type": "string",
            "description": "String representing the NR Cell Identity. Encoded as a bit string (size (36)) as defined in ETSI TS 138 423 [i.17]."
          },
          "nrSCellPlmn": {
            "minItems": 1,
            "type": "array",
Michel Roy's avatar
Michel Roy committed
            "items": {
              "$ref": "#/components/schemas/Plmn"
            "description": "Public land mobile network identities."
      "NrSCs": {
        "title": "NrSCs",
        "required": [
          "nrSCellInfo"
        ],
        "type": "object",
Michel Roy's avatar
Michel Roy committed
        "properties": {
          "nrSCellInfo": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/NrSCellInfo"
            },
            "description": "Secondary serving cell(s) info."
          "nrSCellRsrp": {
            "type": "integer",
            "description": "Reference Signal Received Power measurement according to mapping table in ETSI TS 138.133 [i.14].",
            "contentEncoding": "int32"
          },
          "nrSCellRsrq": {
            "type": "integer",
            "description": "Reference Signal Received Quality measurement according to mapping table in ETSI TS 138.133 [i.14].",
            "contentEncoding": "int32"
          },
          "nrSCellRssi": {
            "type": "integer",
            "description": "Reference signal SINR measurement according to mapping table in ETSI TS 138.133 [i.14].",
            "contentEncoding": "int32"
        "description": "Measurement quantities concerning the secondary serving cells."
      },
      "QosInformation": {
        "title": "QosInformation",
Michel Roy's avatar
Michel Roy committed
        "required": [
          "erabGbrDl",
          "erabGbrUl",
          "erabMbrDl",
          "erabMbrUl"
Michel Roy's avatar
Michel Roy committed
        ],
        "type": "object",
        "properties": {
          "erabGbrDl": {
            "type": "integer",
            "description": "This attribute indicates the guaranteed downlink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.",
            "contentEncoding": "int32"
          "erabGbrUl": {
            "type": "integer",
            "description": "This attribute indicates the guaranteed uplink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.",
            "contentEncoding": "int32"
          },
          "erabMbrDl": {
            "type": "integer",
            "description": "This attribute indicates the maximum downlink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.",
            "contentEncoding": "int32"
          },
          "erabMbrUl": {
            "type": "integer",
            "description": "This attribute indicates the maximum uplink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.",
            "contentEncoding": "int32"
        "description": "The QoS information for the E-RAB."
      },
      "QosInformation2": {
        "title": "QosInformation2",
Michel Roy's avatar
Michel Roy committed
        "required": [
          "erabGbrDl",
          "erabGbrUl",
          "erabMbrDl",
          "erabMbrUl"
Michel Roy's avatar
Michel Roy committed
        ],
        "type": "object",
        "properties": {
          "erabGbrDl": {
            "type": "integer",
            "description": "This attribute indicates the guaranteed downlink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.",
            "contentEncoding": "int32"
          },
          "erabGbrUl": {
            "type": "integer",
            "description": "This attribute indicates the guaranteed uplink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.",
            "contentEncoding": "int32"
          },
          "erabMbrDl": {
            "type": "integer",
            "description": "This attribute indicates the maximum downlink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.",
            "contentEncoding": "int32"
          },
          "erabMbrUl": {
            "type": "integer",
            "description": "This attribute indicates the maximum uplink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.",
            "contentEncoding": "int32"
          }
        },
        "description": "The QoS Information for the E-RAB as defined below."
      "S1BearerInfoDetailed": {
        "title": "S1BearerInfoDetailed",
        "type": "object",
Michel Roy's avatar
Michel Roy committed
        "properties": {
          "enbInfo": {
            "$ref": "#/components/schemas/EnbInfo"
          "erabId": {
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
            "description": "The attribute that uniquely identifies a S1 bearer for a specific UE, as defined in ETSI TS 136 413 [i.3].",
            "contentEncoding": "int32"
          "sGwInfo": {
            "$ref": "#/components/schemas/SGwInfo"
          }
        }
      },
      "S1BearerSubscriptionCriteria": {
        "title": "S1BearerSubscriptionCriteria",
        "type": "object",
        "properties": {
          "associateId": {
            "minItems": 0,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AssociateId"
            "description": "0 to N identifiers to associate the events for a specific UE or a flow."
          "ecgi": {
            "minItems": 0,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Ecgi"
            },
            "description": "E-UTRAN Cell Global Identifier."
          },
          "erabId": {
            "minItems": 0,
            "type": "array",
            "items": {
              "type": "integer",
              "contentEncoding": "int32"
            },
            "description": "The attribute that uniquely identifies a S1 bearer for a specific UE, as defined in ETSI TS 136 413 [i.3]."
        "description": "As defined below."
      "S1UeInfo": {
        "title": "S1UeInfo",
        "type": "object",
Michel Roy's avatar
Michel Roy committed
        "properties": {
          "associateId": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AssociateId"
            "description": "1 to N identifiers to associate the information for a specific UE or flow."
          "ecgi": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Ecgi"
            "description": "E-UTRAN Cell Global Identifier."
          "s1BearerInfoDetailed": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/S1BearerInfoDetailed"
            },
            "description": "S1 bearer information as defined below."
          "tempUeId": {
            "$ref": "#/components/schemas/TempUeId"
          }
        }
      },
      "S1UeInfo1": {
        "title": "S1UeInfo1",
        "required": [
          "ecgi",
          "s1BearerInfo"
        ],
        "type": "object",
        "properties": {
          "associateId": {
            "minItems": 0,
            "type": "array",
Michel Roy's avatar
Michel Roy committed
            "items": {
              "$ref": "#/components/schemas/AssociateId"
            "description": "0 to N identifiers to associate the information for a specific UE or flow."
          },
          "ecgi": {
Michel Roy's avatar
Michel Roy committed
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Ecgi"
            },
            "description": "E-UTRAN Cell Global Identifier."
          "s1BearerInfo": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/S1BearerInfo1"
            },
            "description": "S1 bearer information as defined below."
          "tempUeId": {
            "$ref": "#/components/schemas/TempUeId"
        "description": "Information on specific UE that matches the criteria in S1BearerSubscription as defined below."
      },
      "S1BearerInfo1": {
        "title": "S1BearerInfo1",
Michel Roy's avatar
Michel Roy committed
        "type": "object",
        "properties": {
          "enbInfo": {
            "$ref": "#/components/schemas/EnbInfo"
          },
          "erabId": {
            "type": "integer",
            "description": "The attribute that uniquely identifies a S1 bearer for a specific UE, as defined in ETSI TS 136 413 [i.3].",
            "contentEncoding": "int32"
          },
          "sGwInfo": {
            "$ref": "#/components/schemas/SGwInfo"
          }
        }
      "SCell": {
        "title": "SCell",
        "type": "object",
Michel Roy's avatar
Michel Roy committed
        "properties": {
          "measQuantityResultsCsiRsCell": {
            "$ref": "#/components/schemas/MeasQuantityResultsNr"
          },
          "measQuantityResultsSsbCell": {
            "$ref": "#/components/schemas/MeasQuantityResultsNr"
          },
          "rsIndexResults": {
            "$ref": "#/components/schemas/RsIndexResults"
        "description": "Measurement information relating to this serving cell."
      },
      "SecondaryCellAdd": {
        "title": "SecondaryCellAdd",
        "type": "object",
        "properties": {
          "ecgi": {
            "$ref": "#/components/schemas/Ecgi"
          }
        }
      },
      "SecondaryCellRemove": {
        "title": "SecondaryCellRemove",
        "type": "object",
        "properties": {
          "ecgi": {
            "$ref": "#/components/schemas/Ecgi"
          }
        }
      },
      "ServCellMeasInfo": {
        "title": "ServCellMeasInfo",
        "type": "object",
        "properties": {
          "nCell": {
            "$ref": "#/components/schemas/NCell"
          },
          "nrcgi": {
            "$ref": "#/components/schemas/NRcgi"
          },
          "sCell": {
            "$ref": "#/components/schemas/SCell"
          }
        }
      },
      "SGwInfo": {
        "title": "SGwInfo",
Michel Roy's avatar
Michel Roy committed
        "required": [
          "ipAddress",
          "tunnelId"
Michel Roy's avatar
Michel Roy committed
        ],
        "type": "object",
        "properties": {
          "ipAddress": {
            "type": "string",
            "description": "SGW transport layer address of this S1 bearer."
          "tunnelId": {
            "type": "string",
            "description": "SGW GTP-U TEID of this S1 bearer."
        "description": "S1 bearer information on GW side as defined below."
      },
      "Subscription": {
        "title": "Subscription",
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "The URI referring to the subscription."
          },
          "subscriptionType": {
            "type": "string",
            "description": "Type of the subscription. The string shall be set according to the \"subscriptionType\" attribute of the associated subscription data type event defined in clause 6.3."
          }
        }
      },
      "TempUeId": {
        "title": "TempUeId",
Michel Roy's avatar
Michel Roy committed
        "required": [
          "mmec",
          "mtmsi"
Michel Roy's avatar
Michel Roy committed
        ],
        "type": "object",
        "properties": {
          "mmec": {
            "type": "string",
            "description": "MMEC as defined in ETSI TS 136 413 [i.3]."
          },
          "mtmsi": {
            "type": "string",
            "description": "M-TMSI as defined in ETSI TS 136 413 [i.3]."
          }
        },
        "description": "The temporary identifier allocated for the specific UE as defined below."
      "Type": {
        "title": "Type",
Michel Roy's avatar
Michel Roy committed
        "enum": [
Michel Roy's avatar
Michel Roy committed
          0,
          1,
          2,
          3,
Michel Roy's avatar
Michel Roy committed
        ],
        "type": "integer",
        "description": "Numeric value (0-255) corresponding to specified type of identifier as following: <p>0 = reserved. <p>1 = UE_IPv4_ADDRESS. <p>2 = UE_IPV6_ADDRESS. <p>3 = NATED_IP_ADDRESS. <p>4 = GTP_TEID.",
        "examples": [
          0
        ]
Michel Roy's avatar
Michel Roy committed
      },
      "UeInfo": {
        "title": "UeInfo",
        "type": "object",
        "properties": {
          "associateId": {
            "minItems": 0,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AssociateId"
            },
            "description": "0 to N identifiers to associate the event for a specific UE or flow."
Michel Roy's avatar
Michel Roy committed
          },
          "erabInfo": {
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ErabInfo"
            },
            "description": "Information on E-RAB as defined below."
Michel Roy's avatar
Michel Roy committed
          }
        }
  },
  "security": [
    {}
  ]