) REST Cloud Native Specification Document REST... · 2019-04-19 · • Application data...

Oracle® CommunicationsUser Data Repository (UDR) RESTCloud Native Specification Document

Release 1.0F17732-01April 2019

Oracle Communications User Data Repository (UDR) REST Cloud Native Specification Document, Release 1.0

F17732-01

Copyright © 2019, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use anddisclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement orallowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit,perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilationof this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you findany errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf ofthe U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, anyprograms installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercialcomputer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplementalregulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operatingsystem, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to licenseterms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is notdeveloped or intended for use in any inherently dangerous applications, including applications that may create a risk ofpersonal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take allappropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliatesdisclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of theirrespective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used underlicense and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, andthe AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registeredtrademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products, andservices from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim allwarranties of any kind with respect to third-party content, products, and services unless otherwise set forth in anapplicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss,costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth inan applicable agreement between you and Oracle.

Contents

1 Introduction

Overview 1-1Acronyms 1-2Locate Product Documentation on the Oracle Help Center Site 1-2Customer Training 1-3My Oracle Support 1-3Emergency Response 1-3

2 REST Specifications

Operations Supported for PCF 2-1POST Provisioning System as Consumer 2-5UDM as Consumer 2-13Management URI Schema Update 2-14UDSF Data Operations 2-14List of Title and Type under Problem Details in Error Response 2-15

A Payload Reference for PCF

PATCH-SessionManagementPolicyData A-1PUT-UEPolicySet A-1PATCH-UEPolicySet A-1PUT-UsageMonitoringInformation A-2

B Payload Reference for Provisioning System

PUT-ProfileData B-1PUT-AccessAndMobilityPolicyData B-1PUT-SessionManagementPolicyData B-1PUT-UEPolicySet B-2PUT-AuthenticationSubscriptionData B-2PUT-AuthenticationStatus B-2

iii

PUT-AccessAndMobilitySubscriptionData B-2

C Payload Reference for UDM

PUT-AuthenticationStatus C-1

D Payloads for Management URI Schema Update

PUT-URI D-1

iv

List of Tables

1-1 Acronyms 1-2

2-1 Operations Supported for PCF 2-1

2-2 Provisioning System as Consumer 2-6

2-3 Operations for UDM as Consumer 2-13

2-4 Management URI for Schema Update 2-14

2-5 UDSF Data Operations 2-15

2-6 Titles and Type under Problem Details in Error Response 2-15

v

1Introduction

This document provides information about the REST specifications for User Data Repository.

OverviewThe 5G User Data Repository is one of the main key component of the 5G Service BasedArchitecture. User Data Repository is a converged repository which is used by other 5GNetwork Functions to store the data.

Oracle 5G UDR, implemented as cloud native function, offers a unified database for storingapplication, subscription, authentication, service authorization, policy data, session binding andApplication state information. UDR is one of the main key component of the 5G Service BasedArchitecture. UDR provides a HTTP2 based RESTful interface for other NFs and provisioningclients to access the data stored. As per the 3GPP, the Unified Data Repository (UDR) supportsthe following functionality:

• Storage and retrieval of subscription data by the UDM.

• Storage and retrieval of policy data by the PCF.

• Storage and retrieval of structured data for exposure.

• Application data (including Packet Flow Descriptions (PFDs) for application detection, AFrequest information for multiple UEs), by the NEF.

Oracle's 5G UDR :

• Leverages a common Oracle Communications Cloud Native Framework

• Compliant to 3GPP Release 15 specification

• Has tiered architecture providing separation between the connectivity, business logic anddata layers

• Uses MySQL NDB Cluster as the backend database in the Data Tier

• Registers with NRF in the 5G network, so the other NFs in the network can discover UDRthrough NRF.

Note:

In this release, User Data Repository supports only Policy Control Function data.

UDSF (Unstructured Data Storage Function) is the functionality which supports storage andretrieval of unstructured data by any 5G NF. The specifications of UDSF is not defined by3GPP. This functionality is part of Oracle's 5G UDR solution.

1-1

AcronymsThe following table provides information about the acronyms used in the document.

Table 1-1 Acronyms

Field Description5G-AN 5G Access Network5GC 5G Core Network5G-GUTI 5G Globally Unique Temporary Identifier5GS 5G SystemAMF Access and Mobility Management FunctionAUSF Authentication Server FunctionNEF Network Exposure FunctionNF Network FunctionNRF Network Repository FunctionNSI ID Network Slice Instance IdentifierNSSAI Network Slice Selection Assistance InformationNSSF Network Slice Selection FunctionNSSP Network Slice Selection PolicyPCF Policy Control FunctionSEPP Security Edge Protection ProxyUDM Unified Data ManagementUDR Unified Data RepositoryUDSF Unstructured Data Storage Function

Locate Product Documentation on the Oracle HelpCenter Site

