2 REST Specifications

This section provides information about REST specifications used in Policy Control Function (PCF).

Resource Name: Data Sources

Table 2-1 Supported REST APIs - Data Sources

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
Data Sources	/ocpm/common/v1/configuration/datasources	POST	Create Data Sources	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
Data Sources	/ocpm/common/v1/configuration/datasources/{datasourceName}	GET	Get Data Source	200: OK Data Source is returned. 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
Data Sources	​/ocpm/common/v1/configuration/datasources/{datasourceName}	PUT	update Data Source	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout
Data Sources	/ocpm/common/v1/configuration/datasources/{datasourceName}	DELETE	Delete Data Source	200: Resource deleted successfully 204: No Content 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable

Resource Standard Methods

POST, GET, and PUT - Create, Get, and Update Data Sources

Table 2-2 Data structures supported by the POST, GET, and PUT Response Body

Field Name	Data Type	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
admin_state	boolean	O	1	when value is set to true, datasource (sh/sy) interaction takes place. Default Value: true
description	String	O	1	Details about the data source.
enable_subscription	boolean	O	1	Indicates whether MPE needs to subscribe to notifications from SH. Default Value: true
name	String	O	1	Data Source Name
primary_server	array	M	1	Primary data source server. The LDAP connection will be established with primary data source.
quaternary_server	array	O	1	Quaternary data source server. If primary , secondary and tertiary are not reachable then LDAP connection will be established with tertiary (if available) .
read_connection	number	O	1	Number of read connections established with data source.
realm	string	O	1	Defines the realm of the primary and optional secondary servers to connect (required).
role	string	O	1	only relevant for “Sy” datasource type. Possible values are: Primary – Irrespective of policy deployed, interaction with datasource will happen. Secondary – On Demand – When policy demands, then only interaction with datasource happens.
search_criteria	array	O	1	The criteria on which the data source search will be performed.
search_filter	array	O	1
secondary_server	array	O	1	Secondary data source server. If Primary server is not reachable, then LDAP connection will be established with secondary (if available).
sh_profile	string	O	1	Define the Sh Profile to use with this data source.
tertiary_server	array	O	1	Tertiary data source server. If primary and secondary are not reachable, then LDAP connection will be established with tertiary (if available) .
timer_profile	string	O	1
type	string	O	1	Type of data source. Possible values are: Sh, Sy, and LDAP
use_notif_eff	boolean	O	1	Specifies the User Data Request / Answer will allow multiple data references, Service Indications, and Identity Sets. The User Data Answer will be able to combine DataReference items resulting in the User Data Answer contents including a single XML document with the separate XML sections populated.

DELETE - delete data source

Table 2-3 Data structures supported by the DELETE Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
Data Source Name	string		M	1	Data Source Name

Resource Name: Peer Node

Table 2-4 Supported REST APIs - Peer Node

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
Peer Node	/ocpm/common/v1/configuration/diameter/peernodes	POST	Create Peer Node	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
Peer Node	/ocpm/common/v1/configuration/diameter/peernodes/{peernodeName}	GET	Get Peer Node	200: OK Peer Node is returned. 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
Peer Node	​/ocpm​/common/v1​/configuration​/diameter​/peernodes​/{peernodeName}	PUT	update Peer Node	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout
Peer Node	/ocpm/common/v1/configuration/diameter/peernodes/{peernodeName}	DELETE	Delete Peer Node	200: Resource deleted successfully 204: No Content 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable

Resource Standard Methods

GET and PUT - Get, Create, and Update Peer Node

Table 2-5 Data structures supported by the GET and PUT Response Body

Field Name	Data Type	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
diamName	String	O	1	Unique Name of the Peer Node
dtype	String	O	1	Defines which type of Diameter Service it should take up. The value can be Application function (af) or diameter routing agent(dra).
host	String	O	1	The host name. Enter a FQDN, ipv4 or ipv6 address available for establishing diameter transport connections to the peer node.
identity	String	O	1	An identity to define a node in a realm.
initiateConnection	boolean	O	1	Set it to True to initiate a connection for this peer node. Default Value: FALSE
port	Number	O	1	The port number. Enter a number from 0 to 65535.
realm	String	O	1	The realm name, that is, FQDNs to all of that computers that transact diameter traffic.
reconnectLimit	Number

DELETE - delete peer node

Table 2-6 Data structures supported by the DELETE Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
Peer Node Name	string		M	1	Peer Node Name

Resource Name: Diameter Settings

Table 2-7 Supported REST APIs - Diameter Settings

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
Diameter Settings	/ocpm/common/v1/configuration/diameter/settings	GET	Get Diameter Settings	200: OK Diameter Settings are returned. 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
Diameter Settings	/ocpm/common/v1/configuration/diameter/settings	PUT	update Diameter Settings	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout

Resource Standard Methods

GET and PUT - Get and Update diameter settings

Table 2-8 Data structures supported by the GET and PUT Response Body

Field Name	Data Type	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
timer	timer	O
transport	transport	O

Table 2-9 timer

Field Name	Data Type	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
connectionTimeout	Number	O	1	Defines the connection timeout interval in seconds. The default is 3 seconds.
reconnectDelay	Number	O	1	Defines the time frame to delay before attempting to reconnect after a connection failure in seconds. The default is 3 seconds.
responseTimeout	Number	O	1	Defines the response timeout interval in seconds. The default is 5 seconds.
watchdogInterval	Number	O	1	Defines the watchdog interval in seconds. The default is 6 seconds.

Table 2-10 transport

Field Name	Data Type	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
protocol	string	O

Resource Name: Global Configurations

Table 2-11 Supported REST APIs - Global configurations

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
Global Configurations	/ocpm/pcf/v1/configuration/global	GET	Get individual global configuration	200: OK Global configuration is returned 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
Global Configurations	/ocpm/pcf/v1/configuration/global	PUT	update global configuration	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout

Resource Standard Methods

GET and PUT - Get and Update individual global configuration

Table 2-12 Data structures supported by the GET and PUT Response Body

Field Name	Data Type	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
apiGatewayHost	String	O	1	Name for the API gateway host
apiGatewayPort	Number	O	1	Port number of the API gateway
enableMetrics	boolean	O	1	This determines if system metrics is enabled. This will take priority on global metrics config. Default Value: TRUE
enableTLS	boolean	O	1	This determines if TLS is enabled. Default Value: TRUE
enableTracing	boolean	O	1	This determines if tracing is enabled. Default Value: TRUE

Resource Name: Service Area Restrictions

Table 2-13 Supported REST APIs - Service Area Restrictions

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
Service Area Restrictions	/ocpm/pcf/v1/configuration/policy/am/servicearearestrictions	POST	Create service area restriction	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/am/servicearearestrictions/{serviceAreaRestrictionName}	GET	Get service area restriction	200: Resource fetched successfully 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/am/servicearearestrictions/{serviceAreaRestrictionName}	PUT	Update service area restriction	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout
	/ocpm/pcf/v1/configuration/policy/am/servicearearestrictions/{serviceAreaRestrictionName}	DELETE	Delete service area restriction	200: Resource deleted successfully 204: No Content 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable

Resource Standard Methods

GET, POST, and PUT - Get, create, and update service area restriction

Table 2-14 Data structures supported by the GET , POST and PUT Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
areas	ServiceAreaRestrictionAreas		O	1	A list of Areas. These areas are: allowed areas if RestrictionType is "ALLOWED_AREAS" not allowed areas if RestrictionType is "NOT_ALLOWED_AREAS
description	Number		O	1	Specifies description of the Service Area Restriction
maxNumOfTAs	boolean		O	1	Specifies maximum number of TAs
name	string		M	1	Specifies name of the Service Area Restriction
restrictionType	ENUM	ALLOWED_AREAS, NOT_ALLOWED_AREAS	O	1	Possible values are: ALLOWED_AREAS NOT_ALLOWED_AREAS

Table 2-15 ServiceAreaRestrictionAreas

Field Name	Data Type	Description
areaCodes	String	Specifies area codes.
tacs	String	List of Type Allocation Codes. A decimal number between 0 and 65535.

DELETE - delete service area restriction

Table 2-16 Data structures supported by the DELETE Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
serviceAreaRestrictionName	string		M	1	Service Area Restriction Name

Resource Name: Presence Reporting Area

Table 2-17 Supported REST APIs - Presence Reporting Area

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
Presence Reporting Area	/ocpm/pcf/v1/configuration/policy/common/pras	POST	Create presence reporting area	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/common/pras/{presenceReportingAreaName}	GET	Get presence reporting area	200: OK 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/am/servicearearestrictions/{serviceAreaRestrictionName}	PUT	Update presence reporting area	200: OK 201: Updated 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout
	/ocpm/pcf/v1/configuration/policy/am/servicearearestrictions/{serviceAreaRestrictionName}	DELETE	Delete presence reporting area	200: OK 204: No Content. Presence Reporting Area was successfully deleted 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable

