1. Cloud Native Core Policy REST Specification Document
  2. Cloud Native Policy Charging and Rules Function (CNPCRF) REST Specifications

3 Cloud Native Policy Charging and Rules Function (CNPCRF) REST Specifications

This section provides information about REST specifications used in CNPCRF.

Resource Name: PCRF Public Log

Table 3-1 Supported REST APIs - PCRF Public Log

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
Pcrf Log ​​/ocpm/pcrf/v1/configuration/diameter/logPcrf/export GET Export Pcrf Log See Table A-1
​/ocpm/pcrf/v1/configuration/diameter/logPcrf/import POST Import Pcrf Log See Table A-3
​/ocpm/pcrf/v1/configuration/service/logPcrf GET Get Pcrf Log See Table A-1
/ocpm/pcrf/v1/configuration/service/logPcrf PUT Update Pcrf Log See Table A-2
Resource Standard Methods
GET and PUT - Get and Update Pcrf Log

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
packageLogLevel Array O    
rootLogLevel string M   Allowed values:
  • trace
  • debug
  • info
  • warn
  • error
  • fatal

Table 3-3 packageLogLevel

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
logLevelForPackage string O   Allowed values:
  • trace
  • debug
  • info
  • warn
  • error
  • fatal
packageName string M    
Export and Import Pcrf Log

Table 3-4 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
exportData array     Exported list of Pcrf Log. For more information, see Table 3-2
sourceVersion string     System version of the product from which data is exported
topic string     Topic of each managed object

Resource Name: Policy Engine

Table 3-5 Supported REST APIs - Policy Engine

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
Policy Engine ​/oc-cnpolicy-configuration/v1/services/policyengine/export GET Export Policy Engine See Table A-1
​/oc-cnpolicy-configuration/v1/services/policyengine/import POST Import Policy Engine See Table A-3
Resource Standard Methods
Export and Import Policy Engine

Table 3-6 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
exportData.loglevel string      
exportData.supportedServices.relativeUrl string      
exportData.supportedServices.serviceLabel string      
exportData.supportedServices.serviceName string      
sourceVersion string     System version of the product from which data is exported
topic string M   Topic of each managed object

Resource Name: Charging Server

Table 3-7 Supported REST APIs - Charging Server

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
Charging Server ​/ocpm/pcrf/v1/configuration/policy/chargingServer POST Create Charging Server See Table A-3
​​/ocpm/pcrf/v1/configuration/policy/chargingServer/export GET Export Charging Server See Table A-1
​/ocpm/pcrf/v1/configuration/policy/chargingServer/import POST Import Charging Server See Table A-3
​/ocpm/pcrf/v1/configuration/policy/chargingServer/{chargingServerName} GET Get Charging Server See Table A-1
/ocpm/pcrf/v1/configuration/policy/chargingServer/{chargingServerName} PUT Update Charging Server See Table A-2
​/ocpm/pcrf/v1/configuration/policy/chargingServer/{chargingServerName} DELETE Delete Charging Server See Table A-4
Resource Standard Methods
POST, GET, and PUT - Create, Get, and Update Charging Server

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
description string      
hostName string      
name string M    
port string      
protocol string M   diameter

radius

tacacs+
security boolean      
transport string M   tcp

udp

sctp
Export and Import Charging Server

Table 3-9 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
errors array      
errors:message string      
errors:name string      
exportData array M   Exported list of charging server. For more information, see Table 3-8
key string     Indicates the ID
sourceVersion string     System version of the product from which data is exported
topic string M   Topic of each managed object
DELETE - delete charging server

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

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

Resource Name: Custom AVP

Table 3-11 Supported REST APIs - Custom AVP

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
Custom AVP /oc-cnpolicy-configuration/v1/policydata/common/customattributes/avp POST Create Custom AVP See Table A-3
​/oc-cnpolicy-configuration/v1/policydata/common/customattributes/avp/export GET Export Custom AVP See Table A-1
​/oc-cnpolicy-configuration/v1/policydata/common/customattributes/avp/import POST Import Custom AVP See Table A-3
/oc-cnpolicy-configuration/v1/policydata/common/customattributes/avp/{customAVPName} GET Get Custom AVP See Table A-1
/oc-cnpolicy-configuration/v1/policydata/common/customattributes/avp/{customAVPName} PUT Update Custom AVP See Table A-2
​/oc-cnpolicy-configuration/v1/policydata/common/customattributes/avp/{customAVPName} DELETE Delete Custom AVP See Table A-4
/ocpm/pcrf/v1/configuration/policy/customAVP POST Create Custom AVP See Table A-3
/ocpm/pcrf/v1/configuration/policy/customAVP/export GET Export Custom AVP See Table A-1
​/ocpm/pcrf/v1/configuration/policy/customAVP/import POST Import Custom AVP See Table A-3
/ocpm/pcrf/v1/configuration/policy/customAVP/{customAVPName} GET Get Custom AVP See Table A-1
/ocpm/pcrf/v1/configuration/policy/customAVP/{customAVPName} PUT Update Custom AVP See Table A-2
/ocpm/pcrf/v1/configuration/policy/customAVP/{customAVPName} DELETE Delete Custom AVP See Table A-4
Resource Standard Methods
POST, GET, and PUT - Create, Get, and Update Custom AVP Name

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
vendorSpecificFlag boolean      
avpCode string      
avpType string    
  • enumerated
  • float32
  • float64
  • grouped
  • id
  • int32
  • int64
  • ipFilterRule
  • octetString
  • time
  • uint32
  • uint64
  • uri
  • utf8String
description string      
mandatoryFlag boolean      
mayEncryptFlag boolean      
name string M    
protectFlag boolean      
rootAvp string      
vendorId string M   10415

5535

21274

9

5263

3076

255

2636