Oracle Communications customer documentation is available on the web at the Oracle HelpCenter (OHC) site, http://docs.oracle.com. You do not have to register to access thesedocuments. Viewing these files requires Adobe Acrobat Reader, which can be downloaded at http://www.adobe.com.

1. Access the Oracle Help Center site at http://docs.oracle.com.

2. Click Industries.

3. Under the Oracle Communications subheading, click the Oracle Communicationsdocumentation link.

The Communications Documentation page appears. Most products covered by thesedocumentation sets will appear under the headings "Network Session Delivery and ControlInfrastructure" or "Platforms."

4. Click on your Product and then the Release Number.

A list of the entire documentation set for the selected product and release appears.

5. To download a file to your location, right-click the PDF link, select Save target as(or similar command based on your browser), and save to a local folder.

Chapter 1Acronyms

1-2

http://docs.oracle.com

http://www.adobe.com

http://docs.oracle.com

Customer TrainingOracle University offers training for service providers and enterprises. Visit our web site toview, and register for, Oracle Communications training:

http://education.oracle.com/communication

To obtain contact phone numbers for countries or regions, visit the Oracle University Educationweb site:

www.oracle.com/education/contacts

My Oracle SupportMy Oracle Support is your initial point of contact for all product support and training needs. Arepresentative at Customer Access Support can assist you with My Oracle Support registration.

Call the Customer Access Support main number at 1-800-223-1711 (toll-free in the US), or callthe Oracle Support hotline for your local country from the list at http://www.oracle.com/us/support/contact/index.html. When calling, make the selections in the sequence shown below onthe Support telephone menu:

1. Select 2 for New Service Request

2. Select 3 for Hardware, Networking and Solaris Operating System Support

3. Select one of the following options:

• For Technical issues such as creating a new Service Request (SR), Select 1

• For Non-technical issues such as registration or assistance with MOS, Select 2

You will be connected to a live agent who can assist you with My Oracle Support registrationand opening a support ticket.

My Oracle Support is available 24 hours a day, 7 days a week, 365 days a year.

Emergency ResponseIn the event of a critical service situation, emergency response is offered by the CustomerAccess Support (CAS) main number at 1-800-223-1711 (toll-free in the US), or by calling theOracle Support hotline for your local country from the list at http://www.oracle.com/us/support/contact/index.html. The emergency response provides immediate coverage, automaticescalation, and other features to ensure that the critical situation is resolved as rapidly aspossible.

A critical situation is defined as a problem with the installed equipment that severely affectsservice, traffic, or maintenance capabilities, and requires immediate corrective action. Criticalsituations affect service and/or system operation resulting in one or several of these situations:

• A total system failure that results in loss of all transaction processing capability

• Significant reduction in system capacity or traffic handling capability

• Loss of the system’s ability to perform automatic system reconfiguration

• Inability to restart a processor or the system

• Corruption of system databases that requires service affecting corrective actions

Chapter 1Customer Training

1-3

http://education.oracle.com/pls/web_prod-plq-dad/ou_product_category.getFamilyPage?p_family_id=41&p_mode=Training&sc=WWOU14047594MPP002C005

http://education.oracle.com/pls/web_prod-plq-dad/db_pages.getpage?page_id=225

http://www.oracle.com/us/support/contact/index.html




• Loss of access for maintenance or recovery operations

• Loss of the system ability to provide any required critical or major trouble notification

Any other problem severely affecting service, capacity/traffic, billing, and maintenancecapabilities may be defined as critical by prior discussion and agreement with Oracle.

Chapter 1Emergency Response

1-4

2REST Specifications

This section provides infromation about REST specifications used in the User Data Repsitory.

Operations Supported for PCFThe Operations Supported for PCF table provides information about the operations supportedfor PCF

Table 2-1 Operations Supported for PCF

Operation Type Resource Name REST-URI as perTS29.519 v15.2.0

Notes Possible ErrorCodes

GET AccessAndMobilityPolicyData

{apiRoot}/nudr-dr/v1/policy-data/ues/{ueId}/am-data

https://10.75.212.116:31873/nudr-dr/v1/policy-data/ues/msisdn-7777777779/am-data

• 400: "InvalidURI sent fromclient"

• 404:"Subscriberdoes not exist"

• 404: "Datafield does notexist"

• 400:"Unknownkey, the keyprovided inthe request isinvalid"

2-1

HTTPS://10.75.212.116:31873/NUDR-DR/V1/POLICY-DATA/UES/MSISDN-7777777779/AM-DATA






Table 2-1 (Cont.) Operations Supported for PCF



GET SessionManagementPolicyData

{apiRoot}/nudr-dr/v1/policy-data/ues/{ueId}/sm-data

Different samplesof GET

1. Complete SMdata GET: https://10.75.212.116:31873/nudr-dr/v1/policy-data/ues/msisdn-7777777779/sm-data

