RniAPI.json 197 KB
Newer Older
Michel Roy's avatar
Michel Roy committed
                        "required": [
                          "ipAddress",
                          "tunnelId"
                        ],
                        "type": "object",
                        "x-etsi-mec-cardinality": "1",
                        "x-etsi-mec-origin-type": "Structure (inlined)"
                      }
                    }
                  },
                  "required": [
                    "erabId",
                    "enbInfo",
                    "sGwInfo"
                  ],
                  "type": "array",
                  "x-etsi-mec-cardinality": "1..N",
                  "x-etsi-mec-origin-type": "Structure (inlined)"
                },
                "tempUeId": {
                  "description": "The temporary identifier allocated for the specific UE as defined below.",
                  "properties": {
                    "mmec": {
                      "description": "MMEC as defined in ETSI TS 136 413 [i.3].",
                      "type": "string",
                      "x-etsi-mec-cardinality": "1",
                      "x-etsi-mec-origin-type": "String"
                    },
                    "mtmsi": {
                      "description": "M-TMSI as defined in ETSI TS 136 413 [i.3].",
                      "type": "string",
                      "x-etsi-mec-cardinality": "1",
                      "x-etsi-mec-origin-type": "String"
                    }
                  },
                  "required": [
                    "mmec",
                    "mtmsi"
                  ],
                  "type": "object",
                  "x-etsi-mec-cardinality": "0..1",
                  "x-etsi-mec-origin-type": "Structure (inlined)"
                }
              },
              "type": "object"
            },
            "required": [
              "ecgi",
              "s1BearerInfo"
            ],
            "type": "object",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Structure (inlined)"
          },
          "timeStamp": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TimeStamp"
              }
            ],
            "description": "Time stamp.",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "TimeStamp"
          }
Michel Roy's avatar
Michel Roy committed
        "required": [
          "notificationType",
          "s1Event",
          "s1UeInfo"
        ],
        "type": "object",
        "x-etsi-ref": "6.4.10"
Michel Roy's avatar
Michel Roy committed
      "S1BearerSubscription": {
        "properties": {
          "S1BearerSubscriptionCriteria": {
            "description": "As defined below.",
            "properties": {
              "associateId": {
                "description": "0 to N identifiers to associate the events for a specific UE or a flow.",
                "items": {
                  "$ref": "#/components/schemas/AssociateId"
                },
                "minItems": 0,
                "type": "array",
                "x-etsi-mec-cardinality": "0..N",
                "x-etsi-mec-origin-type": "AssociateId"
              },
              "ecgi": {
                "description": "E-UTRAN Cell Global Identifier.",
                "items": {
                  "$ref": "#/components/schemas/Ecgi"
                },
                "minItems": 0,
                "type": "array",
                "x-etsi-mec-cardinality": "0..N",
                "x-etsi-mec-origin-type": "Ecgi"
              },
              "erabId": {
                "description": "The attribute that uniquely identifies a S1 bearer for a specific UE, as defined in ETSI TS 136 413 [i.3].",
                "items": {
                  "type": "integer"
                },
                "minItems": 0,
                "type": "array",
                "x-etsi-mec-cardinality": "0..N",
                "x-etsi-mec-origin-type": "Integer"
              }
            },
            "type": "object",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Structure (inlined)"
          },
          "_links": {
            "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.",
            "properties": {
              "self": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/LinkType"
                  }
                ],
                "description": "Self referring URI. The URI shall be unique within the RNI API as it acts as an ID for the subscription.",
                "x-etsi-mec-cardinality": "1",
                "x-etsi-mec-origin-type": "LinkType"
              }
            },
            "required": [
              "self"
            ],
            "type": "object",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Structure (inlined)"
          },
          "callbackReference": {
            "description": "URI selected by the service consumer, to receive notifications on the subscribed RNIS information. This shall be included in the request and response.",
            "format": "uri",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "URI"
          },
          "eventType": {
            "description": "Description of the subscribed event. The event is included both in the request and in the response. \\nFor the eventType, the following values are currently defined: 0 = RESERVED. 1 = S1_BEARER_ESTABLISH. 2 = S1_BEARER_MODIFY. 3 = S1_BEARER_RELEASE.",
            "items": {
              "$ref": "#/components/schemas/Enum"
            },
            "minItems": 1,
            "type": "array",
            "x-etsi-mec-cardinality": "1..N",
            "x-etsi-mec-origin-type": "Enum"
          },
          "expiryDeadline": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TimeStamp"
              }
            ],
            "description": "Time stamp.",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "TimeStamp"
          },
          "subscriptionType": {
            "description": "Shall be set to \"S1BearerSubscription\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          }
Michel Roy's avatar
Michel Roy committed
        "required": [
          "subscriptionType",
          "callbackReference",
          "eventType",
          "S1BearerSubscriptionCriteria"
        ],
        "type": "object",
        "x-etsi-ref": "6.3.9"
      },
      "SubscriptionLinkList": {
        "properties": {
          "_links": {
            "description": "List of hyperlinks related to the resource.",
            "properties": {
              "self": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/LinkType"
                  }
                ],
                "description": "",
                "x-etsi-mec-cardinality": "1",
                "x-etsi-mec-origin-type": "LinkType"
              },
              "subscription": {
                "description": "A link to a subscription.",
                "items": {
                  "type": "object",
                  "properties": {
                    "href": {
                      "description": "The URI referring to the subscription.",
                      "format": "uri",
                      "type": "string",
                      "x-etsi-mec-cardinality": "1",
                      "x-etsi-mec-origin-type": "URI"
                    },
                    "subscriptionType": {
                      "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.",
                      "type": "string",
                      "x-etsi-mec-cardinality": "1",
                      "x-etsi-mec-origin-type": "String"
                    }
                  }
                },
                "required": [
                  "href",
                  "subscriptionType"
                ],
                "minItems": 0,
                "type": "array",
                "x-etsi-mec-cardinality": "0..N",
                "x-etsi-mec-origin-type": "Structure (inlined)"
              }
            },
            "required": [
              "self"
            ],
            "type": "object",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Structure (inlined)"
          }