4874
vendorSpecificFlag boolean      
Export and Import Custom AVP

Table 3-13 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
errors array      
errors:message string      
errors:name string      
exportData array M   Exported list of custom avp. For more information, see Table 3-12
key string     Indicates the ID
sourceVersion string     System version of the product from which data is exported
topic string M   Topic of each managed object
DELETE - delete custom AVP

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

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

Resource Name: Custom Schema

Table 3-15 Supported REST APIs - Custom Schema

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
Custom Schema /oc-cnpolicy-configuration/v1/policydata/common/customattributes/customschema/export GET Export Custom Schema See Table A-1
​/oc-cnpolicy-configuration/v1/policydata/common/matchList/export POST Import Custom Schema See Table A-3
Resource Standard Methods
Export and Import Custom Schema

Table 3-16 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
exportData.name string      
exportData.type string      
key        
sourceVersion string     System version of the product from which data is exported
topic string M   Topic of each managed object

Resource Name: Custom Vendor

Table 3-17 Supported REST APIs - Custom Vendor

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
Custom Vendor ​/ocpm/pcrf/v1/configuration/policy/customVendor POST Create Custom Vendor See Table A-3
​​/ocpm/pcrf/v1/configuration/policy/customVendor/export GET Export Custom Vendor See Table A-1
​/ocpm/pcrf/v1/configuration/policy/customVendor/import POST Import Custom Vendor See Table A-3
​/ocpm/pcrf/v1/configuration/policy/customVendor/{customVendorName} GET Get Custom Vendor See Table A-1
/ocpm/pcrf/v1/configuration/policy/customVendor/{customVendorName} PUT Update Custom Vendor See Table A-2
​/ocpm/pcrf/v1/configuration/policy/customVendor/{customVendorName} DELETE Delete Custom Vendor See Table A-4
/oc-cnpolicy-configuration/v1/policydata/common/customattributes/customvendor/export GET Export Custom Vendor See Table A-1
/oc-cnpolicy-configuration/v1/policydata/common/customattributes/customvendor/import POST Import Custom Vendor See Table A-3
Resource Standard Methods
POST, GET, and PUT - Create, Get, and Update Custom Vendor

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
description string O    
name string M    
value string O    
Export and Import Custom Vendor

Table 3-19 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
errors array      
errors:message string      
errors:name string      
exportData array M   Exported list of custom avp. For more information, see Table 3-18
key string     Indicates the ID
sourceVersion string     System version of the product from which data is exported
topic string M   Topic of each managed object
DELETE - delete custom vendor

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

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

Resource Name: Dropdown Blocks

Table 3-21 Supported REST APIs - Dropdown Blocks

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
Dropdown Blocks /oc-cnpolicy-configuration/v1/policydata/common/dropdownBlocks/export GET Export dropdown blocks See Table A-1
​/oc-cnpolicy-configuration/v1/policydata/common/dropdownBlocks/import POST Import Dropdown Blocks See Table A-3
Resource Standard Methods
Export and Import Dropdown Blocks

Table 3-22 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
exportData.attrName string      
exportData.description string      
exportData.options.label string      
exportData.options.value string      
exportData.topic string      
exportData.type string      
sourceVersion string     System version of the product from which data is exported
topic string M   Topic of each managed object

Resource Name: Match List

Table 3-23 Supported REST APIs - Match List

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
Match List /oc-cnpolicy-configuration/v1/policydata/common/matchList/export GET Export Match List See Table A-1
​/oc-cnpolicy-configuration/v1/policydata/common/matchList/export POST Import Match List See Table A-3
Resource Standard Methods
Export and Import Match List

Table 3-24 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
exportData.description string      
exportData.id string      
exportData.options.label string      
exportData.items array      
exportData.name string      
exportData.type string      
sourceVersion string     System version of the product from which data is exported
topic string M   Topic of each managed object

Resource Name: Media Profile

Table 3-25 Supported REST APIs - Media Profile

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
Media Profile ​/ocpm/pcrf/v1/configuration/policy/mediaProfile POST Create Media Profile See Table A-3
​​/ocpm/pcrf/v1/configuration/policy/mediaProfile/export GET Export Media Profile See Table A-1
​/ocpm/pcrf/v1/configuration/policy/mediaProfile/import POST Import Media Profile See Table A-3
​/ocpm/pcrf/v1/configuration/policy/mediaProfile/{mediaProfileName} GET Get Media Profile See Table A-1
/ocpm/pcrf/v1/configuration/policy/mediaProfile/{mediaProfileName} PUT Update Media Profile See Table A-2
​/ocpm/pcrf/v1/configuration/policy/mediaProfile/{mediaProfileName} DELETE Delete Media Profile See Table A-4
Resource Standard Methods
POST, GET, and PUT - Create, Get, and Update Media Profile

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
codecName string M    
description string      
frameSizeInBytes integer M   enter a range in 0 to 65535
frameSizeInMS number M    
id string M    
mediaType string M    
name string M    
pTime integer M   enter a range in 0 to 65535
payLoad integer M   enter a range in 0 to 255
sampleRate integer M   enter a range in 0 to 65535
transportType string M   RTP/AVP

RTP/SAVP

RTP/AVPF
useDefaultPTime boolean M    
Export and Import Media Profile

Table 3-27 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
errors array      
errors:message string      
errors:name string      
exportData array M   Exported list of media profile. For more information, see Table 3-26
key string     Indicates the ID
sourceVersion string     System version of the product from which data is exported
topic string M   Topic of each managed object
DELETE - delete media profile

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

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

Resource Name: Network for GGSN