2. Using queryparameters

a. https://10.75.212.116:31873/nudr-dr/v1/policy-data/ues/msisdn-7777777779/sm-data?dnn=dnn1&snssai=11-abc123&fields=umData

b. https://10.75.212.116:31873/nudr-dr/v1/policy-data/ues/msisdn-7777777779/sm-data?dnn=dnn1&fields=umData,smPolicySnssaiData

c. https://10.75.212.116:31




• 404:"Requesteddata notfound"

• 400: "Invalidqueryparameterssupplied"

Chapter 2Operations Supported for PCF

2-2

HTTPS://10.75.212.116:31873/NUDR-DR/V1/POLICY-DATA/UES/MSISDN-7777777779/SM-DATA







HTTPS://10.75.212.116:31873/NUDR-DR/V1/POLICY-DATA/UES/MSISDN-7777777779/SM-DATA?DNN=DNN1&SNSSAI=11-ABC123&FIELDS=UMDATA

















HTTPS://10.75.212.116:31873/NUDR-DR/V1/POLICY-DATA/UES/MSISDN-7777777779/SM-DATA?DNN=DNN1&FIELDS=UMDATA,SMPOLICYSNSSAIDATA

















HTTPS://10.75.212.116:31873/NUDR-DR/V1/POLICY-DATA/UES/MSISDN-7777777779/SM-DATA?SNSSAI=11-ABC123&FIELDS=SMPOLICYSNSSAIDATA






873/nudr-dr/v1/policy-data/ues/msisdn-7777777779/sm-data?snssai=11-abc123&fields=smPolicySnssaiData

PATCH SessionManagementPolicyData

{apiRoot}/nudr-dr/v1/policy-data/ues/{ueId}/sm-data

https://10.75.212.116:31873/nudr-dr/v1/policy-data/ues/msisdn-7777777779/sm-data Payload:See PATCH-SessionManagementPolicyData

• 400: "Blobsyntax errorwithcorrespondingerror details"




• 400: Datafield does notexist.

PUT UEPolicySet {apiRoot}/nudr-dr/v1/policy-data/ues/{ueId}/ue-policy-set

https://localhost:9443/nudr-dr/v1/policy-data/ues/msisdn-1111111111/ue-policy-setPayload: See PUT-UEPolicySet






2-3





















HTTPS://LOCALHOST:9443/NUDR-DR/V1/POLICY-DATA/UES/MSISDN-1111111111/UE-POLICY-SET








GET UEPolicySet {apiRoot}/nudr-dr/v1/policy-data/ues/{ueId}/ue-policy-set

https://localhost:9443/nudr-dr/v1/policy-data/ues/msisdn-1111111111/ue-policy-set


• 404:"Subscriber does notexist"


PATCH UEPolicySet {apiRoot}/nudr-dr/v1/policy-data/ues/{ueId}/ue-policy-set

https://localhost:9443/nudr-dr/v1/policy-data/ues/msisdn-1111111111/ue-policy-setPayload: See PATCH-UEPolicySet

• 400 : "Blobsyntax errorwithcorrespondingerror details"

• 400 : "InvalidURI sent fromclient"

• 404 :"Subscriberdoes not exist"

• 400 :"Unknownkey, the keyprovided inthe request isinvalid"

• 400: Datafield does notexist

GET UsageMonitoringInformation

{apiRoot}/nudr-dr/v1/policy-data/ues/{ueId}/sm-data/{usageMonId}

https://localhost:9443/nudr-dr/v1/policy-data/ues/msisdn-1111111111/sm-data/mk1



• 404 : "Datafield does notexist "



2-4











HTTPS://LOCALHOST:9443/NUDR-DR/V1/POLICY-DATA/UES/MSISDN-1111111111/SM-DATA/MK1








PUT UsageMonitoringInformation


https://localhost:9443/nudr-dr/v1/policy-data/ues/msisdn-1111111111/sm-data/mk1Payload: See PUT-UsageMonitoringInformation

• 400 : "Blobsyntax errorwithcorrespondingerror details"




DELETE UsageMonitoringInformation


https://localhost:9443/nudr-dr/v1/policy-data/ues/msisdn-1111111111/sm-data/mk1





POST Provisioning System as ConsumerThe following table provides operation for provisioning system as consumer.

Chapter 2POST Provisioning System as Consumer

2-5











Table 2-2 Provisioning System as Consumer

Operation Type Resource Name REST-URI Notes Possible ErrorCodes

POST ProfileData {apiRoot}/nudr-dr-prov/v1/profile-data/{ue-id}

This is for initialsubscriberprovisioning(Create subscriber) https://localhost:9443/nudr-dr-prov/v1/profile-data/msisdn-1111111113Payload : See #unique_20



• 400: "Payloadshould containkey-value pairpresent inURI"

• 400: "Invalidcontentrequest datasupplied"

