3GPP NWDAF Event Subscription Transfers (Collection) API

openapi: 3.2.0
info:
  version: 1.2.0
  title: Nnwdaf_EventsSubscription NWDAF Event Subscription Transfers (Collection) API
  description: "Nnwdaf_EventsSubscription Service API.  \n© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  \nAll rights reserved.\n"
servers:
- url: '{apiRoot}/nnwdaf-eventssubscription/v1'
  variables:
    apiRoot:
      default: https://example.com
      description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501.
security:
- {}
- oAuth2ClientCredentials:
  - nnwdaf-eventssubscription
tags:
- name: NWDAF Event Subscription Transfers (Collection)
paths:
  /transfers:
    post:
      summary: Provide information about requested analytics subscriptions transfer and potentially create a new Individual NWDAF Event Subscription Transfer resource.
      operationId: CreateNWDAFEventSubscriptionTransfer
      tags:
      - NWDAF Event Subscription Transfers (Collection)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnalyticsSubscriptionsTransfer'
      responses:
        '201':
          description: Create a new Individual NWDAF Event Subscription Transfer resource.
          headers:
            Location:
              description: 'Contains the URI of the newly created resource, according to the structure {apiRoot}/nnwdaf-eventssubscription/<apiVersion>/transfers/{transferId}

                '
              required: true
              schema:
                type: string
        '204':
          description: 'No Content. The receipt of the information about analytics subscription(s) that are requested to be transferred and the ability to handle this information (e.g. execute the steps required to transfer an analytics subscription directly) is confirmed.

            '
        '400':
          $ref: TS29571_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29571_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29571_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29571_CommonData.yaml#/components/responses/404
        '411':
          $ref: TS29571_CommonData.yaml#/components/responses/411
        '413':
          $ref: TS29571_CommonData.yaml#/components/responses/413
        '415':
          $ref: TS29571_CommonData.yaml#/components/responses/415
        '429':
          $ref: TS29571_CommonData.yaml#/components/responses/429
        '500':
          $ref: TS29571_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29571_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29571_CommonData.yaml#/components/responses/default