Table 3-29 Supported REST APIs - Network for GGSN

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
Network GGSN ​/ocpm/pcrf/v1/configuration/policy/networkGGSN POST Create Network GGSN See Table A-3
​​/ocpm/pcrf/v1/configuration/policy/networkGGSN/export GET Export Network GGSN See Table A-1
​/ocpm/pcrf/v1/configuration/policy/networkGGSN/import POST Import Network GGSN See Table A-3
​/ocpm/pcrf/v1/configuration/policy/networkGGSN/{networkGGSNName} GET Get Network GGSN See Table A-1
/ocpm/pcrf/v1/configuration/policy/networkGGSN/{networkGGSNName} PUT Update Network GGSN See Table A-2
​/ocpm/pcrf/v1/configuration/policy/networkGGSN/{networkGGSNName} DELETE Delete Network GGSN See Table A-4
Resource Standard Methods
POST, GET, and PUT - Create, Get, and Update Network GGSN

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
backupHostName   O    
capabilities array O    
capacity string O    
description string O    
diameterRealm string O    
hostName string O    
ipDomainId string O    
name string M    
neDiameterId array O    
Export and Import Network GGSN

Table 3-31 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
errors array      
errors:message string      
errors:name string      
exportData array M   Exported list of network for GGSN. For more information, see Table 3-30
key string     Indicates the ID
sourceVersion string     System version of the product from which data is exported
topic string M   Topic of each managed object
DELETE - delete Network GGSN

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

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

Resource Name: Network for PGW

Table 3-33 Supported REST APIs - Network for PGW

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
Network PGW ​/ocpm/pcrf/v1/configuration/policy/networkPGW POST Create Network PGW See Table A-3
​​/ocpm/pcrf/v1/configuration/policy/networkPGW/export GET Export Network PGW See Table A-1
​/ocpm/pcrf/v1/configuration/policy/networkPGW/import POST Import Network PGW See Table A-3
​/ocpm/pcrf/v1/configuration/policy/networkPGW/{networkPGWName} GET Get Network PGW See Table A-1
/ocpm/pcrf/v1/configuration/policy/networkPGW/{networkPGWName} PUT Update Network PGW See Table A-2
​/ocpm/pcrf/v1/configuration/policy/networkPGW/{networkPGWName} DELETE Delete Network PGW See Table A-4
Resource Standard Methods
POST, GET, and PUT - Create, Get, and Update Network PGW

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
backupHostName   O    
capabilities array O    
capacity string O    
description string O    
diameterRealm string O    
fqdn string O    
hostName string O    
ipDomainId string O    
name string M    
neDiameterId array O    
Export and Import Network PGW

Table 3-35 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
errors array      
errors:message string      
errors:name string      
exportData array M   Exported list of network for PGW. For more information, see Table 3-34
key string     Indicates the ID
sourceVersion string     System version of the product from which data is exported
topic string M   Topic of each managed object
DELETE - delete Network PGW

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

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

Resource Name: Pra

Table 3-37 Supported REST APIs - Pra

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
Pra ​/ocpm/pcrf/v1/configuration/policy/pra POST Create Pra See Table A-3
​​/ocpm/pcrf/v1/configuration/policy/pra/export GET Export PCRF Pra See Table A-1
​/ocpm/pcrf/v1/configuration/policy/pra/import POST Import PCRF Pra See Table A-3
​/ocpm/pcrf/v1/configuration/policy/pra/{praPcrfName} GET Get Pra See Table A-1
/ocpm/pcrf/v1/configuration/policy/pra/{praPcrfName} PUT Update Pra See Table A-2
​/ocpm/pcrf/v1/configuration/policy/pra/{praPcrfName} DELETE Delete Pra See Table A-4
Resource Standard Methods
POST, GET, and PUT - Create, Get, and Update Pra

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
descrption string O    
id string M    
name string M    
praItems array O    
type string     Allowed value:

Core Network pre-configured

Table 3-39 praItems

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
cgi Cgi O    
ecgi Ecgi O   Allowed values:
  • -1
  • 0
  • 1
  • 2
  • 3
home_enodeb HomeEnodeb O    
macro_enodeb MacroEnodeb O    
rai RAI      
sai SAI      
tai TAI      
type string     Allowed values:
  • tai
  • rai
  • macro_enodeb
  • home_enodeb
  • ecgi
  • sai
  • cgi

Table 3-40 cgi

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
ci string O    
lac string O    
mcc string O    
mnc string O    

Table 3-41 ecgi

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

Table 3-42 home_enodeb

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
henb string O    
mcc string O    
menb string O    
mnc string O    

Table 3-43 macro_enodeb

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

Table 3-44 rai

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
lac string O    
mcc string O    
mnc string O    
rac string O    

Table 3-45 sai

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
lac string O    
mcc string O    
mnc string O    
sac string O    

Table 3-46 tai

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
mcc string O    
mnc string O    
tac string O    
Export and Import Pra

Table 3-47 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
errors array      
errors:message string      
errors:name string      
exportData array M   Exported list of Pra. For more information, see Table 3-38
key string     Indicates the ID
sourceVersion string     System version of the product from which data is exported
topic string M   Topic of each managed object
DELETE - delete Pra Pcrf

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

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

Resource Name: Predefined Adc Rule

Table 3-49 Supported REST APIs - Predefined Adc Rule

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
Predefined Adc Rule ​/ocpm/pcrf/v1/configuration/policy/predefinedAdcRule POST Create Predefined Adc Rule See Table A-3
​​/ocpm/pcrf/v1/configuration/policy/predefinedAdcRule/export GET Export Predefined Adc Rule See Table A-1
​/ocpm/pcrf/v1/configuration/policy/predefinedAdcRule/import POST Import Predefined Adc Rule See Table A-3
​/ocpm/pcrf/v1/configuration/policy/predefinedAdcRule/{predefinedAdcRuleName} GET Get Predefined Adc Rule See Table A-1
/ocpm/pcrf/v1/configuration/policy/predefinedAdcRule/{predefinedAdcRuleName} PUT Update Predefined Adc Rule See Table A-2
​/ocpm/pcrf/v1/configuration/policy/predefinedAdcRule/{predefinedAdcRuleName} DELETE Delete Predefined Adc Rule See Table A-4
Resource Standard Methods
POST, GET, and PUT - Create, Get, and Update Predefined Adc Rule

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
name string M    
param.diameter.adcPredefRule.description string O    
param.diameter.adcPredefRule.name string O    
Export and Import Predefined Adc Rule

