3GPP Individual Monitoring Event Subscription API

openapi: 3.2.0
info:
  title: 3gpp-monitoring-event Individual Monitoring Event Subscription API
  version: 1.4.0
  description: "API for Monitoring Event.  \n© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  \nAll rights reserved.\n"
servers:
- url: '{apiRoot}/3gpp-monitoring-event/v1'
  variables:
    apiRoot:
      default: https://example.com
      description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
security:
- {}
- oAuth2ClientCredentials: []
tags:
- name: Individual Monitoring Event Subscription
paths:
  /{scsAsId}/subscriptions/{subscriptionId}:
    get:
      summary: Read an active subscriptions for the SCS/AS and the subscription Id.
      operationId: FetchIndMonitoringEventSubscription
      tags:
      - Individual Monitoring Event Subscription
      parameters:
      - name: scsAsId
        in: path
        description: Identifier of the SCS/AS
        required: true
        schema:
          type: string
      - name: subscriptionId
        in: path
        description: Identifier of the subscription resource
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK (Successful get the active subscription)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringEventSubscription'
        '307':
          $ref: TS29122_CommonData.yaml#/components/responses/307
        '308':
          $ref: TS29122_CommonData.yaml#/components/responses/308
        '400':
          $ref: TS29122_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29122_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29122_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29122_CommonData.yaml#/components/responses/404
        '406':
          $ref: TS29122_CommonData.yaml#/components/responses/406
        '429':
          $ref: TS29122_CommonData.yaml#/components/responses/429
        '500':
          $ref: TS29122_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29122_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29122_CommonData.yaml#/components/responses/default
    put:
      summary: Updates/replaces an existing subscription resource.
      operationId: UpdateIndMonitoringEventSubscription
      tags:
      - Individual Monitoring Event Subscription
      parameters:
      - name: scsAsId
        in: path
        description: Identifier of the SCS/AS
        required: true
        schema:
          type: string
      - name: subscriptionId
        in: path
        description: Identifier of the subscription resource
        required: true
        schema:
          type: string
      requestBody:
        description: Parameters to update/replace the existing subscription
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MonitoringEventSubscription'
      responses:
        '200':
          description: OK (Successful update of the subscription)
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/MonitoringEventSubscription'
                - $ref: '#/components/schemas/MonitoringEventReports'
        '204':
          description: No Content (Successful update of the subscription)
        '307':
          $ref: TS29122_CommonData.yaml#/components/responses/307
        '308':
          $ref: TS29122_CommonData.yaml#/components/responses/308
        '400':
          $ref: TS29122_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29122_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29122_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29122_CommonData.yaml#/components/responses/404
        '411':
          $ref: TS29122_CommonData.yaml#/components/responses/411
        '413':
          $ref: TS29122_CommonData.yaml#/components/responses/413
        '415':
          $ref: TS29122_CommonData.yaml#/components/responses/415
        '429':
          $ref: TS29122_CommonData.yaml#/components/responses/429
        '500':
          $ref: TS29122_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29122_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29122_CommonData.yaml#/components/responses/default
    patch:
      summary: Modifies an existing subscription of monitoring event.
      operationId: ModifyIndMonitoringEventSubscription
      tags:
      - Individual Monitoring Event Subscription
      parameters:
      - name: scsAsId
        in: path
        description: Identifier of the SCS/AS.
        required: true
        schema:
          type: string
      - name: subscriptionId
        in: path
        description: Identifier of the subscription resource.
        required: true
        schema:
          type: string
      requestBody:
        description: 'This is used for PATCH request for partial cancellation and/or partial addition of certain UE(s) within an active group.

          '
        required: true
        content:
          application/json-patch+json:
            schema:
              type: array
              items:
                $ref: TS29571_CommonData.yaml#/components/schemas/PatchItem
              minItems: 1
      responses:
        '200':
          description: 'OK. This status code may be used either: Case 1: The Individual Monitoring Event Subscription resource is successfully modified and a representation of the updated resource is returned in the response body. Case 2: The monitoring event report(s) corresponding to the requested monitoring event(s) are returned. This response is applicable only if the "enNB" feature is supported and one-time reporting is requested for all the remaining subscribed event(s) after modification.

            '
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/MonitoringEventSubscription'
                - $ref: '#/components/schemas/MonitoringEventReports'
        '204':
          description: The resource was modified successfully.
        '307':
          $ref: TS29122_CommonData.yaml#/components/responses/307
        '308':
          $ref: TS29122_CommonData.yaml#/components/responses/308
        '400':
          $ref: TS29122_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29122_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29122_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29122_CommonData.yaml#/components/responses/404
        '411':
          $ref: TS29122_CommonData.yaml#/components/responses/411
        '413':
          $ref: TS29122_CommonData.yaml#/components/responses/413
        '415':
          $ref: TS29122_CommonData.yaml#/components/responses/415
        '429':
          $ref: TS29122_CommonData.yaml#/components/responses/429
        '500':
          $ref: TS29122_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29122_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29122_CommonData.yaml#/components/responses/default
    delete:
      summary: Deletes an already existing monitoring event subscription.
      operationId: DeleteIndMonitoringEventSubscription
      tags:
      - Individual Monitoring Event Subscription
      parameters:
      - name: scsAsId
        in: path
        description: Identifier of the SCS/AS
        required: true
        schema:
          type: string
      - name: subscriptionId
        in: path
        description: Identifier of the subscription resource
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content (Successful deletion of the existing subscription)
        '200':
          description: OK (Successful deletion of the existing subscription)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MonitoringEventReport'
                minItems: 1
                description: 'The subscription was terminated successfully, the monitoring event report(s) shall be included if received.

                  '
        '307':
          $ref: TS29122_CommonData.yaml#/components/responses/307
        '308':
          $ref: TS29122_CommonData.yaml#/components/responses/308
        '400':
          $ref: TS29122_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29122_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29122_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29122_CommonData.yaml#/components/responses/404
        '429':
          $ref: TS29122_CommonData.yaml#/components/responses/429
        '500':
          $ref: TS29122_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29122_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29122_CommonData.yaml#/components/responses/default
