Content for TS 29.510 Word version: 17.4.0
6 API Definitions
6.1 Nnrf_NFManagement Service API
6.2 Nnrf_NFDiscovery Service API
6.3 Nnrf_AccessToken Service API
6.4 Nnrf_Bootstrapping Service API
6 API Definitions Word‑p. 45
6.1 Nnrf_NFManagement Service API Word‑p. 45
6.1.1 API URI Word‑p. 45
6.1.2 Usage of HTTP Word‑p. 46
6.1.2.1 General Word‑p. 46
6.1.2.2 HTTP standard headers Word‑p. 46
6.1.2.2.1 General Word‑p. 46
6.1.2.2.2 Content type Word‑p. 46
6.1.2.2.3 Accept-Encoding Word‑p. 46
6.1.2.2.4 ETag |R16| Word‑p. 46
6.1.2.2.5 If-Match |R16| Word‑p. 46
6.1.2.3 HTTP custom headers Word‑p. 47
6.1.2.3.1 General Word‑p. 47
6.1.3 Resources Word‑p. 47
6.1.3.1 Overview Word‑p. 47
6.1.3.2 Resource: nf-instances (Store) Word‑p. 48
6.1.3.2.1 Description Word‑p. 48
6.1.3.2.2 Resource Definition Word‑p. 48
6.1.3.2.3 Resource Standard Methods Word‑p. 49
6.1.3.2.3.1 GET Word‑p. 49
6.1.3.2.3.2 OPTIONS Word‑p. 51
6.1.3.2.4 Resource Custom Operations Word‑p. 52
6.1.3.3 Resource: nf-instance (Document) Word‑p. 52
6.1.3.3.1 Description Word‑p. 52
6.1.3.3.2 Resource Definition Word‑p. 52
6.1.3.3.3 Resource Standard Methods Word‑p. 53
6.1.3.3.3.1 GET Word‑p. 53
6.1.3.3.3.2 PUT Word‑p. 54
6.1.3.3.3.3 PATCH Word‑p. 56
6.1.3.3.3.4 DELETE Word‑p. 58
6.1.3.4 Resource: subscriptions (Collection) Word‑p. 59
6.1.3.4.1 Description Word‑p. 59
6.1.3.4.2 Resource Definition Word‑p. 59
6.1.3.4.3 Resource Standard Methods Word‑p. 59
6.1.3.4.3.1 POST Word‑p. 59
6.1.3.5 Resource: subscription (Document) Word‑p. 60
6.1.3.5.1 Description Word‑p. 60
6.1.3.5.2 Resource Definition Word‑p. 60
6.1.3.5.3 Resource Standard Methods Word‑p. 61
6.1.3.5.3.1 DELETE Word‑p. 61
6.1.3.5.3.2 PATCH Word‑p. 62
6.1.4 Custom Operations without associated resources Word‑p. 63
6.1.5 Notifications Word‑p. 63
6.1.5.1 General Word‑p. 63
6.1.5.2 NF Instance Status Notification Word‑p. 63
6.1.5.2.1 Description Word‑p. 63
6.1.5.2.2 Notification Definition Word‑p. 63
6.1.6 Data Model Word‑p. 64
6.1.6.1 General Word‑p. 64
6.1.6.2 Structured data types Word‑p. 68
6.1.6.2.1 Introduction Word‑p. 68
6.1.6.2.2 Type: NFProfile Word‑p. 69
6.1.6.2.3 Type: NFService Word‑p. 77
6.1.6.2.4 Type: DefaultNotificationSubscription Word‑p. 81
6.1.6.2.5 Type: IpEndPoint Word‑p. 82
6.1.6.2.6 Type: UdrInfo Word‑p. 82
6.1.6.2.7 Type: UdmInfo Word‑p. 83
6.1.6.2.8 Type: AusfInfo Word‑p. 84
6.1.6.2.9 Type: SupiRange Word‑p. 84
6.1.6.2.10 Type: IdentityRange Word‑p. 85
6.1.6.2.11 Type: AmfInfo Word‑p. 85
6.1.6.2.12 Type: SmfInfo Word‑p. 87
6.1.6.2.13 Type: UpfInfo Word‑p. 88
6.1.6.2.14 Type: SnssaiUpfInfoItem Word‑p. 89
6.1.6.2.15 Type: DnnUpfInfoItem Word‑p. 90
6.1.6.2.16 Type: SubscriptionData Word‑p. 91
6.1.6.2.17 Type: NotificationData Word‑p. 94
6.1.6.2.18 Void
6.1.6.2.19 Type: NFServiceVersion Word‑p. 95
6.1.6.2.20 Type: PcfInfo Word‑p. 95
6.1.6.2.21 Type: BsfInfo Word‑p. 96
6.1.6.2.22 Type: Ipv4AddressRange Word‑p. 96
6.1.6.2.23 Type: Ipv6PrefixRange Word‑p. 97
6.1.6.2.24 Type: InterfaceUpfInfoItem Word‑p. 97
6.1.6.2.25 Type: UriList Word‑p. 97
6.1.6.2.26 Type: N2InterfaceAmfInfo Word‑p. 98
6.1.6.2.27 Type: TaiRange Word‑p. 98
6.1.6.2.28 Type: TacRange Word‑p. 98
6.1.6.2.29 Type: SnssaiSmfInfoItem Word‑p. 99
6.1.6.2.30 Type: DnnSmfInfoItem Word‑p. 99
6.1.6.2.31 Type: NrfInfo Word‑p. 100
6.1.6.2.32 Type: ChfInfo Word‑p. 103
6.1.6.2.33 Void
6.1.6.2.34 Type: PlmnRange Word‑p. 104
6.1.6.2.35 Type: SubscrCond Word‑p. 105
6.1.6.2.36 Type: NfInstanceIdCond Word‑p. 105
6.1.6.2.37 Type: NfTypeCond Word‑p. 106
6.1.6.2.38 Type: ServiceNameCond Word‑p. 106
6.1.6.2.39 Type: AmfCond Word‑p. 106
6.1.6.2.40 Type: GuamiListCond Word‑p. 106
6.1.6.2.41 Type: NetworkSliceCond Word‑p. 106
6.1.6.2.42 Type: NfGroupCond Word‑p. 107
6.1.6.2.43 Type: NotifCondition Word‑p. 107
6.1.6.2.44 Type: PlmnSnssai Word‑p. 107
6.1.6.2.45 Type: NwdafInfo |R16| Word‑p. 108
6.1.6.2.46 Type: LmfInfo |R16| Word‑p. 109
6.1.6.2.47 Type: GmlcInfo |R16| Word‑p. 110
6.1.6.2.48 Type: NefInfo |R16| Word‑p. 110
6.1.6.2.49 Type: PfdData |R16| Word‑p. 111
6.1.6.2.50 Type: AfEventExposureData |R16| Word‑p. 111
6.1.6.2.51 Type: WAgfInfo |R16| Word‑p. 111
6.1.6.2.52 Type: TngfInfo |R16| Word‑p. 111
6.1.6.2.53 Type: PcscfInfo |R16| Word‑p. 112
6.1.6.2.54 Type: NfSetCond |R16| Word‑p. 112
6.1.6.2.55 Type: NfServiceSetCond |R16| Word‑p. 112
6.1.6.2.56 Type: NfInfo |R16| Word‑p. 113
6.1.6.2.57 Type: HssInfo |R16| Word‑p. 113
6.1.6.2.58 Type: ImsiRange |R16| Word‑p. 113
6.1.6.2.59 Type: InternalGroupIdRange |R16| Word‑p. 114
6.1.6.2.60 Type: UpfCond |R16| Word‑p. 114
6.1.6.2.61 Type: TwifInfo |R16| Word‑p. 114
6.1.6.2.62 Type: VendorSpecificFeature |R16| Word‑p. 115
6.1.6.2.63 Type: UdsfInfo |R16| Word‑p. 115
6.1.6.2.64 Type: NfInstanceIdListCond |R16| Word‑p. 115
6.1.6.2.65 Type: ScpInfo |R16| Word‑p. 116
6.1.6.2.66 Type: ScpDomainInfo |R16| Word‑p. 118
6.1.6.2.67 Type: ScpDomainCond |R16| Word‑p. 118
6.1.6.2.68 Type: OptionsResponse |R16| Word‑p. 119
6.1.6.2.69 Type: NwdafCond |R16| Word‑p. 119
6.1.6.2.70 Type: NefCond |R16| Word‑p. 120
6.1.6.2.71 Type: SuciInfo |R17| Word‑p. 120
6.1.6.2.72 Type: SeppInfo |R17| Word‑p. 120
6.1.6.2.73 Type: AanfInfo |R17| Word‑p. 121
6.1.6.2.75 Type: MfafInfo |R17| Word‑p. 121
6.1.6.2.76 Type: NwdafCapability |R17| Word‑p. 121
6.1.6.2.77 Type: EasdfInfo |R17| Word‑p. 122
6.1.6.2.78 Type: SnssaiEasdfInfoItem |R17| Word‑p. 122
6.1.6.2.79 Type: DnnEasdfInfoItem |R17| Word‑p. 122
6.1.6.2.80 Type: DccfInfo |R17| Word‑p. 123
6.1.6.2.81 Type: NsacfInfo |R17| Word‑p. 123
6.1.6.2.82 Type: NsacfCapability |R17| Word‑p. 123
6.1.6.2.83 Type: DccfCond |R17| Word‑p. 124
6.1.6.2.84 Type: MlAnalyticsInfo |R17| Word‑p. 124
6.1.6.2.85 Type: MbSmfInfo |R17| Word‑p. 125
6.1.6.2.86 Type: TmgiRange |R17| Word‑p. 125
6.1.6.2.87 Type: MbsSession |R17| Word‑p. 125
6.1.6.2.88 Type: SnssaiMbSmfInfoItem |R17| Word‑p. 126
6.1.6.2.89 Type: DnnMbSmfInfoItem |R17| Word‑p. 126
6.1.6.2.90 Type: MbsAreaSession |R17| Word‑p. 126
6.1.6.2.91 Type: TsctsfInfo |R17| Word‑p. 126
6.1.6.2.92 Type: SnssaiTsctsfInfoItem |R17| Word‑p. 127
6.1.6.2.93 Type: DnnTsctsfInfoItem |R17| Word‑p. 127
6.1.6.2.94 Type: MbUpfInfo |R17| Word‑p. 128
6.1.6.2.95 Type: AfSliceDnn |R17| Word‑p. 128
6.1.6.2.96 Type: TrustAfInfo |R17| Word‑p. 129
6.1.6.2.97 Type: SnssaiInfoItem |R17| Word‑p. 129
6.1.6.2.98 Type: DnnInfoItem |R17| Word‑p. 129
6.1.6.2.99 Type: CollocatedNfInstance |R17| Word‑p. 129
6.1.6.2.100 Type: ServiceNameListCond |R17| Word‑p. 130
6.1.6.2.101 Type: NfGroupListCond |R17| Word‑p. 130
6.1.6.2.102 Type: PlmnOauth2 |R17| Word‑p. 130
6.1.6.3 Simple data types and enumerations Word‑p. 130
6.1.6.3.1 Introduction Word‑p. 130
6.1.6.3.2 Simple data types Word‑p. 130
6.1.6.3.3 Enumeration: NFType Word‑p. 131
6.1.6.3.4 Enumeration: NotificationType Word‑p. 133
6.1.6.3.5 Enumeration: TransportProtocol Word‑p. 134
6.1.6.3.6 Enumeration: NotificationEventType Word‑p. 134
6.1.6.3.7 Enumeration: NFStatus Word‑p. 134
6.1.6.3.8 Enumeration: DataSetId Word‑p. 134
6.1.6.3.9 Enumeration: UPInterfaceType Word‑p. 135
6.1.6.3.10 Relation Types Word‑p. 135
6.1.6.3.10.1 General Word‑p. 135
6.1.6.3.11 Enumeration: ServiceName Word‑p. 136
6.1.6.3.12 Enumeration: NFServiceStatus Word‑p. 138
6.1.6.3.13 Enumeration: AnNodeType |R16| Word‑p. 138
6.1.6.3.14 Enumeration: ConditionEventType |R16| Word‑p. 138
6.1.6.3.15 Enumeration: IpReachability |R16| Word‑p. 138
6.1.6.3.16 Enumeration: ScpCapability |R17| Word‑p. 138
6.1.6.3.17 Enumeration: CollocatedNfType |R17| Word‑p. 139
6.1.7 Error Handling Word‑p. 139
6.1.7.1 General Word‑p. 139
6.1.7.2 Protocol Errors Word‑p. 139
6.1.7.3 Application Errors Word‑p. 139
6.1.8 Security Word‑p. 139
6.1.9 Features supported by the NFManagement service |R16| Word‑p. 139
6.2 Nnrf_NFDiscovery Service API Word‑p. 140
6.2.1 API URI Word‑p. 140
6.2.2 Usage of HTTP Word‑p. 140
6.2.2.1 General Word‑p. 140
6.2.2.2 HTTP standard headers Word‑p. 140
6.2.2.2.1 General Word‑p. 140
6.2.2.2.2 Content type Word‑p. 141
6.2.2.2.3 Cache-Control Word‑p. 141
6.2.2.2.4 ETag Word‑p. 141
6.2.2.2.5 If-None-Match Word‑p. 141
6.2.2.3 HTTP custom headers Word‑p. 141
6.2.2.3.1 General Word‑p. 141
6.2.3 Resources Word‑p. 141
6.2.3.1 Overview Word‑p. 141
6.2.3.2 Resource: nf-instances (Store) Word‑p. 143
6.2.3.2.1 Description Word‑p. 143
6.2.3.2.2 Resource Definition Word‑p. 143
6.2.3.2.3 Resource Standard Methods Word‑p. 143
6.2.3.2.3.1 GET Word‑p. 143
6.2.3.2.4 Resource Custom Operations Word‑p. 157
6.2.3.3 Resource: Stored Search (Document) |R16| Word‑p. 157
6.2.3.3.1 Description Word‑p. 157
6.2.3.3.2 Resource Definition Word‑p. 157
6.2.3.3.2.1 GET Word‑p. 157
6.2.3.4 Resource: Complete Stored Search (Document) |R16| Word‑p. 158
6.2.3.4.1 Description Word‑p. 158
6.2.3.4.2 Resource Definition Word‑p. 158
6.2.3.4.2.1 GET Word‑p. 158
6.2.3.5 Resource: SCP Domain Routing Information (Document) |R17| Word‑p. 159
6.2.3.5.1 Description Word‑p. 159
6.2.3.5.2 Resource Definition Word‑p. 159
6.2.3.5.2.1 GET Word‑p. 159
6.2.3.6 Resource: SCP Domain Routing Information Subscriptions (Collection) |R17| Word‑p. 160
6.2.3.6.1 Description Word‑p. 160
6.2.3.6.2 Resource Definition Word‑p. 160
6.2.3.6.3 Resource Standard Methods Word‑p. 160
6.2.3.6.3.1 POST Word‑p. 160
6.2.3.7 Resource: Individual SCP Domain Routing Information Subscription (Document) |R17| Word‑p. 161
6.2.3.7.1 Description Word‑p. 161
6.2.3.7.2 Resource Definition Word‑p. 161
6.2.3.7.3 Resource Standard Methods Word‑p. 161
6.2.3.7.3.1 DELETE Word‑p. 161
6.2.4 Custom Operations without associated resources Word‑p. 162
6.2.5 Notifications Word‑p. 162
6.2.5.1 General |R17| Word‑p. 162
6.2.5.2 SCP Domain Routing Information Change Notification |R17| Word‑p. 162
6.2.5.2.1 Description Word‑p. 162
6.2.5.2.2 Notification Definition Word‑p. 162
6.2.6 Data Model Word‑p. 163
6.2.6.1 General Word‑p. 163
6.2.6.2 Structured data types Word‑p. 165
6.2.6.2.1 Introduction Word‑p. 165
6.2.6.2.2 Type: SearchResult Word‑p. 166
6.2.6.2.3 Type: NFProfile Word‑p. 167
6.2.6.2.4 Type: NFService Word‑p. 172
6.2.6.2.5 Type: StoredSearchResult |R16| Word‑p. 174
6.2.6.2.6 Type: PreferredSearch |R16| Word‑p. 175
6.2.6.2.7 Type: NfInstanceInfo |R17| Word‑p. 176
6.2.6.2.8 Type: ScpDomainRoutingInformation |R17| Word‑p. 176
6.2.6.2.9 Type: ScpDomainConnectivity |R17| Word‑p. 176
6.2.6.2.10 Type: ScpDomainRoutingInfoSubscription |R17| Word‑p. 177
6.2.6.2.11 Type: ScpDomainRoutingInfoNotification |R17| Word‑p. 177
6.2.6.3 Simple data types and enumerations Word‑p. 177
6.2.6.3.1 Introduction Word‑p. 177
6.2.6.3.2 Simple data types Word‑p. 177
6.2.7 Error Handling Word‑p. 177
6.2.7.1 General Word‑p. 177
6.2.7.2 Protocol Errors Word‑p. 178
6.2.7.3 Application Errors Word‑p. 178
6.2.8 Security Word‑p. 178
6.2.9 Features supported by the NFDiscovery service Word‑p. 178
6.3 Nnrf_AccessToken Service API Word‑p. 181
6.3.1 General Word‑p. 181
6.3.2 API URI Word‑p. 181
6.3.3 Usage of HTTP Word‑p. 181
6.3.3.1 General Word‑p. 181
6.3.3.2 HTTP standard headers Word‑p. 181
6.3.3.2.1 General Word‑p. 181
6.3.3.2.2 Content type Word‑p. 181
6.3.3.3 HTTP custom headers Word‑p. 181
6.3.3.3.1 General Word‑p. 181
6.3.4 Custom Operations without associated resources Word‑p. 181
6.3.4.1 Overview Word‑p. 181
6.3.4.2 Operation: Get (Access Token Request) Word‑p. 182
6.3.4.2.1 Description Word‑p. 182
6.3.4.2.2 Operation Definition Word‑p. 182
6.3.5 Data Model Word‑p. 183
6.3.5.1 General Word‑p. 183
6.3.5.2 Structured data types Word‑p. 184
6.3.5.2.1 Introduction Word‑p. 184
6.3.5.2.2 Type: AccessTokenReq Word‑p. 185
6.3.5.2.3 Type: AccessTokenRsp Word‑p. 187
6.3.5.2.4 Type: AccessTokenClaims Word‑p. 188
6.3.5.2.5 Type: AccessTokenErr |R16| Word‑p. 189
6.3.5.3 Simple data types and enumerations Word‑p. 189
6.3.5.4 Data types describing alternative data types or combinations of data types Word‑p. 189
6.3.5.4.1 Type: Audience Word‑p. 189
6.4 Nnrf_Bootstrapping Service API |R16| Word‑p. 189
6.4.1 API URI Word‑p. 189
6.4.2 Usage of HTTP Word‑p. 190
6.4.2.1 General Word‑p. 190
6.4.2.2 HTTP standard headers Word‑p. 190
6.4.2.2.1 General Word‑p. 190
6.4.2.2.2 Content type Word‑p. 190
6.4.2.3 HTTP custom headers Word‑p. 190
6.4.2.3.1 General Word‑p. 190
6.4.3 Resources Word‑p. 190
6.4.3.1 Overview Word‑p. 190
6.4.3.2 Resource: Bootstrapping (Document) Word‑p. 191
6.4.3.2.1 Description Word‑p. 191
6.4.3.2.2 Resource Definition Word‑p. 191
6.4.3.2.3 Resource Standard Methods Word‑p. 191
6.4.3.2.3.1 GET Word‑p. 191
6.4.4 Custom Operations without associated resources Word‑p. 192
6.4.5 Notifications Word‑p. 192
6.4.6 Data Model Word‑p. 192
6.4.6.1 General Word‑p. 192
6.4.6.2 Structured data types Word‑p. 192
6.4.6.2.1 Introduction Word‑p. 192
6.4.6.2.2 Type: BootstrappingInfo Word‑p. 193
6.4.6.3 Simple data types and enumerations Word‑p. 193
6.4.6.3.1 Introduction Word‑p. 193
6.4.6.3.2 Enumeration: Status Word‑p. 193
6.4.6.3.3 Relation Types Word‑p. 194
6.4.6.3.3.1 General Word‑p. 194