Resource Standard Methods

GET, POST, and PUT - Get, create, and update presence reporting area

Table 2-18 Data structures supported by the GET , POST and PUT Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)aints	Cardinality	Description
ecgiList	PresenceReportingAreaEcgiList		O	1	Represents the list of tracking areas that constitutes the area. This IE shall be present if the subscription or the event report is for tracking UE presence in the tracking areas. For non 3GPP access the TAI shall be the N3GPP TAI.
globalRanNodeIdList	PresenceReportingAreaglobalRanNodeIdList		O	1	Represents the list of NG RAN node identifiers that constitutes the area. This IE shall be present if the Area of Interest subscribed is a list of NG RAN node identifiers.
name	string		M	1	The unique name assigned to the PRA.
praId	String		M	1	The unique identifying number of the PRA list. The ID must be numeric value between 0 and 16777125.
ncgiList	PresenceReportingAreaNcgiList		O	1	Represents the list of NR cell Ids that constitutes the area. This IE shall be present if the Area of Interest subscribed is a list of NR cell Ids.
presenceState	ENUM	IN_AREA, OUT_OF_AREA, UNKNOWN, INACTIVE	O	1	Indicates whether the UE is inside or outside of the area of interest (e.g presence reporting area or the LADN area), or if the presence reporting area is inactive in the serving node. Select any one of the following values: IN_AREA : Indicates that the UE is inside or enters the presence reporting area. OUT_OF_AREA : Indicates that the UE is outside or leaves the presence reporting area. UNKNOWN : Indicates it is unknown whether the UE is in the presence reporting area or not. INACTIVE : Indicates that the presence reporting area is inactive in the serving node.
trackingAreaList	PresenceReportingAreaTrackingAreaList		O	1	Represents the list of tracking areas that constitutes the area. This IE shall be present if the subscription or the event report is for tracking UE presence in the tracking areas. For non 3GPP access the TAI shall be the N3GPP TAI.

Table 2-19 PresenceReportingAreaEcgiList

Field Name	Data Type	Mandatory(M)/Optional(O)/Conditional(C)	Description
eutraCellId	String, enter a 7 digit hexadecimal value	M	28-bit string identifying an E-UTRA Cell Id as specified in hexadecimal representation. Each character in the string shall take a value of "0" to "9" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id shall appear first in the string, and the character representing the 4 least significant bit of the Cell Id shall appear last in the string. Pattern: '^[A-Fa-f0-9]{7}$' Example: An E-UTRA Cell Id 0x5BD6007 shall be encoded as "5BD6007".
plmnId	PlmnId	M	PLMN Identity

Table 2-20 PresenceReportingAreaglobalRanNodeIdList

Field Name	Data Type	Mandatory(M)/Optional(O)/Conditional(C)	Description
gNbId	GNbId		This field is included if the RAN Node Id represents a gNB. When present, this field contains the identifier of the gNB.
n3IwfId	string		This field is included if the RAN node belongs to non 3GPP access (i.e a N3IWF). If included, this field contains the FQDN of the N3IWF.
ngeNbId	string		This field is included if the RAN Node Id represents a NG-eNB. When present, this field contains the identifier of an NG-eNB.
plmnId	PlmnId	M	Indicates the identity of the PLMN that the RAN node belongs to.

Table 2-21 PlmnId

Field Name	Data Type	Mandatory(M)/Optional(O)/Conditional(C)	Description
mcc	String	M	Specifies a Mobile Country Code of the PLMN. enter a 2 or 3 digit number.
mnc	Stirng	M	Specifies a Mobile Network Code of the PLMN. enter a 2 or 3 digit number.

Table 2-22 PresenceReportingAreaNcgiList

Field Name	Data Type	Mandatory(M)/Optional(O)/Conditional(C)	Description
nrCellId	String, enter a 9 digit hexadecimal value	M	36-bit string identifying an NR Cell Id as specified in hexadecimal representation. Each character in the string shall take a value of "0" to "9" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id shall appear first in the string, and the character representing the 4 least significant bit of the Cell Id shall appear last in the string. Pattern: '^[A-Fa-f0-9]{9}$' Example: An NR Cell Id 0x225BD6007 shall be encoded as "225BD6007".
plmnId	PlmnId	M	PLMN Identity

Table 2-23 PresenceReportingAreaTrackingAreaList

Field Name	Data Type	Mandatory(M)/Optional(O)/Conditional(C)	Description
plmnId	PlmnId		PLMN Identity
tac	string, enter a 4 or 6 digit hexadecimal value		28-bit string identifying an E-UTRA Cell Id as specified, in hexadecimal representation. Each character in the string shall take a value of "0" to "9" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id shall appear first in the string, and the character representing the 4 least significant bit of the Cell Id shall appear last in the string. Pattern: '^[A-Fa-f0-9]{7}$' Example: An E-UTRA Cell Id 0x5BD6007 shall be encoded as "5BD6007".

DELETE - Delete presence reporting area

Table 2-24 Data structures supported by the DELETE Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
presenceReportingAreaName	string		M	1	Presence Reporting Area Name

Resource Name: Charging Data

Table 2-25 Supported REST APIs - Charging Data

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
Charging Data	/ocpm/pcf/v1/configuration/policy/smpolicy/chargingdata	POST	Create charging data	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/smpolicy/chargingdata/{chargingDataName}	GET	Get charging data	200: OK 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/smpolicy/chargingdata/{chargingDataName}	PUT	Update charging data	200: Update Charging Data 201: Updated 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout
	/ocpm/pcf/v1/configuration/policy/smpolicy/chargingdata/{chargingDataName}	DELETE	Delete charging data	200: OK 204: Charging Data was successfully deleted 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable

Resource Standard Methods

GET, POST, and PUT - Get, create, and update charging data

Table 2-26 Data structures supported by the GET , POST and PUT Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)aints	Cardinality	Description
afChargingIdentifiercgiList	integer ($int64), Enter a value between 0 and 4294967295		O	1	Univocally identifies the charging control policy data within a PDU session.
appSvcProvId	string		O	1	Indicates the application service provider identity.
chgId	string		M		Specifies the charging id.
description	string		O	1	The description of the Charging Data.
meteringMethod	ENUM	DURATION, VOLUME, DURATION_VOLUME, EVENT	O	1	The following options are available DURATION VOLUME DURATION_VOLUME EVENT Defines what parameters shall be metered for offline charging. If the attribute is not present but it has been supplied previously, the previous information remains valid. If the attribute is not present and it has not been supplied previously or the attribute has been supplied previously but the attribute is set to NULL, the metering method pre-configured at the SMF is applicable as default metering method.
name	string		M	1	The name of the Charging Data.
offline	boolean		O	1	Indicates the offline charging is applicable to the PDU session or PCC rule. The default value "FALSE" shall apply, if the attribute is not present and has not been supplied previously. (NOTE)
online	boolean		O	1	Indicates the online charging is applicable to the PDU session or PCC rule. The default value "FALSE" shall apply, if the attribute is not present and has not been supplied previously. (NOTE)
ratingGroup	integer ($int64), Enter a value between 0 and 4294967295		O	1	The charging key for the PCC rule used for rating purposes.
reportingLevel	ENUM	SER_ID_LEVEL, RAT_GR_LEVEL, SPON_CON_LEV	O	1	The following options are available: SER_ID_LEVEL RAT_GR_LEVEL SPON_CON_LEVEL Defines on what level the SMF reports the usage for the related PCC rule. If the attribute is not present but it has been supplied previously, the previous information remains valid. If the attribute is not present and it has not been supplied previously or the attribute has been supplied previously but it is set to NULL, the reporting level pre-configured at the SMF is applicable as default reporting level.
serviceId	integer ($int64), Enter a value between 0 and 4294967295		O	1	Indicates the identifier of the service or service component the service data flow in a PCC rule relates to.
sponsorId	string		O	1	Indicates the sponsor identity.

DELETE - Delete charging data

Table 2-27 Data structures supported by the DELETE Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
chargingDataName	string		M	1	Charging Data Name

Resource Name: Condition Data

Table 2-28 Supported REST APIs - Condition Data

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
Condition Data	/ocpm/pcf/v1/configuration/policy/smpolicy/conditiondata	POST	Create condition data	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/smpolicy/conditiondata/{conditionDataName}	GET	Get condition data	200: OK 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/smpolicy/conditiondata/{conditionDataName}	PUT	Update condition data	200: Updated condition Data 201: Updated 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout
	/ocpm/pcf/v1/configuration/policy/smpolicy/conditiondata/{conditionDataName}	DELETE	Delete condition data	200: OK 204: condition Data was successfully deleted 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable

Resource Standard Methods

GET, POST, and PUT - Get, create, and update condition data

Table 2-29 Data structures supported by the GET , POST and PUT Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)aints	Cardinality	Description
activationTime	string, example : YYYY-MM-DDTHH:MM:SS		O	1	The time when the decision data shall be activated.
condId	string		O	1	Specifies the condition ID.
deactivationTime	string example : YYYY-MM-DDTHH:MM:SS		O	1	The time when the decision data shall be deactivated.
description	string		O	1	The description of the Condition Data policy data.
name	string		M	1	The name of the Condition Data policy data.

DELETE - Delete condition data

Table 2-30 Data structures supported by the DELETE Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
conditionDataName	string		M	1	The name of the Condition Data policy data.

Resource Name: PCC Rule Profile

Table 2-31 Supported REST APIs - PCC Rule Profile

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
PCC Rule Profile	/ocpm/pcf/v1/configuration/policy/smpolicy/pccruleprofiles	POST	Create PCC Rule Profile	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/smpolicy/pccruleprofiles/{pccRuleProfileName}	GET	Get PCC Rule Profile	200: OK 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/smpolicy/pccruleprofiles/{pccRuleProfileName}	PUT	Update PCC Rule Profile	200: Updated PCC Rule Profile 201: Updated 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout
	/ocpm/pcf/v1/configuration/policy/smpolicy/pccruleprofiles/{pccRuleProfileName}	DELETE	Delete PCC Rule Profile	200: OK 204: PCC Rule Profile was successfully deleted 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable

Resource Standard Methods

GET, POST, and PUT - Get, create, and update PCC Rule Profile

Table 2-32 Data structures supported by the GET , POST and PUT Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)aints	Cardinality	Description
afSigProtocol	ENUM	NO_INFORMATION, SIP	O	1	Specifies the protocol used for signaling between the UE and the AF.
appId	string		O	1	A reference to the application detection filter configured at the UPF.
appReloc	boolean		O	1	Specifies application relocation possibility.
contVer	string		O	1	Specifies the content version of the PCC rule.
description	string		O	1	Description of PCC Rule Profile.
flowInfos	FlowInfos		O	1	An array of IP flow packet filter information.
id	string		M		Unique identifier of PCC Rule Profile
name	string		M		Specifies the name of PCC Rule Profile.
precedence	string				Determines the order in which this PCC rule is applied relative to other PCC rules within the same PDU session. It shall be included if the flowInfos attribute is included or may be included if the appId attribute is included when the PCF initially provisions the PCC rule.
refChgData	string				A reference to the ChargingData policy decision type.
refCondData	string				A reference to the condition data.
refQosData	string				A reference to the QoSData policy type decision type.
refTcData	string				A reference to the TrafficControlData policy decision type.
refUmData	string				A reference to UsageMonitoringData policy decision type.
type	ENUM	DYNAMIC, PREDEFINED			Possible values are: DYNAMIC PREDEFINED

Table 2-33 FlowInfos

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
ethFlowDescription	ethFlowDescription			Defines a packet filter for an Ethernet flow.
flowDescription	string			Specifies the packet filters of the IP flow(s).
flowDirection	ENUM	DOWNLINK, UPLINK, BIDIRECTIONAL, UNSPECIFIED		Indicates the direction/directions that a filter is applicable, downlink only, uplink only or both down- and uplink (bidirectional).
flowLabel	string			Ipv6 flow label header field.
name	string		M
packFiltId	string			An identifier of packet filter.
packetFilterUsage	boolean			The packet shall be sent to the UE. The default value FALSE shall apply, if the attribute is not present and has not been supplied previously.
spi	string			Specifies the security parameter index of the IPSec packet.
tosTrafficClass	string			Specifies the Ipv4 Type-of-Service and mask field or the Ipv6 Traffic-Class field and mask field.

Table 2-34 ethFlowDescription

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
destMacAddr	string enter a MAC address ,such as'3D-F2-C9-A6-B3-4F'.			A string indicating MAC address. Enter a valid MAC address. For example, 3D-F2-C9-A6-B3-4F
ethType	string			A two-octet string that represents the Ethertype, in hexadecimal representation. Each character in the string shall take a value of "0" to "9" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the ethType shall appear first in the string, and the character representing the 4 least significant bits of the ethType shall appear last in the string.
fDesc	string			Indicates the details about flow. Enter a description for the flow.
fDir	ENUM	DOWNLINK, UPLINK, BIDIRECTIONAL, UNSPECIFIED		Indicates the flow direction. Select from the following options: DOWNLINK UPLINK BIDIRECTIONAL UNSPECIFIED
sourceMacAddr	string enter a MAC address ,such as'3D-F2-C9-A6-B3-4F'			Enter a MAC Address. For example, 3D-F2-C9-A6-B3-4F
vlanTags	string			Customer-VLAN and/or Service-VLAN tags containing the VID, PCP/DEI fields. Each field is encoded as a two-octet string in hexadecimal representation. Each character in the string shall take a value of "0" to "9" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the VID or PCF/DEI field shall appear first in the string, and the character representing the 4 least significant bits of the VID or PCF/DEI field shall appear last in the string.

DELETE - Delete PCC rule profile

Table 2-35 Data structures supported by the DELETE Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
PCCRuleProfileName	string		M	1	PCC Rule Profile Name

Resource Name: PCC Rule

Table 2-36 Supported REST APIs - PCC Rule

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
PCC Rule	/ocpm/pcf/v1/configuration/policy/smpolicy/pccrules	POST	Create PCC Rule	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/smpolicy/pccrules/{pccRuleName}	GET	Get PCC Rule	200: OK 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/smpolicy/pccrules/{pccRuleName}	PUT	Update PCC Rule	200: Updated PCC Rule 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout
	/ocpm/pcf/v1/configuration/policy/smpolicy/pccrules/{pccRuleName}	DELETE	Delete PCC Rule	200: OK 204: PCC Rule was successfully deleted 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable

Resource Standard Methods

GET, POST, and PUT - Get, create, and update PCC Rule

Table 2-37 Data structures supported by the GET , POST and PUT Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)aints	Cardinality	Description
afSigProtocol	ENUM	NO_INFORMATION, SIP	O	1	Indicates the protocol used for signalling between the UE and the AF. The default value "NO_INFORMATION" shall apply, if the attribute is not present and has not been supplied previously.
appId	string		O	1	A reference to the application detection filter configured at the UPF.
appReloc	boolean		O	1	Indication of application relocation possibility. The default value "NO_INFORMATION" shall apply, if the attribute is not present and has not been supplied previously.
contVer	string		O	1	Indicates the content version of the PCC rule.
description	string		O	1	The description of the PCC rule
flowInfos	FlowInfos		O	1	An array of IP flow packet filter information.
name	string		M		The name of the PCC rule
pccRuleId	string		M		Univocally identifies the PCC rule within a PDU session.
precedence	string		O		Determines the order in which this PCC rule is applied relative to other PCC rules within the same PDU session. It shall be included if the "flowInfos" attribute is included or may be included if the "appId" attribute is included when the PCF initially provisions the PCC rule.
refChgData	string		O		A reference to the ChargingData policy decision type.
refCondData	string		O		A reference to the condition data.
refQosData	string		O		A reference to the QoSData policy type decision type.
refTcData	string		O		A reference to the TrafficControlData policy decision type.
refUmData	string		O		A reference to UsageMonitoringData policy decision type.
type	ENUM	DYNAMIC, PREDEFINED	O

Table 2-38 FlowInfos

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
ethFlowDescription	ethFlowDescription		O	Ethernet Flow Description Information
flowDescription	string		O	Indicates the details about flow. Enter a description for the flow.
flowDirection	ENUM	DOWNLINK, UPLINK, BIDIRECTIONAL, UNSPECIFIED	O	Indicates the flow direction. Select from the following options: DOWNLINK UPLINK BIDIRECTIONAL UNSPECIFIED
flowLabel	string		O	The Ipv6 flow label header field.
name	string		M	Indicates the name for the flow
packFiltId	string		O	An identifier of packet filter
packetFilterUsage	boolean		O	The packet shall be sent to the UE. The default value "FALSE" shall apply, if the attribute is not present and has not been supplied previously
spi	string		O	The security parameter index of the IPSec packet.
tosTrafficClass	string		O	Contains the Ipv4 Type-of-Service and mask field or the Ipv6 Traffic-Class field and mask field.