components:
  schemas:
    GroupMembListChanges:
      description: Represents information on the change(s) to a group's members list.
      type: object
      properties:
        addedUEs:
          type: array
          items:
            $ref: TS29571_CommonData.yaml#/components/schemas/Gpsi
          minItems: 1
        removedUEs:
          type: array
          items:
            $ref: TS29571_CommonData.yaml#/components/schemas/Gpsi
          minItems: 1
      anyOf:
      - required:
        - addedUEs
      - required:
        - removedUEs
    EnergyInfo:
      description: Contains the Energy consumption information for the UE.
      type: object
      properties:
        energy:
          format: float
          type: number
          minimum: 0
      required:
      - energy
    LocationFailureCause:
      anyOf:
      - type: string
        enum:
        - POSITIONING_DENIED
        - UNSUPPORTED_BY_UE
        - NOT_REGISTED_UE
        - UNSPECIFIED
        - REQUESTED_AREA_NOT_ALLOWED
        - INVALID_USER_PLANE_ADDRESS_INFO
      - type: string
        description: 'This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.

          '
      description: "Represents the cause of location positioning failure.   Possible values are: - POSITIONING_DENIED: Positioning is denied. - UNSUPPORTED_BY_UE: Positioning is not supported by UE. - NOT_REGISTED_UE: UE is not registered. - UNSPECIFIED: Unspecified. - REQUESTED_AREA_NOT_ALLOWED: The location request is rejected because the location area\n  requested by the AF for area event reporting is not allowed.\n- INVALID_USER_PLANE_ADDRESS_INFO: The location request is rejected because the user plane\n  address info provided by the AF for location reporting over user plane between the UE\n  and AF is invalid.\n"
    UePerLocationReport:
      description: Represents the number of UEs found at the indicated location.
      type: object
      properties:
        ueCount:
          type: integer
          minimum: 0
          description: Identifies the number of UEs.
        externalIds:
          type: array
          items:
            $ref: TS29122_CommonData.yaml#/components/schemas/ExternalId
          minItems: 1
          description: Each element uniquely identifies a user.
        msisdns:
          type: array
          items:
            $ref: TS29122_CommonData.yaml#/components/schemas/Msisdn
          minItems: 1
          description: Each element identifies the MS internal PSTN/ISDN number allocated for a UE.
        servLevelDevIds:
          type: array
          items:
            type: string
          minItems: 1
          description: Each element uniquely identifies a UAV.
      required:
      - ueCount
    PdnConnectionStatus:
      anyOf:
      - type: string
        enum:
        - CREATED
        - RELEASED
        - RAT_TYPE_CHANGED
      - type: string
        description: 'This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.

          '
      description: "Represents the PDN connection status.  \nPossible values are\n- CREATED: The PDN connection is created.\n- RELEASED: The PDN connection is released.\n- RAT_TYPE_CHANGED: Indicates the RAT Type is changed for an established PDU Session.\n"
    UeStrAndFwdStatus:
      anyOf:
      - type: string
        enum:
        - IN_SF_MODE
        - OUT_OF_SF_MODE
      - type: string
        description: 'This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.

          '
      description: "Represents the Store and Forward mode status of the UE.\nPossible values are\n- IN_SF_MODE: Indicates that the UE is registered in Store and Forward mode.\n- OUT_OF_SF_MODE: Indicates that the UE is moving from Store and Forward mode to not\n  registered in Store and Forward mode.\n"
    PdnConnectionInformation:
      description: Represents the PDN connection information of the UE.
      type: object
      properties:
        status:
          $ref: '#/components/schemas/PdnConnectionStatus'
        apn:
          type: string
          description: 'Identify the APN, it is depending on the SCEF local configuration whether or not this attribute is sent to the SCS/AS.

            '
        pdnType:
          $ref: '#/components/schemas/PdnType'
        interfaceInd:
          $ref: '#/components/schemas/InterfaceIndication'
        ipv4Addr:
          $ref: TS29122_CommonData.yaml#/components/schemas/Ipv4Addr
        ipv6Addrs:
          type: array
          items:
            $ref: TS29122_CommonData.yaml#/components/schemas/Ipv6Addr
          minItems: 1
        macAddrs:
          type: array
          items:
            $ref: TS29571_CommonData.yaml#/components/schemas/MacAddr48
          minItems: 1
        ratType:
          $ref: TS29571_CommonData.yaml#/components/schemas/RatType
      required:
      - status
      - pdnType
    SACRepFormat:
      anyOf:
      - type: string
        enum:
        - NUMERICAL
        - PERCENTAGE
      - type: string
        description: 'This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.

          '
      description: Indicates the NSAC reporting format.
    UavPolicy:
      description: 'Represents the policy information included in the UAV presence monitoring request.

        '
      type: object
      properties:
        uavMoveInd:
          type: boolean
        revokeInd:
          type: boolean
      required:
      - uavMoveInd
      - revokeInd
    UpLocRepAddrAfRm:
      description: Represents the user plane addressing information.
      type:
      - object
      - 'null'
      properties:
        ipv4Addrs:
          type: array
          items:
            $ref: TS29571_CommonData.yaml#/components/schemas/Ipv4Addr
          minItems: 1
        ipv6Addrs:
          type: array
          items:
            $ref: TS29571_CommonData.yaml#/components/schemas/Ipv6Addr
          minItems: 1
        fqdn:
          $ref: TS29571_CommonData.yaml#/components/schemas/Fqdn
      anyOf:
      - required:
        - ipv4Addrs
      - required:
        - ipv6Addrs
      - required:
        - fqdn
    MonitoringEventSubscription:
      description: Represents a subscription to event(s) monitoring.
      type: object
      properties:
        self:
          $ref: TS29122_CommonData.yaml#/components/schemas/Link
        supportedFeatures:
          $ref: TS29571_CommonData.yaml#/components/schemas/SupportedFeatures
        mtcProviderId:
          type: string
          description: Identifies the MTC Service Provider and/or MTC Application.
        appIds:
          type: array
          items:
            type: string
          description: Identifies the Application Identifier(s)
          minItems: 1
        externalId:
          $ref: TS29122_CommonData.yaml#/components/schemas/ExternalId
        msisdn:
          $ref: TS29122_CommonData.yaml#/components/schemas/Msisdn
        addedExternalIds:
          type: array
          items:
            $ref: TS29122_CommonData.yaml#/components/schemas/ExternalId
          minItems: 1
          description: Indicates the added external Identifier(s) within the active group.
        addedMsisdns:
          type: array
          items:
            $ref: TS29122_CommonData.yaml#/components/schemas/Msisdn
          minItems: 1
          description: Indicates the added MSISDN(s) within the active group.
        excludedExternalIds:
          type: array
          items:
            $ref: TS29122_CommonData.yaml#/components/schemas/ExternalId
          minItems: 1
          description: Indicates cancellation of the external Identifier(s) within the active group.
        excludedMsisdns:
          type: array
          items:
            $ref: TS29122_CommonData.yaml#/components/schemas/Msisdn
          minItems: 1
          description: Indicates cancellation of the MSISDN(s) within the active group.
        externalGroupId:
          $ref: TS29122_CommonData.yaml#/components/schemas/ExternalGroupId
        addExtGroupId:
          type: array
          items:
            $ref: TS29122_CommonData.yaml#/components/schemas/ExternalGroupId
          minItems: 2
        ipv4Addr:
          $ref: TS29122_CommonData.yaml#/components/schemas/Ipv4Addr
        ipDomain:
          type: string
        ipv6Addr:
          $ref: TS29122_CommonData.yaml#/components/schemas/Ipv6Addr
        dnn:
          $ref: TS29571_CommonData.yaml#/components/schemas/Dnn
        notificationDestination:
          $ref: TS29122_CommonData.yaml#/components/schemas/Link
        requestTestNotification:
          type: boolean
          description: 'Set to true by the SCS/AS to request the SCEF to send a test notification as defined in clause 5.2.5.3. Set to false by the SCS/AS indicates not request SCEF to send a test notification, default false if omitted otherwise.

            '
        websockNotifConfig:
          $ref: TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig
        monitoringType:
          $ref: '#/components/schemas/MonitoringType'
        maximumNumberOfReports:
          type: integer
          minimum: 1
          description: 'Identifies the maximum number of event reports to be generated by the HSS, MME/SGSN as specified in clause 5.6.0 of 3GPP TS 23.682.

            '
        monitorExpireTime:
          $ref: TS29122_CommonData.yaml#/components/schemas/DateTime
        repPeriod:
          $ref: TS29122_CommonData.yaml#/components/schemas/DurationSec
        repTimeWin:
          $ref: TS29122_CommonData.yaml#/components/schemas/TimeWindow
        enrgRepThres:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/EnergyInfo'
          minProperties: 1
          description: 'Contains the reporting thresholds of the Energy consumption information. The key of the map shall be set to the value of the energy monitoring type, i.e., either UE_ENERGY, UE_SNSSAI_ENERGY, PDU_SESSION_ENERGY or SERVICE_FLOW_ENERGY, to which the energy reporting thresholds provided within the map value are related. This attribute may contain more than one map element only in case several energy monitoring types are subscribed via the monitoringType attribute and the addnMonTypes attribute. If there is only a single energy monitoring type that is subscribed, then a single map element may be provided within this attribute, with its map key set to the value of the monitoringType attribute. This attribute shall be present only in case threshold-based reporting of the Energy consumption information is requested.

            '
        repPeriodThres:
          $ref: TS29122_CommonData.yaml#/components/schemas/DurationSec
        groupReportGuardTime:
          $ref: TS29122_CommonData.yaml#/components/schemas/DurationSec
        maximumDetectionTime:
          $ref: TS29122_CommonData.yaml#/components/schemas/DurationSec
        reachabilityType:
          $ref: '#/components/schemas/ReachabilityType'
        maximumLatency:
          $ref: TS29122_CommonData.yaml#/components/schemas/DurationSec
        maximumResponseTime:
          $ref: TS29122_CommonData.yaml#/components/schemas/DurationSec
        suggestedNumberOfDlPackets:
          type: integer
          minimum: 0
          description: 'If "monitoringType" is "UE_REACHABILITY", this parameter may be included to identify the number of packets that the serving gateway shall buffer in case that the UE is not reachable.

            '
        idleStatusIndication:
          type: boolean
          description: 'If "monitoringType" is set to "UE_REACHABILITY" or "AVAILABILITY_AFTER_DDN_FAILURE", this parameter may be included to indicate the notification of when a UE, for which PSM is enabled, transitions into idle mode. "true"  indicates enabling of notification; "false"  indicate no need to notify. Default value is "false" if omitted.

            '
        locationType:
          $ref: '#/components/schemas/LocationType'
        accuracy:
          $ref: '#/components/schemas/Accuracy'
        minimumReportInterval:
          $ref: TS29122_CommonData.yaml#/components/schemas/DurationSec
        maxRptExpireIntvl:
          $ref: TS29122_CommonData.yaml#/components/schemas/DurationSec
        samplingInterval:
          $ref: TS29122_CommonData.yaml#/components/schemas/DurationSec
        reportingLocEstInd:
          type: boolean
          description: 'Indicates whether to request the location estimate for event reporting. If "monitoringType" is "LOCATION_REPORTING", this parameter may be included to indicate whether event reporting requires the location information. If set to true, the location estimation information shall be included in event reporting. If set to "false", indicates the location estimation information shall not be included in event reporting. Default "false" if omitted.

            '
        linearDistance:
          $ref: TS29572_Nlmf_Location.yaml#/components/schemas/LinearDistance
        locQoS:
          $ref: TS29572_Nlmf_Location.yaml#/components/schemas/LocationQoS
        svcId:
          $ref: TS29515_Ngmlc_Location.yaml#/components/schemas/ServiceIdentity
        ldrType:
          $ref: TS29572_Nlmf_Location.yaml#/components/schemas/LdrType
        velocityRequested:
          $ref: TS29572_Nlmf_Location.yaml#/components/schemas/VelocityRequested
        maxAgeOfLocEst:
          $ref: TS29572_Nlmf_Location.yaml#/components/schemas/AgeOfLocationEstimate
        locTimeWindow:
          $ref: TS29122_CommonData.yaml#/components/schemas/TimeWindow
        supportedGADShapes:
          type: array
          items:
            $ref: TS29572_Nlmf_Location.yaml#/components/schemas/SupportedGADShapes
        codeWord:
          $ref: TS29515_Ngmlc_Location.yaml#/components/schemas/CodeWord
        upLocRepIndAf:
          description: 'Indicates whether location reporting over user plane is requested or not. "true" indicates the location reporting over user plane is requested. "false" indicates the location reporting over user plane is not requested. Default value is "false" if omitted.

            '
          type: boolean
          default: false
        upLocRepAddrAf:
          $ref: '#/components/schemas/UpLocRepAddrAfRm'
        associationType:
          $ref: '#/components/schemas/AssociationType'
        plmnIndication:
          type: boolean
          description: 'If "monitoringType" is "ROAMING_STATUS", this parameter may be included to indicate the notification of UE''s Serving PLMN ID. Value "true" indicates enabling of notification; "false" indicates disabling of notification. Default value is "false" if omitted.

            '
        locationArea:
          $ref: TS29122_CommonData.yaml#/components/schemas/LocationArea
        locationArea5G:
          $ref: TS29122_CommonData.yaml#/components/schemas/LocationArea5G
        dddTraDescriptors:
          type: array
          items:
            $ref: TS29571_CommonData.yaml#/components/schemas/DddTrafficDescriptor
          minItems: 1
        dddStati:
          type: array
          items:
            $ref: TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus
          minItems: 1
        apiNames:
          type: array
          items:
            type: string
          minItems: 1
        monitoringEventReport:
          $ref: '#/components/schemas/MonitoringEventReport'
        snssai:
          $ref: TS29571_CommonData.yaml#/components/schemas/Snssai
        tgtNsThreshold:
          $ref: TS29571_CommonData.yaml#/components/schemas/SACInfo
        nsRepFormat:
          $ref: '#/components/schemas/SACRepFormat'
        afServiceId:
          type: string
        immediateRep:
          type: boolean
          description: 'Indicates whether an immediate reporting is requested or not. "true" indicate an immediate reporting is requested. "false" indicate an immediate reporting is not requested. Default value "false" if omitted.

            '
        uavPolicy:
          $ref: '#/components/schemas/UavPolicy'
        sesEstInd:
          type: boolean
          description: 'Set to true by the SCS/AS so that only UAV''s with "PDU session established for DNN(s) subject to aerial service" are to be listed in the Event report. Set to false or default false if omitted otherwise.

            '
        subType:
          $ref: '#/components/schemas/SubType'
        addnMonTypes:
          type: array
          items:
            $ref: '#/components/schemas/MonitoringType'
        addnMonEventReports:
          type: array
          items:
            $ref: '#/components/schemas/MonitoringEventReport'
        ueIpAddr:
          $ref: TS29571_CommonData.yaml#/components/schemas/IpAddr
        ueMacAddr:
          $ref: TS29571_CommonData.yaml#/components/schemas/MacAddr48
        revocationNotifUri:
          $ref: TS29122_CommonData.yaml#/components/schemas/Uri
        reqRangSlRes:
          type: array
          items:
            $ref: TS29572_Nlmf_Location.yaml#/components/schemas/RangingSlResult
          minItems: 1
        relatedUes:
          type: object
          additionalProperties:
            $ref: TS29572_Nlmf_Location.yaml#/components/schemas/RelatedUe
          minProperties: 1
          description: 'Contains a list of the related UE(s) for the ranging and sidelink positioning and the corresponding information. The key of the map shall be a any unique string set to the value.

            '
        flowDescs:
          type: array
          items:
            $ref: TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription
          minItems: 1
          description: Describes the application traffic service data flows.
      required:
      - notificationDestination
      - monitoringType
      anyOf:
      - required:
        - maximumNumberOfReports
      - required:
        - monitorExpireTime
    UpCumEvtRep:
      description: Represents the cumulative event report.
      type: object
      properties:
        upLocRepStat:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
    UeStrAndFwdSatInfo:
      description: Contains the Store and Forward operation information for satellite access.
      type: object
      properties:
        ueStrAndFwdStatus:
          $ref: '#/components/schemas/UeStrAndFwdStatus'
        externalId:
          $ref: TS29122_CommonData.yaml#/components/schemas/ExternalId
        msisdn:
          $ref: TS29122_CommonData.yaml#/components/schemas/Msisdn
        estTime:
          $ref: TS29122_CommonData.yaml#/components/schemas/DurationSec
        fLinkAvail:
          $ref: TS29122_CommonData.yaml#/components/schemas/TimeWindow
      required:
      - ueStrAndFwdStatus
      oneOf:
      - required:
        - externalId
      - required:
        - msisdn
    LocationType:
      anyOf:
      - type: string
        enum:
        - CURRENT_LOCATION
        - LAST_KNOWN_LOCATION
        - CURRENT_OR_LAST_KNOWN_LOCATION
        - INITIAL_LOCATION
      - type: string
        description: 'This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.

          '
      description: "Represents a location type.  \nPossible values are\n- CURRENT_LOCATION: The SCS/AS requests to be notified for current location\n- LAST_KNOWN_LOCATION: The SCS/AS requests to be notified for last known location\n- CURRENT_OR_LAST_KNOWN_LOCATION: The AF requests the current or last known location\n- INITIAL_LOCATION: The AF requests the initial location\n"
    SubType:
      anyOf:
      - type: string
        enum:
        - AERIAL_UE
      - type: string
        description: 'This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.

          '
      description: "Represents a subscription type.  \nPossible values are\n- AERIAL_UE: The UE has Aerial subscription.\n"
    AssociationType:
      anyOf:
      - type: string
        enum:
        - IMEI
        - IMEISV
      - type: string
        description: 'This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.

          '
      description: "Represents an IMEI or IMEISV to IMSI association.  \nPossible values are\n- IMEI: The value shall be used when the change of IMSI-IMEI association shall be detected\n- IMEISV: The value shall be used when the change of IMSI-IMEISV association shall be\n  detected\n"
    MonitoringEventReports:
      description: Represents a set of event monitoring reports.
      type: object
      properties:
        monitoringEventReports:
          type: array
          items:
            $ref: '#/components/schemas/MonitoringEventReport'
          minItems: 1
      required:
      - monitoringEventReports
    ReachabilityType:
      anyOf:
      - type: string
        enum:
        - SMS
        - DATA
      - type: string
        description: 'This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.

          '
      description: "Represents a reachability type.  \nPossible values are\n- SMS: The SCS/AS requests to be notified when the UE becomes reachable for sending SMS\n  to the UE\n- DATA: The SCS/AS requests to be notified when the UE becomes reachable for sending\n  downlink data to the UE.\n"
    MonitoringType:
      anyOf:
      - type: string
        enum:
        - LOSS_OF_CONNECTIVITY
        - UE_REACHABILITY
        - LOCATION_REPORTING
        - CHANGE_OF_IMSI_IMEI_ASSOCIATION
        - ROAMING_STATUS
        - COMMUNICATION_FAILURE
        - AVAILABILITY_AFTER_DDN_FAILURE
        - NUMBER_OF_UES_IN_AN_AREA
        - PDN_CONNECTIVITY_STATUS
        - DOWNLINK_DATA_DELIVERY_STATUS
        - API_SUPPORT_CAPABILITY
        - NUM_OF_REGD_UES
        - NUM_OF_ESTD_PDU_SESSIONS
        - AREA_OF_INTEREST
        - GROUP_MEMBER_LIST_CHANGE
        - APPLICATION_START
        - APPLICATION_STOP
        - SESSION_INACTIVITY_TIME
        - TRAFFIC_VOLUME
        - UL_DL_DATA_RATE
        - STR_FWD_SAT_INFO
        - UE_ENERGY
        - PDU_SESSION_ENERGY
        - SERVICE_FLOW_ENERGY
        - UE_SNSSAI_ENERGY
      - type: string
        description: 'This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.

          '
      description: "Represents a monitoring event type.  \nPossible values are\n- LOSS_OF_CONNECTIVITY: The SCS/AS requests to be notified when the 3GPP network detects\n  that the UE is no longer reachable for signalling or user plane communication\n- UE_REACHABILITY: The SCS/AS requests to be notified when the UE becomes reachable for\n  sending either SM

# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/3gpp/refs/heads/main/openapi/3gpp-individual-monitoring-event-subscription-api-openapi.yml