3GPP Events Subscription (Document) API

openapi: 3.2.0
info:
  title: Npcf_PolicyAuthorization Service Events Subscription (Document) API
  version: 1.1.5
  description: 'PCF Policy Authorization Service.

    © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

    All rights reserved.

    '
servers:
- url: '{apiRoot}/npcf-policyauthorization/v1'
  variables:
    apiRoot:
      default: https://example.com
      description: apiRoot as defined in subclause 4.4 of 3GPP TS 29.501
security:
- {}
- oAuth2ClientCredentials:
  - npcf-policyauthorization
tags:
- name: Events Subscription (Document)
paths:
  /app-sessions/{appSessionId}/events-subscription:
    put:
      summary: creates or modifies an Events Subscription subresource
      operationId: updateEventsSubsc
      tags:
      - Events Subscription (Document)
      parameters:
      - name: appSessionId
        description: string identifying the Events Subscription resource
        in: path
        required: true
        schema:
          type: string
      requestBody:
        description: Creation or modification of an Events Subscription resource.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventsSubscReqData'
      responses:
        '201':
          description: The creation of the Events Subscription resource is confirmed and its representation is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventsSubscPutData'
          headers:
            Location:
              description: 'Contains the URI of the created Events Subscription resource, according to the structure: {apiRoot}/npcf-policyauthorization/v1/app-sessions/{appSessionId}/events-subscription}'
              required: true
              schema:
                type: string
        '200':
          description: The modification of the Events Subscription resource is confirmed its representation is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventsSubscPutData'
        '204':
          description: The modification of the Events Subscription subresource is confirmed without returning additional data.
        '307':
          $ref: TS29571_CommonData.yaml#/components/responses/307
        '308':
          $ref: TS29571_CommonData.yaml#/components/responses/308
        '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
      callbacks:
        eventNotification:
          '{$request.body#/notifUri}/notify':
            post:
              requestBody:
                description: Contains the information for the notification of an event occurrence in the PCF.
                required: true
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/EventsNotification'
              responses:
                '204':
                  description: The receipt of the notification is acknowledged.
                '307':
                  $ref: TS29571_CommonData.yaml#/components/responses/307
                '308':
                  $ref: TS29571_CommonData.yaml#/components/responses/308
                '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
    delete:
      summary: deletes the Events Subscription subresource
      operationId: DeleteEventsSubsc
      tags:
      - Events Subscription (Document)
      parameters:
      - name: appSessionId
        description: string identifying the Individual Application Session Context resource
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The deletion of the of the Events Subscription sub-resource is confirmed without returning additional data.
        '307':
          $ref: TS29571_CommonData.yaml#/components/responses/307
        '308':
          $ref: TS29571_CommonData.yaml#/components/responses/308
        '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
        '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:
    AfNotifMethod:
      anyOf:
      - type: string
        enum:
        - EVENT_DETECTION
        - ONE_TIME
        - PERIODIC
        - PDU_SESSION_RELEASE
      - type: string
    QosNotifType:
      anyOf:
      - type: string
        enum:
        - GUARANTEED
        - NOT_GUARANTEED
      - type: string
    AfEvent:
      anyOf:
      - type: string
        enum:
        - ACCESS_TYPE_CHANGE
        - ANI_REPORT
        - CHARGING_CORRELATION
        - EPS_FALLBACK
        - FAILED_RESOURCES_ALLOCATION
        - OUT_OF_CREDIT
        - PLMN_CHG
        - QOS_MONITORING
        - QOS_NOTIF
        - RAN_NAS_CAUSE
        - REALLOCATION_OF_CREDIT
        - SUCCESSFUL_RESOURCES_ALLOCATION
        - TSN_BRIDGE_INFO
        - USAGE_REPORT
      - type: string
    QosNotificationControlInfo:
      description: Indicates whether the QoS targets for a GRB flow are not guaranteed or guaranteed again
      type: object
      required:
      - notifType
      properties:
        notifType:
          $ref: '#/components/schemas/QosNotifType'
        flows:
          type: array
          items:
            $ref: '#/components/schemas/Flows'
          minItems: 1
        altSerReq:
          type: string
    Flows:
      description: Identifies the flows
      type: object
      required:
      - medCompN
      properties:
        contVers:
          type: array
          items:
            $ref: '#/components/schemas/ContentVersion'
          minItems: 1
        fNums:
          type: array
          items:
            type: integer
          minItems: 1
        medCompN:
          type: integer
    AccessNetChargingIdentifier:
      description: Describes the access network charging identifier.
      type: object
      required:
      - accNetChaIdValue
      properties:
        accNetChaIdValue:
          $ref: TS29571_CommonData.yaml#/components/schemas/ChargingId
        flows:
          type: array
          items:
            $ref: '#/components/schemas/Flows'
          minItems: 1
    AfEventSubscription:
      description: describes the event information delivered in the subscription
      type: object
      required:
      - event
      properties:
        event:
          $ref: '#/components/schemas/AfEvent'
        notifMethod:
          $ref: '#/components/schemas/AfNotifMethod'
        repPeriod:
          $ref: TS29571_CommonData.yaml#/components/schemas/DurationSec
        waitTime:
          $ref: TS29571_CommonData.yaml#/components/schemas/DurationSec
    EventsNotification:
      description: describes the notification of a matched event
      type: object
      required:
      - evSubsUri
      - evNotifs
      properties:
        accessType:
          $ref: TS29571_CommonData.yaml#/components/schemas/AccessType
        addAccessInfo:
          $ref: TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AdditionalAccessInfo
        relAccessInfo:
          $ref: TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AdditionalAccessInfo
        anChargAddr:
          $ref: TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AccNetChargingAddress
        anChargIds:
          type: array
          items:
            $ref: '#/components/schemas/AccessNetChargingIdentifier'
          minItems: 1
        anGwAddr:
          $ref: '#/components/schemas/AnGwAddress'
        evSubsUri:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uri
        evNotifs:
          type: array
          items:
            $ref: '#/components/schemas/AfEventNotification'
          minItems: 1
        failedResourcAllocReports:
          type: array
          items:
            $ref: '#/components/schemas/ResourcesAllocationInfo'
          minItems: 1
        succResourcAllocReports:
          type: array
          items:
            $ref: '#/components/schemas/ResourcesAllocationInfo'
          minItems: 1
        noNetLocSupp:
          $ref: TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/NetLocAccessSupport
        outOfCredReports:
          type: array
          items:
            $ref: '#/components/schemas/OutOfCreditInformation'
          minItems: 1
        plmnId:
          $ref: TS29571_CommonData.yaml#/components/schemas/PlmnIdNid
        qncReports:
          type: array
          items:
            $ref: '#/components/schemas/QosNotificationControlInfo'
          minItems: 1
        qosMonReports:
          type: array
          items:
            $ref: '#/components/schemas/QosMonitoringReport'
          minItems: 1
        ranNasRelCauses:
          type: array
          items:
            $ref: TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RanNasRelCause
          minItems: 1
          description: Contains the RAN and/or NAS release cause.
        ratType:
          $ref: TS29571_CommonData.yaml#/components/schemas/RatType
        ueLoc:
          $ref: TS29571_CommonData.yaml#/components/schemas/UserLocation
        ueLocTime:
          $ref: TS29571_CommonData.yaml#/components/schemas/DateTime
        ueTimeZone:
          $ref: TS29571_CommonData.yaml#/components/schemas/TimeZone
        tsnBridgeManCont:
          $ref: TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/BridgeManagementContainer
        tsnPortManContDstt:
          $ref: TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer
        tsnPortManContNwtts:
          type: array
          items:
            $ref: TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer
          minItems: 1
    AnGwAddress:
      description: describes the address of the access network gateway control node
      type: object
      anyOf:
      - required:
        - anGwIpv4Addr
      - required:
        - anGwIpv6Addr
      properties:
        anGwIpv4Addr:
          $ref: TS29571_CommonData.yaml#/components/schemas/Ipv4Addr
        anGwIpv6Addr:
          $ref: TS29571_CommonData.yaml#/components/schemas/Ipv6Addr
    RequiredAccessInfo:
      anyOf:
      - type: string
        enum:
        - USER_LOCATION
        - UE_TIME_ZONE
      - type: string
    EventsSubscReqData:
      description: Identifies the events the application subscribes to.
      type: object
      required:
      - events
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/AfEventSubscription'
          minItems: 1
        notifUri:
          $ref: TS29571_CommonData.yaml#/components/schemas/Uri
        reqQosMonParams:
          type: array
          items:
            $ref: TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RequestedQosMonitoringParameter
          minItems: 1
        qosMon:
          $ref: '#/components/schemas/QosMonitoringInformation'
        reqAnis:
          type: array
          items:
            $ref: '#/components/schemas/RequiredAccessInfo'
          minItems: 1
        notifCorreId:
          type: string
    QosMonitoringInformation:
      description: Indicates the QoS Monitoring information to report, i.e. UL and/or DL and or round trip delay.
      type: object
      properties:
        repThreshDl:
          type: integer
        repThreshUl:
          type: integer
        repThreshRp:
          type: integer
    ContentVersion:
      description: Represents the content version of some content.
      type: integer
    EventsSubscPutData:
      description: Identifies the events the application subscribes to within an Events Subscription sub-resource data. It may contain the notification of the already met events
      anyOf:
      - $ref: '#/components/schemas/EventsSubscReqData'
      - $ref: '#/components/schemas/EventsNotification'
    ResourcesAllocationInfo:
      description: describes the status of the PCC rule(s) related to certain media components.
      type: object
      properties:
        mcResourcStatus:
          $ref: '#/components/schemas/MediaComponentResourcesStatus'
        flows:
          type: array
          items:
            $ref: '#/components/schemas/Flows'
          minItems: 1
        altSerReq:
          type: string
    OutOfCreditInformation:
      description: Indicates the SDFs without available credit and the corresponding termination action.
      type: object
      required:
      - finUnitAct
      properties:
        flows:
          type: array
          items:
            $ref: '#/components/schemas/Flows'
          minItems: 1
    MediaComponentResourcesStatus:
      anyOf:
      - type: string
        enum:
        - ACTIVE
        - INACTIVE
      - type: string
    QosMonitoringReport:
      description: QoS Monitoring reporting information
      type: object
      properties:
        flows:
          type: array
          items:
            $ref: '#/components/schemas/Flows'
          minItems: 1
        ulDelays:
          type: array
          items:
            type: integer
          minItems: 1
        dlDelays:
          type: array
          items:
            type: integer
          minItems: 1
        rtDelays:
          type: array
          items:
            type: integer
          minItems: 1
    AfEventNotification:
      description: describes the event information delivered in the notification
      type: object
      required:
      - event
      properties:
        event:
          $ref: '#/components/schemas/AfEvent'
        flows:
          type: array
          items:
            $ref: '#/components/schemas/Flows'
          minItems: 1
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: '{nrfApiRoot}/oauth2/token'
          scopes:
            npcf-policyauthorization: Access to the Npcf_PolicyAuthorization API
externalDocs:
  description: 3GPP TS 29.514 V16.10.0; 5G System; Policy Authorization Service;Stage 3.
  url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.514/