Content for TS 29.518 Word version: 18.4.0
6 API Definitions
6.1 Namf_Communication Service API
6.1.1 API URI
6.1.2 Usage of HTTP
6.1.3 Resources
6.1.4 Custom Operations without associated resources
6.1.5 Notifications
6.1.6 Data Model
6.1.7 Error Handling
6.1.8 Feature Negotiation
6.1.9 Security
6.1.10 HTTP redirection
...
...
6 API Definitions p. 85
6.1 Namf_Communication Service API p. 85
6.1.1 API URI p. 85
6.1.2 Usage of HTTP p. 86
6.1.2.1 General p. 86
6.1.2.2 HTTP standard headers p. 86
6.1.2.2.1 General p. 86
6.1.2.2.2 Content type p. 86
6.1.2.3 HTTP custom headers p. 86
6.1.2.3.1 General p. 86
6.1.2.4 HTTP multipart messages p. 86
6.1.3 Resources p. 88
6.1.3.1 Overview p. 88
6.1.3.2 Resource: Individual ueContext p. 89
6.1.3.2.1 Description p. 89
6.1.3.2.2 Resource Definition p. 90
6.1.3.2.3 Resource Standard Methods p. 90
6.1.3.2.3.1 PUT p. 90
6.1.3.2.4 Resource Custom Operations p. 92
6.1.3.2.4.1 Overview p. 92
6.1.3.2.4.2 Operation: release (POST) p. 92
6.1.3.2.4.3 Operation: assign-ebi (POST) p. 93
6.1.3.2.4.4 Operation: transfer (POST) p. 96
6.1.3.2.4.5 Operation: transfer-update (POST) p. 97
6.1.3.2.4.6 Operation: relocate (POST) p. 99
6.1.3.2.4.7 Operation: cancel-relocate (POST) p. 100
6.1.3.3 Resource: N1N2 Subscriptions Collection for Individual UE Contexts p. 101
6.1.3.3.1 Description p. 101
6.1.3.3.2 Resource Definition p. 101
6.1.3.3.3 Resource Standard Methods |R16| p. 101
6.1.3.3.3.1 POST p. 101
6.1.3.3.4 Resource Custom Operations p. 103
6.1.3.4 Resource: N1N2 Individual Subscription p. 103
6.1.3.4.1 Description p. 103
6.1.3.4.2 Resource Definition p. 103
6.1.3.4.3 Resource Standard Methods |R16| p. 103
6.1.3.4.3.1 DELETE p. 103
6.1.3.4.4 Resource Custom Operations p. 104
6.1.3.5 Resource: N1N2 Messages Collection p. 104
6.1.3.5.1 Description p. 104
6.1.3.5.2 Resource Definition p. 104
6.1.3.5.3 Resource Standard Methods p. 105
6.1.3.5.3.1 POST p. 105
6.1.3.6 Resource: subscriptions collection p. 109
6.1.3.6.1 Description p. 109
6.1.3.6.2 Resource Definition p. 109
6.1.3.6.3 Resource Standard Methods p. 109
6.1.3.6.3.1 POST p. 109
6.1.3.7 Resource: individual subscription p. 111
6.1.3.7.1 Description p. 111
6.1.3.7.2 Resource Definition p. 111
6.1.3.7.3 Resource Standard Methods p. 111
6.1.3.7.3.1 DELETE p. 111
6.1.3.7.3.2 PUT p. 112
6.1.3.8 Resource: Non UE N2 Messages Collection p. 113
6.1.3.8.1 Description p. 113
6.1.3.8.2 Resource Definition p. 114
6.1.3.8.3 Resource Standard Methods p. 114
6.1.3.8.4 Resource Custom Operations p. 114
6.1.3.8.4.1 Overview p. 114
6.1.3.8.4.2 Operation: transfer p. 114
6.1.3.9 Resource: Non UE N2 Messages Subscriptions Collection p. 116
6.1.3.9.1 Description p. 116
6.1.3.9.2 Resource Definition p. 116
6.1.3.9.3 Resource Standard Methods p. 116
6.1.3.9.3.1 POST p. 116
6.1.3.9.4 Resource Custom Operations p. 117
6.1.3.10 Resource: Non UE N2 Message Notification Individual Subscription p. 118
6.1.3.10.1 Description p. 118
6.1.3.10.2 Resource Definition p. 118
6.1.3.10.3 Resource Standard Methods p. 118
6.1.3.10.3.1 DELETE p. 118
6.1.3.10.4 Resource Custom Operations p. 119
6.1.4 Custom Operations without associated resources p. 119
6.1.5 Notifications p. 119
6.1.5.1 General p. 119
6.1.5.2 AMF Status Change Notification p. 120
6.1.5.2.1 Description p. 120
6.1.5.2.2 Notification Definition p. 120
6.1.5.2.3 Notification Standard Methods p. 120
6.1.5.2.3.1 POST p. 120
6.1.5.3 Non UE N2 Information Notification p. 121
6.1.5.3.1 Description p. 121
6.1.5.3.2 Notification Definition p. 121
6.1.5.3.3 Notification Standard Methods p. 122
6.1.5.3.3.1 POST p. 122
6.1.5.4 N1 Message Notification p. 123
6.1.5.4.1 Description p. 123
6.1.5.4.2 Notification Definition p. 123
6.1.5.4.3 Notification Standard Methods p. 123
6.1.5.4.3.1 POST p. 123
6.1.5.5 UE Specific N2 Information Notification p. 124
6.1.5.5.1 Description p. 124
6.1.5.5.2 Notification Definition p. 124
6.1.5.5.3 Notification Standard Methods p. 124
6.1.5.5.3.1 POST p. 124
6.1.5.6 N1N2 Transfer Failure Notification p. 125
6.1.5.6.1 Description p. 125
6.1.5.6.2 Notification Definition p. 125
6.1.5.6.3 Notification Standard Methods p. 126
6.1.5.6.3.1 POST p. 126
6.1.5.7 Void
6.1.6 Data Model p. 127
6.1.6.1 General p. 127
6.1.6.2 Structured data types p. 134
6.1.6.2.1 Introduction p. 134
6.1.6.2.2 Type: SubscriptionData p. 135
6.1.6.2.3 Type: AmfStatusChangeNotification p. 135
6.1.6.2.4 Type: AmfStatusInfo p. 135
6.1.6.2.5 Type: AssignEbiData p. 136
6.1.6.2.6 Type: AssignedEbiData p. 136
6.1.6.2.7 Type: AssignEbiFailed p. 137
6.1.6.2.8 Type: UEContextRelease p. 137
6.1.6.2.9 Type: N2InformationTransferReqData p. 137
6.1.6.2.10 Type: NonUeN2InfoSubscriptionCreateData p. 138
6.1.6.2.11 Type: NonUeN2InfoSubscriptionCreatedData p. 139
6.1.6.2.12 Type: UeN1N2InfoSubscriptionCreateData p. 139
6.1.6.2.13 Type: UeN1N2InfoSubscriptionCreatedData p. 139
6.1.6.2.14 Type: N2InformationNotification p. 140
6.1.6.2.15 Type: N2InfoContainer p. 143
6.1.6.2.16 Type: N1MessageNotification p. 144
6.1.6.2.17 Type: N1MessageContainer p. 145
6.1.6.2.18 Type: N1N2MessageTransferReqData p. 146
6.1.6.2.19 Type: N1N2MessageTransferRspData p. 150
6.1.6.2.20 Type: RegistrationContextContainer p. 151
6.1.6.2.21 Type: AreaOfValidity p. 153
6.1.6.2.22 Void
6.1.6.2.23 Type: UeContextTransferReqData p. 153
6.1.6.2.24 Type: UeContextTransferRspData p. 154
6.1.6.2.25 Type: UeContext p. 155
6.1.6.2.26 Type: N2SmInformation p. 165
6.1.6.2.27 Type: N2InfoContent p. 166
6.1.6.2.28 Type: NrppaInformation p. 166
6.1.6.2.29 Type: PwsInformation p. 167
6.1.6.2.30 Type: N1N2MsgTxfrFailureNotification p. 169
6.1.6.2.31 Type: N1N2MessageTransferError p. 169
6.1.6.2.32 Type: N1N2MsgTxfrErrDetail p. 170
6.1.6.2.33 Type: N2InformationTransferRspData p. 170
6.1.6.2.34 Type: MmContext p. 171
6.1.6.2.35 Type: SeafData p. 174
6.1.6.2.36 Type: NasSecurityMode p. 174
6.1.6.2.37 Type: PduSessionContext p. 175
6.1.6.2.38 Type: NssaiMapping p. 180
6.1.6.2.39 Type: UeRegStatusUpdateReqData p. 181
6.1.6.2.40 Type: AssignEbiError p. 181
6.1.6.2.41 Type: UeContextCreateData p. 182
6.1.6.2.42 Type: UeContextCreatedData p. 183
6.1.6.2.43 Type: UeContextCreateError p. 183
6.1.6.2.44 Type: NgRanTargetId p. 184
6.1.6.2.45 Type: N2InformationTransferError p. 184
6.1.6.2.46 Type: PWSResponseData p. 184
6.1.6.2.47 Type: PWSErrorData p. 185
6.1.6.2.48 Void
6.1.6.2.49 Type: NgKsi p. 185
6.1.6.2.50 Type: KeyAmf p. 185
6.1.6.2.51 Type: ExpectedUeBehavior p. 185
6.1.6.2.52 Type: UeRegStatusUpdateRspData p. 186
6.1.6.2.53 Type: N2RanInformation p. 186
6.1.6.2.54 Type: N2InfoNotificationRspData p. 186
6.1.6.2.55 Type: SmallDataRateStatusInfo |R16| p. 186
6.1.6.2.56 Type: SmfChangeInfo |R16| p. 187
6.1.6.2.57 Type: V2xContext |R16| p. 187
6.1.6.2.58 Type: ImmediateMdtConf |R16| p. 188
6.1.6.2.59 Type: V2xInformation |R16| p. 190
6.1.6.2.60 Type: EpsNasSecurityMode p. 190
6.1.6.2.61 Type: UeContextRelocateData |R16| p. 191
6.1.6.2.62 Type: UeContextRelocatedData |R16| p. 191
6.1.6.2.63 Void
6.1.6.2.64 Type: EcRestrictionDataWb |R16| p. 192
6.1.6.2.65 Type: ExtAmfEventSubscription |R16| p. 192
6.1.6.2.66 Type: AmfEventSubscriptionAddInfo |R16| p. 193
6.1.6.2.67 Type: UeContextCancelRelocateData |R16| p. 194
6.1.6.2.68 Type: UeDifferentiationInfo |R16| p. 194
6.1.6.2.69 Type: CeModeBInd |R16| p. 194
6.1.6.2.70 Type: LteMInd |R16| p. 195
6.1.6.2.71 Type: NpnAccessInfo |R16| p. 195
6.1.6.2.72 Type: ProseContext |R17| p. 195
6.1.6.2.73 Type: AnalyticsSubscription |R17| p. 196
6.1.6.2.74 Type: NwdafSubscription |R17| p. 196
6.1.6.2.75 Type: UpdpSubscriptionData p. 196
6.1.6.2.76 Type: ProSeInformation |R17| p. 196
6.1.6.2.77 Type: ReleaseSessionInfo |R17| p. 197
6.1.6.2.78 Type: AreaOfInterestEventState |R16| p. 197
6.1.6.2.79 Type: TssInformation |R18| p. 197
6.1.6.2.80 Type: AmPolicyInfoContainer |R18| p. 197
6.1.6.2.81 Type: RslpInformation |R18| p. 198
6.1.6.2.82 Type: A2xContext |R18| p. 198
6.1.6.2.83 Type: A2xInformation |R18| p. 198
6.1.6.2.84 Type: LcsUpContext |R18| p. 198
6.1.6.3 Simple data types and enumerations p. 199
6.1.6.3.1 Introduction p. 199
6.1.6.3.2 Simple data types p. 199
6.1.6.3.3 Enumeration: StatusChange p. 200
6.1.6.3.4 Enumeration: N2InformationClass p. 200
6.1.6.3.5 Enumeration: N1MessageClass p. 200
6.1.6.3.6 Enumeration: N1N2MessageTransferCause p. 201
6.1.6.3.7 Enumeration: UeContextTransferStatus p. 202
6.1.6.3.8 Enumeration: N2InformationTransferResult p. 202
6.1.6.3.9 Enumeration: CipheringAlgorithm p. 202
6.1.6.3.10 Enumeration: IntegrityAlgorithm p. 202
6.1.6.3.11 Enumeration: SmsSupport p. 202
6.1.6.3.12 Enumeration: ScType p. 203
6.1.6.3.13 Enumeration: KeyAmfType p. 203
6.1.6.3.14 Enumeration: TransferReason p. 203
6.1.6.3.15 Enumeration: PolicyReqTrigger p. 203
6.1.6.3.16 Enumeration: RatSelector p. 204
6.1.6.3.17 Enumeration: NgapIeType p. 204
6.1.6.3.18 Enumeration: N2InfoNotifyReason p. 204
6.1.6.3.19 Enumeration: SmfChangeIndication |R16| p. 204
6.1.6.3.20 Enumeration: SbiBindingLevel |R16| p. 205
6.1.6.3.21 Enumeration: EpsNasCipheringAlgorithm p. 205
6.1.6.3.22 Enumeration: EpsNasIntegrityAlgorithm p. 205
6.1.6.3.23 Enumeration: PeriodicCommunicationIndicator |R16| p. 205
6.1.6.3.24 Enumeration: UuaaMmStatus |R17| p. 205
6.1.6.3.25 Enumeration: ReleaseCause |R17| p. 206
6.1.6.4 Binary data p. 206
6.1.6.4.1 Introduction p. 206
6.1.6.4.2 N1 Message p. 206
6.1.6.4.3 N2 Information p. 207
6.1.6.4.4 Mobile Terminated Data |R16| p. 211
6.1.6.4.5 GTP-C Message |R16| p. 211
6.1.7 Error Handling p. 211
6.1.8 Feature Negotiation p. 215
6.1.9 Security p. 218
6.1.10 HTTP redirection |R16| p. 219