• 400:"Occurrenceconstraintviolation"

• 400:"Duplicatekey"

PUT ProfileData {apiRoot}/nudr-dr-prov/v1/profile-data/{ue-id}

https://localhost:9443/nudr-dr-prov/v1/profile-data/nai-3333333332Payload: PUT-ProfileData



• 400: " Payloadshould containkey-value pairpresent in URI"

• 400: "Invalidcontentrequest datasupplied"

• 400:"Occurrenceconstraintviolation"


2-6

HTTPS://LOCALHOST:9443/NUDR-DR-PROV/V1/PROFILE-DATA/NAI-3333333332









Table 2-2 (Cont.) Provisioning System as Consumer


DELETE ProfileData {apiRoot}/nudr-dr-prov/v1/profile-data/{ue-id}

https://localhost:9443/nudr-dr-prov/v1/profile-data/nai-3333333332This operationdeletes all datafrom all DATAtables(PCF,UDMetc)




GET ProfileData {apiRoot}/nudr-dr-prov/v1/profile-data/{ue-id}

https://localhost:9443/nudr-dr-prov/v1/profile-data/msisdn-1111111113




PCF data's provisioning APIsPUT AccessAndMobilit

yPolicyData{apiRoot}/nudr-dr-prov/v1/policy-data/{ueId}/am-data

https://10.75.212.116:31873/nudr-dr-prov/v1/policy-data/msisdn-7777777779/am-data Payload:See PUT-AccessAndMobilityPolicyData






2-7











HTTPS://10.75.212.116:31873/NUDR-DR-PROV/V1/POLICY-DATA/MSISDN-7777777779/AM-DATA








GET AccessAndMobilityPolicyData

{apiRoot}/nudr-dr-prov/v1/policy-data/{ueId}/am-data

https://10.75.212.116:31873/nudr-dr/v1/policy-data/ues/msisdn-7777777779/am-data





DELETE AccessAndMobilityPolicyData

{apiRoot}/nudr-dr-prov/v1/policy-data/{ueId}/am-data

https://localhost:9443/nudr-dr-prov/v1/policy-data/msisdn-1111111111/am-data




PUT SessionManagementPolicyData

{apiRoot}/nudr-dr-prov/v1/policy-data/{ueId}/sm-data

https://10.75.212.116:31873/nudr-dr-prov/v1/policy-data/msisdn-7777777779/sm-data Payload: PUT-SessionManagementPolicyData






2-8







HTTPS://LOCALHOST:9443/NUDR-DR-PROV/V1/POLICY-DATA/MSISDN-11111111131/AM-DATA






HTTPS://10.75.212.116:31873/NUDR-DR-PROV/V1/POLICY-DATA/MSISDN-7777777779/SM-DATA








GET SessionManagementPolicyData


https://10.75.212.116:31873/nudr-dr-prov/v1/policy-data/msisdn-7777777779/sm-data





DELETE SessionManagementPolicyData


https://localhost:9443/nudr-dr-prov/v1/policy-data/msisdn-11111111131/sm-data




PUT UEPolicySet {apiRoot}/nudr-dr-prov/v1/policy-data/{ueId}/ue-policy-set

https://localhost:9443/nudr-dr/v1/policy-data/ues/msisdn-1111111111/ue-policy-setPayload: See PUT-UEPolicySet






2-9




















GET UEPolicySet {apiRoot}/nudr-dr-prov/v1/policy-data/{ueId}/ue-policy-set






DELETE UEPolicySet {apiRoot}/nudr-dr-prov/v1/policy-data/{ueId}/ue-policy-set





UDM data's provisioning APIsPUT AuthenticationSubs

criptionData{apiRoot}/nudr-dr-prov/v1/subscription-data/{ueId}/authentication-data/authentication-subscription

https://10.75.212.116:31873/nudr-dr-prov/v1/subscription-data/msisdn-7777777779/authentication-data/authentication-subscriptionPayload: See PUT-AuthenticationSubscriptionData






2-10











HTTPS://10.75.212.116:30196/NUDR-DR-PROV/V1/SUBSCRIPTION-DATA/MSISDN-7777777778/AUTHENTICATION-DATA/AUTHENTICATION-SUBSCRIPTION










GET AuthenticationSubscriptionData

{apiRoot}/nudr-dr-prov/v1/subscription-data/{ueId}/authentication-data/authentication-subscription

https://10.75.212.116:31873/nudr-dr-prov/v1/subscription-data/msisdn-7777777779/authentication-data/authentication-subscription





DELETE AuthenticationSubscriptionData

{apiRoot}/nudr-dr-prov/v1/subscription-data/{ueId}/authentication-data/authentication-subscription

https://localhost:9443/nudr-dr-prov/v1/subscription-data/msisdn-1111111111/authentication-data/authentication-subscription




PUT AuthenticationStatus