Table 2-39 ethFlowDescription

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
destMacAddr	string enter a MAC address ,such as'3D-F2-C9-A6-B3-4F'.		O	A string indicating MAC address. Enter a valid MAC address. For example, 3D-F2-C9-A6-B3-4F
ethType	string		O	A two-octet string that represents the Ethertype, in hexadecimal representation. Each character in the string shall take a value of "0" to "9" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the ethType shall appear first in the string, and the character representing the 4 least significant bits of the ethType shall appear last in the string.
fDesc	string		O	Contains the flow description for the Uplink or Downlink IP flow. It shall be present when the Ethertype is IP.
fDir	ENUM	DOWNLINK, UPLINK, BIDIRECTIONAL, UNSPECIFIED	O	Indicates the packet filter direction. Select from the following options: DOWNLINK UPLINK BIDIRECTIONAL UNSPECIFIED
sourceMacAddr	string enter a MAC address ,such as'3D-F2-C9-A6-B3-4F'		O	Enter a source MAC Address. For example, 3D-F2-C9- A6-B3-4F
vlanTags	string		O	Customer-VLAN and/or Service-VLAN tags containing the VID, PCP/DEI fields. Each field is encoded as a two-octet string in hexadecimal representation. Each character in the string shall take a value of "0" to "9" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the VID or PCF/DEI field shall appear first in the string, and the character representing the 4 least significant bits of the VID or PCF/DEI field shall appear last in the string.

DELETE - Delete PCC Rule

Table 2-40 Data structures supported by the DELETE Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
PCCRuleName	string		M	1	PCC Rule Name

Resource Name: Policy Control Id

Table 2-41 Supported REST APIs - Policy Control Id

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
Policy Control Id	/ocpm/pcf/v1/configuration/policy/smpolicy/policycounterids	POST	Create Policy Control Id	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/smpolicy/policycounterids/{policyCounterIdName}	GET	Get Policy Control Id	200: OK 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/smpolicy/policycounterids/{policyCounterIdName}	PUT	Update Policy Control Id	200: Updated Policy Control Id 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout
	/ocpm/pcf/v1/configuration/policy/smpolicy/policycounterids/{policyCounterIdName}	DELETE	Delete Policy Control Id	200: OK 204: Policy Control Id was successfully deleted 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable

Resource Standard Methods

GET, POST, and PUT - Get, create, and update Policy Control Id

Table 2-42 Data structures supported by the GET , POST and PUT Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)aints	Cardinality	Description
defaultStatus	string		O	1	Specifies the default status of Policy Counter Id.
desc	string		O	1	Specifies the description of Policy Counter Id.
id	string		O		Specifies the ID of Policy Counter Id.
name	string		M	1	Specifies the name of Policy Counter Id.

DELETE - Delete Policy Control Id

Table 2-43 Data structures supported by the DELETE Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
policyControlIdName	string		M	1	Policy Counter Id's Name

Resource Name: QoS Data

Table 2-44 Supported REST APIs - QoS Data

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
QoS Data	/ocpm/pcf/v1/configuration/policy/smpolicy/qosdata	POST	Create QoS Data	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/smpolicy/qosdata/{qosDataName}	GET	Get QoS Data	200: OK 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/smpolicy/qosdata/{qosDataName}	PUT	Update QoS Data	200: Updated QoS Data 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout
	/ocpm/pcf/v1/configuration/policy/smpolicy/qosdata/{qosDataName}	DELETE	Delete QoS Data	200: OK 204:QoS Data was successfully deleted 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable

Resource Standard Methods

GET, POST, and PUT - Get, create, and update QoS Data

Table 2-45 Data structures supported by the GET , POST and PUT Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)aints	Cardinality	Description
5qi	string ($int32) enter a range in [0-255] number		O	1	Identifier for the authorized QoS parameters for the service data flow. It shall be included when the QoS data decision.
arp	Arp		O	1	ARP information
averwindow	string
defQosFlowIndication	boolean		O	1	Indicates that the dynamic PCC rule shall always have its binding with the QoS Flow associated with the default QoS rule. Default value is "FALSE", if not present and has not been supplied previously.
description	string		O		The description of the Qos Data
gbrDl	string , Enter a value starting with number and ending bps or Kbps or Mbps or Gbps or Tbps		O		Indicates the guaranteed bandwidth in downlink.
gbrUl	string , Enter a value starting with number and ending bps or Kbps or Mbps or Gbps or Tbps		O		Indicates the guaranteed bandwidth in uplink.
maxDataBurstVol	integer ($int32) Enter a value between 1 and 4095		O		Denotes the largest amount of data that is required to be transferred within a period of 5GAN PDB (NOTE).
maxPacketLossRateDl	integer ($int32) Enter a value between 0 and 1000		O		Indicates the downlink maximum rate for lost packets that can be tolerated for the service data flow.
maxPacketLossRateUl	integer ($int32) Enter a value between 0 and 1000		O		Indicates the uplink maximum rate for lost packets that can be tolerated for the service data flow.
maxbrDl	string , Enter a value starting with number and ending bps or Kbps or Mbps or Gbps or Tbps		O		Indicates the max bandwidth in downlink.
maxbrUl	string , Enter a value starting with number and ending bps or Kbps or Mbps or Gbps or Tbps		O		Indicates the max bandwidth in uplink.
name	string		M	1	The name of the Qos Data
priorityLevel	integer ($int32) Enter a value between 1 and 127		O		Defines the relative importance of a resource request.
qnc	boolean		O		Indicates whether notifications are requested from 3GPP NG-RAN when the GFBR can no longer (or again) be guaranteed for a QoS flow during the lifetime of the QoS flow.
qosId	string				Specifies the QoS Id.
reflectiveQos	boolean		O		Indicates whether the QoS information is reflective for the corresponding service data flow. Default value is "FALSE", if not present and has not been supplied previously.
sharingKeyDl	string		O		Indicates, by containing the same value, what PCC rules may share resource in downlink direction.
sharingKeyUl	string		O		Indicates, by containing the same value, what PCC rules may share resource in uplink direction.

Table 2-46 Arp

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
preemptCap	ENUM	NOT_PREEMPT, MAY_PREEMPT	M	Defines whether a service data flow may get resources that were already assigned to another service data flow with a lower priority level.
preemptVuln	ENUM	NOT_PREEMPTABLE, PREEMPTABLE	M	Defines whether a service data flow may lose the resources assigned to it in order to admit a service data flow with higher priority level.
priorityLevel	integer ($int32) enter a range in [1-15] number		M	Defines the relative importance of a resource request.

DELETE - Delete QoS Data

Table 2-47 Data structures supported by the DELETE Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
qosDataName	string		M	1	Qos Data Name

Resource Name: QoS Information

Table 2-48 Supported REST APIs - QoS Information

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
QoS Information	/ocpm/pcf/v1/configuration/policy/smpolicy/qosinformation	POST	Create QoS Information	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/smpolicy/qosinformation/{qosInformationName}	GET	Get QoS Information	200: OK 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/smpolicy/qosinformation/{qosInformationName}	PUT	Update QoS Information	200: Updated QoS Information 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout
	/ocpm/pcf/v1/configuration/policy/smpolicy/qosinformation/{qosInformationName}	DELETE	Delete QoS Information	200: OK 204: QoS Information was successfully deleted 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable

Resource Standard Methods

GET, POST, and PUT - Get, create, and update QoS Information

Table 2-49 Data structures supported by the GET , POST and PUT Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)aints	Cardinality	Description
5qi	string ($int32) enter a range in [0-255] number		O	1	Identifier for the authorized QoS parameters for the service data flow. It shall be included when the QoS data decision is initially provisioned.
arp	Arp		O	1	Indicates the allocation and retention priority. It shall be included when the Authorized Default QoS is initially provisioned.
averWindow	string example : 2000		O		Represents the duration over which the guaranteed and maximum bitrate shall be calculated (NOTE).
description	string		O		The description of the Qos Information.
maxDataBurstVol	string example : 2000				Denotes the largest amount of data that is required to be transferred within a period of 5GAN PDB (NOTE).
name	string		M	1	The name of the Qos Information.
priorityLevel	integer ($int32)		O		Unsigned integer indicating the 5QI Priority Level, within a range of 1 to 127.

Table 2-50 Arp

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
preemptCap	ENUM	NOT_PREEMPT, MAY_PREEMPT	M	Defines whether a service data flow may get resources that were already assigned to another service data flow with a lower priority level. Possible values are: NOT_PREEMPT : Shall not trigger pre-emption. MAY_PREEMPT : May trigger pre-emption.
preemptVuln	ENUM	NOT_PREEMPTABLE, PREEMPTABLE	M	Defines whether a service data flow may lose the resources assigned to it in order to admit a service data flow with higher priority level. Possible values are: NOT_PREEMPTABLE : Shall not be pre-empted. PREEMPTABLE : May be pre-empted.
priorityLevel	integer ($int32)		M	Unsigned integer indicating the ARP Priority Level, within the range 1 to 15.