components:
  schemas:
    WlanOrderingCriterion:
      anyOf:
      - type: string
        enum:
        - TIME_SLOT_START
        - NUMBER_OF_UES
        - RSSI
        - RTT
        - TRAFFIC_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: 'Possible values are:

        - TIME_SLOT_START: Indicates the order of time slot start.

        - NUMBER_OF_UES: Indicates the order of number of UEs.

        - RSSI: Indicates the order of RSSI.

        - RTT: Indicates the order of RTT.

        - TRAFFIC_INFO: Indicates the order of Traffic information.

        '
    TimeUnit:
      anyOf:
      - type: string
        enum:
        - MINUTE
        - HOUR
        - DAY
      - 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: 'Possible values are:

        - MINUTE: Time unit is per minute.

        - HOUR: Time unit is per hour.

        - DAY: Time unit is per day.

        '
    ClassCriterion:
      description: 'Indicates the dispersion class criterion for fixed, camper and/or traveller UE, and/or the  top-heavy UE dispersion class criterion.

        '
      type: object
      properties:
        disperClass:
          $ref: '#/components/schemas/DispersionClass'
        classThreshold:
          $ref: TS29571_CommonData.yaml#/components/schemas/SamplingRatio
        thresMatch:
          $ref: '#/components/schemas/MatchingDirection'
      required:
      - disperClass
      - classThreshold
      - thresMatch
    UeMobility:
      description: Represents UE mobility information.
      type: object
      properties:
        ts:
          $ref: TS29571_CommonData.yaml#/components/schemas/DateTime
        duration:
          $ref: TS29571_CommonData.yaml#/components/schemas/DurationSec
        durationVariance:
          $ref: TS29571_CommonData.yaml#/components/schemas/Float
        locInfos:
          type: array
          items:
            $ref: '#/components/schemas/LocationInfo'
          minItems: 1
      allOf:
      - required:
        - duration
      - required:
        - locInfos
      - oneOf:
        - required:
          - ts
        - required:
          - recurringTime
    FailureEventInfo:
      description: Contains information on the event for which the subscription is not successful.
      type: object
      properties:
        event:
          $ref: '#/components/schemas/NwdafEvent'
        failureCode:
          $ref: '#/components/schemas/NwdafFailureCode'
      required:
      - event
      - failureCode
    DnPerformanceReq:
      description: Represents other DN performance analytics requirements.
      type: object
      properties:
        dnPerfOrderCriter:
          $ref: '#/components/schemas/DnPerfOrderingCriterion'
        order:
          $ref: '#/components/schemas/MatchingDirection'
        reportThresholds:
          type: array
          items:
            $ref: '#/components/schemas/ThresholdLevel'
          minItems: 1
    TrafficInformation:
      description: Traffic information including UL/DL data rate and/or Traffic volume.
      type: object
      properties:
        uplinkRate:
          $ref: TS29571_CommonData.yaml#/components/schemas/BitRate
        downlinkRate:
          $ref: TS29571_CommonData.yaml#/components/schemas/BitRate
      anyOf:
      - required:
        - uplinkRate
      - required:
        - downlinkRate
    RedundantTransmissionExpInfo:
      description: 'The redundant transmission experience related information. When subscribed event is  "RED_TRANS_EXP", the "redTransInfos" attribute shall be included.

        '
      type: object
      properties:
        dnn:
          $ref: TS29571_CommonData.yaml#/components/schemas/Dnn
        redTransExps:
          type: array
          items:
            $ref: '#/components/schemas/RedundantTransmissionExpPerTS'
          minItems: 1
      required:
      - redTransExps
    UeAnalyticsContextDescriptor:
      description: Contains information about available UE related analytics contexts.
      type: object
      properties:
        supi:
          $ref: TS29571_CommonData.yaml#/components/schemas/Supi
        anaTypes:
          type: array
          items:
            $ref: '#/components/schemas/NwdafEvent'
          minItems: 1
          description: 'List of analytics types for which UE related analytics contexts can be retrieved.

            '
      required:
      - supi
      - anaTypes
    NnwdafEventsSubscription:
      description: Represents an Individual NWDAF Event Subscription resource.
      type: object
      properties:
        eventSubscriptions:
          type: array
          items:
            $ref: '#/components/schemas/EventSubscription'
          minItems: 1
          description: Subscribed events
        notificationURI:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uri
        notifCorrId:
          type: string
          description: Notification correlation identifier.
        supportedFeatures:
          $ref: TS29571_CommonData.yaml#/components/schemas/SupportedFeatures
        eventNotifications:
          type: array
          items:
            $ref: '#/components/schemas/EventNotification'
          minItems: 1
        failEventReports:
          type: array
          items:
            $ref: '#/components/schemas/FailureEventInfo'
          minItems: 1
        prevSub:
          $ref: '#/components/schemas/PrevSubInfo'
        consNfInfo:
          $ref: '#/components/schemas/ConsumerNfInformation'
      required:
      - eventSubscriptions
    WlanPerTsPerformanceInfo:
      description: WLAN performance information per Time Slot during the analytics target period.
      type: object
      properties:
        tsStart:
          $ref: TS29571_CommonData.yaml#/components/schemas/DateTime
        tsDuration:
          $ref: TS29571_CommonData.yaml#/components/schemas/DurationSec
        rssi:
          type: integer
        rtt:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
        trafficInfo:
          $ref: '#/components/schemas/TrafficInformation'
        numberOfUes:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
        confidence:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
      required:
      - tsStart
      - tsDuration
      anyOf:
      - required:
        - rssi
      - required:
        - rtt
      - required:
        - trafficInfo
      - required:
        - numberOfUes
    NumberAverage:
      description: Represents average and variance information.
      type: object
      properties:
        number:
          type: integer
        variance:
          $ref: TS29571_CommonData.yaml#/components/schemas/Float
      required:
      - number
      - variance
    NotificationMethod:
      anyOf:
      - type: string
        enum:
        - PERIODIC
        - THRESHOLD
      - 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: "Possible values are:\n- PERIODIC: The subscribe of NWDAF Event is periodically. The periodic of the notification is identified by repetitionPeriod defined in clause 5.1.6.2.3.  \n- THRESHOLD: The subscribe of NWDAF Event is upon threshold exceeded.\n"
    PerfData:
      description: Represents DN performance data.
      type: object
      properties:
        avgTrafficRate:
          $ref: TS29571_CommonData.yaml#/components/schemas/BitRate
        maxTrafficRate:
          $ref: TS29571_CommonData.yaml#/components/schemas/BitRate
        avePacketDelay:
          $ref: TS29571_CommonData.yaml#/components/schemas/PacketDelBudget
        maxPacketDelay:
          $ref: TS29571_CommonData.yaml#/components/schemas/PacketDelBudget
        avgPacketLossRate:
          $ref: TS29571_CommonData.yaml#/components/schemas/PacketLossRate
    RankingCriterion:
      description: Indicates the usage ranking criterion between the high, medium and low usage UE.
      type: object
      properties:
        highBase:
          $ref: TS29571_CommonData.yaml#/components/schemas/SamplingRatio
        lowBase:
          $ref: TS29571_CommonData.yaml#/components/schemas/SamplingRatio
      required:
      - highBase
      - lowBase
    DnPerfOrderingCriterion:
      anyOf:
      - type: string
        enum:
        - AVERAGE_TRAFFIC_RATE
        - MAXIMUM_TRAFFIC_RATE
        - AVERAGE_PACKET_DELAY
        - MAXIMUM_PACKET_DELAY
        - AVERAGE_PACKET_LOSS_RATE
      - 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: "Possible values are:  \n- AVERAGE_TRAFFIC_RATE: Indicates the average traffic rate.  \n- MAXIMUM_TRAFFIC_RATE: Indicates the maximum traffic rate.  \n- AVERAGE_PACKET_DELAY: Indicates the average packet delay.  \n- MAXIMUM_PACKET_DELAY: Indicates the maximum packet delay.  \n- AVERAGE_PACKET_LOSS_RATE: Indicates the average packet loss rate.\n"
    CongestionInfo:
      description: Represents the congestion information.
      type: object
      properties:
        congType:
          $ref: '#/components/schemas/CongestionType'
        nsi:
          $ref: '#/components/schemas/ThresholdLevel'
        confidence:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
        topAppListUl:
          type: array
          items:
            $ref: '#/components/schemas/TopApplication'
          minItems: 1
        topAppListDl:
          type: array
          items:
            $ref: '#/components/schemas/TopApplication'
          minItems: 1
      required:
      - congType
      - nsi
    ServiceExperienceInfo:
      description: Represents service experience information.
      type: object
      properties:
        svcExprcVariance:
          $ref: TS29571_CommonData.yaml#/components/schemas/Float
        supis:
          type: array
          items:
            $ref: TS29571_CommonData.yaml#/components/schemas/Supi
          minItems: 1
        snssai:
          $ref: TS29571_CommonData.yaml#/components/schemas/Snssai
        appId:
          $ref: TS29571_CommonData.yaml#/components/schemas/ApplicationId
        srvExpcType:
          $ref: '#/components/schemas/ServiceExperienceType'
        ueLocs:
          type: array
          items:
            $ref: '#/components/schemas/LocationInfo'
          minItems: 1
        dnai:
          $ref: TS29571_CommonData.yaml#/components/schemas/Dnai
        confidence:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
        dnn:
          $ref: TS29571_CommonData.yaml#/components/schemas/Dnn
        ratio:
          $ref: TS29571_CommonData.yaml#/components/schemas/SamplingRatio
        ratFreq:
          $ref: '#/components/schemas/RatFreqInformation'
      required:
      - svcExprc
    UserDataCongestionInfo:
      description: Represents the user data congestion information.
      type: object
      properties:
        congestionInfo:
          $ref: '#/components/schemas/CongestionInfo'
        snssai:
          $ref: TS29571_CommonData.yaml#/components/schemas/Snssai
      required:
      - congestionInfo
    DispersionInfo:
      description: 'Represents the Dispersion information. When subscribed event is "DISPERSION", the  "disperInfos" attribute shall be included.

        '
      type: object
      properties:
        tsStart:
          $ref: TS29571_CommonData.yaml#/components/schemas/DateTime
        tsDuration:
          $ref: TS29571_CommonData.yaml#/components/schemas/DurationSec
        disperCollects:
          type: array
          items:
            $ref: '#/components/schemas/DispersionCollection'
          minItems: 1
        disperType:
          $ref: '#/components/schemas/DispersionType'
      required:
      - tsStart
      - tsDuration
      - disperCollects
      - disperType
    CircumstanceDescription:
      description: Contains the description of a circumstance.
      type: object
      properties:
        freq:
          $ref: TS29571_CommonData.yaml#/components/schemas/Float
        tm:
          $ref: TS29571_CommonData.yaml#/components/schemas/DateTime
    TransferRequestType:
      anyOf:
      - type: string
        enum:
        - PREPARE
        - TRANSFER
      - 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: 'Possible values are:

        - PREPARE: Indicates that the request is for analytics subscription transfer preparation.

        - TRANSFER: Indicates that the request is for analytics subscription transfer execution.

        '
    MLModelInfo:
      description: Contains information about an ML models.
      type: object
      properties:
        modelProvId:
          $ref: TS29571_CommonData.yaml#/components/schemas/NfInstanceId
        modelProvSetId:
          $ref: TS29571_CommonData.yaml#/components/schemas/NfSetId
      oneOf:
      - required:
        - modelProvId
      - required:
        - modelProvSetId
    UeCommunication:
      description: Represents UE communication information.
      type: object
      properties:
        commDur:
          $ref: TS29571_CommonData.yaml#/components/schemas/DurationSec
        commDurVariance:
          $ref: TS29571_CommonData.yaml#/components/schemas/Float
        perioTime:
          $ref: TS29571_CommonData.yaml#/components/schemas/DurationSec
        perioTimeVariance:
          $ref: TS29571_CommonData.yaml#/components/schemas/Float
        ts:
          $ref: TS29571_CommonData.yaml#/components/schemas/DateTime
        tsVariance:
          $ref: TS29571_CommonData.yaml#/components/schemas/Float
        trafChar:
          $ref: '#/components/schemas/TrafficCharacterization'
        ratio:
          $ref: TS29571_CommonData.yaml#/components/schemas/SamplingRatio
        perioCommInd:
          type: boolean
        confidence:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
        anaOfAppList:
          $ref: '#/components/schemas/AppListForUeComm'
        sessInactTimer:
          $ref: '#/components/schemas/SessInactTimerForUeComm'
      allOf:
      - required:
        - commDur
      - required:
        - trafChar
      - oneOf:
        - required:
          - ts
        - required:
          - recurringTime
    ExceptionTrend:
      anyOf:
      - type: string
        enum:
        - UP
        - DOWN
        - UNKNOW
        - STABLE
      - 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: 'Possible values are:

        - UP: Up trend of the exception level.

        - DOWN: Down trend of the exception level.

        - UNKNOW: Unknown trend of the exception level.

        - STABLE: Stable trend of the exception level.

        '
    NwdafFailureCode:
      anyOf:
      - type: string
        enum:
        - UNAVAILABLE_DATA
        - BOTH_STAT_PRED_NOT_ALLOWED
        - UNSATISFIED_REQUESTED_ANALYTICS_TIME
        - OTHER
      - 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: "Possible values are:\n- UNAVAILABLE_DATA: Indicates the requested statistics information for the event is rejected since necessary data to perform the service is unavailable.\n- BOTH_STAT_PRED_NOT_ALLOWED: Indicates the requested analysis information for the event is rejected since the start time is in the past and the end time is in the future, which means the NF service consumer requested both statistics and prediction for the analytics.\n- UNSATISFIED_REQUESTED_ANALYTICS_TIME: Indicates that the requested event is rejected since the analytics information is not ready when the time indicated by the \"timeAnaNeeded\" attribute (as provided during the creation or modification of subscription) is reached.\n- OTHER: Indicates the requested analysis information for the event is rejected due to other reasons. \n"
    DnPerf:
      description: Represents DN performance for the application.
      type: object
      properties:
        dnai:
          $ref: TS29571_CommonData.yaml#/components/schemas/Dnai
        perfData:
          $ref: '#/components/schemas/PerfData'
      required:
      - perfData
    EventReportingRequirement:
      description: Represents the type of reporting that the subscription requires.
      type: object
      properties:
        accuracy:
          $ref: '#/components/schemas/Accuracy'
        accPerSubset:
          type: array
          items:
            $ref: '#/components/schemas/Accuracy'
          minItems: 1
          description: 'Each element indicates the preferred accuracy level per analytics subset. It may be present if the "listOfAnaSubsets" attribute is present in the subscription request when the subscription event is NF_LOAD, UE_COMM, DISPERSION, NETWORK_PERFORMANCE, WLAN_PERFORMANCE, DN_PERFORMANCE or SERVICE_EXPERIENCE.

            '
        startTs:
          $ref: TS29571_CommonData.yaml#/components/schemas/DateTime
        endTs:
          $ref: TS29571_CommonData.yaml#/components/schemas/DateTime
        offsetPeriod:
          type: integer
          description: 'Offset period in units of seconds to the reporting time, if the value is negative means  statistics in the past offset period, otherwise a positive value means prediction in the  future offset period. May be present if the "repPeriod" attribute is included within the  "evtReq" attribute.

            '
        sampRatio:
          $ref: TS29571_CommonData.yaml#/components/schemas/SamplingRatio
        maxObjectNbr:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
        maxSupiNbr:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
        timeAnaNeeded:
          $ref: TS29571_CommonData.yaml#/components/schemas/DateTime
        anaMeta:
          type: array
          items:
            $ref: '#/components/schemas/AnalyticsMetadata'
          minItems: 1
        anaMetaInd:
          $ref: '#/components/schemas/AnalyticsMetadataIndication'
    AnalyticsMetadataIndication:
      description: 'Contains analytics metadata information requested to be used during analytics generation.

        '
      type: object
      properties:
        dataStatProps:
          type: array
          items:
            $ref: '#/components/schemas/DatasetStatisticalProperty'
          minItems: 1
        strategy:
          $ref: '#/components/schemas/OutputStrategy'
        aggrNwdafIds:
          type: array
          items:
            $ref: TS29571_CommonData.yaml#/components/schemas/NfInstanceId
          minItems: 1
    SessInactTimerForUeComm:
      description: Represents the N4 Session inactivity timer.
      type: object
      properties:
        n4SessId:
          $ref: TS29571_CommonData.yaml#/components/schemas/PduSessionId
        sessInactiveTimer:
          $ref: TS29571_CommonData.yaml#/components/schemas/DurationSec
      required:
      - N4SessId
      - sessInactiveTimer
    WlanPerformanceInfo:
      description: The WLAN performance related information.
      type: object
      properties:
        wlanPerSsidInfos:
          type: array
          items:
            $ref: '#/components/schemas/WlanPerSsIdPerformanceInfo'
          minItems: 1
      required:
      - wlanPerSsidInfos
    Exception:
      description: Represents the Exception information.
      type: object
      properties:
        excepId:
          $ref: '#/components/schemas/ExceptionId'
        excepLevel:
          type: integer
        excepTrend:
          $ref: '#/components/schemas/ExceptionTrend'
      required:
      - excepId
    AnalyticsSubscriptionsTransfer:
      description: Contains information about a request to transfer analytics subscriptions.
      type: object
      properties:
        subsTransInfos:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionTransferInfo'
          minItems: 1
      required:
      - subsTransInfos
    SliceLoadLevelInformation:
      description: Contains load level information applicable for one or several slices.
      type: object
      properties:
        loadLevelInformation:
          $ref: '#/components/schemas/LoadLevelInformation'
        snssais:
          type: array
          items:
            $ref: TS29571_CommonData.yaml#/components/schemas/Snssai
          minItems: 1
          description: Identification(s) of network slice to which the subscription applies.
      required:
      - loadLevelInformation
      - snssais
    ApplicationVolume:
      description: Application data volume per Application Id.
      type: object
      properties:
        appId:
          $ref: TS29571_CommonData.yaml#/components/schemas/ApplicationId
      required:
      - appId
    AnalyticsMetadata:
      anyOf:
      - type: string
        enum:
        - NUM_OF_SAMPLES
        - DATA_WINDOW
        - DATA_STAT_PROPS
        - STRATEGY
        - ACCURACY
      - 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: 'Possible values are:

        - NUM_OF_SAMPLES: Number of data samples used for the generation of the output analytics.

        - DATA_WINDOW: Data time window of the data samples.

        - DATA_STAT_PROPS: Dataset statistical properties of the data used to generate the analytics.

        - STRATEGY: Output strategy used for the reporting of the analytics.

        - ACCURACY: Level of accuracy reached for the analytics.

        '
    LoadLevelInformation:
      type: integer
      description: 'Load level information of the network slice and the optionally associated network slice  instance.

        '
    AnalyticsContextIdentifier:
      description: Contains information about available analytics contexts.
      type: object
      properties:
        subscriptionId:
          type: string
          description: The identifier of a subscription.
        nfAnaCtxts:
          type: array
          items:
            $ref: '#/components/schemas/NwdafEvent'
          minItems: 1
          description: 'List of analytics types for which NF related analytics contexts can be retrieved.

            '
        ueAnaCtxts:
          type: array
          items:
            $ref: '#/components/schemas/UeAnalyticsContextDescriptor'
          minItems: 1
          description: 'List of objects that indicate for which SUPI and analytics types combinations analytics  context can be retrieved.

            '
      allOf:
      - anyOf:
        - required:
          - nfAnaCtxts
        - required:
          - ueAnaCtxts
      - required:
        - subscriptionId
    WlanPerformanceReq:
      description: Represents other WLAN performance analytics requirements.
      type: object
      properties:
        ssIds:
          type: array
          items:
            type: string
          minItems: 1
        bssIds:
          type: array
          items:
            type: string
          minItems: 1
        wlanOrderCriter:
          $ref: '#/components/schemas/WlanOrderingCriterion'
        order:
          $ref: '#/components/schemas/MatchingDirection'
    LocationInfo:
      description: Represents UE location information.
      type: object
      properties:
        loc:
          $ref: TS29571_CommonData.yaml#/components/schemas/UserLocation
        ratio:
          $ref: TS29571_CommonData.yaml#/components/schemas/SamplingRatio
        confidence:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
      required:
      - loc
    NfLoadLevelInformation:
      description: Represents load level information of a given NF instance.
      type: object
      properties:
        nfInstanceId:
          $ref: TS29571_CommonData.yaml#/components/schemas/NfInstanceId
        nfSetId:
          $ref: TS29571_CommonData.yaml#/components/schemas/NfSetId
        nfStatus:
          $ref: '#/components/schemas/NfStatus'
        nfCpuUsage:
          type: integer
        nfMemoryUsage:
          type: integer
        nfStorageUsage:
          type: integer
        nfLoadLevelAverage:
          type: integer
        nfLoadLevelpeak:
          type: integer
        nfLoadAvgInAoi:
          type: integer
        snssai:
          $ref: TS29571_CommonData.yaml#/components/schemas/Snssai
        confidence:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
      allOf:
      - required:
        - nfInstanceId
      - anyOf:
        - required:
          - nfStatus
        - required:
          - nfCpuUsage
        - required:
          - nfMemoryUsage
        - required:
          - nfStorageUsage
        - required:
          - nfLoadLevelAverage
        - required:
          - nfLoadLevelPeak
    ResourceUsage:
      description: 'The current usage of the virtual resources assigned to the NF instances belonging to a  particular network slice instance.

        '
      type: object
      properties:
        cpuUsage:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
        memoryUsage:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
        storageUsage:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
    RetainabilityThreshold:
      description: Represents a QoS flow retainability threshold.
      type: object
      properties:
        relFlowNum:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
        relTimeUnit:
          $ref: '#/components/schemas/TimeUnit'
        relFlowRatio:
          $ref: TS29571_CommonData.yaml#/components/schemas/SamplingRatio
      oneOf:
      - allOf:
        - required:
          - relFlowNum
        - required:
          - relTimeUnit
      - required:
        - relFlowRatio
    DispersionCollection:
      description: Dispersion collection per UE location or per slice.
      type: object
      properties:
        ueLoc:
          $ref: TS29571_CommonData.yaml#/components/schemas/UserLocation
        snssai:
          $ref: TS29571_CommonData.yaml#/components/schemas/Snssai
        supis:
          type: array
          items:
            $ref: TS29571_CommonData.yaml#/components/schemas/Supi
          minItems: 1
        gpsis:
          type: array
          items:
            $ref: TS29571_CommonData.yaml#/components/schemas/Gpsi
          minItems: 1
        appVolumes:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationVolume'
          minItems: 1
        disperAmount:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
        disperClass:
          $ref: '#/components/schemas/DispersionClass'
        usageRank:
          type: integer
          description: Integer where the allowed values correspond to 1, 2, 3 only.
          minimum: 1
          maximum: 3
        percentileRank:
          $ref: TS29571_CommonData.yaml#/components/schemas/SamplingRatio
        ueRatio:
          $ref: TS29571_CommonData.yaml#/components/schemas/SamplingRatio
        confidence:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
      allOf:
      - oneOf:
        - required:
          - ueLoc
        - required:
          - snssai
      - anyOf:
        - required:
          - disperAmount
        - required:
          - disperClass
        - required:
          - usageRank
        - required:
          - percentileRank
    ServiceExperienceType:
      anyOf:
      - type: string
        enum:
        - VOICE
        - VIDEO
        - OTHER
      - 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: 'Possible values are:

        - VOICE: Indicates that the service experience analytics is for voice service.

        - VIDEO: Indicates that the service experience analytics is for video service.

        - OTHER: Indicates that the service experience analytics is for other service.

        '
    DnPerfInfo:
      description: Represents DN performance information.
      type: object
      properties:
        appId:
          $ref: TS29571_CommonData.yaml#/components/schemas/ApplicationId
        dnn:
          $ref: TS29571_CommonData.yaml#/components/schemas/Dnn
        snssai:
          $ref: TS29571_CommonData.yaml#/components/schemas/Snssai
        dnPerf:
          type: array
          items:
            $ref: '#/components/schemas/DnPerf'
          minItems: 1
        confidence:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
      required:
      - dnPerf
    NetworkPerfRequirement:
      description: Represents a network performance requirement.
      type: object
      properties:
        nwPerfType:
          $ref: '#/components/schemas/NetworkPerfType'
        relativeRatio:
          $ref: TS29571_CommonData.yaml#/components/schemas/S

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