{apiRoot}/nudr-dr-prov/v1/subscription-data/{ueId}/authentication-data/authentication-status

https://10.75.212.116:31873/nudr-dr-prov/v1/subscription-data/msisdn-7777777779/authentication-data/authentication-status Payload: See PUT-AuthenticationStatus






2-11









HTTPS://LOCALHOST:9443/NUDR-DR-PROV/V1/SUBSCRIPTION-DATA/MSISDN-1111111111/AUTHENTICATION-DATA/AUTHENTICATION-SUBSCRIPTION








HTTPS://10.75.212.116:30196/NUDR-DR/V1/SUBSCRIPTION-DATA/MSISDN-7777777778/AUTHENTICATION-DATA/AUTHENTICATION-STATUS










GET AuthenticationStatus


https://10.75.212.116:31873/nudr-dr-prov/v1/subscription-data/msisdn-7777777779/authentication-data/authentication-status





DELETE AuthenticationStatus


https://localhost:9443/nudr-dr-prov/v1/subscription-data/msisdn-1111111111/authentication-data/authentication-status




PUT AccessAndMobilitySubscriptionData

{apiRoot}/nudr-dr-prov/v1/subscription-data/{ueId}/{servingPlmnId}/provisioned-data /am-data

https://localhost:9443/nudr-dr-prov/v1/subscription-data/msisdn-1111111111/323/provisioned-data/am-dataPayload: See PUT-AccessAndMobilitySubscriptionData






2-12

HTTPS://10.75.212.116:31873/NUDR-DR-PROV/V1/SUBSCRIPTION-DATA/MSISDN-7777777779/AUTHENTICATION-DATA/AUTHENTICATION-STATUS








HTTPS://LOCALHOST:9443/NUDR-DR-PROV/V1/SUBSCRIPTION-DATA/MSISDN-1111111111/AUTHENTICATION-DATA/AUTHENTICATION-STATUS








HTTPS://LOCALHOST:9443/NUDR-DR-PROV/V1/SUBSCRIPTION-DATA/MSISDN-1111111111/323/PROVISIONED-DATA/AM-DATA









GET AccessAndMobilitySubscriptionData


https://localhost:9443/nudr-dr-prov/v1/subscription-data/msisdn-1111111111/323/provisioned-data/am-data



• 404:"Subscriber ordata field doesnot exist indata table"


DELETE AccessAndMobilitySubscriptionData


https://localhost:9443/nudr-dr-prov/v1/subscription-data/msisdn-1111111111/323/provisioned-data/am-data




UDM as ConsumerThe Table 2-3 provides information about the operations for UDM.

Table 2-3 Operations for UDM as Consumer


Notes

GET AuthenticationSubscriptionData

{apiRoot}/nudr-dr/v1/subscription-data/{ueId}/authentication-data/authentication-subscription

https://10.75.212.116:31873/nudr-dr/v1/subscription-data/msisdn-7777777779/authentication-data/authentication-subscription

Chapter 2UDM as Consumer

2-13















HTTPS://10.75.212.116:31873/NUDR-DR/V1/SUBSCRIPTION-DATA/MSISDN-7777777779/AUTHENTICATION-DATA/AUTHENTICATION-SUBSCRIPTION








Table 2-3 (Cont.) Operations for UDM as Consumer


Notes

PUT AuthenticationStatus {apiRoot}/nudr-dr/v1/subscription-data/{ueId}/authentication-data/authentication-status

https://10.75.212.116:31873/nudr-dr/v1/subscription-data/msisdn-7777777779/authentication-data/authentication-statusPayload: See PUT-AuthenticationStatus

GET AuthenticationStatus {apiRoot}/nudr-dr/v1/subscription-data/{ueId}/authentication-data/authentication-status

https://10.75.212.116:31873/nudr-dr/v1/subscription-data/msisdn-7777777779/authentication-data/authentication-status

GET AccessAndMobilitySubscriptionData

{apiRoot}/nudr-dr/v1/subscription-data/{ueId}/{servingPlmnId}/provisioned-data /am-data

-

Management URI Schema UpdateThe Table 2-4 table provides information about the operations supported for management URIschema update.

Table 2-4 Management URI for Schema Update

Operation Type URI Sample Schema Possible Error Codes

PUT https://localhost:9443/nudr-dr-mgm/v1/policy-data/schema/am-data

Adding new fieldcustom for am-data.Payload: See PUT-URI

• 405: "Operation notallowed" (for nudr-dr)

• 400: incase of jsonsyntax error withappropriate errormsg sent from SQLdb.

GET https://localhost:9443/nudr-dr-mgm/v1/policy-data/schema/am-data

405: "Operation notallowed" (for nudr-dr)

UDSF Data OperationsThe Table 2-5 table provides information about the UDSF Data Operations.

Chapter 2Management URI Schema Update

2-14















HTTPS://LOCALHOST:9443/NUDR-DR-MGM/V1/POLICY-DATA/SCHEMA/AM-DATA