DELETE - Delete QoS Information

Table 2-51 Data structures supported by the DELETE Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
qosInformationName	string		M	1	Qos Information Name

Resource Name: Session Rule Profile

Table 2-52 Supported REST APIs - Session Rule Profile

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
Session Rule Profile	/ocpm/pcf/v1/configuration/policy/smpolicy/sessionruleprofiles	POST	Create Session Rule Profile	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/smpolicy/sessionruleprofiles/{sessionRuleProfileName}	GET	Get Session Rule Profile	200: OK 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/smpolicy/sessionruleprofiles/{sessionRuleProfileName}	PUT	Update Session Rule Profile	200: Updated Session Rule Profile 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout
	/ocpm/pcf/v1/configuration/policy/smpolicy/sessionruleprofiles/{sessionRuleProfileName}	DELETE	Delete Session Rule Profile	200: OK 204: Session Rule Profile was successfully deleted 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable

Resource Standard Methods

GET, POST, and PUT - Get, create, and update Session Rule Profile

Table 2-53 Data structures supported by the GET , POST and PUT Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)aints	Cardinality	Description
authDefQosId	string		O	1	Authorized default QoS information
authSessAmbr	AuthSessAmbr		O	1	Authorized Session-AMBR
description	string				Specifies the description of the Session Rule Profile
name	string		M	1	Specifies the name of the Session Rule Profile
refCondData	stiring
sessRuleProfileId	string		M	1	Specifies the Session Rule Profile ID

Table 2-54 AuthSessAmbr

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
downlink	string		O	AMBR for downlink
uplink	string		O	AMBR for uplink

DELETE - Delete Session Rule Profile

Table 2-55 Data structures supported by the DELETE Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
sessionRuleProfileName	string		M	1	Session Rule Profile Name

Resource Name: Session Rule

Table 2-56 Supported REST APIs - Session Rule

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
Session Rule Profile	/ocpm/pcf/v1/configuration/policy/smpolicy/sessionrules	POST	Create Session Rule	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/smpolicy/sessionruleprofiles/{sessionRuleName}	GET	Get Session Rule	200: OK 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/smpolicy/sessionruleprofiles/{sessionRuleName}	PUT	Update Session Rule	200: Updated Session Rule 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout
	/ocpm/pcf/v1/configuration/policy/smpolicy/sessionruleprofiles/{sessionRuleName}	DELETE	Delete Session Rule	200: OK 204: Session Rule was successfully deleted 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable

Resource Standard Methods

GET, POST, and PUT - Get, create, and update Session Rule

Table 2-57 Data structures supported by the GET , POST and PUT Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)aints	Cardinality	Description
authDefQosId	string		O	1	Authorized default QoS information
authSessAmbr	AuthSessAmbr		O	1	Authorized Session-AMBR
description	string		O		Specifies the description of the Session Rule
name	string		M	1	Specifies the name of the Session Rule
refCondData	string				specifies the reference to the condition data
sessRuleId	string		M	1	Specifies the Session Rule ID

Table 2-58 AuthSessAmbr

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
downlink	string Enter a value starting with number and ending bps or Kbps or Mbps or Gbps or Tbps		O	AMBR for downlink
uplink	string Enter a value starting with number and ending bps or Kbps or Mbps or Gbps or Tbps		O	AMBR for uplink

DELETE - Delete Session Rule Profile

Table 2-59 Data structures supported by the DELETE Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
sessionRuleName	string		M	1	Session Rule Name

Resource Name:Traffic Control Data

Table 2-60 Supported REST APIs -Traffic Control Data

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
Traffic Control Data	/ocpm/pcf/v1/configuration/policy/smpolicy/trafficcontroldata	POST	Create Traffic Control Data	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/smpolicy/trafficcontroldata/{trafficControlDataName}	GET	Get Traffic Control Data	200: OK 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/smpolicy/trafficcontroldata/{trafficControlDataName}	PUT	Update Traffic Control Data	200: Updated Traffic Control Data 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout
	/ocpm/pcf/v1/configuration/policy/smpolicy/trafficcontroldata/{trafficControlDataName}	DELETE	Delete Traffic Control Data	200: OK 204: Traffic Control Data was successfully deleted 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable

Resource Standard Methods

GET, POST, and PUT - Get, create, and update Traffic Control Data

Table 2-61 Data structures supported by the GET , POST and PUT Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)aints	Cardinality	Description
description	string		O		The description of the Traffic Control policy data.
flowStatus	ENUM	ENABLED-UPLINK, ENABLED-DOWNLINK, ENABLED, DISABLED, REMOVED	O		The following options are available: ENABLED-UPLINK ENABLED-DOWNLINK ENABLED DISABLED REMOVED Enum determining what action to perform on traffic. Possible values are: [enable, disable, enable_uplink, enable_downlink] . The default value "ENABLED" shall apply, if the attribute is not present and has not been supplied previously.
muteNotif	boolean		O		Indicates whether application's start or stop notification is to be muted. The default value "FALSE" shall apply, if the attribute is not present and has not been supplied previously.
name	string		M	1	The name of the Traffic Control policy data.
redirectInfo	RedirectInfo		O	1	Redirect Information
routeToLocs	RouteToLocs		O		Route To Locs Information
tcId	string		O		Specifies the traffic control ID.
trafficSteeringPolIdDl	string		O		Reference to a pre-configured traffic steering policy for downlink traffic at the SMF.
trafficSteeringPolIdUl	string		O		Reference to a pre-configured traffic steering policy for uplink traffic at the SMF.
upPathChgEvent	UpPathChgEvent		O		Up Path Chg Event Information

Table 2-62 RedirectInfo

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
redirectAddressType	ENUM	IPV4_ADDR, IPV6_ADDR, URL, SIP_URI	O	This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
redirectEnabled	boolean		O	Indicates the redirect is enabled.
redirectServerAddress	string		O	Indicates the address of the redirect server.

Table 2-63 RouteToLocs

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
dnai	string		O	Identifies the location of the application.
routeInfo	RouteInfo		O	Includes the traffic routing information.
routeProfId	string		O	Identifies the routing profile Id.

Table 2-64 RouteInfo

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
ipv4Addr	string		O	Ipv4 address of the tunnel end point in the data network.
ipv6Addr	string		O	Ipv6 address of the tunnel end point in the data network
portNumber	integer ($int32) Enter a number greater than or equal to 0		O	UDP port number of the tunnel end point in the data network.

Table 2-65 UpPathChgEvent

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
dnaiChgType	ENUM	EARLY, EARLY_LATE, LATE	O	The following options are available: EARLY EARLY_LATE LATE Possible values are - EARLY: Early notification of UP path reconfiguration. - EARLY_LATE: Early and late notification of UP path reconfiguration. This value shall only be present in the subscription to the DNAI change event. - LATE: Late notification of UP path reconfiguration. This string provides forwardcompatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
notifCorreId	string		O	It is used to set the value of Notification Correlation ID in the notification sent by the SMF.
notificationUri	string		O

DELETE - Delete Traffic Control Data

Table 2-66 Data structures supported by the DELETE Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
trafficControlDataName	string		M	1	Traffic Control Data Name

Resource Name: Usage Monitoring Data

Table 2-67 Supported REST APIs - Usage Monitoring Data

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
Usage Monitoring Data	​/ocpm​/pcf​/v1​/configuration​/policy​/smpolicy​/usagemonitoringdata	POST	Create Usage Monitoring Data	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/smpolicy/usagemonitoringdata/{usageMonitoringDataName}	GET	Get Usage Monitoring Data	200: OK 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/smpolicy/usagemonitoringdata/{usageMonitoringDataName}	PUT	Update Usage Monitoring Data	200: Updated Usage Monitoring Data 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout
	/ocpm/pcf/v1/configuration/policy/smpolicy/usagemonitoringdata/{usageMonitoringDataName}	DELETE	Delete Usage Monitoring Data	200: OK 204: Usage Monitoring Data was successfully deleted 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable

Resource Standard Methods

GET, POST, and PUT - Get, create, and update Usage Monitoring Data