Table 3-51 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
errors array      
errors:message string      
errors:name string      
exportData array M   Exported list of predefined Adc Rule. For more information, see Table 3-50
key string     Indicates the ID
sourceVersion string     System version of the product from which data is exported
topic string M   Topic of each managed object
DELETE - delete Predefined Adc Rule

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

Field Name Data Type Constraints Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
predefinedAdcRuleName string M 1 Predefined Adc Rule Name

Resource Name: Predefined Adc Rule Base

Table 3-53 Supported REST APIs - Predefined Adc Rule Base

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
Predefined Adc Rule Base ​/ocpm/pcrf/v1/configuration/policy/predefinedAdcRuleBase POST Create Predefined Adc Rule Base See Table A-3
​​/ocpm/pcrf/v1/configuration/policy/predefinedAdcRuleBase/export GET Export Predefined Adc Rule Base See Table A-1
​/ocpm/pcrf/v1/configuration/policy/predefinedAdcRuleBase/import POST Import Predefined Adc Rule Base See Table A-3
​/ocpm/pcrf/v1/configuration/policy/predefinedAdcRuleBase/{predefinedAdcRuleBaseName} GET Get Predefined Adc Rule Base See Table A-1
/ocpm/pcrf/v1/configuration/policy/predefinedAdcRuleBase/{predefinedAdcRuleBaseName} PUT Update Predefined Adc Rule Base See Table A-2
​/ocpm/pcrf/v1/configuration/policy/predefinedAdcRuleBase/{predefinedAdcRuleBaseName} DELETE Delete Predefined Adc Rule Base See Table A-4
Resource Standard Methods
POST, GET, and PUT - Create, Get, and Update Predefined Adc Rule Base

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
name string M    
param.diameter.adcPredefBaseRule.description string O    
param.diameter.adcPredefBaseRule.name string O    
Export and Import Predefined Adc Rule Base

Table 3-55 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
errors array      
errors:message string      
errors:name string      
exportData array M   Exported list of predefined Adc Base Rule. For more information, see Table 3-54
key string     Indicates the ID
sourceVersion string     System version of the product from which data is exported
topic string M   Topic of each managed object
DELETE - delete Predefined Adc Rule Base

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

Field Name Data Type Constraints Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
predefinedAdcRuleBaseName string M 1 Predefined Adc Rule Base Name

Resource Name: Predefined Pcc Rule

Table 3-57 Supported REST APIs - Predefined Pcc Rule

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
Predefined Pcc Rule ​/ocpm/pcrf/v1/configuration/policy/predefinedPccRule POST Create Predefined Pcc Rule See Table A-3
​​/ocpm/pcrf/v1/configuration/policy/predefinedPccRule/export GET Export Predefined Pcc Rule See Table A-1
​/ocpm/pcrf/v1/configuration/policy/predefinedPccRule/import POST Import Predefined Pcc Rule See Table A-3
​/ocpm/pcrf/v1/configuration/policy/predefinedPccRule/{predefinedPccRuleName} GET Get Predefined Pcc Rule See Table A-1
/ocpm/pcrf/v1/configuration/policy/predefinedPccRule/{predefinedPccRuleName} PUT Update Predefined Pcc Rule See Table A-2
​/ocpm/pcrf/v1/configuration/policy/predefinedPccRule/{predefinedPccRuleName} DELETE Delete Predefined Pcc Rule See Table A-4
Resource Standard Methods
POST, GET, and PUT - Create, Get, and Update Predefined Pcc Rule

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
name string M    
param.diameter.pccPredefRule.MonitoringKey string O    
param.diameter.pccPredefRule.description string O    
param.diameter.pccPredefRule.name string O    
Export and Import Predefined Pcc Rule

Table 3-59 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
errors array      
errors:message string      
errors:name string      
exportData array M   Exported list of predefined Pcc Rule. For more information, see Table 3-58
key string     Indicates the ID
sourceVersion string     System version of the product from which data is exported
topic string M   Topic of each managed object
DELETE - delete Predefined Pcc Rule

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

Field Name Data Type Constraints Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
predefinedPccRuleName string M 1 Predefined Pcc Rule Name

Resource Name: Predefined Pcc Rule Base

Table 3-61 Supported REST APIs - Predefined Pcc Rule Base

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
Predefined Pcc Rule Base ​/ocpm/pcrf/v1/configuration/policy/predefinedPccRuleBase POST Create Predefined Pcc Rule Base See Table A-3
​​/ocpm/pcrf/v1/configuration/policy/predefinedPccRuleBase/export GET Export Predefined Pcc Rule Base See Table A-1
​/ocpm/pcrf/v1/configuration/policy/predefinedPccRuleBase/import POST Import Predefined Pcc Rule Base See Table A-3
​/ocpm/pcrf/v1/configuration/policy/predefinedPccRuleBase/{predefinedPccRuleBaseName} GET Get Predefined Pcc Rule Base See Table A-1
/ocpm/pcrf/v1/configuration/policy/predefinedPccRuleBase/{predefinedPccRuleBaseName} PUT Update Predefined Pcc Rule Base See Table A-2
​/ocpm/pcrf/v1/configuration/policy/predefinedPccRuleBase/{predefinedPccRuleBaseName} DELETE Delete Predefined Pcc Rule Base See Table A-4
Resource Standard Methods
POST, GET, and PUT - Create, Get, and Update Predefined Pcc Rule Base

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
name string M    
param.diameter.pccPredefBaseRule.description string O    
param.diameter.pccPredefBaseRule.name string O    
Export and Import Predefined Pcc Rule Base

