Tech-invite  3GPPspecs  RELs  Glossaries  SIP
21  22  23  24  25  26  27  28  29  31  32  33  34  35  36  37  38  4‑5x
Top   in Index   Prev   Next

TS 29.522  CT3 ★
5GS — Network Exposure Function Northbound APIs

3GPP‑Page   ETSI‑search   full‑ToC
use "3GPP‑Page" to get the Word version
use "ETSI‑search" to get the PDF version
for a better overview, the Table of Contents (ToC) is reproduced
V16.2.0 (Wzip)  2019/12  106 p.
V15.5.0 (PDF)  2019/12  37 p.
WI Acronym:  5GS_Ph1-CT
Rapporteur:  Dr. Yan, Yali  Huawei Technologies Co. Ltd.
The present document describes the protocol for the NEF Northbound interface between the NEF and the AF.
Symbolic representation of 5GS Nnef services

full Table of Contents for  TS 29.522  Word version:   16.2.0

Here   Top
1 Scope  2 References  3 Definitions and abbreviations  4 NEF Northbound Interface  5 NEF Northbound APIs  6 Security  7 Using Common API Framework  A [N] OpenAPI representation for NEF Northbound APIs  B Change history 

 

1  Scope  Word-p. 9
2  References
3  Definitions and abbreviations  Word-p. 10
3.1  Definitions
3.2  Abbreviations
4  NEF Northbound Interface  Word-p. 11
4.1  Overview
4.2  Reference model  Word-p. 12
4.3  Functional elements
4.3.1  NEF
4.3.2  AF  Word-p. 13
4.4  Procedures over NEF Northbound Interface
4.4.1  Introduction
4.4.2  Procedures for Monitoring
4.4.3  Procedures for Device Triggering  Word-p. 14
4.4.4  Procedures for resource management of Background Data Transfer
4.4.5  Procedures for CP Parameters Provisioning  Word-p. 15
4.4.6  Procedures for PFD Management
4.4.7  Procedures for Traffic Influence
4.4.7.1  General
4.4.7.2  AF request identified by UE address  Word-p. 16
4.4.7.3  AF request not identified by UE address
4.4.7.4  Handling of UP path management event notification [R16]  Word-p. 17
4.4.8  Procedures for changing the chargeable party at session set up or during the session
4.4.9  Procedures for setting up an AF session with required QoS
4.4.10  Procedures for MSISDN-less Mobile Originated SMS [R16]  Word-p. 18
4.4.11  Procedures for Network Configuration Parameters Provisioning [R16]
4.4.12  Procedures for Non-IP data delivery [R16]
4.4.12.1  General
4.4.12.2  NIDD configuration Triggered by the NEF
4.4.12.3  NIDD configuration triggered by the AF and NIDD delivery  Up
4.4.13  Procedures for RACS Parameter Provisioning [R16]  Word-p. 19
4.4.14  Procedures for analytics information exposure [R16]
4.4.14.1  Subscription/unsubscription to notification of analytics information
4.4.14.2  Fetch analytics information  Word-p. 20
4.4.15  Procedures for 5G LAN Parameter Provisioning [R16]  Word-p. 21
4.4.15.1  General
4.4.15.2  Creation of a new subscription for 5G LAN parameter provisioning
4.4.15.3  Modification of an existing subscription for 5G LAN parameter provisioning
4.4.15.4  Deletion of an existing subscription for 5G LAN parameter provisioning
4.4.16  Procedures for applying BDT policy [R16]  Up
4.4.17  Procedures for Enhanced Coverage Restriction Control [R16]  Word-p. 22
4.4.18  Procedures for IPTV Configuration [R16]
5  NEF Northbound APIs  Word-p. 23
5.1  Introduction
5.2  Information applicable to several APIs
5.3  Reused APIs
5.4  TrafficInfluence API  Word-p. 24
5.4.1  Resources
5.4.1.1  Overview
5.4.1.2  Resource: Traffic Influence Subscription  Word-p. 25
5.4.1.2.1  Introduction
5.4.1.2.2  Resource Definition
5.4.1.2.3  Resource Methods
5.4.1.2.3.1  General
5.4.1.2.3.2  GET
5.4.1.2.3.3  POST  Word-p. 26
5.4.1.3  Resource: Individual Traffic Influence Subscription
5.4.1.3.1  Introduction
5.4.1.3.2  Resource Definition
5.4.1.3.3  Resource Methods  Word-p. 27
5.4.1.3.3.1  General
5.4.1.3.3.2  GET
5.4.1.3.3.3  PUT
5.4.1.3.3.4  PATCH  Word-p. 28
5.4.1.3.3.5  DELETE
5.4.2  Notifications  Word-p. 29
5.4.2.1  Introduction
5.4.2.2  Event Notification
5.4.2.2.1  Description [R16]
5.4.2.2.2  Target URI [R16]  Up
5.4.2.2.3  Operation Definition [R16]
5.4.2.2.3.1  Notification via HTTP POST
5.4.2.2.3.2  Notification via Websocket  Word-p. 30
5.4.2.3  Acknowledgement of event notification
5.4.2.3.1  Description
5.4.2.3.2  Target URI
5.4.2.3.3  Operation Definition [R16]
5.4.2.3.3.1  Notification via HTTP POST
5.4.3  Data Model
5.4.3.1  General  Up
5.4.3.2  Reused data types
5.4.3.3  Structured data types  Word-p. 31
5.4.3.3.1  Introduction
5.4.3.3.2  Type: TrafficInfluSub
5.4.3.3.3  Type: TrafficInfluSubPatch  Word-p. 33
5.4.3.3.4  Type: EventNotification  Word-p. 35
5.4.3.3.5  Type: AfResultInfo [R16]  Word-p. 36
5.4.3.3.6  Type AfAckInfo [R16]
5.4.3.4  Simple data types and enumerations
5.4.3.4.1  Introduction  Up
5.4.3.4.2  Simple data types
5.4.3.4.3  Enumeration: SubscribedEvent
5.4.3.4.4  Enumeration: AfResultStatus [R16]
5.4.4  Used Features  Word-p. 37
5.5  NiddConfigurationTrigger API [R16]
5.5.1  Resources
5.5.2  Notifications
5.5.2.1  Introduction
5.5.2.2  Event Notification
5.5.2.3  Operation Definition  Word-p. 38
5.5.2.3.1  Notification via HTTP POST
5.5.2.3.2  Notification via Websocket
5.5.3  Data Model
5.5.3.1  General
5.5.3.2  Reused data types
5.5.3.3  Structured data types
5.5.3.3.1  Introduction
5.5.3.3.2  Type: NiddConfigTrigger
5.5.3.3.3  Type: NiddConfigTriggerReply  Word-p. 39
5.5.3.4  Simple data types and enumerations  Up
5.5.3.4.1  Introduction
5.5.3.4.2  Simple data types
5.5.4  Used Features
5.6  AnalyticsExposure API [R16]  Word-p. 40
5.6.1  Resources
5.6.1.1  Overview
5.6.1.2  Resource: Analytics Exposure Subscriptions
5.6.1.2.1  Introduction
5.6.1.2.2  Resource Definition
5.6.1.2.3  Resource Methods  Word-p. 41
5.6.1.2.3.1  General
5.6.1.2.3.2  GET
5.6.1.2.3.3  POST
5.6.1.3  Resource: Individual Analytics Exposure Subscription  Word-p. 42
5.6.1.3.1  Introduction
5.6.1.3.2  Resource Definition
5.6.1.3.3  Resource Methods
5.6.1.3.3.1  General
5.6.1.3.3.2  GET
5.6.1.3.3.3  PUT  Word-p. 43
5.6.1.3.3.4  DELETE
5.6.1a  Custom Operations without associated resources  Word-p. 44
5.6.1a.1  Overview
5.6.1a.2  Operation: fetch
5.6.1a.2.1  Description
5.6.1a.2.2  Operation Definition
5.6.2  Notifications
5.6.2.1  Introduction
5.6.2.2  Event Notification  Word-p. 45
5.6.2.3  Operation Definition  Up
5.6.2.3.1  Notification via HTTP POST
5.6.2.3.2  Notification via Websocket
5.6.3  Data Model
5.6.3.1  General
5.6.3.2  Reused data types
5.6.3.3  Structured data types  Word-p. 46
5.6.3.3.1  Introduction
5.6.3.3.2  Type: AnalyticsExposureSubsc
5.6.3.3.3  Type: AnalyticsEventNotification  Word-p. 47
5.6.3.3.4  Type: AnalyticsEventNotif  Up
5.6.3.3.5  Type: AnalyticsEventSubsc
5.6.3.3.6  Type: AnalyticsEventFilterSubsc  Word-p. 48
5.6.3.3.7  Type TargetUeId
5.6.3.3.8  Type UeMobilityExposure
5.6.3.3.9  Type UeTrajectoryInfo  Word-p. 49
5.6.3.3.10  Type UeLocationInfo
5.6.3.3.11  Type UeCommunicationExposure
5.6.3.3.12  Type: AnalyticsRequest  Word-p. 50
5.6.3.3.13  Type AnalyticsEventFilter
5.6.3.3.14  Type AnalyticsData  Up
5.6.3.4  Simple data types and enumerations
5.6.3.4.1  Introduction
5.6.3.4.2  Simple data types  Word-p. 51
5.6.3.4.3  Enumeration: AnalyticsEvent
5.6.4  Used Features
5.7  5GLANParameterProvision API [R16]
5.7.1  Resources
5.7.1.1  Overview
5.7.1.2  Resource: 5GLAN Parameters Provision Subscriptions  Word-p. 52
5.7.1.2.1  Introduction  Up
5.7.1.2.2  Resource Definition
5.7.1.2.3  Resource Methods
5.7.1.2.3.1  General
5.7.1.2.3.2  GET  Word-p. 53
5.7.1.2.3.3  POST
5.7.1.3  Resource: Individual 5GLAN Parameters Provision Subscription  Word-p. 54
5.7.1.3.1  Introduction
5.7.1.3.2  Resource Definition
5.7.1.3.3  Resource Methods
5.7.1.3.3.1  General  Up
5.7.1.3.3.2  GET
5.7.1.3.3.3  PUT  Word-p. 55
5.7.1.3.3.4  DELETE
5.7.1.3.3.5  PATCH  Word-p. 56
5.7.2  Data Model
5.7.2.1  General
5.7.2.2  Reused data types
5.7.2.3  Structured data types
5.7.2.3.1  Introduction
5.7.2.3.2  Type: 5GLanParametersProvision  Word-p. 57
5.7.2.3.3  Type: 5GLanParameters
5.7.2.3.4  Type: AppDescriptor
5.7.2.3.5  Type: 5GLanParametersProvisionPatch
5.7.2.3.6  Type: 5GLanParametersPatch  Word-p. 58
5.7.2.4  Simple data types and enumerations
5.7.2.4.1  Introduction
5.7.2.4.2  Simple data types
5.7.3  Used Features
5.8  ApplyingBdtPolicy API [R16]
5.8.1  Resources  Up
5.8.1.1  Overview
5.8.1.2  Resource: Applied BDT Policy Subscription  Word-p. 59
5.8.1.2.1  Introduction
5.8.1.2.2  Resource Definition
5.8.1.2.3  Resource Methods
5.8.1.2.3.1  General
5.8.1.2.3.2  GET  Word-p. 60
5.8.1.2.3.3  POST
5.8.1.3  Resource: Individual Applied BDT Policy Subscription
5.8.1.3.1  Introduction  Up
5.8.1.3.2  Resource Definition  Word-p. 61
5.8.1.3.3  Resource Methods
5.8.1.3.3.1  General
5.8.1.3.3.2  GET
5.8.1.3.3.3  PATCH
5.8.1.3.3.4  DELETE  Word-p. 62
5.8.2  Notifications
5.8.3  Data Model
5.8.3.1  General
5.8.3.2  Reused data types  Up
5.8.3.3  Structured data types  Word-p. 63
5.8.3.3.1  Introduction
5.8.3.3.2  Type: AppliedBdtPolicy
5.8.3.3.3  Type: AppliedBdtPolicyPatch
5.8.3.4  Simple data types and enumerations
5.8.3.4.1  Introduction
5.8.3.4.2  Simple data types  Word-p. 64
5.8.4  Used Features
5.9  IPTVConfiguration API [R16]
5.9.1  Resources  Up
5.9.1.1  Overview
5.9.1.2  Resource: IPTV Configurations  Word-p. 65
5.9.1.2.1  Introduction
5.9.1.2.2  Resource Definition
5.9.1.2.3  Resource Methods
5.9.1.2.3.1  General
5.9.1.2.3.2  GET
5.9.1.2.3.3  POST  Word-p. 66
5.9.1.3  Resource: Individual IPTV Configuration
5.9.1.3.1  Introduction  Up
5.9.1.3.2  Resource Definition
5.9.1.3.3  Resource Methods  Word-p. 67
5.9.1.3.3.1  General
5.9.1.3.3.2  GET
5.9.1.3.3.3  PUT
5.9.1.3.3.4  DELETE  Word-p. 68
5.9.1.3.3.5  PATCH
5.9.2  Data Model  Word-p. 69
5.9.2.1  General
5.9.2.2  Reused data types  Up
5.9.2.3  Structured data types
5.9.2.3.1  Introduction
5.9.2.3.2  Type: IptvConfigData  Word-p. 70
5.9.2.3.3  Type: MulticastAccessControl
5.9.2.3.4  Type: IptvConfigDataPatch
5.9.2.4  Simple data types and enumerations
5.9.2.4.1  Introduction
5.9.2.4.2  Simple data types  Word-p. 71
5.9.2.4.3  Enumeration: AccessRightStatus
5.9.3  Used Features  Up
6  Security
7  Using Common API Framework
7.1  General
7.2  Security  Word-p. 72
A (Normative)  OpenAPI representation for NEF Northbound APIs  Word-p. 73
A.1  General
A.2  TrafficInfluence API
A.3  NiddConfigurationTrigger API [R16]  Word-p. 80
A.4  AnalyticsExposure API [R16]  Word-p. 82
A.5  5GLANParameterProvision API [R16]  Word-p. 89
A.6  ApplyingBdtPolicy API [R16]  Word-p. 94
A.7  IPTVConfiguration API [R16]  Word-p. 97
B  Change history  Word-p. 103

Up   Top