Table 2-68 Data structures supported by the GET , POST and PUT Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)aints	Cardinality	Description
description	string		O		The description of the UsageMonitoring Data.
exUsagePccRuleIds	string		O		Contains the PCC rule identifier(s) which corresponding service data flow(s) shall be excluded from PDU Session usage monitoring. It is only included in the UsageMonitoringData instance for session level usage monitoring.
inactivityTime	string		O		Defines the period of time after which the time measurement shall stop, if no packets are received.
monitoringTime	string		O	1	Indicates the time at which the UP function is expected to reapply the next thresholds (e.g. nextVolThreshold).
name	string		M	1	The name of the UsageMonitoring Data.
nextTimeThreshold	string		O		Indicates a time threshold after the Monitoring.
nextVolThreshold	string		O		Indicates a volume threshold after the Monitoring.
nextVolThresholdDownlink	string		O		Indicates a volume threshold in downlink after the Monitoring Time.
nextVolThresholdUplink	string		O		Indicates a volume threshold in uplink after the Monitoring Time.
timeThreshold	string		O		Indicates a time threshold.
umId	string		M		Specifies the usage monitoring data Id.
volumeThreshold	string		O		Indicates a volume threshold.
volumeThresholdDownlink	string		O		Indicates a volume threshold in downlink.
volumeThresholdUplink	string		O		Indicates a volume threshold in uplink.

DELETE - Delete Usage Monitoring Data

Table 2-69 Data structures supported by the DELETE Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
usageMonitoringDataName	string		M	1	Usage Monitoring Data Name

Resource Name: UPSI

Table 2-70 Supported REST APIs -UPSI

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
UPSI	/ocpm/pcf/v1/configuration/policy/userpolicy/upsis	POST	Create UPSI	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/userpolicy/upsis/{upsiName}	GET	Get UPSI	200: OK 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/userpolicy/upsis/{upsiName}	PUT	Update UPSI	200: Updated UPSI 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout
	/ocpm/pcf/v1/configuration/policy/userpolicy/upsis/{upsiName}	DELETE	Delete UPSI	200: OK 204: UPSI was successfully deleted 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable

Resource Standard Methods

GET, POST, and PUT - Get, create, and update UPSI

Table 2-71 Data structures supported by the GET , POST and PUT Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)aints	Cardinality	Description
name	string		M	1	Name of the UPSI.
plmn	Plmn		M	1	PLMN Identity
upsc	integer($int32) Enter a value between 0 and 65535.		M	1	Defines UE Policy Section Code. Enter a number between 0 and 65,535.
urspRules	string		O		Defines URSP rules.

Table 2-72 Plmn

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
mcc	string Valid Range [0-999]		M	Specifies a Mobile Country Code. enter a 2 or 3 digit number.
mnc	string Valid Range [0-999]		M	Specifies a Mobile Network Code. enter a 2 or 3 digit number.

DELETE - Delete UPSI

Table 2-73 Data structures supported by the DELETE Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
upsiName	string		M	1	UPSI Name

Resource Name: URSP

Table 2-74 Supported REST APIs -URSP

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
URSP	​/ocpm​/pcf​/v1​/configuration​/policy​/userpolicy​/ursps	POST	Create URSP	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/userpolicy/ursps/{urspName}	GET	Get URSP	200: OK 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/policy/userpolicy/ursps/{urspName}	PUT	Update URSP	200: Updated URSP 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout
	/ocpm/pcf/v1/configuration/policy/userpolicy/ursps/{urspName}	DELETE	Delete URSP	200: OK 204: URSP was successfully deleted 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable

Resource Standard Methods

GET, POST, and PUT - Get, create, and update URSP

Table 2-75 Data structures supported by the GET , POST and PUT Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)aints	Cardinality	Description
name	string		M	1	Name of the URSP rule.
precedence	integer($int32) Enter a value between 0 and 255.		M	1	Precedence value of the URSP rule.
routeSelectionDescriptorList	UrspRouteSelectionDescriptorList		O		List of URSP routes.
trafficDescriptors	TrafficDescriptorIE		O		List of traffic descriptors.

Table 2-76 UrspRouteSelectionDescriptorList

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
routePrecedence	integer($int32)		M
routeSelectionDescriptorComponents	RouteSelectionDescriptorComponentIE		M

Table 2-77 UrspRouteSelectionDescriptorList

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
routePrecedence	integer($int32)		O
routeSelectionDescriptorComponents	RouteSelectionDescriptorComponentIE		O

Table 2-78 RouteSelectionDescriptorComponentIE

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
routeSelectionDescriptorType	ENUM		O
value	RouteSelectionDescriptorComponent		O

Table 2-79 TrafficDescriptorIE

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
trafficDescriptorType	ENUM	SSC_MODE, SNSSAI, DNN, PDU_SESSION_TYPE, PREFERRED_ACCESS_TYPE, NON_SEAMLESS_NON_3GPP_OFFLOAD_INDICATION	O
value	RouteSelectionDescriptorComponent		O

Table 2-80 RouteSelectionDescriptorComponentIE

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
routeSelectionDescriptorType	ENUM	MATCH_ALL, OS_ID_OS_APP_ID, IPV4_REMOTE_ADDRESS, IPV6_REMOTE_ADDRESS, PROTOCOL_IDENTIFIER, SINGLE_REMOTE_PORT, REMOTE_PORT_RANGE, SECURITY_PARAMETER_INDEX, TYPE_OF_SERVICE_CLASS, FLOW_LABEL, DESTINATION_MAC_ADDRESS, T_802_1Q_C_TAG_VID, T_802_1Q_S_TAG_VID, ETHERTYPE, DNN, CONNECTION_CAPABILITIES, DESTINATION_FQDN, OS_APP_ID, T_802_1Q_C_TAG_PCP_DEI, T_802_1Q_S_TAG_PCP_DEI	O
value	TrafficDescriptorComponent		O

DELETE - Delete URSP

Table 2-81 Data structures supported by the DELETE Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
urspName	string		M	1	URSP Name

Resource Name: Access and Mobility Service

Table 2-82 Supported REST APIs - Access and Mobility Service

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
Access and Mobility Service	​ /ocpm/pcf/v1/configuration/service/am	GET	Get Access and Mobility Service	200: OK 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/service/am	PUT	Update Access and Mobility Service	200: Updated 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout

Resource Standard Methods

GET and PUT - Get and update Access and Mobility Service

Table 2-83 Data structures supported by the GET and PUT Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)aints	Cardinality	Description
app	AppConfiguration		O
system	AMServiceSystemConfiguration		O

Table 2-84 AppConfiguration

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
defaultRfsp	string		O	RFSP (Rat Frequency Selection Priority)
defaultServAreaResCfgId	string		O	SAR (Service Area Restriction)
defaultTriggers	ENUM	LOC_CH, PRA_CH, SERV_AREA_CH, RFSP_CH, UE_POLICY	O

Table 2-85 AMServiceSystemConfiguration

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
enableHttp2Client	boolean		O	Enables http2 client. Default Value: TRUE
isSubscribe	boolean		O	Indicates whether service is subscribed. Default Value: TRUE
isValidateUser	boolean		O	Determines if user validate is enabled. HTTP 400 with cause USER_UNKNOWN returns, if this is enabled and user not found in UDR. Default Value: FALSE
logList	AMServiceSystemConfigurationLogList		O
rootLogLevel	string, ENUM	TRACE, DEBUG, INFO, WARN, ERROR, ALWAYS	M	Indicates the log level of PCF Session Management (SM) service. Default Value: WARN
usePolicyService	boolean		O	If selected, uses the policy service. Component tracing is used to evaluate system process latency in detail level. Default Value:TRUE
useUserPolicy	boolean		O	If selected uses the user service. Default Value:TRUE

Table 2-86 AMServiceSystemConfigurationLogList

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
level	ENUM	TRACE, DEBUG, INFO, WARN, ERROR, ALWAYS	O
name	string		M

Resource Name: Policy Authorization Service

Table 2-87 Supported REST APIs - Policy Authorization Service

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
Policy Authorization Service	​ /ocpm/pcf/v1/configuration/service/pa	GET	Get Policy Authorization Service	200: OK 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/service/pa	PUT	Update Policy Authorization Service	200: Updated 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout

Resource Standard Methods

GET and PUT - Get and update Policy Authorization Service

Table 2-88 Data structures supported by the GET and PUT Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)aints	Cardinality	Description
imsEmergencySession	IMSEmergencySessionPAServiceConfiguration		O
system	PAServiceSystemConfiguration		O

Table 2-89 IMSEmergencySessionPAServiceConfiguration

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
emergencyServiceURNs	string Any number of values are permitted for Emergency Service URNs		O
reservationPriorityTypes	ENUM	PRIO_1, PRIO_2, PRIO_3, PRIO_4, PRIO_5, PRIO_6, PRIO_7, PRIO_8, PRIO_9, PRIO_10, PRIO_11, PRIO_12, PRIO_13, PRIO_14, PRIO_15, PRIO_16	O