Table 3-63 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
errors array      
errors:message string      
errors:name string      
exportData array M   Exported list of predefined Pcc Rule Base. For more information, see Table 3-62
key string     Indicates the ID
sourceVersion string     System version of the product from which data is exported
topic string M   Topic of each managed object
DELETE - delete Predefined Pcc Rule Base

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

Field Name Data Type Constraints Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
predefinedPccRuleBaseName string M 1 Predefined Pcc Rule Base Name

Resource Name: Retry Profile for ADC

Table 3-65 Supported REST APIs - Retry Profile for ADC

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
ADC Retry Profile ​/ocpm/pcrf/v1/configuration/policy/adcRetryProfile POST Create ADC Retry Profile See Table A-3
​​/ocpm/pcrf/v1/configuration/policy/adcRetryProfile/export GET Export ADC Retry Profile See Table A-1
​/ocpm/pcrf/v1/configuration/policy/adcRetryProfile/import POST Import ADC Retry Profile See Table A-3
​/ocpm/pcrf/v1/configuration/policy/adcRetryProfile/{adcRetryProfileName} GET Get ADC Retry Profile See Table A-1
/ocpm/pcrf/v1/configuration/policy/adcRetryProfile/{adcRetryProfileName} PUT Update ADC Retry Profile See Table A-2
​/ocpm/pcrf/v1/configuration/policy/adcRetryProfile/{adcRetryProfileName} DELETE Delete ADC Retry Profile See Table A-4
Resource Standard Methods
POST, GET, and PUT - Create, Get, and Update Retry Profile for ADC

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
backOffInterval integer M   Enter a value between 1 and 86400
description string O    
id string O    
initialRetryInterval integer M   Enter a value between 0 and 30
maxRetryAttempt integer M   Enter a value between 1 and 10
maxRetryCycles integer M   Enter a value between 1 and 4
maxRetryInterval integer M   Enter a value between 1 and 180
name string M    
ruleFailureCode array     Contains items of type string. Supported values:
  • UNKNOWN_RULE_NAME
  • RATING_GROUP_ERROR
  • SERVICE_IDENTIFIER_ERROR
  • GW_PCEF_MALFUNCTION
  • RESOURCES_LIMITATION
  • MAX_NR_BEARERS_REACHED
  • UNKNOWN_BEARER_ID
  • MISSING_BEARER_ID
  • MISSING_FLOW_INFORMATION
  • RESOURCE_ALLOCATION_FAILURE
  • UNSUCCESSFUL_QOS_VALIDATION
  • INCORRECT_FLOW_INFORMATION
  • PS_TO_CS_HANDOVER
  • TDF_APPLICATION_IDENTIFIER_ERROR
  • NO_BEARER_BOUND
  • FILTER_RESTRICTIONS
  • AN_GW_FAILED
  • MISSING_REDIRECT_SERVER_ADDRESS
  • CM_END_USER_SERVICE_DENIED
  • CM_CREDIT_CONTROL_NOT_APPLICABLE
  • CM_AUTHORIZATION_REJECTED
  • CM_USER_UNKNOWN
  • CM_RATING_FAILED
Export and Import Retry Profile for ADC

Table 3-67 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
errors array      
errors:message string      
errors:name string      
exportData array M   Exported list of ADC retry profile. For more information, see Table 3-66
key string     Indicates the ID
sourceVersion string     System version of the product from which data is exported
topic string M   Topic of each managed object
DELETE - delete Retry Profile for ADC

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

Field Name Data Type Constraints Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
adcRetryProfileName string M 1 ADC Retry Profile Name

Resource Name: Retry Profile for PCC

Table 3-69 Supported REST APIs - Retry Profile for PCC

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
PCC Retry Profile ​/ocpm/pcrf/v1/configuration/policy/pccRetryProfile POST Create PCC Retry Profile See Table A-3
​​/ocpm/pcrf/v1/configuration/policy/pccRetryProfile/export GET Export PCC Retry Profile See Table A-1
​/ocpm/pcrf/v1/configuration/policy/pccRetryProfile/import POST Import PCC Retry Profile See Table A-3
​/ocpm/pcrf/v1/configuration/policy/pccRetryProfile/{pccRetryProfileName} GET Get PCC Retry Profile See Table A-1
/ocpm/pcrf/v1/configuration/policy/pccRetryProfile/{pccRetryProfileName} PUT Update PCC Retry Profile See Table A-2
​/ocpm/pcrf/v1/configuration/policy/pccRetryProfile/{pccRetryProfileName} DELETE Delete PCC Retry Profile See Table A-4
Resource Standard Methods
POST, GET, and PUT - Create, Get, and Update Retry Profile for PCC

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
backOffInterval integer M   Enter a value between 1 and 86400
description string O    
id string O    
initialRetryInterval integer M   Enter a value between 0 and 30
maxRetryAttempt integer M   Enter a value between 1 and 10
maxRetryCycles integer M   Enter a value between 1 and 4
maxRetryInterval integer M   Enter a value between 1 and 180
name string M    
ruleFailureCode array     Contains items of type string. Supported values:
  • UNKNOWN_RULE_NAME
  • RATING_GROUP_ERROR
  • SERVICE_IDENTIFIER_ERROR
  • GW_PCEF_MALFUNCTION
  • RESOURCES_LIMITATION
  • MAX_NR_BEARERS_REACHED
  • UNKNOWN_BEARER_ID
  • MISSING_BEARER_ID
  • MISSING_FLOW_INFORMATION
  • RESOURCE_ALLOCATION_FAILURE
  • UNSUCCESSFUL_QOS_VALIDATION
  • INCORRECT_FLOW_INFORMATION
  • PS_TO_CS_HANDOVER
  • TDF_APPLICATION_IDENTIFIER_ERROR
  • NO_BEARER_BOUND
  • FILTER_RESTRICTIONS
  • AN_GW_FAILED
  • MISSING_REDIRECT_SERVER_ADDRESS
  • CM_END_USER_SERVICE_DENIED
  • CM_CREDIT_CONTROL_NOT_APPLICABLE
  • CM_AUTHORIZATION_REJECTED
  • CM_USER_UNKNOWN
  • CM_RATING_FAILED
