openapi: 3.0.0 info: title: 3gpp-as-session-with-qos version: 1.4.1 description: | API for setting us an AS session with required QoS. © 2026, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: description: 3GPP TS 29.122 V19.6.0 T8 reference point for Northbound APIs url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' security: - {} - oAuth2ClientCredentials: [] servers: - url: '{apiRoot}/3gpp-as-session-with-qos/v1' variables: apiRoot: default: https://example.com description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122. paths: /{scsAsId}/subscriptions: get: summary: Read all or queried active subscriptions for the SCS/AS. operationId: FetchAllASSessionWithQoSSubscriptions tags: - AS Session with Required QoS Subscriptions parameters: - name: scsAsId in: path description: Identifier of the SCS/AS required: true schema: type: string - name: ip-addrs in: query description: The IP address(es) of the requested UE(s). required: false content: application/json: schema: type: array items: $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' minItems: 1 - name: ip-domain in: query description: > The IPv4 address domain identifier. The attribute may only be provided if IPv4 address is included in the ip-addrs query parameter. required: false schema: type: string - name: mac-addrs in: query description: The MAC address(es) of the requested UE(s). required: false schema: type: array items: $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' minItems: 1 - name: supp-feat in: query description: Contains the list of supported features. required: false schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' responses: '200': description: OK. content: application/json: schema: type: array items: $ref: '#/components/schemas/AsSessionWithQoSSubscription' '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' post: summary: Creates a new subscription resource. operationId: CreateASSessionWithQoSSubscription tags: - AS Session with Required QoS Subscriptions parameters: - name: scsAsId in: path description: Identifier of the SCS/AS required: true schema: type: string requestBody: description: Request to create a new subscription resource required: true content: application/json: schema: $ref: '#/components/schemas/AsSessionWithQoSSubscription' callbacks: notificationDestination: '{$request.body#/notificationDestination}': post: requestBody: # contents of the callback message required: true content: application/json: schema: $ref: '#/components/schemas/UserPlaneNotificationData' responses: '204': description: No Content (successful notification) '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' responses: '201': description: Created (Successful creation of subscription) content: application/json: schema: $ref: '#/components/schemas/AsSessionWithQoSSubscription' headers: Location: description: 'Contains the URI of the newly created resource' required: true schema: type: string '400': $ref: 'TS29122_CommonData.yaml#/components/responses/400' '401': $ref: 'TS29122_CommonData.yaml#/components/responses/401' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetailsAsSessionWithQos' headers: Retry-After: description: > Indicates the time the AF has to wait before making a new request. It can be a non-negative integer (decimal number) indicating the number of seconds the AF has to wait before making a new request or an HTTP-date after which the AF can retry a new request. schema: type: string '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' /{scsAsId}/subscriptions/{subscriptionId}: get: summary: Read an active subscriptions for the SCS/AS and the subscription Id. operationId: FetchIndASSessionWithQoSSubscription tags: - Individual AS Session with Required QoS 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/AsSessionWithQoSSubscription' '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: UpdateIndASSessionWithQoSSubscription tags: - Individual AS Session with Required QoS 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/AsSessionWithQoSSubscription' responses: '200': description: OK (Successful update of the subscription) content: application/json: schema: $ref: '#/components/schemas/AsSessionWithQoSSubscription' '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': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetailsAsSessionWithQos' headers: Retry-After: description: > Indicates the time the AF has to wait before making a new request. It can be a non-negative integer (decimal number) indicating the number of seconds the AF has to wait before making a new request or an HTTP-date after which the AF can retry a new request. schema: type: string '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: Updates/replaces an existing subscription resource. operationId: ModifyIndASSessionWithQoSSubscription tags: - Individual AS Session with Required QoS 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: required: true content: application/merge-patch+json: schema: $ref: '#/components/schemas/AsSessionWithQoSSubscriptionPatch' responses: '200': description: OK. The subscription was modified successfully. content: application/json: schema: $ref: '#/components/schemas/AsSessionWithQoSSubscription' '204': description: No Content. The subscription 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': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetailsAsSessionWithQos' headers: Retry-After: description: > Indicates the time the AF has to wait before making a new request. It can be a non-negative integer (decimal number) indicating the number of seconds the AF has to wait before making a new request or an HTTP-date after which the AF can retry a new request. schema: type: string '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 subscription. operationId: DeleteIndASSessionWithQoSSubscription tags: - Individual AS Session with Required QoS 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: $ref: '#/components/schemas/UserPlaneNotificationData' '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: securitySchemes: oAuth2ClientCredentials: type: oauth2 flows: clientCredentials: tokenUrl: '{tokenUrl}' scopes: {} schemas: AsSessionWithQoSSubscription: description: Represents an individual AS session with required QoS subscription resource. type: object properties: self: $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' supportedFeatures: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' dnn: $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' snssai: $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' notificationDestination: $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' exterAppId: type: string description: Identifies the external Application Identifier. extGroupId: $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId' gpsi: $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' flowInfo: type: array items: $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' minItems: 1 description: Describe the data flow which requires QoS. ethFlowInfo: type: array items: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' minItems: 1 description: Identifies Ethernet packet flows. enEthFlowInfo: type: array items: $ref: 'TS29122_CommonData.yaml#/components/schemas/EthFlowInfo' minItems: 1 description: > Identifies the Ethernet flows which require QoS. Each Ethernet flow consists of a flow idenifer and the corresponding UL and/or DL flows. listUeAddrs: type: array items: $ref: '#/components/schemas/UeAddInfo' minItems: 1 description: Identifies the list of UE address. multiModalId: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/MultiModalId' protoDescUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/ProtocolDescription' protoDescDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/ProtocolDescription' qosReference: type: string description: Identifies a pre-defined QoS information altQoSReferences: type: array items: type: string minItems: 1 description: > Identifies an ordered list of pre-defined QoS information. The lower the index of the array for a given entry, the higher the priority. altQosReqs: type: array items: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AlternativeServiceRequirementsData' minItems: 1 description: > Identifies an ordered list of alternative service requirements that include individual QoS parameter sets. The lower the index of the array for a given entry, the higher the priority. disUeNotif: description: > Indicates whether the QoS flow parameters signalling to the UE when the SMF is notified by the NG-RAN of changes in the fulfilled QoS situation is disabled (true) or not (false). Default value is false. The fulfilled situation is either the QoS profile or an Alternative QoS Profile. type: boolean ueIpv4Addr: $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr' ipDomain: type: string ueIpv6Addr: $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv6Addr' macAddr: $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' usageThreshold: $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' sponsorInfo: $ref: 'TS29122_CommonData.yaml#/components/schemas/SponsorInformation' qosMonInfo: $ref: '#/components/schemas/QosMonitoringInformation' pdvMon: $ref: '#/components/schemas/QosMonitoringInformation' qosDuration: $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' qosInactInt: $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' directNotifInd: type: boolean description: > Indicates whether the direct event notification is requested (true) or not (false) for the provided and/or previously provided QoS monitoring parameter(s). tscQosReq: $ref: '#/components/schemas/TscQosRequirement' l4sInd: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/UplinkDownlinkSupport' 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 or omitted otherwise. tempInValidity: $ref: 'TS29565_Ntsctsf_QoSandTSCAssistance.yaml#/components/schemas/TemporalInValidity' websockNotifConfig: $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' events: description: > Represents the list of user plane event(s) to which the SCS/AS requests to subscribe to. type: array items: $ref: '#/components/schemas/UserPlaneEvent' minItems: 1 multiModDatFlows: type: object additionalProperties: $ref: '#/components/schemas/AsSessionMediaComponent' minProperties: 1 description: > Contains media component data for a single-modal data flow(s). The key of the map is the medCompN attribute. pduSetQosDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosPara' pduSetQosUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosPara' rTLatencyInd: type: boolean description: > Indicates the service data flow needs to meet the Round-Trip (RT) latency requirement of the service, when it is included and set to "true". The default value is "false" if omitted. pdb: $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' periodUl: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/DurationMilliSec' periodDl: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/DurationMilliSec' qosMonDatRate: $ref: '#/components/schemas/QosMonitoringInformation' avrgWndw: $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindow' servAuthInfo: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ServAuthInfo' qosMonConReq: $ref: '#/components/schemas/QosMonitoringInformation' avlBitRateMon: $ref: '#/components/schemas/QosMonitoringInformation' qosMonCapRepoTypes: type: array items: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/NotifCapType' minItems: 1 description: > Contains the type(s) of QoS Monitoring capability report is applied. listUeConsDtRt: type: array items: $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' minItems: 1 description: > Identifies the list of UE addresses subject for Consolidated Data Rate monitoring. datBurstSizeInd: type: boolean description: > Indicates the Data Burst Size marking for the DL service data flow is supported, when it is included and set to "true". The default value is "false" if omitted. timetoNextBurstInd: type: boolean description: > Indicates the Time to Next Burst for the DL service data flow is supported, when it is included and set to "true". The default value is "false" if omitted. onPathN6SigInfo: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/OnPathN6SigInfo' expTranInd: type: boolean description: > Expedited Transfer Indication for the downlink traffic to enable expedited data transfer with reflective QoS for the Non-GBR service data flow. "true": the expedited data transfer of larger payload for XR application is enabled in the flow. "false": the expedited data transfer of larger payload for XR application is not enabled in the flow. The default value is "false" if omitted. ulBrRecInd: type: boolean description: > Indicates whether the RAN-Controlled UL Bitrate Recommendation for a media flow is supported or not. Set to "true" indicates that the RAN-controlled UL Bitrate Recommendation is supported. Set to "false" indicates that the RAN-controlled UL Bitrate Recommendation is not supported. The default value "false" is used if this attribute is omitted. required: - notificationDestination AsSessionWithQoSSubscriptionPatch: description: Represents parameters to modify an AS session with specific QoS subscription. type: object properties: exterAppId: type: string description: Identifies the external Application Identifier. flowInfo: type: array items: $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' minItems: 1 description: Describe the IP data flow which requires QoS. ethFlowInfo: type: array items: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' minItems: 1 description: Identifies Ethernet packet flows. enEthFlowInfo: type: array items: $ref: 'TS29122_CommonData.yaml#/components/schemas/EthFlowInfo' minItems: 1 description: > Identifies the Ethernet flows which require QoS. Each Ethernet flow consists of a flow idenifer and the corresponding UL and/or DL flows. listUeAddrs: type: array items: $ref: '#/components/schemas/UeAddInfo' minItems: 1 description: Identifies the list of UE address. qosReference: type: string description: Pre-defined QoS reference altQoSReferences: type: array items: type: string minItems: 1 description: > Identifies an ordered list of pre-defined QoS information. The lower the index of the array for a given entry, the higher the priority. altQosReqs: type: array items: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AlternativeServiceRequirementsData' minItems: 1 description: > Identifies an ordered list of alternative service requirements that include individual QoS parameter sets. The lower the index of the array for a given entry, the higher the priority. disUeNotif: type: boolean description: > Indicates whether the QoS flow parameters signalling to the UE when the SMF is notified by the NG-RAN of changes in the fulfilled QoS situation is disabled (true) or not (false). The fulfilled situation is either the QoS profile or an Alternative QoS Profile. usageThreshold: $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThresholdRm' qosMonInfo: $ref: '#/components/schemas/QosMonitoringInformationRm' pdvMon: $ref: '#/components/schemas/QosMonitoringInformationRm' directNotifInd: type: boolean description: > Indicates whether the direct event notification is requested (true) or not (false) for the provided QoS monitoring parameter(s). notificationDestination: $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' tscQosReq: $ref: '#/components/schemas/TscQosRequirementRm' l4sInd: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/UplinkDownlinkSupport' tempInValidity: $ref: 'TS29565_Ntsctsf_QoSandTSCAssistance.yaml#/components/schemas/TemporalInValidity' events: description: > Represents the updated list of user plane event(s) to which the SCS/AS requests to subscribe to. type: array items: $ref: '#/components/schemas/UserPlaneEvent' minItems: 1 multiModDatFlows: type: object additionalProperties: $ref: '#/components/schemas/AsSessionMediaComponentRm' minProperties: 1 description: > Contains media component data for a single-modal data flow(s). The key of the map is the medCompN attribute. pduSetQosDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosParaRm' pduSetQosUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosParaRm' rTLatencyInd: type: boolean nullable: true description: > Indicates the service data flow needs to meet the Round-Trip (RT) latency requirement of the service, when it is included and set to "true". pdb: $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudgetRm' protoDescUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/ProtocolDescriptionRm' protoDescDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/ProtocolDescriptionRm' periodUl: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/DurationMilliSecRm' periodDl: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/DurationMilliSecRm' qosDuration: $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSecRm' qosInactInt: $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSecRm' qosMonDatRate: $ref: '#/components/schemas/QosMonitoringInformationRm' avrgWndw: $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindowRm' qosMonConReq: $ref: '#/components/schemas/QosMonitoringInformationRm' avlBitRateMon: $ref: '#/components/schemas/QosMonitoringInformationRm' qosMonCapRepoTypes: type: array items: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/NotifCapType' minItems: 1 description: > Contains the type(s) of QoS Monitoring capability report is applied. listUeConsDtRt: type: array items: $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' minItems: 1 description: > Identifies the list of UE addresses subject for Consolidated Data Rate monitoring. datBurstSizeInd: type: boolean nullable: true description: > Indicates the Data Burst Size marking for the DL service data flow is supported, when it is included and set to "true". timetoNextBurstInd: type: boolean nullable: true description: > Indicates the Time to Next Burst for the DL service data flow is supported, when it is included and set to "true". onPathN6SigInfo: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/OnPathN6SigInfo' expTranInd: type: boolean nullable: true description: > Expedited Transfer Indication for the downlink traffic to enable expedited data transfer with reflective QoS for the Non-GBR service data flow. "true": the expedited data transfer of larger payload for XR application is enabled in the flow. "false": the expedited data transfer of larger payload for XR application is not enabled in the flow. ulBrRecInd: type: boolean nullable: true description: > Indicates whether the RAN-Controlled UL Bitrate Recommendation for a media flow is supported or not. Set to "true" indicates that the RAN-controlled UL Bitrate Recommendation is supported. Set to "false" indicates that the RAN-controlled UL Bitrate Recommendation is not supported. QosMonitoringInformation: description: Represents QoS monitoring information. type: object properties: reqQosMonParams: type: array items: $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RequestedQosMonitoringParameter' minItems: 1 repFreqs: type: array items: $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ReportingFrequency' minItems: 1 repThreshDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' repThreshUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' repThreshRp: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' conThreshDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' conThreshUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' waitTime: $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' repPeriod: $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' repThreshDatRateDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' repThreshDatRateUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' consDataRateThrDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' consDataRateThrUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' avlBitrateUlThrs: type: array items: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' minItems: 1 description: Indicates a list of thresholds for uplink available bitrate reporting. avlBitrateDlThrs: type: array items: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' minItems: 1 description: Indicates a list of thresholds for downlink available bitrate reporting. required: - reqQosMonParams - repFreqs QosMonitoringInformationRm: description: > Represents the same as the QosMonitoringInformation data type but with the nullable:true property. type: object properties: reqQosMonParams: type: array items: $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RequestedQosMonitoringParameter' minItems: 1 repFreqs: type: array items: $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ReportingFrequency' minItems: 1 repThreshDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm' repThreshUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm' repThreshRp: $ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm' conThreshDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm' conThreshUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm' waitTime: $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSecRm' repPeriod: $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSecRm' repThreshDatRateDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' repThreshDatRateUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' consDataRateThrDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' consDataRateThrUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' avlBitrateUlThrs: type: array items: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' minItems: 1 description: Indicates a list of thresholds for uplink available bitrate reporting. avlBitrateDlThrs: type: array items: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' minItems: 1 description: Indicates a list of thresholds for downlink available bitrate reporting. nullable: true QosMonitoringReport: description: Represents a QoS monitoring report. type: object properties: ulDelays: type: array items: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' minItems: 1 dlDelays: type: array items: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' minItems: 1 rtDelays: type: array items: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' minItems: 1 pdmf: type: boolean description: Represents the packet delay measurement failure indicator. ulDataRate: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' dlDataRate: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' ulAggrDataRate: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' dlAggrDataRate: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' ulConInfo: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' dlConInfo: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' UserPlaneNotificationData: description: Represents the parameters to be conveyed in a user plane event(s) notification. type: object properties: transaction: $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' eventReports: type: array items: $ref: '#/components/schemas/UserPlaneEventReport' minItems: 1 description: Contains the reported event and applicable information required: - transaction - eventReports UserPlaneEventReport: description: Represents an event report for user plane. type: object properties: event: $ref: '#/components/schemas/UserPlaneEvent' accumulatedUsage: $ref: 'TS29122_CommonData.yaml#/components/schemas/AccumulatedUsage' flowIds: type: array items: type: integer minItems: 1 description: > Identifies the affected flows that were sent during event subscription. It might be omitted when the reported event applies to all the flows sent during the subscription. multiModFlows: type: array items: $ref: '#/components/schemas/MultiModalFlows' minItems: 1 description: > Identifies the the flow filters for the single-modal data flows thatwere sent during event subscription. It may be omitted when the reported event applies to all the single-modal data flows sent during the subscription. appliedQosRef: type: string description: > The currently applied QoS reference. Applicable for event QOS_NOT_GUARANTEED or SUCCESSFUL_RESOURCES_ALLOCATION. altQosNotSuppInd: type: boolean description: > When present and set to true it indicates that the Alternative QoS profiles are not supported by the access network. Applicable for event QOS_NOT_GUARANTEED. plmnId: $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' qosMonReports: type: array items: $ref: '#/components/schemas/QosMonitoringReport' minItems: 1 description: Contains the QoS Monitoring Reporting information pdvMonReports: type: array items: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/PdvMonitoringReport' minItems: 1 description: Contains the PDV Monitoring Reporting information ratType: $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' batOffsetInfo: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/BatOffsetInfo' rttMonReports: type: array items: $ref: '#/components/schemas/QosMonitoringReport' minItems: 1 description: Contains the round trip delay over two SDFs reporting information qosMonDatRateReps: type: array items: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/QosMonitoringReport' minItems: 1 description: > Contains QoS Monitoring for data rate information. It shall be present when the notified event is "QOS_MONITORING" and data rate measurements are available. aggrDataRateRpts: type: array items: $ref: '#/components/schemas/QosMonitoringReport' minItems: 1 description: > Contains QoS Monitoring for aggregated data rate information. It shall be present when the notified event is "QOS_MONITORING" and data rate measurements are available. qosMonConInfoReps: type: array items: $ref: '#/components/schemas/QosMonitoringReport' minItems: 1 description: > Contains QoS Monitoring for congestion information. It shall be present when the notified event is "QOS_MONITORING" and congestion measurements are available. qosMonCapRepos: type: object additionalProperties: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/CapabilityReport' minProperties: 1 description: > QoS Monitoring notification can be performed or not. It shall be present when the notified event is "QOS_MON_CAP_REPO".The key of of the map is the attribute "capType". rateLimitRepo: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/RateLimitRepo' required: - event TscQosRequirement: description: Represents QoS requirements for time sensitive communication. type: object properties: reqGbrDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' reqGbrUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' reqMbrDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' reqMbrUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' maxTscBurstSize: $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVol' maxTscBurstSizeSmall: $ref: 'TS29571_CommonData.yaml#/components/schemas/MaxDataBurstVol' req5Gsdelay: $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' reqPer: $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate' priority: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscPriorityLevel' tscaiTimeDom: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' tscaiInputDl: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' tscaiInputUl: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' capBatAdaptation: type: boolean description: > Indicates the capability for AF to adjust the burst sending time, when it is supported and set to "true". The default value is "false" if omitted. not: required: [maxTscBurstSize, maxTscBurstSizeSmall] TscQosRequirementRm: description: > Represents the same as the TscQosRequirement data type but with the nullable:true property. type: object properties: reqGbrDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' reqGbrUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' reqMbrDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' reqMbrUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' maxTscBurstSize: $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVolRm' maxTscBurstSizeSmall: $ref: 'TS29571_CommonData.yaml#/components/schemas/MaxDataBurstVolRm' req5Gsdelay: $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudgetRm' reqPer: $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRateRm' priority: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscPriorityLevelRm' tscaiTimeDom: $ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm' tscaiInputDl: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' tscaiInputUl: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' capBatAdaptation: type: boolean description: > Indicates the capability for AF to adjust the burst sending time, when it is supported and set to "true". The default value is "false" if omitted. nullable: true not: required: [maxTscBurstSize, maxTscBurstSizeSmall] AdditionInfoAsSessionWithQos: description: Describes additional error information specific for this API. type: object properties: acceptableServInfo: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AcceptableServiceInfo' ProblemDetailsAsSessionWithQos: description: Extends ProblemDetails to also include the acceptable service info. allOf: - $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails' - $ref: '#/components/schemas/AdditionInfoAsSessionWithQos' AsSessionMediaComponent: description: > Representmedia component data for a single-modal data flow of a multi-modal service. type: object required: - medCompN allOf: - not: required: [altSerReqs,altSerReqsData] - not: required: [qosReference,altSerReqsData] properties: flowInfos: type: array items: $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' minItems: 1 nullable: true description: > Contains the IP data flow(s) description for a single-modal data flow. qosReference: type: string disUeNotif: type: boolean altSerReqs: type: array items: type: string minItems: 1 description: > Contains alternative service requirements that include QoS references set altSerReqsData: type: array items: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AlternativeServiceRequirementsData' minItems: 1 description: > Contains alternative service requirements that include individual QoS parameter sets. marBwDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' marBwUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' medCompN: type: integer medType: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/MediaType' mirBwDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' mirBwUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' rTLatencyInd: type: boolean description: > Indicates the service data flow needs to meet the Round-Trip (RT) latency requirement of the service, when it is included and set to "true". The default value is "false" if omitted. pdb: $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' rTLatencyIndCorreId: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/RttFlowReference' pduSetQosDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosPara' pduSetQosUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosPara' l4sInd: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/UplinkDownlinkSupport' protoDescDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/ProtocolDescription' protoDescUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/ProtocolDescription' periodUl: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/DurationMilliSec' periodDl: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/DurationMilliSec' evSubsc: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EventsSubscReqData' datBurstSizeInd: type: boolean description: > Indicates the Data Burst Size marking for the DL service data flow is supported, when it is included and set to "true". The default value is "false" if omitted. timetoNextBurstInd: type: boolean description: > Indicates the Time to Next Burst for the DL service data flow is supported, when it is included and set to "true". The default value is "false" if omitted. onPathN6SigInfo: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/OnPathN6SigInfo' expTranInd: type: boolean description: > Expedited Transfer Indication for the downlink traffic to enable expedited data transfer with reflective QoS for the Non-GBR service data flow. "true": the expedited data transfer of larger payload for XR application is enabled in the flow. "false": the expedited data transfer of larger payload for XR application is not enabled in the flow. The default value is "false" if omitted. ulBrRecInd: type: boolean description: > Indicates whether the RAN-Controlled UL Bitrate Recommendation for a media flow is supported or not. Set to "true" indicates that the RAN-controlled UL Bitrate Recommendation is supported. Set to "false" indicates that the RAN-controlled UL Bitrate Recommendation is not supported. The default value "false" is used if this attribute is omitted. AsSessionMediaComponentRm: description: > Represents the AsSessionMediaComponent data type with nullable information. type: object required: - medCompN allOf: - not: required: [altSerReqs,altSerReqsData] - not: required: [qosReference,altSerReqsData] properties: flowInfos: type: array items: $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' minItems: 1 nullable: true description: > Contains the IP data flow(s) description for a single-modal data flow. qosReference: type: string nullable: true altSerReqs: type: array items: type: string minItems: 1 description: > Contains removable alternative service requirements that include set of QoS references nullable: true altSerReqsData: type: array items: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AlternativeServiceRequirementsData' minItems: 1 description: > Contains removable alternative service requirements that include individual QoS parameter sets. nullable: true disUeNotif: type: boolean nullable: true marBwDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' marBwUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' medCompN: type: integer medType: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/MediaType' mirBwDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' mirBwUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' rTLatencyInd: type: boolean nullable: true description: > Indicates the service data flow needs to meet the Round-Trip (RT) latency requirement of the service, when it is included and set to "true". pdb: $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudgetRm' rTLatencyIndCorreId: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/RttFlowReferenceRm' pduSetQosDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosParaRm' pduSetQosUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosParaRm' l4sInd: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/UplinkDownlinkSupport' protoDescDl: $ref: 'TS29571_CommonData.yaml#/components/schemas/ProtocolDescriptionRm' protoDescUl: $ref: 'TS29571_CommonData.yaml#/components/schemas/ProtocolDescriptionRm' periodUl: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/DurationMilliSecRm' periodDl: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/DurationMilliSecRm' evSubsc: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EventsSubscReqDataRm' datBurstSizeInd: type: boolean nullable: true description: > Indicates the Data Burst Size marking for the DL service data flow is supported, when it is included and set to "true". timetoNextBurstInd: type: boolean nullable: true description: > Indicates the Time to Next Burst for the DL service data flow is supported, when it is included and set to "true". onPathN6SigInfo: $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/OnPathN6SigInfo' expTranInd: type: boolean nullable: true description: > Expedited Transfer Indication for the downlink traffic to enable expedited data transfer with reflective QoS for the Non-GBR service data flow. "true": the expedited data transfer of larger payload for XR application is enabled in the flow. "false": the expedited data transfer of larger payload for XR application is not enabled in the flow. ulBrRecInd: type: boolean nullable: true description: > Indicates whether the RAN-Controlled UL Bitrate Recommendation for a media flow is supported or not. Set to "true" indicates that the RAN-controlled UL Bitrate Recommendation is supported. Set to "false" indicates that the RAN-controlled UL Bitrate Recommendation is not supported. nullable: true MultiModalFlows: description: Represents a flow information within a single-modal data flow. type: object properties: medCompN: type: integer description: > It contains the ordinal number of the single-modal data flow. Identifies the single-modal data flow. flowIds: type: array items: type: integer minItems: 1 description: > Identifies the affected flow(s) within the single-modal data flow (identified by the medCompN attribute). It may be omitted when all flows are affected. required: - medCompN UeAddInfo: description: Represent the UE address information. properties: ueIpAddr: $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' portNumber: $ref: 'TS29122_CommonData.yaml#/components/schemas/Port' UserPlaneEvent: anyOf: - type: string enum: - SESSION_TERMINATION - LOSS_OF_BEARER - RECOVERY_OF_BEARER - RELEASE_OF_BEARER - USAGE_REPORT - FAILED_RESOURCES_ALLOCATION - QOS_GUARANTEED - QOS_NOT_GUARANTEED - QOS_NOT_GUARANTEED_DL - QOS_NOT_GUARANTEED_UL - QOS_MONITORING - SUCCESSFUL_RESOURCES_ALLOCATION - ACCESS_TYPE_CHANGE - PLMN_CHG - L4S_NOT_AVAILABLE - L4S_AVAILABLE - BAT_OFFSET_INFO - RT_DELAY_TWO_QOS_FLOWS - PACK_DELAY_VAR - QOS_MON_CAP_REPO - RATE_LIMIT_INFO_REPO - 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 user plane event. Possible values are: - SESSION_TERMINATION: Indicates that Rx session is terminated. - LOSS_OF_BEARER : Indicates a loss of a bearer. - RECOVERY_OF_BEARER: Indicates a recovery of a bearer. - RELEASE_OF_BEARER: Indicates a release of a bearer. - USAGE_REPORT: Indicates the usage report event. - FAILED_RESOURCES_ALLOCATION: Indicates the resource allocation is failed. - QOS_GUARANTEED: The QoS targets of one or more SDFs are guaranteed again. - QOS_NOT_GUARANTEED: The QoS targets of one or more SDFs are not being guaranteed. - QOS_NOT_GUARANTEED_DL: The QoS targets of one or more SDFs are not being guaranteed in DL direction. - QOS_NOT_GUARANTEED_UL: The QoS targets of one or more SDFs are not being guaranteed in UL direction. - QOS_MONITORING: Indicates a QoS monitoring event. - SUCCESSFUL_RESOURCES_ALLOCATION: Indicates the resource allocation is successful. - ACCESS_TYPE_CHANGE: Indicates an Access type change. - PLMN_CHG: Indicates a PLMN change. - L4S_NOT_AVAILABLE: The ECN marking for L4S of one or more SDFs is not available. - L4S_AVAILABLE: The ECN marking for L4S of one or more SDFs is available again. - BAT_OFFSET_INFO: Indicates the network provided BAT offset and the optionally adjusted periodicity. - RT_DELAY_TWO_QOS_FLOWS: Indicates round-trip delay on UL and DL flows over two QoS flows. - PACK_DELAY_VAR: Indicates Packet Delay Variation is enabled for the SDF. - QOS_MON_CAP_REPO: Indicates whether the QoS Monitoring can be performed or not. - RATE_LIMIT_INFO_REPO: Indicates whether support of reporting rate limitation information.