Table 2-90 PAServiceSystemConfiguration

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
afDirectReply	boolean		O
afSubsNotifySegment	string example: termination		O
afTerminateUriSegment	string example: termination		O
overrideSupportedFeatures	string		O

Resource Name: Session Management Service

Table 2-91 Supported REST APIs - Session Management Service

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
Session Management Service	​ /ocpm/pcf/v1/configuration/service/sm	GET	Get Session Management Service	200: OK 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/service/sm	PUT	Update Session Management Service	200: Updated 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout

Resource Standard Methods

GET and PUT - Get and update Session Management Service

Table 2-92 Data structures supported by the GET and PUT Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)aints	Cardinality	Description
imsEmergencySession	BindingConfiguration
charging	ChargingConfiguration
imsEmergencySession	IMSEmergencySessionConfiguration
policy	Policy
policyControlRequestTrigger	PolicyControlRequestTrigger
qos	QOSConfiguration
rule	RuleConfiguration
system	SystemConfiguration
traffic	TrafficControlConfiguration
user	UserConfiguration

Table 2-93 BindingConfiguration

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
bindingOperationEnabled	boolean		O	This determines if binding operation (register and deregister) to the BSF is enabled. Default Value: TRUE
useHttp2	boolean		O	Determines if using http/2 to communicate with BSF. Otherwise use http/1.1. Default Value: TRUE
useLocalConfiguredBsfAlways	boolean		O	Whether to use local configured BSF without Always discovering. Default Value: FALSE
useLocalConfiguredBsfWhenNotDiscovered	boolean		O	Whether to use local configured (if having) BSF when not discovered or discover failed.Default Value: FALSE

Table 2-94 ChargingConfiguration

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
chgDataIdPrefix	string		O	This is the prefix of chg data id used by PCF to generate chg data id. For example, prefix is "chgdata_", the generated chg data id is chgdata_0, chgdata_1, etc. Default Value: chgdata_
offline	boolean		O
online	boolean		O
primaryChfAddress	string		O	Specifies the primary CHF address.
secondaryChfAddress	string		O	Specifies the secondary CHF address.

Table 2-95 IMSEmergencySessionConfiguration

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
arpPreemptCap	ENUM	NOT_PREEMPT, MAY_PREEMPT	M
arpPreemptVuln	boolean	NOT_PREEMPTABLE, PREEMPTABLE	M
arpPriorityLevel	integer ($int32)		O
emergencyDNNs	string Any number of values are permitted for Emergency DNNs		O

Table 2-96 Policy

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
evaluateEnabled	boolean		O	This determines if policy evaluate is enabled. Default Value: TRUE

Table 2-97 PolicyControlRequestTrigger

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
defaultPolicyControlRequestTriggers	string, ENUM	PLMN_CH, RES_MO_RE, AC_TY_CH, UE_IP_CH, UE_MAC_CH, AN_CH_COR, US_RE, APP_STA, APP_STO, AN_INFO, CM_SES_FAIL, PS_DA_OFF, DEF_QOS_CH, SE_AMBR_CH, QOS_NOTIF, NO_CREDIT, PRA_CH, SAREA_CH, SCNN_CH, RE_TIMEOUT, RES_RELEASE, SUCC_RES_ALLO, RAT_TY_CH, REF_QOS_IND_CH	O	This is the default Policy Control Request Trigger(s) to install on PDU session at SM Policy Association Establishment. This is a comma split string.

Table 2-98 QOSConfiguration

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)aints	Description
defaultQos5qi	string example: 9		O	This is the 5Qi of default Qos which will be applied if no default Qos is requested by UE. Default Value: 9
defaultQosArpPreemptCap	ENUM	NOT_PREEMPT, MAY_PREEMPT	O	This is the ARP PreemptionCapability of default Qos which will be applied if no default Qos is requested by UE. Default Value: MAY_PREEMPT
defaultQosArpPreemptVuln	ENUM	PREEMPTABLE, NOT_PREEMPTABLE	O	This is the ARP PreemptionVulnerability of default Qos which will be applied if no default Qos is requested by UE. Default Value: NOT_PREEMPTABLE
defaultQosArpPriorityLevel	string		O	This is the ARP Priority Level of default Qos which will be applied if no default Qos is requested by UE. Default Value: 1
installDefQosIfNotRequested	boolean		O	This determines whether to install default Qos to the PDU session if UE not requested Default Value: TRUE
qosDataIdPrefix	string		O	This is the prefix of qos data id used by PCF to generate qos data id. For example, prefix is "qosdata_", the generated qos data id is qosdata_0, chgdata_1, etc. Default Value: qosdata_
updateDefaultPcfRuleWithAuthDefQos	boolean		O	This determines whether to update Qos of default PccRule with the authDefQos of session rule. Default Value: TRUE

Table 2-99 RuleConfiguration

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)aints	Description
appRulePrecedenceMax	string		O	This value defines the maximum value for precedence of a PCC rule as authorized by the establishment of an application flow by the AF. If multiple rules are applied to the same packet flow or UE resource (i.e., overlapping rules) a rule with lower precedence value takes the priority over a rule with higher precedence value. The value of -1 is used to not set the precedence of a rule (NOT RECOMMENDED). Default Value: 899
appRulePrecedenceMin	string		O	This value defines the minimum value for precedence of a PCC rule as authorized by the establishment of an application flow by the AF. If multiple rules are applied to the same packet flow or UE resource (i.e., overlapping rules) a rule with lower precedence value takes the priority over a rule with higher precedence value. The value of -1 is used to not set the precedence of a rule (NOT RECOMMENDED). Default Value: 400
defaultPccRule5qi	string		O	This is the 5Qi of default pcc rule. Default Value: 9
defaultQosArpPriorityLevel	string		O	This is the ARP Priority Level of qos of default pcc rule The range is 1 to 15. Values are ordered in decreasing order of priority, for example, with 1 as the highest priority and 15 as the lowest priority. Default Value: 15
defaultPccRuleArpPreemptCap	ENUM	NOT_PREEMPT, MAY_PREEMPT	O	This is the ARP PreemptionCapability of qos of default PCC rule. NOT_PREEMPT MAY_PREEMPT Default Value: NOT_PREEMPT
defaultPccRuleArpPreemptVuln	ENUM	PREEMPTABLE, NOT_PREEMPTABLE	O	This is the ARP PreemptionVulnerability of qos of default pcc rule. PREEMPTABLE NOT_PREEMPTABLE Default Value: PREEMPTABLE
defaultPccRuleArpPriorityLevel	string example: 15		O	This is the ARP Priority Level of qos of default pcc rule The range is 1 to 15. Values are ordered in decreasing order of priority, for example, with 1 as the highest priority and 15 as the lowest priority. Default Value: 15
defaultPccRulePrecedence	string		O	This is the precedence of default pcc rule. Default Value: 3000
installDefaultPccRule	ENUM	ALWAYS, IF_NO_PROVISIONED_RULE, IF_NO_RULE, NEVER	O	This determine whether and how to install default pcc rule for a PDU session ALWAYS IF_NO_PROVISIONED_RULE: Only if no other provisioned rule is configured IF_NO_RULE: Only if no other rule (predefined or provisioned) is configured/installed NEVER Default Value: IF_NO_RULE
ruleIdPrefix	string		O	This is the prefix of rule id of the pcc rule or session rule auto generated by PCF. for example, prefix is "0_", the generated rule id is 0_0, 0_1, etc. Default Value: 0_
switchFlowInToOutEnabled	boolean		O	This determines whether to switch "in" to "out" in flow description. The src and desc will be switched as well. For example, if enabled, "permit in ip from 2800:a00:cc01:c056:1c00:de10:c481:f193/128 to 2800:a00:800:7::1:3b/128 36004" will be changed to "permit out ip from 2800:a00:800:7::1:3b/128 36004 to 2800:a00:cc01:c056:1c00:de10:c481:f193/128" Default Value: FALSE