Export and Import Retry Profile for PCC

Table 3-71 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
errors array      
errors:message string      
errors:name string      
exportData array M   Exported list of PCC retry profile. For more information, see Table 3-70
key string     Indicates the ID
sourceVersion string     System version of the product from which data is exported
topic string M   Topic of each managed object
DELETE - delete Retry Profile for PCC

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

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

Resource Name: Serving Gateway

Table 3-73 Supported REST APIs - Serving Gateway

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
Serving Gateway ​/ocpm/pcrf/v1/configuration/policy/servingGateway POST Create Serving Gateway See Table A-3
​​/ocpm/pcrf/v1/configuration/policy/servingGateway/export GET Export Serving Gateway See Table A-1
​/ocpm/pcrf/v1/configuration/policy/servingGateway/import POST Import Serving Gateway See Table A-3
​/ocpm/pcrf/v1/configuration/policy/servingGateway/{servingGatewayName} GET Get Serving Gateway See Table A-1
/ocpm/pcrf/v1/configuration/policy/servingGateway/{servingGatewayName} PUT Update Serving Gateway See Table A-2
​/ocpm/pcrf/v1/configuration/policy/servingGateway/{servingGatewayName} DELETE Delete Serving Gateway See Table A-4
Resource Standard Methods
POST, GET, and PUT - Create, Get, and Update Serving Gateway

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
description string      
mccMnc string      
name string M    
sgwIpAddress array      
Export and Import Serving Gateway

Table 3-75 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
errors array      
errors:message string      
errors:name string      
exportData array M   Exported list of serving gateway. For more information, see Table 3-74
key string     Indicates the ID
sourceVersion string     System version of the product from which data is exported
topic string M   Topic of each managed object
DELETE - delete Serving Gateway

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

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

Resource Name: Time Period

Table 3-77 Supported REST APIs - Time Period

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
Time Period ​/ocpm/pcrf/v1/configuration/policy/timePeriod POST Create Time Period See Table A-3
​​/ocpm/pcrf/v1/configuration/policy/timePeriod/export GET Export Time Period See Table A-1
​/ocpm/pcrf/v1/configuration/policy/timePeriod/import POST Import Time Period See Table A-3
​/ocpm/pcrf/v1/configuration/policy/timePeriod/{timePeriodName} GET Get Time Period See Table A-1
/ocpm/pcrf/v1/configuration/policy/timePeriod/{timePeriodName} PUT Update Time Period See Table A-2
​/ocpm/pcrf/v1/configuration/policy/timePeriod/{timePeriodName} DELETE Delete Time Period See Table A-4
Resource Standard Methods
POST, GET, and PUT - Create, Get, and Update Time Period

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
description string O    
name string M    
precedence string O    
timeSlot array O    

Table 3-79 timeSlot

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
daysOfMonth string O 1  
daysOfWeek string O 1  
endTime string O 1  
monthsOfYear string O 1  
startTime string O 1  
years string O 1  
Export and Import Time Period

Table 3-80 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
errors array      
errors:message string      
errors:name string      
exportData array M   Exported list of time period. For more information, see Table 3-78
key string     Indicates the ID
sourceVersion string     System version of the product from which data is exported
topic string M   Topic of each managed object
DELETE - delete Time Period

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

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

Resource Name: Traffic for ADC Rule

Table 3-82 Supported REST APIs - Traffic for ADC Rule

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
Traffic Adc Rule ​/ocpm/pcrf/v1/configuration/policy/trafficAdcRule POST Create Traffic Adc Rule See Table A-3
​​/ocpm/pcrf/v1/configuration/policy/trafficAdcRule/export GET Export Traffic Adc Rule See Table A-1
​/ocpm/pcrf/v1/configuration/policy/trafficAdcRule/import POST Import Traffic Adc Rule See Table A-3
​/ocpm/pcrf/v1/configuration/policy/trafficAdcRule/{trafficAdcRuleName} GET Get Traffic Adc Rule See Table A-1
/ocpm/pcrf/v1/configuration/policy/trafficAdcRule/{trafficAdcRuleName} PUT Update Traffic Adc Rule See Table A-2
​/ocpm/pcrf/v1/configuration/policy/trafficAdcRule/{trafficAdcRuleName} DELETE Delete Traffic Adc Rule See Table A-4
Resource Standard Methods
POST, GET, and PUT - Create, Get, and Update Traffic ADC Rule

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
description string O    
name string M    
param.diameter.adcRule.FlowStatus string O   Allowed values:
  • 0
  • 1
  • 2
  • 3
param.diameter.adcRule.MeteringMethod string O   Allowed values:
  • 0
  • 1
  • 2
  • 3
param.diameter.adcRule.MonitoringKey string O    
param.diameter.adcRule.Offline string O   Allowed values:
  • 0
  • 1
param.diameter.adcRule.Online string O   Allowed values:
  • 0
  • 1
param.diameter.adcRule.Precedence string O    
param.diameter.adcRule.RatingGroup string O    
param.diameter.adcRule.ReportingLevel string O   Allowed values:
  • 0
  • 1