Table 2-5 UDSF Data Operations

Operations Type URI Notes Possible Error codes

PUT https://localhost:9443/nudsf-dr/v1/udsf/msisdn-1111111111/udsf-data

Sample data blob forUDSF data could be:

{"a":1,"b":2}

• 400: "Invalid URIsent from client"

• 404: "Subscriberdoes not exist"

• 400: "Unknownkey, the keyprovided in therequest is invalid"

• 400: "Blob syntaxerror withcorresponding errordetails"

GET https://localhost:9443/nudsf-dr/v1/udsf/msisdn-1111111111/udsf-data

- • 400: "Invalid URIsent from client"


• 404: "Data fielddoes not exist"


DELETE https://localhost:9443/nudsf-dr/v1/udsf/msisdn-1111111111/udsf-data

- • 400: "Invalid URIsent from client"



List of Title and Type under Problem Details in ErrorResponse

The Table 2-6 table lists the titles which can be accompanied by any of the types given below.

Table 2-6 Titles and Type under Problem Details in Error Response

Error Codes Title Type

400 Bad request Invalid Data Content SchemaValidation Failure Invalid URIOccurrence Constraint ViolationKey Not Supported InvalidPayload Invalid Value InvalidJSON Format Invalid NumberFormat

404 Not Found Not Found405 Operation Not Allowed Operation Not Allowed

Chapter 2List of Title and Type under Problem Details in Error Response

2-15

HTTPS://LOCALHOST:9443/NUDSF-DR/V1/UDSF/MSISDN-1111111111/UDSF-DATA












Table 2-6 (Cont.) Titles and Type under Problem Details in Error Response

Error Codes Title Type

500 Internal Server Error Invalid Result Set Access DataAccess Denied Data AccessDenied/Resource FailureTemporary Resource FailureAcquire Lock Failure TransactionRollback

501 Not Implemented Bad SQL Grammar

Chapter 2List of Title and Type under Problem Details in Error Response

2-16

APayload Reference for PCF

This section provides the details of payloads for the following PCF Operations.

• PATCH-SessionManagementPolicyData

• PUT-UEPolicySet

• PATCH-UEPolicySet

• PUT-UsageMonitoringInformation

PATCH-SessionManagementPolicyData{"mk1": {"scopes": {"11-abc123": {"dnn": ["dnn1"],"snssai": {"sd":"abc123","sst":11}},"22-abc123": {"dnn": ["dnn2"],"snssai": {"sd":"abc123","sst":22}},"33-abc123": {"dnn": ["dnn1","dnn2"],"snssai": {"sd":"abc123","sst":33}}},"limitId":"mk1","umLevel":"SERVICE_LEVEL","resetTime":"2018-01-02T08:17:14.090Z","allowedUsage": {"duration":9000,"totalVolume":8888,"uplinkVolume":6666,"downlinkVolume":7777}},"mk5": {"scopes": {"11-abc123": {"dnn": ["dnn1"],"snssai": {"sd":"abc123","sst":11}},"22-abc123": {"dnn": ["dnn2"],"snssai": {"sd":"abc123","sst":22}},"33-abc123": {"dnn": ["dnn1","dnn2"],"snssai": {"sd":"abc123","sst":33}}},"limitId":"mk5","umLevel":"SERVICE_LEVEL","resetTime":"2018-01-02T08:17:14.090Z","allowedUsage": {"duration":9000,"totalVolume":8888,"uplinkVolume":6666,"downlinkVolume":7777}}}

PUT-UEPolicySet{"subscCats": ["cat1","cat2"],"uePolicySections": {"111": {"upsi":"111","uePolicySectionInfo":null},"33": {"upsi":"33","uePolicySectionInfo":null}},"upsis": ["111","33"]}

PATCH-UEPolicySet{"subscCats": ["cat1","cat2"],"uePolicySections": {"111": {"upsi":"111","uePolicySectionInfo":null},"33": {"upsi":"33","uePolicySectionInfo":null}},"upsis": ["111","33"]}

A-1

PUT-UsageMonitoringInformation{"scopes": {"11-abc123": {"dnn": ["mydnn1"],"snssai": {"sd":"abc123","sst":11}},"22-abc123": {"dnn": ["dnn2"],"snssai": {"sd":"abc123","sst":22}},"33-abc123": {"dnn": ["dnn1","dnn2"],"snssai": {"sd":"abc123","sst":33}}},"limitId":"mk1","umLevel":"SERVICE_LEVEL","resetTime":"2018-01-02T08:17:14.090Z","allowedUsage": {"duration":9000,"totalVolume":8888,"uplinkVolume":6666,"downlinkVolume":7777}}

Appendix APUT-UsageMonitoringInformation

A-2

BPayload Reference for Provisioning System

This section provides the details of payloads for the following Provisioning System Operations.

