3GPP Individual Member UE Selection Assistance Subscription (Document) API

openapi: 3.2.0
info:
  title: 3gpp-musa Individual Member UE Selection Assistance Subscription (Document) API
  version: 1.1.0
  description: "API for Member UE Selection Assistance.  \n© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  \nAll rights reserved.\n"
servers:
- url: '{apiRoot}/3gpp-musa/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 Member UE Selection Assistance Subscription (Document)
paths:
  /{afId}/subscriptions/{subscriptionId}:
    parameters:
    - name: afId
      in: path
      description: Represents the identifier of the AF.
      required: true
      schema:
        type: string
    - name: subscriptionId
      in: path
      description: 'Represents the identifier of the Individual Member UE Selection Assistance Subscription resource.

        '
      required: true
      schema:
        type: string
    get:
      summary: Retrieve an existing Individual Member UE Selection Assistance Subscription resource.
      operationId: GetIndMemberUESelectAssistSubsc
      tags:
      - Individual Member UE Selection Assistance Subscription (Document)
      responses:
        '200':
          description: 'OK. The requested Individual Member UE Selection Assistance Subscription resource is successfully returned in the response body.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemUeSelectAssistSubsc'
        '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: Request the update of an existing Individual Member UE Selection Assistance Subscription resource.
      operationId: UpdateIndMemberUESelectAssistSubsc
      tags:
      - Individual Member UE Selection Assistance Subscription (Document)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MemUeSelectAssistSubsc'
      responses:
        '200':
          description: 'OK. The Individual Member UE Selection Assistance Subscription resource is successfully updated and a representation of the updated resource is returned in the response body.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemUeSelectAssistSubsc'
        '204':
          description: 'No Content. The Individual Member UE Selection Assistance Subscription resource is successfully updated and no content is returned in the response body.

            '
        '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: Request the Modification of an existing Individual Member UE Selection Assistance Subscription resource.
      operationId: ModifyIndMemberUESelectAssistSubsc
      tags:
      - Individual Member UE Selection Assistance Subscription (Document)
      requestBody:
        required: true
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/MemUeSelectAssistSubscPatch'
      responses:
        '200':
          description: 'OK. The Individual Member UE Selection Assistance Subscription resource is successfully modified and a representation of the updated resource is returned in the response body.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemUeSelectAssistSubsc'
        '204':
          description: 'No Content. The Individual Member UE Selection Assistance Subscription resource is successfully modified and no content is returned in the response body.

            '
        '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: Request the deletion of an existing Individual Member UE Selection Assistance Subscription resource.
      operationId: DeleteIndMemberUESelectAssistSubsc
      tags:
      - Individual Member UE Selection Assistance Subscription (Document)
      responses:
        '204':
          description: 'No Content. The Individual Member UE Selection Assistance Subscription resource is successfully deleted.

            '
        '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:
    UeHisLocFilterCriteria:
      description: 'Represents the UE historical location filtering criteria for Member UE selection.

        '
      type: object
      properties:
        event:
          $ref: TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent
        loc:
          $ref: TS29122_CommonData.yaml#/components/schemas/LocationArea5G
    DnnFilterCriteria:
      description: 'Represents the DNN filtering criteria for Member UE selection.

        '
      type: object
      properties:
        event:
          $ref: TS29508_Nsmf_EventExposure.yaml#/components/schemas/SmfEvent
        dnn:
          $ref: TS29571_CommonData.yaml#/components/schemas/Dnn
    UeDistanceFilterCriteria:
      description: 'Represents the UE distance filtering criteria for Member UE selection.

        '
      type: object
      properties:
        event:
          $ref: TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent
        distance:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
    AccessRatTypeFilterCriteria:
      description: Represents the the Access types and RAT types filtering criteria for Member UE selection.
      type: object
      properties:
        events:
          type: array
          items:
            $ref: TS29508_Nsmf_EventExposure.yaml#/components/schemas/SmfEvent
          minItems: 1
          description: 'Contains the SMF event(s) which may be used to retrieve the Access Type and/or RAT Type of the selected UE.

            '
        dnn:
          $ref: TS29571_CommonData.yaml#/components/schemas/Dnn
        snssai:
          $ref: TS29571_CommonData.yaml#/components/schemas/Snssai
        accTypes:
          type: array
          items:
            $ref: TS29571_CommonData.yaml#/components/schemas/AccessType
          minItems: 1
          description: Contains the Access Types of the selected UE.
        ratTypes:
          type: array
          items:
            $ref: TS29571_CommonData.yaml#/components/schemas/RatType
          minItems: 1
          description: Contains the RAT Types of the selected UE.
    QoSFilterCriteria:
      description: Represents the QoS filtering criteria for Member UE selection.
      type: object
      properties:
        event:
          $ref: TS29508_Nsmf_EventExposure.yaml#/components/schemas/SmfEvent
        appId:
          type: string
          description: Contains the identifier(s) of the application.
        dnn:
          $ref: TS29571_CommonData.yaml#/components/schemas/Dnn
        snssai:
          $ref: TS29571_CommonData.yaml#/components/schemas/Snssai
        ulDelay:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
        dlDelay:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
        rtDelay:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
    MemUeSelectAssistSubsc:
      description: Represents a Member UE Selection Assistance Subscription.
      type: object
      properties:
        afId:
          type: string
          description: Represents the identifier of the AF.
        tgtUeIds:
          type: array
          items:
            $ref: TS29571_CommonData.yaml#/components/schemas/Gpsi
          minItems: 1
          description: 'Contains the list of identifier(s) of the UEs for which Member UE Selection Assistance Reporting is requested.

            '
        tgtUeIps:
          type: array
          items:
            $ref: TS29571_CommonData.yaml#/components/schemas/IpAddr
          minItems: 1
          description: 'Contains the IP addresses of a list of UEs for Member UE Selection Assistance Reporting.

            '
        notifUri:
          $ref: TS29122_CommonData.yaml#/components/schemas/Uri
        notifId:
          type: string
          description: Contains the Notification Correlation ID assigned by the AF.
        expTime:
          $ref: TS29122_CommonData.yaml#/components/schemas/DateTime
        qosFilters:
          type: array
          items:
            $ref: '#/components/schemas/QoSFilterCriteria'
          minItems: 1
          description: Contains the QoS filtering criteria for Member UE selection.
        accRatTypeFilters:
          type: array
          items:
            $ref: '#/components/schemas/AccessRatTypeFilterCriteria'
          minItems: 1
          description: 'Contains the Access types and Rat types filtering criteria for Member UE selection.

            '
        e2eTransTimeFilters:
          type: array
          items:
            $ref: '#/components/schemas/E2ETransTimeFilterCriteria'
          minItems: 1
          description: 'Contains the End-to-end data volume transfer time filtering criteria for Member UE selection.

            '
        ueLocFilters:
          type: array
          items:
            $ref: '#/components/schemas/UeLocFilterCriteria'
          minItems: 1
          description: Contains the UE location filtering criteria for Member UE selection.
        ueHisLocFilters:
          type: array
          items:
            $ref: '#/components/schemas/UeHisLocFilterCriteria'
          minItems: 1
          description: 'Contains the UE historical location filtering criteria for Member UE selection.

            '
        ueDirFilters:
          type: array
          items:
            $ref: '#/components/schemas/UeDirectionFilterCriteria'
          minItems: 1
          description: Contains the UE direction filtering criteria for Member UE selection.
        ueDistanceFilters:
          type: array
          items:
            $ref: '#/components/schemas/UeDistanceFilterCriteria'
          minItems: 1
          description: Contains the UE distance filtering criteria for Member UE selection.
        serviceExpFilters:
          type: array
          items:
            $ref: '#/components/schemas/ServiceExpFilterCriteria'
          minItems: 1
          description: Contains the Service Experience filtering criteria for Member UE selection.
        dnnFilters:
          type: array
          items:
            $ref: '#/components/schemas/DnnFilterCriteria'
          minItems: 1
          description: Contains the DNN filtering criteria for Member UE selection.
        memUpdatePeriod:
          $ref: TS29571_CommonData.yaml#/components/schemas/DurationSec
        maxUeNum:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
        timeWin:
          $ref: TS29122_CommonData.yaml#/components/schemas/TimeWindow
        suppFeat:
          $ref: TS29571_CommonData.yaml#/components/schemas/SupportedFeatures
      required:
      - notifUri
      - notifId
      oneOf:
      - required:
        - tgtUeIds
      - required:
        - tgtUeIps
      anyOf:
      - required:
        - qosFilters
      - required:
        - accRatTypeFilters
      - required:
        - e2eTransTimeFilters
      - required:
        - ueLocFilters
      - required:
        - ueHisLocFilters
      - required:
        - ueDirFilters
      - required:
        - ueDistanceFilters
      - required:
        - serviceExpFilters
      - required:
        - dnnFilters
    E2ETransTimeFilterCriteria:
      description: 'Represents the End-to-end data volume transfer time filtering criteria for Member UE selection.

        '
      type: object
      properties:
        event:
          $ref: TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent
        appId:
          type: string
          description: Contains the identifier of the application.
        dnn:
          $ref: TS29571_CommonData.yaml#/components/schemas/Dnn
        snssai:
          $ref: TS29571_CommonData.yaml#/components/schemas/Snssai
        dataVolTransTime:
          $ref: TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/DataVolumeTransferTime
        geoDistrInfos:
          type: array
          items:
            $ref: TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/GeoDistributionInfo
          minItems: 1
          description: Indicates the geographical distribution of the UEs per location information.
        locationArea:
          $ref: TS29122_CommonData.yaml#/components/schemas/LocationArea5G
        numDataTrans:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
        timeInterval:
          $ref: TS29122_CommonData.yaml#/components/schemas/DurationSec
    UeDirectionFilterCriteria:
      description: 'Represents the UE direction filtering criteria for Member UE selection.

        '
      type: object
      properties:
        event:
          $ref: TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent
        directions:
          type: array
          items:
            $ref: TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/Direction
          minItems: 1
          description: Contains the moving directions of the UEs.
    MemUeSelectAssistSubscPatch:
      description: 'Represents the requested modifications to aMember UE Selection Assistance Subscription.

        '
      type:
      - object
      - 'null'
      properties:
        notifUri:
          $ref: TS29122_CommonData.yaml#/components/schemas/Uri
        notifId:
          type: string
        expTime:
          $ref: TS29122_CommonData.yaml#/components/schemas/DateTime
        qosFilters:
          type: array
          items:
            $ref: '#/components/schemas/QoSFilterCriteria'
          minItems: 1
          description: Contains the updatedQoS filtering criteria for Member UE selection.
        accRatTypeFilters:
          type: array
          items:
            $ref: '#/components/schemas/AccessRatTypeFilterCriteria'
          minItems: 1
          description: 'Contains the updated Access types and Rat types filtering criteria for Member UE selection.

            '
        e2eTransTimeFilters:
          type: array
          items:
            $ref: '#/components/schemas/E2ETransTimeFilterCriteria'
          minItems: 1
          description: 'Contains the updated End-to-end data volume transfer time filtering criteria for Member UE selection.

            '
        ueLocFilters:
          type: array
          items:
            $ref: '#/components/schemas/UeLocFilterCriteria'
          minItems: 1
          description: 'Contains the updated UE location filtering criteria for Member UE selection.

            '
        ueHisLocFilters:
          type: array
          items:
            $ref: '#/components/schemas/UeHisLocFilterCriteria'
          minItems: 1
          description: 'Contains the updated UE historical location filtering criteria for Member UE selection.

            '
        ueDirFilters:
          type: array
          items:
            $ref: '#/components/schemas/UeDirectionFilterCriteria'
          minItems: 1
          description: 'Contains the updated UE direction filtering criteria for Member UE selection.

            '
        ueDistanceFilters:
          type: array
          items:
            $ref: '#/components/schemas/UeDistanceFilterCriteria'
          minItems: 1
          description: 'Contains the updated UE distance filtering criteria for Member UE selection.

            '
        serviceExpFilters:
          type: array
          items:
            $ref: '#/components/schemas/ServiceExpFilterCriteria'
          minItems: 1
          description: 'Contains the updated Service Experience filtering criteria for Member UE selection.

            '
        dnnFilters:
          type: array
          items:
            $ref: '#/components/schemas/DnnFilterCriteria'
          minItems: 1
          description: 'Contains the updated DNN filtering criteria for Member UE selection.

            '
        memUpdatePeriod:
          $ref: TS29571_CommonData.yaml#/components/schemas/DurationSecRm
        maxUeNum:
          $ref: TS29571_CommonData.yaml#/components/schemas/UintegerRm
        timeWin:
          $ref: TS29122_CommonData.yaml#/components/schemas/TimeWindow
    ServiceExpFilterCriteria:
      description: 'Represents the Service Experience filtering criteria for Member UE selection.

        '
      type: object
      properties:
        event:
          $ref: TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent
        dnn:
          $ref: TS29571_CommonData.yaml#/components/schemas/Dnn
        snssai:
          $ref: TS29571_CommonData.yaml#/components/schemas/Snssai
        appId:
          type: string
          description: Contains the Identifier(s) of the application.
        dnai:
          $ref: TS29571_CommonData.yaml#/components/schemas/Dnai
        loc:
          $ref: TS29122_CommonData.yaml#/components/schemas/LocationArea5G
        contribWeightThr:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uinteger
        expTypes:
          type: array
          items:
            $ref: TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/ServiceExperienceType
          minItems: 1
          description: Contains the Service Experience Types.
    UeLocFilterCriteria:
      description: 'Represents the UE location filtering criteria for Member UE selection.

        '
      type: object
      properties:
        event:
          $ref: TS29518_Namf_EventExposure.yaml#/components/schemas/AmfEventType
        loc:
          $ref: TS29122_CommonData.yaml#/components/schemas/LocationArea5G
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: '{tokenUrl}'
          scopes: {}
externalDocs:
  description: '3GPP TS 29.522 V19.5.0; 5G System; Network Exposure Function Northbound APIs.

    '
  url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/