Table 2-100 SystemConfiguration

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)aints	Description
apiRoot	string		O
componentTracingEnabled	boolean		O	Determines if component tracing is enabled. Component tracing is used to evaluate system process latency in detail level. Default Value:FALSE
logLevel	Sting, ENUM	DEBUG, INFO, WARN, ERROR	O	Indicates the log level of PCF Session Management (SM) service. Default Value: WARN
metricsEnabled	boolean		O	This determines if system metrics is enabled. This will take priority on global metrics config. Default Value: TRUE
overrideSupportedFeatures	string		O
pcf_diamidentity	string		O	This is the PCF diameter identity used by the PCF to register Binding data to BSF. Diameter based AF may use this diameter identity to communicate with PCF on Rx reference point. Default Value: pcf-smservice
pcf_diamrealm	string		O	This is the PCF diameter realm used by the PCF to register Binding data to BSF. Diameter based AF may use this diameter realm to communicate with PCF on Rx reference point. Default Value: pcf-smservice.svc
pcf_fqdn	string		O	This is the PCF FQDN used by the PCF to register Binding data to BSF. AF may use this FQDN to communicate with PCF on N5 reference point. Default Value: pcf-smservice.pcfn
process400as200	boolean		O
smfTerminateUriSegment	string example: terminate		O
smfUpdateUriSegment	string example: update		O
snssai	string		O	This is the PCF SNSSAI used by the PCF to register Binding data to BSF. AF/BSF may use this SNSSAI to discover proper PCF. Format: sst,sd. Default Value: 0,000000

Table 2-101 TrafficControlConfiguration

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
tcDataIdPrefix	string		O	This is the prefix of traffic control data id used by PCF to generate tc data id. For example, prefix is "tcdata_", the generated tc data id is tcdata_0, tcdata_1, etc. Default Value: tcdata_

Table 2-102 UserConfiguration

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
enableChfQueryAll	boolean		O
ignoreSubsNotificationCheck	boolean		O
queryUser	boolean		O	Determines if user query from UDR is enabled. Default Value: TRUE
queryUserOnDelete	boolean		O	Determines if user query from UDR on delete is enabled. Default Value: FALSE
queryUserOnReauth	boolean		O	Determines if user query from UDR on reuath is enabled. Default Value: FALSE
queryUserOnUpdate	boolean		O	Determines if user query from UDR on update is enabled. Default Value: FALSE
subsToNotifyEnabled	boolean		O	Determines if subscribe to nofity about subscriber data change is enabled. Default Value: TRUE
validateUser	boolean		O	Determines if user validate is enabled. HTTP 400 with cause USER_UNKNOWN returns, if this is enabled and user not found in UDR. Default Value: FALSE

Resource Name: UE Policy Service

Table 2-103 Supported REST APIs - UE Policy Service

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
UE Policy Service	​ /ocpm/pcf/v1/configuration/service/ue	GET	Get UE Policy Service	200: OK 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/service/ue	PUT	Update UE Policy Service	200: Updated 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout

Resource Standard Methods

GET and PUT - Get and update UE Policy Service

Table 2-104 Data structures supported by the GET and PUT Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)aints	Cardinality	Description
amf	AMFConfiguration		O
system	UEPolicyServiceSystemConfiguration		O
user	UserUEPolicyServiceConfiguration		O

Table 2-105 AMFConfiguration

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
enableHttp11Client	boolean		O
naSMsgTransferMaxSize	integer ($int32)		O

Table 2-106 UEPolicyServiceSystemConfiguration

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
loglevel	String, ENUM	DEBUG, INFO, WARN, ERROR	O	Indicates the log level of PCF Session Management (SM) service. Default Value: WARN
notifUriRoot	string		O

Table 2-107 UserUEPolicyServiceConfiguration

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
queryUser	boolean		O	Determines if user query from UDR is enabled. Default Value: TRUE
validateUser	boolean		O	Determines if user validate is enabled. HTTP 400 with cause USER_UNKNOWN returns, if this is enabled and user not found in UDR. Default Value: FALSE

Resource Name: User Service

Table 2-108 Supported REST APIs - User Service

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
User Service	​ /ocpm/pcf/v1/configuration/service/user	GET	Get User Service	200: OK 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
	/ocpm/pcf/v1/configuration/service/user	PUT	Update User Service	200: Updated 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 406: Not Acceptable 408: Request Timeout 409: Conflict 412: Precondition Failed 500: Internal Server Error 503: Service Unavailable 504: Gateway Timeout

Resource Standard Methods

GET and PUT - Get and update User Service

Table 2-109 Data structures supported by the GET and PUT Response Body

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)aints	Cardinality	Description
common	CommonConfiguration		O
db	DBConfiguration		O
system	UserSystemConfiguration		O
udr	UDRConfiguration		O

Table 2-110 CommonConfiguration

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
requestTimeout	string example: 1000		O
resourceGetSub	boolean		O

Table 2-111 DBConfiguration

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
indexing	Indexing		O
keysPrecedence	ENUM	MSISDN, IMSI, NAI, EXTID	O
userIndexKeys	ENUM	msisdn, imsi, nai, extid	O

Table 2-112 Indexing

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
indexByExtid	boolean		O
indexByImsi	boolean		O
indexByMsisdn	boolean		O
indexByNai	boolean		O

Table 2-113 UserSystemConfiguration

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
apiRoot	string		O	This is PCF User Service API Root URI. It is part of PCF user service. This value is auto injected at service deployment. User can also configure this manually. Default Value:N/A
logLevel	string, ENUM	DEBUG, INFO, WARN, ERROR	O	Indicates the log level of PCF Session Management (SM) service. Default Value: WARN

Table 2-114 UDRConfiguration

Field Name	Data Type	Constraints	Mandatory(M)/Optional(O)/Conditional(C)	Description
amDataUri	string example: /policy-data/ues/{ueId}/am-data		O
baseUri	string example: /nudr-dr/v1		O
enableDiscoveryOnDemand	boolean		O
enableHttp11	boolean		O
explodeSnssai	boolean		O
requestTimeout	string example: 1000		O
smDataUri	string example: /policy-data/ues/{ueId}/sm-data		O
subsToNotifySubsIdUri	string example: /policy-data/subs-to-notify/{subsId}		O
subsToNotifyUri	string example: /policy-data/subs-to-notify		O
supportedFeatures	string example: f		O
uePolicySetUri	string example: /policy-data/ues/{ueId}/ue-policy-set		O
usageMonUri	string example: /policy-data/ues/{ueId}/sm-data/{usageMonId}		O

Resource Name: Policy Management

Table 2-115 Supported REST APIs - Policy Management

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
Policy Management	​/ocpm​/policymanagement​/v1​/policyprojects	POST	Import policy projects	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
Policy Management	​/ocpm​/policymanagement​/v1​/policyprojects	GET	Export Policy Projects	400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
Policy Management	/ocpm/policymanagement/v1/policyprojects	DELETE	Delete policy projects	200: Resource deleted successfully 204: No Content 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
Policy Management	​/ocpm/policymanagement/v1/policyprojects/report	POST	Create policy report	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
Policy Management	​/ocpm​/policymanagement​/v1​/policyprojects​/{policyProjectName}	GET	Expot policy projects	400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
Policy Management	/ocpm/policymanagement/v1/policyprojects/{policyProjectName}	DELETE	Delete policy project	200: Resource deleted successfully 204: No Content 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable

Resource Standard Methods

POST, GET - Create, Import, and Export policy projects

Table 2-116 Data structures supported by the POST, GET Response Body

Field Name	Data Type	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
description	string	O	1	Specifies the description of a policy project.
name	String	O	1	Specifies the name of a policy project.
policy	array	O	1
serviceType	String	O	1	Specifies the supported service type.

DELETE - delete policy project

Table 2-117 Data structures supported by the DELETE Response Body

Field Name	Data Type	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
policyProjectName	string	M	1	Policy Project Name

Resource Name: Policy Table

Table 2-118 Supported REST APIs - Policy Table

Resource Name	Resource URI	HTTP Method or Custom Operation	Description	Possible Result Code
Policy Table	​/ocpm/policymanagement/v1/policytables	POST	Import policy tables	200: OK 201: Created 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 405: Method Not Allowed 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
Policy Table	/ocpm/policymanagement/v1/policytables/{serviceName}	DELETE	Delete Policy Table	400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable
Policy Table	​/ocpm​/policymanagement​/v1​/policytables​/{serviceName}​/{policyTableName}	DELETE	Delete policy project	200: Resource deleted successfully 204: No Content 400: Bad request 401: Unauthorized 403: Forbidden 404: Not Found 429: Too Many Requests 500: Internal Server Error 503: Service Unavailable

Resource Standard Methods

POST, GET - Import and Export policy tables

Table 2-119 Data structures supported by the POST, GET Response Body

Field Name	Data Type	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
columns	array	O	1	Specifies the column of a policy table.
name	String	O	1	Specifies the name of a policy table.
description	name	O	1	Specifies the description of a policy table.
rows	array	O	1	Specifies the rows of a policy table.

DELETE - delete policy table

Table 2-120 Data structures supported by the DELETE Response Body

Field Name	Data Type	Mandatory(M)/Optional(O)/Conditional(C)	Cardinality	Description
policyTableName	string	M	1	Policy Table Name
serviceName	string	M		Service Name