param.diameter.adcRule.ServiceIdentifier string O    
param.diameter.adcRule.maxAuthDL string O    
param.diameter.adcRule.maxAuthUL string O    
param.diameter.adcRule.name string M    
param.diameter.adcRule.tdfApplicationIdentifier string O    
param.diameter.adcRule.tdfMuteNotification string O   Allowed values:
  • 0
param.diameter.adcRule.tdfRedirectAddressType string O   Allowed values:
  • 0
  • 1
  • 2
  • 3
param.diameter.adcRule.tdfRedirectServerAddress string O    
param.diameter.adcRule.tdfRedirectSupport string O   Allowed values:
  • 0
  • 1
Export and Import Traffic ADC Rule

Table 3-84 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
errors array      
errors:message string      
errors:name string      
exportData array M   Exported list of traffic Adc Rule. For more information, see Table 3-83
key string     Indicates the ID
sourceVersion string     System version of the product from which data is exported
topic string M   Topic of each managed object
DELETE - delete Traffic ADC Rule

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

Field Name Data Type Constraints Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
trafficAdcRuleName string M 1 Traffic ADC Rule Name

Resource Name: Traffic for Diameter QoS

Table 3-86 Supported REST APIs - Traffic for Diameter QoS

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
Traffic Diameter QoS ​/ocpm/pcrf/v1/configuration/policy/trafficDiameterQoS POST Create Traffic Diameter QoS See Table A-3
​​/ocpm/pcrf/v1/configuration/policy/trafficDiameterQoS/export GET Export Traffic Diameter QoS See Table A-1
​/ocpm/pcrf/v1/configuration/policy/trafficDiameterQoS/import POST Import Traffic Diameter QoS See Table A-3
​/ocpm/pcrf/v1/configuration/policy/trafficDiameterQoS/{trafficDiameterQoSName} GET Get Traffic Diameter QoS See Table A-1
/ocpm/pcrf/v1/configuration/policy/trafficDiameterQoS/{trafficDiameterQoSName} PUT Update Traffic Diameter QoS See Table A-2
​/ocpm/pcrf/v1/configuration/policy/trafficDiameterQoS/{trafficDiameterQoSName} DELETE Delete Traffic Diameter QoS See Table A-4
Resource Standard Methods
POST, GET, and PUT - Create, Get, and Update Traffic Diameter QoS

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
description string O    
name string M    
param.diameter.qosProfile.ARP.PreemptionCapability string O   Allowed values:
  • 0
  • 1
param.diameter.qosProfile.ARP.PreemptionVulnerability string O   Allowed values:
  • 0
  • 1
param.diameter.qosProfile.ARP.PriorityLevel string O    
param.diameter.qosProfile.ResourceAllocationNotification string O   Allowed values:
  • 0
param.diameter.qosProfile.maxAuthDL string O    
param.diameter.qosProfile.maxAuthUL string O    
param.diameter.qosProfile.minRateDL string O    
param.diameter.qosProfile.minRateUL string O    
param.diameter.qosProfile.qci string O   Allowed values:
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 65
  • 66
  • 69
  • 70
Export and Import Traffic Diameter QoS

Table 3-88 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
errors array      
errors:message string      
errors:name string      
exportData array M   Exported list of traffic diameter QoS. For more information, see Table 3-87
key string     Indicates the ID
sourceVersion string     System version of the product from which data is exported
topic string M   Topic of each managed object
DELETE - delete Traffic Diameter QoS

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

Field Name Data Type Constraints Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
trafficDiameterQoSName string M 1 Traffic Diameter QoS Name

Resource Name: Traffic for PCC Profile

Table 3-90 Supported REST APIs - Traffic for PCC Profile

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
Traffic PCC Profile ​/ocpm/pcrf/v1/configuration/policy/trafficPccProfile POST Create Traffic PCC Profile See Table A-3
​​/ocpm/pcrf/v1/configuration/policy/trafficPccProfile/export GET Export Traffic PCC Profile See Table A-1
​/ocpm/pcrf/v1/configuration/policy/trafficPccProfile/import POST Import Traffic PCC Profile See Table A-3
​/ocpm/pcrf/v1/configuration/policy/trafficPccProfile/{trafficPccProfileName} GET Get Traffic PCC Profile See Table A-1
/ocpm/pcrf/v1/configuration/policy/trafficPccProfile/{trafficPccProfileName} PUT Update Traffic PCC Profile See Table A-2
​/ocpm/pcrf/v1/configuration/policy/trafficPccProfile/{trafficPccProfileName} DELETE Delete Traffic PCC Profile See Table A-4
Resource Standard Methods
POST, GET, and PUT - Create, Get, and Update Traffic for PCC Profile

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
description string O    
name string M    
param.diameter.pccProfile.ARP.PreemptionCapability string O   Allowed values
  • 0
  • 1
param.diameter.pccProfile.ARP.PreemptionVulnerability string O   Allowed values
  • 0
  • 1
param.diameter.pccProfile.ARP.PriorityLevel string O    
param.diameter.pccProfile.FlowDescriptions string O    
param.diameter.pccProfile.FlowInformations array O    
param.diameter.pccProfile.FlowStatus string O   Allowed values
  • 0
  • 1
  • 2
  • 3
param.diameter.pccProfile.MeteringMethod string O   Allowed values
  • 0
  • 1
  • 2
  • 3
param.diameter.pccProfile.MonitoringKey string O    
param.diameter.pccProfile.Offline string O   Allowed values
  • 0
  • 1
param.diameter.pccProfile.Online string O   Allowed values
  • 0
  • 1
param.diameter.pccProfile.Precedence string O    
param.diameter.pccProfile.RatingGroup string O    
param.diameter.pccProfile.ReportingLevel string O   Allowed values
  • 0
  • 1
  • 2
param.diameter.pccProfile.RequiredAccessInfo string O   Allowed values
  • 1
  • 2
  • 3