• PUT-ProfileData

• PUT-AccessAndMobilityPolicyData

• PUT-SessionManagementPolicyData

• PUT-UEPolicySet

• PUT-AuthenticationSubscriptionData

• PUT-AuthenticationStatus

• PUT-AccessAndMobilitySubscriptionData

PUT-ProfileData{ "subscCats": ["cat1", "cat2"]}

PUT-AccessAndMobilityPolicyData{"subscCats": ["cat1","cat2"]}

PUT-SessionManagementPolicyData{"umData": {"mk1": {"scopes": {"11-abc123": {"dnn": ["dnn1"],"snssai": {"sd":"abc123","sst":11}},"22-abc123": {"dnn": ["dnn2"],"snssai": {"sd":"abc123","sst":22}},"33-abc123": {"dnn": ["dnn1","dnn2"],"snssai": {"sd":"abc123","sst":33}}},"limitId":"mk1","umLevel":"SERVICE_LEVEL","resetTime":"2018-01-02T08:17:14.090Z","allowedUsage": {"duration":9000,"totalVolume":8888,"uplinkVolume":6666,"downlinkVolume":7777}},"mk2": {"scopes": {"11-abc123": {"dnn": ["dnn1"],"snssai": {"sd":"abc123","sst":11}},"22-abc123": {"dnn": ["dnn2"],"snssai": {"sd":"abc123","sst":22}},"33-abc123": {"dnn": ["dnn1","dnn2"],"snssai": {"sd":"abc123","sst":33}}},"limitId":"mk2","umLevel":"SERVICE_LEVEL","resetTime":"2018-01-02T08:17:14.090Z","allowedUsage": {"duration":9000,"totalVolume":8888,"uplinkVolume":6666,"downlinkVolume":7777}}},"umDataLimits": {"mk1": {"scopes": {"11-abc123": {"dnn": ["dnn1"],"snssai": {"sd":"abc123","sst":11}},"22-abc123": {"dnn": ["dnn2"],"snssai": {"sd":"abc123","sst":22}},"33-abc123": {"dnn": ["dnn1","dnn2"],"snssai": {"sd":"abc123","sst":33}}},"endDate":"2018-11-05T08:17:14.090Z","limitId":"mk1","umLevel":"SESSION_LEVEL","startDate":"2018-09-05T08:17:14.090Z","usageLimit": {"duration":6000,"totalVolume":9000,"uplinkVolume":5000,"downlinkVolume":4000},"resetPeriod": {"period":"WEEKLY","maxNumPeriod":2}}},"smPolicySnssaiData": {"11-abc123": {"snssai": {"sd":"abc123","sst":11},"smPolicyDnnData": {"dnn1": {"dnn":"dnn1","gbrDl":"7788 Kbps","gbrUl":"5566 Kbps","online":true,"chfInfo":

B-1

{"primaryChfAddress":"1.1.1.1","secondaryChfAddress":"2.2.2.2"},"offline":true,"ipv4Index":0,"ipv6Index":0,"subscCats": ["cat1","cat2"],"adcSupport":true,"mpsPriority":true,"allowedServices": ["ser1","ser2"],"mpsPriorityLevel":2,"imsSignallingPrio":true,"refUmDataLimitIds": {"mk1": {"monkey": ["monkey1"],"limitId":"mk1"}},"subscSpendingLimits":true}}},"22-abc123": {"snssai": {"sd":"abc123","sst":22},"smPolicyDnnData": {"dnn2": {"dnn":"dnn2","gbrDl":"7788 Kbps","gbrUl":"5566 Kbps","online":true,"chfInfo": {"primaryChfAddress":"1.1.1.1","secondaryChfAddress":"2.2.2.2"},"offline":true,"ipv4Index":0,"ipv6Index":0,"subscCats": ["cat1","cat2"],"adcSupport":true,"mpsPriority":true,"allowedServices": ["ser1","ser2"],"mpsPriorityLevel":2,"imsSignallingPrio":true,"refUmDataLimitIds": {"mk1": {"monkey": ["monkey1"],"limitId":"mk1"}},"subscSpendingLimits":true}}},"33-abc123": {"snssai": {"sd":"abc123","sst":33},"smPolicyDnnData": {"dnn1": {"dnn":"dnn1","gbrDl":"7788 Kbps","gbrUl":"5566 Kbps","online":true,"chfInfo": {"primaryChfAddress":"1.1.1.1","secondaryChfAddress":"2.2.2.2"},"offline":true,"ipv4Index":0,"ipv6Index":0,"subscCats": ["cat1","cat2"],"adcSupport":true,"mpsPriority":true,"allowedServices": ["ser1","ser2"],"mpsPriorityLevel":2,"imsSignallingPrio":true,"refUmDataLimitIds": {"mk1": {"monkey": ["monkey1"],"limitId":"mk1"}},"subscSpendingLimits":true},"dnn2": {"dnn":"dnn2","gbrDl":"7788 Kbps","gbrUl":"5566 Kbps","online":true,"chfInfo": {"primaryChfAddress":"1.1.1.1","secondaryChfAddress":"2.2.2.2"},"offline":true,"ipv4Index":0,"ipv6Index":0,"subscCats": ["cat1","cat2"],"adcSupport":true,"mpsPriority":true,"allowedServices": ["ser1","ser2"],"mpsPriorityLevel":2,"imsSignallingPrio":true,"refUmDataLimitIds": {"mk1": {"monkey": ["monkey1"],"limitId":"mk1"}},"subscSpendingLimits":true}}}}}

