Update README.md (600f9631) · Commits · All Groups / 5G APIs

README.md

+122 −11

Original line number	Diff line number	Diff line
		# OpenAPI Specification Files for 3GPP 5G Core Network (Release 18)

		© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved.
		© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved.

		API version: December 2023
		Release status: {+ Open +}
		API version: March 2024
		Release status: {- Frozen -}
		Other releases: [Rel-17 (Frozen)](https://forge.3gpp.org/rep/all/5G_APIs/tree/REL-17), [Rel-16 (Frozen)](https://forge.3gpp.org/rep/all/5G_APIs/tree/REL-16), [Rel-15 (Frozen)](https://forge.3gpp.org/rep/all/5G_APIs/tree/REL-15)


		@@ -309,9 +309,9 @@ The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML f
		* Event Exposure
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29564_Nupf_EventExposure.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29564_Nupf_EventExposure.yaml))
		* Get Private UE IP Address
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29564_Nupf_GetPrivateUEIPaddr.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29564_Nupf_GetPrivateUEIPaddr.yaml))
		* Get UE Private IP Address and Identifiers
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29564_Nupf_GetUEPrivateIPaddrAndIdentifiers.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29564_Nupf_GetUEPrivateIPaddrAndIdentifiers.yaml))

		## HSS (Home Subscriber Server)
		* UE Authentication
		@@ -388,6 +388,7 @@ The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML f
		* Handshake (N32-c)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29573_N32_Handshake.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29573_N32_Handshake.yaml))
		([ABNF](https://forge.3gpp.org/swagger/tools/headers.html?abnf=TS29573_CustomHeaders.abnf))
		* Forwarding (N32-f)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29573_JOSEProtectedMessageForwarding.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29573_JOSEProtectedMessageForwarding.yaml))
		@@ -766,9 +767,6 @@ These APIs are not part of the 5G Core Network; these APIs are exposed by the 4G
		* Network Resource Monitoring
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29549_SS_NetworkResourceMonitoring.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29549_SS_NetworkResourceMonitoring.yaml))
		* Network Slice Adaptation
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29549_SS_NetworkSliceAdaptation.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29549_SS_NetworkSliceAdaptation.yaml))
		* User Profile Retrieval
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29549_SS_UserProfileRetrieval.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29549_SS_UserProfileRetrieval.yaml))
		@@ -787,6 +785,9 @@ These APIs are not part of the 5G Core Network; these APIs are exposed by the 4G
		* Key Information Retrieval
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29549_SS_KeyInfoRetrieval.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29549_SS_KeyInfoRetrieval.yaml))
		* Key Parameters Provisioning
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29549_SS_KMParametersProvisioning.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29549_SS_KMParametersProvisioning.yaml))
		* VAL Service Data Retrieval
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29549_SS_VALServiceData.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29549_SS_VALServiceData.yaml))
		@@ -811,9 +812,72 @@ These APIs are not part of the 5G Core Network; these APIs are exposed by the 4G
		* SEALDD Policy Configuration
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29548_SDD_PolicyConfiguration.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29548_SDD_PolicyConfiguration.yaml))
		* NSCE Server Policy Management
		* NSCE Policy Management
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29435_NSCE_PolicyManagement.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29435_NSCE_PolicyManagement.yaml))
		* NSCE Network Slice Optimization Service
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29435_NSCE_NSOptimization.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29435_NSCE_NSOptimization.yaml))
		* NSCE Network Slice Performance and Analytics Monitoring Service
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29435_NSCE_PerfMonitoring.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29435_NSCE_PerfMonitoring.yaml))
		* NSCE Information Collection Service
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29435_NSCE_InfoCollection.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29435_NSCE_InfoCollection.yaml))
		* NSCE Multiple Slices Optimization Service
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29435_NSCE_MultiSlicesOptimization.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29435_NSCE_MultiSlicesOptimization.yaml))
		* NSCE Network Slice Adaptation Service
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29435_NSCE_NetworkSliceAdaptation.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29435_NSCE_NetworkSliceAdaptation.yaml))
		* NSCE Network Slice Communication Service
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29435_NSCE_SliceCommService.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29435_NSCE_SliceCommService.yaml))
		* NSCE Inter-PLMN Service Continuity Service
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29435_NSCE_InterPLMNContinuity.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29435_NSCE_InterPLMNContinuity.yaml))
		* NSCE Network Slice Diagnostics Service
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29435_NSCE_NSDiagnostics.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29435_NSCE_NSDiagnostics.yaml))
		* NSCE Network Slice Fault Diagnosis Service
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29435_NSCE_FaultDiagnosis.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29435_NSCE_FaultDiagnosis.yaml))
		* NSCE Network Slice Requirements Verification And Alignment Service
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29435_NSCE_SliceReqVerifyAndAlign.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29435_NSCE_SliceReqVerifyAndAlign.yaml))
		* NSCE Network Slice Information Delivery Service
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29435_NSCE_NSInfoDelivery.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29435_NSCE_NSInfoDelivery.yaml))
		* NSCE Network Slice Allocation Service
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29435_NSCE_NSAllocation.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29435_NSCE_NSAllocation.yaml))
		* ADAE VAL Performance Analytics
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29549_SS_ADAE_VALPerformanceAnalytics.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29549_SS_ADAE_VALPerformanceAnalytics.yaml))
		* ADAE Slice Performance Analytics
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29549_SS_ADAE_SlicePerformanceAnalytics.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29549_SS_ADAE_SlicePerformanceAnalytics.yaml))
		* ADAE UE to UE Performance Analytics
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29549_SS_ADAE_Ue2UePerformanceAnalytics.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29549_SS_ADAE_Ue2UePerformanceAnalytics.yaml))
		* ADAE Location Accuracy Analytics
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29549_SS_ADAE_LocationAccuracyAnalytics.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29549_SS_ADAE_LocationAccuracyAnalytics.yaml))
		* ADAE Service API Analytics
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29549_SS_ADAE_ServiceApiAnalytics.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29549_SS_ADAE_ServiceApiAnalytics.yaml))
		* ADAE Slice Usage Pattern Analytics
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29549_SS_ADAE_SliceUsagePatternAnalytics.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29549_SS_ADAE_SliceUsagePatternAnalytics.yaml))
		* ADAE Edge Load Analytics
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29549_SS_ADAE_EdgeLoadAnalytics.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29549_SS_ADAE_EdgeLoadAnalytics.yaml))
		* ADAE Service Configuration
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS24559_ADAE_ServiceConfiguration.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS24559_ADAE_ServiceConfiguration.yaml))
		* AADRF Data Management
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29549_SS_AADRF_DataManagement.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29549_SS_AADRF_DataManagement.yaml))

		## EDGEAPP (Enabling Edge Applications)
		* EAS Registration
		@@ -864,6 +928,9 @@ These APIs are not part of the 5G Core Network; these APIs are exposed by the 4G
		* EES App Context Relocation
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS24558_Eees_AppContextRelocation.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS24558_Eees_AppContextRelocation.yaml))
		* EAS Information Provisioning
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS24558_Eees_EASInformationProvisioning.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS24558_Eees_EASInformationProvisioning.yaml))
		* EES ACR Parameters Information
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29558_Eees_ACRParameterInformation.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29558_Eees_ACRParameterInformation.yaml))
		@@ -873,6 +940,12 @@ These APIs are not part of the 5G Core Network; these APIs are exposed by the 4G
		* CAS Selected EES
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29558_Ecas_SelectedEES.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29558_Ecas_SelectedEES.yaml))
		* EES Application Traffic Influence
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29558_Eees_TrafficInfluenceEAS.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29558_Eees_TrafficInfluenceEAS.yaml))
		* EAS Information Management
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29558_Eecs_EASInfoManagement.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29558_Eecs_EASInfoManagement.yaml))

		## UAS Application Enabler (UAE) Server
		* C2 Operation Mode Management
		@@ -887,6 +960,9 @@ These APIs are not part of the 5G Core Network; these APIs are exposed by the 4G
		* DAA Support
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29257_UAE_DAASupport.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29257_UAE_DAASupport.yaml))
		* UAV Dynamic Information
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29257_UAE_UAVDynamicInfo.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29257_UAE_UAVDynamicInfo.yaml))

		## 5GMARCH (Enabling MSGin5G Service)
		* AS Registration
		@@ -904,6 +980,9 @@ These APIs are not part of the 5G Core Network; these APIs are exposed by the 4G
		* Broadcast Message Delivery
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29538_MSGG_BGDelivery.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29538_MSGG_BGDelivery.yaml))
		* Topic List Event
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29538_MSGS_TopiclistEvent.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29538_MSGS_TopiclistEvent.yaml))

		## PINAPP (Personal IoT Network Application)
		* PINServer PAS Registration
		@@ -995,9 +1074,33 @@ The APIs at reference points M1 and M5 are exposed by the 5GMS AF.
		* Common NRM definitions (TS 28.623)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS28623_ComDefs.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS28623_ComDefs.yaml))
		* Management Data Collection NRM (TS 28.623)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS28623_ManagementDataCollectionNrm.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS28623_ManagementDataCollectionNrm.yaml))
		* MnS Registry NRM (TS 28.623)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS28623_MnSRegistryNrm.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS28623_MnSRegistryNrm.yaml))
		* PM control NRM (TS 28.623)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS28623_PmControlNrm.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS28623_PmControlNrm.yaml))
		* QoE Measurement Collection NRM (TS 28.623)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS28623_QoEMeasurementCollectionNrm.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS28623_QoEMeasurementCollectionNrm.yaml))
		* Subscription Control NRM NRM (TS 28.623)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS28623_SubscriptionControlNrm.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS28623_SubscriptionControlNrm.yaml))
		* Threshold Monitor NRM(TS 28.623)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS28623_ThresholdMonitorNrm.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS28623_ThresholdMonitorNrm.yaml))
		* File Management NRM (TS 28.623)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS28623_FileManagementNrm.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS28623_FileManagementNrm.yaml))
		* Trace Control (TS 28.623)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS28623_TraceControlNrm.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS28623_TraceControlNrm.yaml))
		* Fault Management NRM(TS 28.111)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS28111_FaultNrm.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS28111_FaultNrm.yaml))
		* NR NRM (TS 28.541)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS28541_NrNrm.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS28541_NrNrm.yaml))
		@@ -1031,7 +1134,12 @@ The APIs at reference points M1 and M5 are exposed by the 5GMS AF.
		* Self-configuration of RAN entities (TS 28.317)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS28317_RanScNrm.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS28317_RanScNrm.yaml))

		* OutageAndRecoveryInfo NRM (TS 28.318)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS28318_DsoNrm.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS28318_DsoNrm.yaml))
		* MSAC NRM (TS 28.319)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS28319_MsacNrm.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS28319_MsacNrm.yaml))
		## Management Services (MnS)
		* Provisioning MnS (TS 28.532)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS28532_ProvMnS.yaml))
		@@ -1039,6 +1147,9 @@ The APIs at reference points M1 and M5 are exposed by the 5GMS AF.
		* Fault Supervision MnS (TS 28.532)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS28532_FaultMnS.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS28532_FaultMnS.yaml))
		* Fault Management Notifications (TS 28.111)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS28111_FaultNotifications.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS28111_FaultNotifications.yaml))
		* Performance Measurement Job Control MnS (28.550)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS28550_PerfMeasJobCtrlMnS.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS28550_PerfMeasJobCtrlMnS.yaml))