Michel Roy's avatar
Michel Roy committed
        "required": [
          "_links"
        ],
        "type": "object",
        "x-etsi-ref": "6.3.10"
      },
      "TimeStamp": {
        "properties": {
          "nanoSeconds": {
            "type": "integer",
            "format": "uint32",
            "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint32"
          },
          "seconds": {
            "type": "integer",
            "format": "uint32",
            "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint32"
          }
Michel Roy's avatar
Michel Roy committed
        "required": [
          "seconds",
          "nanoSeconds"
        ],
        "type": "object",
        "x-etsi-ref": "6.5.3"
Michel Roy's avatar
Michel Roy committed
      "Trigger": {
        "description": "As defined in Ref ETSI TS 136 331 [i.7]",
        "enum": [
          "0 = NOT_AVAILABLE",
          "1 = PERIODICAL_REPORT_STRONGEST_CELLS",
          "2 = PERIODICAL_REPORT_STRONGEST_CELLS_FOR_SON",
          "3 = PERIODICAL_REPORT_CGI",
          "4 = INTRA_PERIODICAL_REPORT_STRONGEST_CELLS",
          "5 = INTRA_PERIODICAL_REPORT_CGI",
          "10 = EVENT_A1",
          "11 = EVENT_A2",
          "12 = EVENT_A3",
          "13 = EVENT_A4",
          "14 = EVENT_A5",
          "15 = EVENT_A6",
          "20 = EVENT_B1",
          "21 = EVENT_B2",
          "20 = EVENT_B1-NR",
          "21 = EVENT_B2-NR",
          "30 = EVENT_C1",
          "31 = EVENT_C2",
          "40 = EVENT_W1",
          "41 = EVENT_W2",
          "42 = EVENT_W3",
          "50 = EVENT_V1",
          "51 = EVENT_V2",
          "60 = EVENT_H1",
          "61 = EVENT_H2"
        ],
        "type": "string"
      },
      "TriggerNr": {
        "description": "The enumeration Trigger represents specified triggers for a 5G UE Measurement Report. Full details can be found in ETSI TS 138 331 [i.13]).",
        "enum": [
          "0 = NOT_AVAILABLE",
          "1 = NR_PERIODICAL",
          "2 = NR_CGI",
          "10 = EVENT_A1",
          "11 = EVENT_A2",
          "12 = EVENT_A3",
          "13 = EVENT_A4",
          "14 = EVENT_A5",
          "15 = EVENT_A6",
          "20 = INTER_RAT_PERIODICAL",
          "21 = INTER_RAT_CGI",
          "30 = EVENT_B1",
          "31 = EVENT_B2"
        ],
        "type": "string"
      }