PUT-UEPolicySet{"subscCats": ["cat1","cat2"],"uePolicySections": {"111": {"upsi":"111","uePolicySectionInfo":null},"33": {"upsi":"33","uePolicySectionInfo":null}},"upsis": ["111","33"]}

PUT-AuthenticationSubscriptionData{"permanentKey": {"encryptionKey":45463,"permanentKeyValue":"FAC123","encryptionAlgorithm":1512212},"sequenceNumber":"AB1","authenticationMethod":"5G_AKA","sharedAuthenticationSubscriptionId": {"sharedDataId":"123-45-98765-123456-43210"}}

PUT-AuthenticationStatus{"nfInstanceId":"34e8b7af-bcf3-4ec4-b94d-67e06c2cf8bb","success":true,"timeStamp":"2018-01-02T08:17:14.090Z","authType":"EAP_AKA_PRIME","servingNetworkName":"5G:mnc555.mcc440.3gppnetwork.org"}

PUT-AccessAndMobilitySubscriptionData{"supportedFeatures":"0","gpsis": ["msisdn-2251433282984","extid-TX"],"internalGroupIds": ["bfF92beb-162-09-3B73c1","e3bB528a-739-79-35b7C4"],"subscribedUeAmbr": {"uplink":"20 Mbps","downlink":"10 Gbps"},"nssai": {"supportedFeatures":"2","defaultSingleNssais": [{"sst":20,"sd":"AAde65"}],"singleNssais": [{"sst":

Appendix BPUT-UEPolicySet

B-2

100,"sd":"BA3445"}]},"ratRestrictions": ["WLAN"],"forbiddenAreas": [{"tacs":"Bbb5","areaCode":"jpn"},{"tacs":"FBAB","areaCode":"jayn"}],"serviceAreaRestriction": {"restrictionType":"ALLOWED_AREAS","areas": [{"tacs":"2761","areaCode":"bmh"},{"tacs":"83dd","areaCode":"mrth"}],"maxNumOfTAs":2},"coreNetworkTypeRestrictions": ["EPC"],"rfspIndex":167,"subsRegTimer":22,"ueUsageType":11,"mpsPriority":false,"mcsPriority":true,"activeTime":2343,"dlPacketCount":34353426,"sorInfo": {"steeringContainer": [{"plmnId": {"mcc":"976","mnc":"32"},"accessTechList": ["EUTRAN_IN_NBS1_MODE_ONLY","EUTRAN_IN_WBS1_MODE_ONLY"]},{"plmnId": {"mcc":"362","mnc":"91"},"accessTechList": ["UTRAN","GSM_AND_ECGSM_IoT"]}],"ackInd":true,"sorMacIausf":"Cbb5D1EbEb0184896E57C6e6a2Cf6e10","countersor":"EfA8"},"micoAllowed":false,"sharedAmDataIds": ["465208-Zp","14994-1"],"odbPacketServices":"ROAMER_ACCESS_HPLMN_AP"}

Appendix BPUT-AccessAndMobilitySubscriptionData

B-3

CPayload Reference for UDM

This section provides the details of payloads for the following UDM Operations.

• PUT-AuthenticationStatus

PUT-AuthenticationStatus { "nfInstanceId": "34e8b7af-bcf3-4ec4-b94d-67e06c2cf8bb", "success": true, "timeStamp": "2018-01-02T08:17:14.090Z", "authType": "EAP_AKA_PRIME", "servingNetworkName": "5G:mnc555.mcc440.3gppnetwork.org"}

C-1

DPayloads for Management URI Schema Update

This section provides the details of payloads for the following Management URI SchemaUpdate.

• PUT-URI

PUT-URI{"type":"object","$schema":" ="">http://json-schema.org/draft-07/schema#" ,"properties": {"subscCats": {"type":"array","items": {"type":"string"}},"custom": {"type":"string"}},"definitions": {},"additionalProperties":false}

.

D-1

HTTP://JSON-SCHEMA.ORG/DRAFT-07/SCHEMA

) REST Cloud Native Specification Document REST... · 2019-04-19 · • Application data...

Documents

Transcript of ) REST Cloud Native Specification Document REST... · 2019-04-19 · • Application data...