param.diameter.pccProfile.ResourceAllocationNotification string O   Allowed values
  • 0
param.diameter.pccProfile.ServiceIdentifier string O    
param.diameter.pccProfile.applicationServiceProviderIdentity string O    
param.diameter.pccProfile.maxAuthDL string O    
param.diameter.pccProfile.maxAuthUL string O    
param.diameter.pccProfile.minRateDL string O    
param.diameter.pccProfile.minRateUL string O    
param.diameter.pccProfile.qci string O   Allowed values:
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 65
  • 66
  • 69
  • 70
param.diameter.pccProfile.sponsorIdentity string O    
param.diameter.pccProfile.tdfApplicationIdentifier string O    
param.diameter.pccProfile.tdfMuteNotification string O   Allowed values
  • 0
param.diameter.pccProfile.tdfRedirectAddressType string O   Allowed values
  • 0
  • 1
  • 2
  • 3
param.diameter.pccProfile.tdfRedirectServerAddress string O    
param.diameter.pccProfile.tdfRedirectSupport string O   Allowed values
  • 0
  • 1

Table 3-92 param.diameter.pccProfile.FlowInformations

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
flowDescription string O    
flowDirection string M   Allowed values:
  • -1
  • 0
  • 1
  • 2
  • 3
tos string O    
tosMask string O    
Export and Import Traffic for PCC Profile

Table 3-93 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
errors array      
errors:message string      
errors:name string      
exportData array M   Exported list of traffic Pcc Profile. For more information, see Table 3-91
key string     Indicates the ID
sourceVersion string     System version of the product from which data is exported
topic string M   Topic of each managed object
DELETE - delete Traffic for PCC Profile

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

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

Resource Name: Traffic for PCC Rule

Table 3-95 Supported REST APIs - Traffic for PCC Rule

Resource Name Resource URI HTTP Method or Custom Operation Description Possible Result Code
Traffic PCC Rule ​/ocpm/pcrf/v1/configuration/policy/trafficPccRule POST Create Traffic PCC Rule See Table A-3
​​/ocpm/pcrf/v1/configuration/policy/trafficPccRule/export GET Export Traffic PCC Rule See Table A-1
​/ocpm/pcrf/v1/configuration/policy/trafficPccRule/import POST Import Traffic PCC Rule See Table A-3
​/ocpm/pcrf/v1/configuration/policy/trafficPccRule/{trafficPccRuleName} GET Get Traffic PCC Rule See Table A-1
/ocpm/pcrf/v1/configuration/policy/trafficPccRule/{trafficPccRuleName} PUT Update Traffic PCC Rule See Table A-2
​/ocpm/pcrf/v1/configuration/policy/trafficPccRule/{trafficPccRuleName} DELETE Delete Traffic PCC Rule See Table A-4
Resource Standard Methods
POST, GET, and PUT - Create, Get, and Update Traffic for PCC Rule

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
description string O    
name string M    
param.diameter.pccRule.ARP.PreemptionCapability string O   Allowed values
  • 0
  • 1
param.diameter.pccRule.ARP.PreemptionVulnerability string O   Allowed values
  • 0
  • 1
param.diameter.pccRule.ARP.PriorityLevel string O    
param.diameter.pccRule.FlowDescriptions string O    
param.diameter.pccRule.FlowInformations array O    
param.diameter.pccRule.FlowStatus string O   Allowed values
  • 0
  • 1
  • 2
  • 3
param.diameter.pccRule.MeteringMethod string O   Allowed values
  • 0
  • 1
  • 2
  • 3
param.diameter.pccRule.MonitoringKey string O    
param.diameter.pccRule.Offline string O   Allowed values
  • 0
  • 1
param.diameter.pccRule.Online string O   Allowed values
  • 0
  • 1
param.diameter.pccRule.Precedence string O    
param.diameter.pccRule.RatingGroup string O    
param.diameter.pccRule.ReportingLevel string O   Allowed values
  • 0
  • 1
  • 2
param.diameter.pccRule.RequiredAccessInfo string O   Allowed values
  • 1
  • 2
  • 3
param.diameter.pccRule.ResourceAllocationNotification string O   Allowed values
  • 0
param.diameter.pccRule.ServiceIdentifier string O    
param.diameter.pccRule.applicationServiceProviderIdentity string O    
param.diameter.pccRule.maxAuthDL string O    
param.diameter.pccRule.maxAuthUL string O    
param.diameter.pccRule.minRateDL string O    
param.diameter.pccRule.minRateUL string O    
param.diameter.pccRule.qci string O   Allowed values:
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 65
  • 66
  • 69
  • 70
param.diameter.pccRule.sponsorIdentity string O    
param.diameter.pccRule.tdfApplicationIdentifier string O    
param.diameter.pccRule.tdfMuteNotification string O   Allowed values
  • 0
param.diameter.pccRule.tdfRedirectAddressType string O   Allowed values
  • 0
  • 1
  • 2
  • 3
param.diameter.pccRule.tdfRedirectServerAddress string O    
param.diameter.pccRule.tdfRedirectSupport string O   Allowed values
  • 0
  • 1

Table 3-97 param.diameter.pccRule.FlowInformations

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
flowDescription string O    
flowDirection string M   Allowed values:
  • -1
  • 0
  • 1
  • 2
  • 3
tos string O    
tosMask string O    
Export and Import Traffic for PCC Rule

Table 3-98 Data structures supported by Export and Import Response Body

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Cardinality Description
date string     Current timestamp
errors array      
errors:message string      
errors:name string      
exportData array M   Exported list of traffic Pcc Ruke. For more information, see Table 3-96
key string     Indicates the ID
sourceVersion string     System version of the product from which data is exported
topic string M   Topic of each managed object
DELETE - delete Traffic for PCC Rule

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

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