2 Policy REST Specifications

This chapter provides information about REST specifications used in Oracle Communications Cloud Native Core Converged Policy (Policy).

Note:

action is a query parameter that has been provided for each individual import api, which can either have replace or ignore value. If the action parameter is not provided, then the default value is ignore.

2.1 Bulwark Pod Congestion Control

Table 2-1 Supported REST APIs for Bulwark Pod Congestion Control Settings

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Get congestion control configurations. GET {apiRoot}/oc-cnpolicy-configuration/v1/congestionConfigurations/{serviceName} See Table A-1
Update congestion control configurations. PUT {apiRoot}/oc-cnpolicy-configuration/v1/congestionConfigurations/{serviceName} See Table A-2

Get and Update Operations

Table 2-2 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
stateChangeSampleCount Integer M Number of continuous interval after which the pods state will change.

Default value:2

stateCalculationInterval Integer M Number of interval after which the pod congestion state will be re-verified.

Default value:5000 (Milliseconds)

activeThresholdProfile String M Threshold profile of resource usage limits for CPU & Queue.

Default value:DEFAULT

Sample body request for Put operation:


{   
    "stateChangeSampleCount": 2,    
    "stateCalculationInterval": 5000,   
    "activeThresholdProfile": "DEFAULT"
}

Table 2-3 Supported REST APIs for Bulwark Pod Congestion Control Threshold Profiles

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Get congestion control threshold profiles. GET {apiRoot}/oc-cnpolicy-configuration/v1/congestionThresholdProfiles/{serviceName} See Table A-1
Update congestion control threshold profile. PUT {apiRoot}/oc-cnpolicy-configuration/v1/congestionThresholdProfiles/{serviceName}/{profileName} See Table A-2
Add congestion control threshold profile. POST {apiRoot}/oc-cnpolicy-configuration/v1/congestionThresholdProfiles/{serviceName}/{profileName} See Table A-3
Delete congestion control threshold profile. DELETE {apiRoot}/oc-cnpolicy-configuration/v1/congestionThresholdProfiles/{serviceName}/{profileName} See Table A-4

Get, Put, and Post Operations

Table 2-4 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
name String M This value should be same as the profileName in path variable.
value.state Enum M The value can be following pod Congestion states:
  • DANGER_OF_CONGESTION
  • CONGESTED
value.resourceUsageLimit Object M The Threshold profiles resource usage limits for CPU & Queue.
isCustomProfile Boolean M Denotes that this profile is custom created.

Note: Currently user can create custom profiles only. Hence this value should be set to true.

Sample body request for Put and Post operations:


{
    name: "profileName",
    isCustomProfile: true,
    value: [      
    {       
      "state": "DANGER_OF_CONGESTION",
      "resourceUsageLimit": {     
          "cpu": 70,          
          "queue": 32        
      }     
    },
    {
      "state": "CONGESTED",       
      "resourceUsageLimit": {
          "cpu": 80, 
          "queue":35
       }
    }
    ]
}

Table 2-5 Supported REST APIs for Bulwark Pod Congestion Control Load Shedding Rules

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Get congestion load shedding profile. GET {apiRoot}/oc-cnpolicy-configuration/v1/congestionLoadSheddingProfile/{serviceName} See Table A-1
Update congestion control configuration. PUT {apiRoot}/oc-cnpolicy-configuration/v1/congestionConfigurations/{serviceName} See Table A-2

Get and Update Operations

Table 2-6 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
name String M Name of the load shedding profile.
loadSheddingRuleName String M Name of profile name which we want to activate.
type Enum M This value will be congestion always.

Sample body request for Put and Post operations:


{
    "name": "profileName",
    "loadSheddingRuleName": "DEFAULT",   
    "type": "congestion"
}

Table 2-7 Supported REST APIs for Bulwark Pod Congestion Control

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Get congestion control load shedding rules. GET {apiRoot}/oc-cnpolicy-configuration/v1/congestionLoadSheddingRule/{serviceName} See Table A-1
Update congestion control load shedding rules. PUT {apiRoot}/oc-cnpolicy-configuration/v1/congestionLoadSheddingRule/{serviceName}/{ruleName} See Table A-2
Add congestion control load shedding rule. POST {apiRoot}/oc-cnpolicy-configuration/v1/congestionLoadSheddingRule/{serviceName}/{ruleName} See Table A-3
Delete congestion control load shedding rule. DELETE {apiRoot}/oc-cnpolicy-configuration/v1/congestionLoadSheddingRule/{serviceName}/{ruleName} See Table A-4

Get, Put, and Post Operations

Table 2-8 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
name String M This value should be same as the ruleName in path variable.
value.state Enum M The value can be following pod Congestion states:
  • DANGER_OF_CONGESTION
  • CONGESTED
value.discardPriority Integer M The discard priority value for the requests.
isCustomProfile Boolean M Denotes that the rule is custom created by user.

Note: Currently user can create custom rules only. Hence this value should be set to true.

Sample body request for Put and Post operations:


{  
    "name": "ruleName",  
    "value": [    
      {      
        "state":"CONGESTED",
        "discardPriority": 5    
      },{     
        "state": "DANGER_OF_CONGESTION",
        "discardPriority": 15   
      }],  
    "isCustomProfile": true
}

2.2 NRF Agent

Table 2-9 Policy General Settings APIs Schema updated for supporting Sbi-correlation:

Description HTTP Method Resource URI Application Type Response Status
Get NRF Agent Service GET {apiRoot}/oc-cnpolicy-configuration/v1/services/nrfAgent application/json See Table A-1
Update NRF Agent Service PUT {apiRoot}/oc-cnpolicy-configuration/v1/services/nrfAgent application/json See Table A-2
Import NRF agent service POST {apiRoot}/oc-cnpolicy-configuration/v1/services/nrfAgent/export application/json  
Export NRF agent service GET {apiRoot}/oc-cnpolicy-configuration/v1/services/nrfAgent/import application/json  

Table 2-10 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/ Optional(O)/ Conditional(C) Description
nrfAgentNfCommProfile String O NRF Agent Communication Profile
onDemandDiscoveryCaching.enableFeature Boolean O

Indicates NRF Client to cache the profile data and use it to process the future discovery on-demand requests.

Default value: false

onDemandDiscoveryCaching.queryParameters String O

Accepts the list of parameters that NRF Client uses to fetch the profile data from cache.

Note: The query parameters in the request from SM service, AM service, UE Policy service must match and must be in the same order as the data received from NRF. Otherwise, NRF Client can not process the request.

Supported values:

  • target-nf-type
  • requester-nf-type
  • target-nf-set-id
  • service-names
  • amf-region-id
  • amf-set-id
  • GUAMI
onDemandDiscoveryCaching.refreshBeforeExpiryTime String O

Indicates the time in milliseconds before expiration when a rediscovery must be performed for the requested discovery parameters.

Default value: 4500

onDemandDiscoveryCaching.limitCacheEntries String O

Parameter to set the upper bound of cache registries allowed to be retained.

Default value: 2000

onDemandDiscoveryCaching.retentionPeriod String O

Indicates the time a record is allowed to stay in database after expiry and before any clean process is executed.

Default value: 864000000

Note: Retention Period value is ignored when force discovery is enabled

onDemandDiscoveryCaching.auditorSchedulerInterval String O

Parameter to set time in milliseconds to activate the Discovery Cache auditor service to clean stale records.

Default value: 1800000

onDemandDiscoveryCaching.auditorPurgePercentage String O

Parameter to set the percentage of the cached DiscoveryRequests that will be pruned once the threshold has been passed.

Default value: 20

Sample Response/Request body structure for GET and PUT operations respectively:

{
  "nrfAgentNfCommProfile": "string"
  "onDemandDiscoveryCaching": 
  {
    "enableFeature": false,
    "queryParameters": [],
    "refreshBeforeExpiryTime": 4500,
    "limitCacheEntries": 2000,
    "retentionPeriod": 864000000,
    "auditorSchedulerInterval": 1800000,
    "auditorPurgePercentage": 20
  }
}

2.3 Error Configurations

API support is available for EXPORT/IMPORT of error handler configurations.

Table 2-11 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Media Type Possible Result Code
Export Error Configuration GET {apiRoot}/oc-cnpolicy-configuration/v1/services/errorHandler/errorConfiguration/export application/json See Table A-1
Import Error Configuration POST {apiRoot}/oc-cnpolicy-configuration/v1/services/errorHandler/errorConfiguration/import application/json See Table A-3
This section describes the body parameters for Error Import or Export Configurations.

Table 2-12 Request/Response Body Parameters

Field Name Data Type Mandatory( M)/ Optional(O)/ Conditional( C) Description
topic string M Topic of each managed object
sourceVersion string O System version of product from which data is exported
date string O Current Timestamp
exportData array O Exported list of error rules configurations

2.4 Diameter Error Codes

Table 2-13 Supported REST APIs - Diameter Error Codes

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Get Diameter Error Codes GET /oc-cnpolicy-configuration/v1/diameter/ diameterErrorCodes/{appId}

200: OK

400: Bad request

404: Not Found

500: Internal Server Error

503: Service Unavailable
Update Diameter Error Codes PUT /oc-cnpolicy-configuration/v1/diameter/ diameterErrorCodes/{appId}

200: OK

400: Bad request

404: Not Found

500: Internal Server Error

503: Service Unavailable
Export Diameter Error Codes GET /oc-cnpolicy-configuration/v1/diameter/ diameterErrorCodes/export

200: OK

400: Bad request

404: Not Found

500: Internal Server Error

503: Service Unavailable
Import Diameter Error Codes POST /oc-cnpolicy-configuration/v1/diameter/ diameterErrorCodes/import

200: OK

400: Bad request

404: Not Found

500: Internal Server Error

503: Service Unavailable

Get and Update Diameter Error Codes

Table 2-14 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
appId string Mandatory Specifies the application ID.
errorCodes array Mandatory Specifies the error parameters.
conditionName string Mandatory Specifies the system defined name for a given condition.
useExperimentalResultCode boolean Optional Indicates whether to use the Result Code AVP (268) or Experimental Result AVP (297) when an error result is generated by Policy.
errorMessage string Optional Specifies the description for a defined condition. It is recommended to use descriptions that clearly explain the condition.
diameterResultCode string Conditional Specifies the Diameter result code for a defined condition.
experimentalResultCode string Conditional Specifies the custom Diameter result code for a defined condition.

Sample Request body for Diameter Error Codes PUT operation:

{
  "appId": "Rx",
  "errorCodes": [
    {
      "conditionName": "IP CAN session not established",
      "useExperimentalResultCode": false,
      "errorMessage": "Enforcement session not found for current request",
      "diameterResultCode": "3012"
    }
  ]
}

Sample Response body structure for Diameter Error Codes GET and PUT operation:

{
  "appId": "Rx",
  "errorCodes": [
    {
      "conditionName": "IP CAN session not established",
      "useExperimentalResultCode": false,
      "errorMessage": "Enforcement session not found for current request",
      "diameterResultCode": "3012"
    }
  ]
}

Import and Export Diameter Error Codes

Table 2-15 Request or Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
topic string Mandatory Topic of each managed object
sourceVersion string Optional System version of product from which data is exported
date string Optional Current timestamp
exportData array Mandatory Exported list of Error Codes.
appId string Mandatory Specifies the application ID.
errorCodes string Mandatory Specifies the error parameters.
conditionName string Mandatory Specifies the error condition name
useExperimentalResultCode Boolean Optional Indicates whether to use the Result Code AVP (268) or Experimental Result AVP (297) when an error result is generated by BSF.
errors.message string Optional Error message
diameterResultCode string Conditional Specifies the custom Diameter result code for a defined condition.

Sample Request Body structure for Diameter Error Codes Import and Export operations:

{
  "topic": "diameter.errorcodes.test",
  "sourceVersion": "23.2.0-od-20230307",
  "date": "2023-03-10T17:44:08Z",
  "exportData": [
    {
      "appId": "Rx",
      "errorCodes": [
        {
          "conditionName": "IP CAN session not established",
          "useExperimentalResultCode": false,
          "errorMessage": "Enforcement session not found for current request",
          "diameterResultCode": "3012"
        }
      ]
    }
  ]
}

2.5 Session Viewer

Table 2-16 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Get Session GET ​{apiRoot}​/oc-cnpolicy-query​/v1​/sessions See Table A-1
Delete Session DELETE ​{apiRoot}/oc-cnpolicy-query​/v1​/sessions See Table A-4

Get and Delete Session

Table 2-17 Request Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
getUserData boolean M Allowed Values:
  • true
  • false
identifierType string M Allowed Values:
  • SUPI
  • IMSI
  • MSISDN
  • POLICY_ASSOC_ID
  • DIAMETER_SESSION_ID
  • GPSI
  • PEI

SM Service supports all the values from 1-6

UE Service supports SUPI, GPSI, PEI, and POLICY_ASSOC_ID

AM Service supports SUPI, GPSI, and POLICY_ASSOC_ID

PA service only supports POLICY_ASSOC_ID

PCRF-CORE supports (IMSI , MSISDN ,IPV4, IPV6, DIAMETER_SESSION_ID)

USER-DATA supports SUPI and GPSI

UE Service supports ( SUPI and POLICY_ASSOC_ID)

Usage Monitoring supports SUPI and GPSI

ALL supports SUPI and GPSI
identifierValue string M Indicates the value of the selected identifier type.
remote boolean O Allowed Values:
  • true
  • false
sessionType string M Allowed Values:
  1. SM_Policy_Association
  2. AM_Policy_Association
  3. PA_Policy_Association
  4. PCRF_Core_Session
  5. Binding_Session
  6. User_Data
  7. UE_Policy_Association
  8. Usage_Monitoring
  9. All
DELETE with "All" option is implemented to delete all subscriber/session for SM and PA session type only.
sessionSubtype string O Allowed Values:
  • ALL
  • GX
  • RX
  • SD

Sample Response body structure for GET operation:

"string"

cURL Commands

The following are sample cURL commands for some of the services:

For UE Service

  • GET

    curl -X GET "http://<localhost>/oc-cnpolicy-query/v1/sessions?identifierType=POLICY_ASSOC_ID&identifierValue=5bc04e63-b2b8-4084-b8d5-577c8d05a0b2&sessionType=UE_Policy_Association" -H "accept: application/json"

  • DELETE

    curl -X DELETE "http://<localhost>/oc-cnpolicy-query/v1/sessions?identifierType=SUPI&identifierValue=imsi-10000000002&sessionType=UE_Policy_Association" -H "accept: application/json"

For PA Service

  • GET

    curl -X GET "http://<localhost>/oc-cnpolicy-query/v1/sessions?identifierType=POLICY_ASSOC_ID&identifierValue=5bc04e63-b2b8-4084-b8d5-577c8d05a0b2&sessionType=PA_Policy_Association" -H "accept: application/json"

  • DELETE

    curl -X DELETE "http://<localhost>/oc-cnpolicy-query/v1/sessions?identifierType=POLICY_ASSOC_ID&identifierValue=73c3a7cd-afdb-4ce6-828b-a0fd2bd401ae&sessionType=PA_Policy_Association" -H "accept: application/json"

For AM Service

  • GET

    curl -X GET "http://<localhost>/oc-cnpolicy-query/v1/sessions?identifierType=supi&identifierValue=imsi-450081000000001&sessionType=AM_Policy_Association" -H "accept: application/json"

  • DELETE

    curl -X DELETE "http://<localhost>/oc-cnpolicy-query/v1/sessions?identifierType=SUPI&identifierValue=imsi-450081000000001&sessionType=AM_Policy_Association" -H "accept: application/json"

For PCRF Core Service

  • GET

    curl -X 'GET' \ 'https://<localhost>/oc-cnpolicy-query/v1/sessions?getUserData=true&identifierType=MSISDN&identifierValue=01151601062&sessionType=PCRF_Core_Session' \ -H 'accept: application/json'

  • DELETE

    curl -X 'DELETE' \ 'https://<localhost>/oc-cnpolicy-query/v1/sessions?getUserData=true&identifierType=MSISDN&identifierValue=01151601062&sessionType=PCRF_Core_Session' \ -H 'accept: application/json'

2.6 Global Configurations

Table 2-18 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Get Individual General Configuration GET {apiRoot}/oc-cnpolicy-configuration/v1/general See Table A-1
Update General Configuration PUT {apiRoot}/oc-cnpolicy-configuration/v1/general See Table A-2
Export Global Configurations GET {apiRoot}/oc-cnpolicy-configuration/v1/general/export See Table A-1
Import Global Configurations POST {apiRoot}/oc-cnpolicy-configuration/v1/general/import See Table A-3

Get and Update Operations

Table 2-19 Request/Response Body Parameters

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

Default Value: TRUE

enableTLS boolean O This determines if TLS is enabled

Default Value: TRUE

enableTracing boolean O This determines if tracing is enabled

Default Value: TRUE

enableSubscriberLog boolean O This determines if subscriber logging is enabled for a subscriber

Default Value: FALSE

perHost string O Valid url of PER host to receive the PER record. The format of the url is: http://per-host:per-port, where per-host specifies the PER host and per-port specifies the PER port. For example, http://localhost:8101/v1/echo
enablePER boolean O This determines whether to enable/disable Policy Event Record (PER) feature

Default Value: false

enableSBICorrelation boolean O This determines whether to enable/disable correlation-info header in PCF

Default Value: false

Sample Request body structure for PUT operations:

{
  "apiGatewayHost": "string",
  "apiGatewayPort": 80,
  "enableMetrics": true,
  "enablePER": true,
  "enableSubscriberLog": true,
  "enableTls": true,
  "enableTracing": true,
  "perHost": "string",
  "enableSBICorrelation": true
}

Sample Response body structure for GET and PUT operations:

{
  "apiGatewayHost": "string",
  "apiGatewayPort": 80,
  "enableMetrics": true,
  "enablePER": true,
  "enableSubscriberLog": true,
  "enableTls": true,
  "enableTracing": true,
  "perHost": "string",
  "enableSBICorrelation": true
}

Export/Import Global Configurations

Table 2-20 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData array   Exported list of diameter settings. For more information, see Get and Update Operations
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "exportData": {
    "apiGatewayHost": "string",
    "apiGatewayPort": 80,
    "enableMetrics": true,
    "enablePER": true,
    "enableSubscriberLog": true,
    "enableTls": true,
    "enableTracing": true,
    "perHost": "string",
    "enableSBICorrelation": true
  },
  "sourceVersion": "string",
  "topic": "string"
}

2.7 Subscriber Logging

Table 2-21 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Subscriber Logging POST {apiRoot}/oc-cnpolicy-configuration​/v1/subscriberActivityLogging See Table A-3
Export Subscriber Logs GET ​{apiRoot}/oc-cnpolicy-configuration​/v1/subscriberActivityLogging/export See Table A-1
Import Subscriber Logs POST {apiRoot}​/oc-cnpolicy-configuration​/v1/subscriberActivityLogging/import See Table A-3
Get Subscriber Logging GET {apiRoot}​/oc-cnpolicy-configuration​/v1/subscriberActivityLogging/{identifierValue} See Table A-1
Update Subscriber Logging PUT {apiRoot}​/oc-cnpolicy-configuration​/v1/subscriberActivityLogging/{identifierValue} See Table A-2
Delete Subscriber Logging DELETE ​{apiRoot}​/oc-cnpolicy-configuration​/v1/subscriberActivityLogging/{identifierValue} See Table A-4

Get and Create Subscriber Logging

Table 2-22 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
enable boolean O  
type string O  
value string M  

Sample Request body structure for POST operation:

{
  "enable": true,
  "type": "gpsi",
  "value": "string"
}

Sample Response body structure for GET, POST, and PUT operations:

[
  {
    "date": "string",
    "errors": [
      {
        "message": "string",
        "name": "string"
      }
    ],
    "exportData": [
      {
        "enable": true,
        "type": "gpsi",
        "value": "string"
      }
    ],
    "sourceVersion": "string",
    "topic": "string"
  }
]

Delete Subscriber Logging

Table 2-23 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
identifierValue string M Subscriber Identifier

Export/Import Subscriber Logging s

Table 2-24 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string O Current timestamp
exportData array M Exported list of subscriber logs. For more information, see Get and Create Subscriber Logging.
sourceVersion string O System version of product from which data is exported
topic string M Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "enable": true,
      "type": "gpsi",
      "value": "string"
    }
  ],
  "sourceVersion": "string",
  "topic": "string"
}

2.8 Reattempts Profile

This section describes the service URIs available to create and configure reattempt profiles for Policy.

Table 2-25 Supported REST APIs for Reattempt Profile

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Reattempt Profile POST {apiRoot}/oc-cnpolicy-configuration/v1/services/common/reattemptsProfile See Table A-3
Get Reattempt Profile GET {apiRoot}​/oc-cnpolicy-configuration/v1/services/common/reattemptsProfile/{retryProfileName} See Table A-1
Update Reattempt Profile PUT {apiRoot}/oc-cnpolicy-configuration/v1/services/common/reattemptsProfile/{retryProfileName} See Table A-2
Export Reattempt Profiles GET {apiRoot}/oc-cnpolicy-configuration/v1/services/common/reattemptsProfile/export See Table A-1
Import Reattempt Profiles POST {apiRoot}/oc-cnpolicy-configuration/v1/services/common/reattemptsProfile/import See Table A-3
Delete Reattempt Profile DELETE {apiRoot}/oc-cnpolicy-configuration/v1/services/common/reattemptsProfile/{retryProfileName} See Table A-4

Request and Response Body Parameters

This section describes the request and response parameters used in reattempt profile APIs.

Table 2-26 Request and Response Body Parameters (for POST and PUT operations)

Field Name Data Type Description
name  

The unique name for the reattempt profile. This name is used to refer to the reattempt profile in other service configuration screen, such as SM Service.

The name can only contain the characters A–Z, a–z, 0–9, period (.), hyphen (-), and underline (_). The maximum length is 255 characters.
interfaceType   The interface for which a reattempt profile is being created.

Note: Policy supports only the BSF Interface.

reattemptSettings.numberofAttempts  

The maximum number of allowed recreate attempts. The number of reattempts that must be run when PCF Binding request fails.

Range: 0 to 50

reattemptSettings.backOffTimeConfig   The amount of time that represents each back-off timer.
The Back-off timer configurations table includes the following parameters:
  • Index: Represents the number of back-off timer
  • Back-Off Timer: The timer value in seconds
  • Max Random Number (Millisecond): Any random number that is added to the back-off timer.

Range: 0-5000 milliseconds

Note: In case the number of configured attempts in the Back-off timer configurations table is less than the set value for Maximum Number of Attempts, the remaining attempts uses the back off timer and max random number of the last configured attempt.

Note: Policy supports a maximum of 10 back-off timer configurations.

reattemptSettings.thresholdLimitLevel  

The threshold limit for the Pending Operations. Once this value is reached, no pending operations are added to the table.

Default Value: 1000

Sample Request body structure for POST and PUT operations:

{
    "name": "profile-name",
    "interfaceType": BSF,
    "reattemptSettings": {
        "numberOfAttempts": 0,
        "backOffTimerConfig": [],
        "thresholdLimitLevel": 0,
    }
}

cURL Command for GET

curl -X GET "http://<IP Address>/api-docs/oc-cnpolicy-configuration/v1/services/common/reattemptsProfile/<retryProfileName>" -H "accept: application/json"

cURL Command for POST

curl -X POST "http://<IP Address>/api-docs/oc-cnpolicy-configuration/v1/services/common/reattemptsProfile" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"alternateRoutingSettings\": { \"enableFallback\": true, \"errorCodesAlternateRoute\": [ { \"errorCauses\": [ \"string\" ], \"errorCode\": 0 } ], \"errorCodesReAttempt\": [ { \"errorCauses\": [ \"string\" ], \"errorCode\": 0 } ], \"localityPreference\": \"DIFFERENT\", \"maxNumOfAlternateRoutingAttempts\": 3, \"nfSetPreference\": \"DIFFERENT\", \"priorityPool\": false, \"reAttemptFailedNF\": true, \"reAttemptSameNf\": true, \"retryFallbackAfterInterval\": 900, \"useAlternateSCPforAlternateRouting\": true, \"useSbiBindingInformation\": true }, \"enableAlternateRouting\": true, \"enableRetry\": true, \"name\": \"string\", \"retrySettings\": { \"maximumNumberOfRetries\": 3 }, \"serverHeaderSupport\": \"DISABLED\"}"

Export or Import Retry Profile

Table 2-27 Response Body Parameters for Import Request

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string O Specifies the current timestamp
errors:message string O Specifies the error message.
errors:name string O Specifies the name of the error.
exportData array M Exported retry profile. For more information, see Table 2-29.
key string O Indicates the ID of Retry Profile
sourceVersion string O System version of product from which data is exported
topic string M Topic of each managed object

Sample Request Body structure for Import and Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
  {
    "name": "profile-name",
    "interfaceType": BSF,
    "reattemptSettings": {
        "numberOfAttempts": 0,
        "backOffTimerConfig": [],
        "thresholdLimitLevel": 0,
    }
}
}

2.9 Retry Profile

This section describes the service URIs available to create and configure retry profiles for Policy.

Table 2-28 Supported REST APIs for Retry Profile

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Retry Profile POST {apiRoot}/oc-cnpolicy-configuration/v1/services/common/retryprofiles See Table A-3
Get Retry Profile GET {apiRoot}​/oc-cnpolicy-configuration/v1/services/common/retryprofiles/{retryProfileName} See Table A-1
Update Retry Profile PUT {apiRoot}/oc-cnpolicy-configuration/v1/services/common/retryprofiles/{retryProfileName} See Table A-2
Export Retry Profiles GET {apiRoot}/oc-cnpolicy-configuration/v1/services/common/retryprofiles/export See Table A-1
Import Retry Profiles POST {apiRoot}/oc-cnpolicy-configuration/v1/services/common/retryprofiles/import See Table A-3
Delete Retry Profile DELETE {apiRoot}/oc-cnpolicy-configuration/v1/services/common/retryprofiles/{retryProfileName} See Table A-4

Request and Response Body Parameters

This section describes the request and response parameters used in retry profile APIs.

Table 2-29 Request and Response Body Parameters (for POST and PUT operations)

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
alternateRoutingSettings AlternateRoutingSettings Optional Specifies the alternate routing settings for a retry profile.
enableAlternateRouting boolean Optional

Specifies whether to enable or disable alternate routing.

On enabling this switch, ensure that you configure the parameters under the Alternate Routing Settings group.

When enabled, alternate routing is attempted when Policy messages are not delivered successfully to an external NF destination. It may happen because of an exception on the Egress Gateway, such as connection error, timeout, or a failure returned by the external NF or an intermediate router.
enableRetry boolean Optional

Specifies whether to enable or disable retry for failed messages between core microservices of Policy.

On enabling this switch, ensure that you configure the parameters under Retry Settings group. However, if the switch is disabled, the configurations in the Retry Settings group are not taken into consideration.

When enabled, retries are attempted when PCF encounters internal send failures for egress messages.

A failure to send egress messages internally indicates an exception in the core service, such as SM service, UDR or CHF connector, and so on. The exception can occur while connecting to the next microservice or a failure on the microservice itself. For example, egress message did not reach the egress gateway. This also includes the connection errors and timeouts on the core microservice.

Note: Since the failure is internal, the external NF and SCP (if applicable) remain the same during retry attempt.

name string Optional

The name can only contain the characters A–Z, a–z, 0–9, period (.), hyphen (-), and underline (_). The maximum length is 255 characters.

 Specifies the unique name for the retry profile.
retrySettings RetrySettings Optional Specifies the retry settings for a retry profile.
serverHeaderSupport Enum
The valid values for this parameter are as follow:
  • DISABLED
  • MULTI_INSTANCE
  • SINGLE_INSTANCE
 Optional

Specifies whether to enable or disable server header. The value configured in this parameter is used when PCF acts as a consumer and receives server header in error response messages.

  • Disabled: Disable server header. On disabling server header, Policy as a consumer searches for alternate producer without considering the value of server header.
  • Single Instance: Accept only one value in the server header. When the value is configured as Single Instance and server header contains multiple values, Policy rejects the header.
  • Multi Instance: Accept only one value in the server header.

Table 2-30 AlternateRoutingSettings

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
enableFallback boolean Optional Specifies whether to enable or disable falling back to the higher priority destination that failed earlier (after the retry interval). Policy attempts fallback even if the current destination is available.

When enabled, Policy attempts to fallback to a higher priority NF destination. The priority of NF destination is determined by Alternate Route service (either via DNS-SRV resolution or by static configuration).

By default, it is disabled.
errorCodesAlternateRoute AlternateRoutingErrorCodes Optional Specifies the HTTP error codes for which Policy retries alternate routing on receiving the error response from the destination network function or Egress Gateway.
errorCodesReAttempt AlternateRoutingErrorCodes Optional Specifies the HTTP error codes for which Policy does not look for alternate producer and retries the request to the same producer NF or SCP that failed in the first attempt.

Policy considers this parameter only when Re-attempt to same NF switch is enabled.

localityPreference ENUM
The valid values for this parameter are as follow:
  • DIFFERENT
  • NONE
  • SAME
 Optional

Specifies the locality preference when choosing the alternate producer for a failed request.

Policy excludes the producer (received in the failed request) and selects an alternate producer based on the value provided for this attribute.

  • Same: Chooses the next producer from the same locality as the previous request.
  • Different: Chooses the next producer from a different locality.
  • None (default): Locality filter does not apply.
maxNumOfAlternateRoutingAttempts boolean Optional

Specifies the number of retries that PCF attempts on receiving error response from Ingress Gateway. The number of retry attempts can be in the range of 1 to 10.

Note: The value configured for this parameter does not include the initial attempt. For instance, if you set the value as 3, Policy performs the retry cycle three times after the initial attempt.

If the retry attempts are exhausted, Policy fails the transaction with an exception. In certain cases, the number of retry attempts can be greater than the available alternate destinations to be tried. If such a situation arises, Policy fails the transaction when no alternate destination is available even if retry attempts are still available.
nfSetPreference ENUM
The valid values for this parameter are as follow:
  • DIFFERENT
  • NONE
  • SAME
 Optional

Specifies the NF set preference when choosing the alternate producer for an initial request.

Policy excludes the producer (received in the failed request) and selects an alternate producer based on the value provided for this attribute.

  • Same: Selects the next producer from the same NFSet as the previous request.
  • Different: Selects the next producer from a different NFSet.
  • None (default): NFSets filter does not apply.

Note: This parameter applies only to initial requests. For subsequent requests, the default behavior is to choose the same NFSet irrespective of the value configured for this field.

reAttemptFailedNF boolean Optional

When you set the value for this parameter to true, Policy initiates the retry cycle and sends request to the selected NF when the following conditions are true:

  • Retry attempts made to all available NF instances
  • Maximum Number of Alternate Routing Attempt is not exhausted
reAttemptSameNf boolean Optional

Specifies whether Policy shall send the request to the same NF that failed in the first attempt. If you set the value to true, make sure to configure the value for errorCodesReAttempt attribute.

By default, the value is false for this parameter.
retryFallbackAfterInterval integer Optional

Specifies the time in seconds after which Policy re-attempts a request to a higher priority destination.

In case of fallback, when a route is being determined while the current destination has not failed, PCF attempts to fallback to a higher priority NF destination. Priority of NF destination is determined by Alternate Route service, either through DNS-SRV resolution or static configuration.

You can set the value for retry after interval from 0 to 86,400 seconds.

By default, the value is set to 0, which means that a high priority destination is blocklisted.

Note:

  • This configuration applies to subsequent message routing only.

  • Blacklisting may still be done by Egress Gateway

  • An NF destination (FQDN) is not re-attempted within the context of a single operation, such as SM Modification request
useAlternateSCPforAlternateRouting boolean Optional

Specifies whether to enable or disable choosing alternate SCP to reach the alternate destination.

If you set the value for this parameter as true, Egress Gateway uses an alternate SCP for routing to an alternate NF destination. If there are fewer SCPs than alternate NF destinations, Egress Gateway tries sending the request through one of the previously used SCPs.

Note: Additional SCP configuration is required for Egress Gateway. For more information, see Oracle Communications Cloud Native Core, Converged Policy Installation, Upgrade and Fault Recovery Guide.

useSbiBindingInformation boolean Optional

Specifies whether to enable or disable use of information received in 3gpp-sbi-binding header. When Policy receives the unique NF Instance ID in the error response, it retrieves 3gpp-sbi-binding header for that particular NF instance, and then extracts the SetId to choose the alternate producer. This parameter is considered only for subsequent retry requests.

By default, the value is false for this attribute.

Note: When the value is set to false, the NFSet Preference parameter is not taken into consideration.

Table 2-31 AlternateRoutingErrorCodes

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

You can configure up to five error causes per error code.

 Specifies the HTTP error code. For example, 504
errorCode integer Mandatory

You can configure up to 10 error codes for a retry profile.

Enter a range in [100-999] number

 Specifies the error cause. For example, GATEWAY_TIMEOUT, NF_TIMEOUT.

Table 2-32 RetrySettings

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
maximumNumberOfRetries integer Optional

The number of retry attempts can be in the range of 1 to 10.

Note: It is mandatory to configure this parameter if Retry on Internal Send Failure parameter is set to true.

Specifies the number of retries that PCF attempts on encountering failure while sending egress messages between Policy core microservices.

Note: The value configured for this parameter does not include the initial attempt. For instance, if you set the value as 3, Policy performs the retry cycle three times after the initial attempt.

Sample Request body structure for POST and PUT operations:

{
  "alternateRoutingSettings": {
    "enableFallback": true,
    "errorCodesAlternateRoute": [
      {
        "errorCauses": [
          "string"
        ],
        "errorCode": 0
      }
    ],
    "errorCodesReAttempt": [
      {
        "errorCauses": [
          "string"
        ],
        "errorCode": 0
      }
    ],
    "localityPreference": "DIFFERENT",
    "maxNumOfAlternateRoutingAttempts": 3,
    "nfSetPreference": "DIFFERENT",
    "reAttemptFailedNF": true,
    "reAttemptSameNf": true,
    "retryFallbackAfterInterval": 900,
    "useAlternateSCPforAlternateRouting": true,
    "useSbiBindingInformation": true
  },
  "enableAlternateRouting": true,
  "enableRetry": true,
  "name": "string",
  "retrySettings": {
    "maximumNumberOfRetries": 3
  },
  "serverHeaderSupport": "DISABLED"
}

Sample Response body structure for GET, POST, and PUT operations:

{
  "alternateRoutingSettings": {
    "enableFallback": true,
    "errorCodesAlternateRoute": [
      {
        "errorCauses": [
          "string"
        ],
        "errorCode": 0
      }
    ],
    "errorCodesReAttempt": [
      {
        "errorCauses": [
          "string"
        ],
        "errorCode": 0
      }
    ],
    "localityPreference": "DIFFERENT",
    "maxNumOfAlternateRoutingAttempts": 3,
    "nfSetPreference": "DIFFERENT",
    "reAttemptFailedNF": true,
    "reAttemptSameNf": true,
    "retryFallbackAfterInterval": 900,
    "useAlternateSCPforAlternateRouting": true,
    "useSbiBindingInformation": true
  },
  "enableAlternateRouting": true,
  "enableRetry": true,
  "name": "string",
  "retrySettings": {
    "maximumNumberOfRetries": 3
  },
  "serverHeaderSupport": "DISABLED"
}

cURL Command for GET

curl -X GET "http://10.75.168.25:31679/api-docs/oc-cnpolicy-configuration/v1/services/common/retryprofiles/<retryProfileName>" -H "accept: application/json"

cURL Command for POST

curl -X POST "http://10.75.168.25:31679/api-docs/oc-cnpolicy-configuration/v1/services/common/retryprofiles" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"alternateRoutingSettings\": { \"enableFallback\": true, \"errorCodesAlternateRoute\": [ { \"errorCauses\": [ \"string\" ], \"errorCode\": 0 } ], \"errorCodesReAttempt\": [ { \"errorCauses\": [ \"string\" ], \"errorCode\": 0 } ], \"localityPreference\": \"DIFFERENT\", \"maxNumOfAlternateRoutingAttempts\": 3, \"nfSetPreference\": \"DIFFERENT\", \"priorityPool\": false, \"reAttemptFailedNF\": true, \"reAttemptSameNf\": true, \"retryFallbackAfterInterval\": 900, \"useAlternateSCPforAlternateRouting\": true, \"useSbiBindingInformation\": true }, \"enableAlternateRouting\": true, \"enableRetry\": true, \"name\": \"string\", \"retrySettings\": { \"maximumNumberOfRetries\": 3 }, \"serverHeaderSupport\": \"DISABLED\"}"

Export or Import Retry Profile

Table 2-33 Response Body Parameters for Import Request

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string O Specifies the current timestamp
errors:message string O Specifies the error message.
errors:name string O Specifies the name of the error.
exportData array M Exported retry profile. For more information, see Table 2-29.
key string O Indicates the ID of Retry Profile
sourceVersion string O System version of product from which data is exported
topic string M Topic of each managed object

Sample Request Body structure for Import and Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "alternateRoutingSettings": {
        "enableFallback": true,
        "errorCodesAlternateRoute": [
          {
            "errorCauses": [
              "string"
            ],
            "errorCode": 0
          }
        ],
        "errorCodesReAttempt": [
          {
            "errorCauses": [
              "string"
            ],
            "errorCode": 0
          }
        ],
        "localityPreference": "DIFFERENT",
        "maxNumOfAlternateRoutingAttempts": 3,
        "nfSetPreference": "DIFFERENT",
        "reAttemptFailedNF": true,
        "reAttemptSameNf": true,
        "retryFallbackAfterInterval": 900,
        "useAlternateSCPforAlternateRouting": true,
        "useSbiBindingInformation": true
      },
      "enableAlternateRouting": true,
      "enableRetry": true,
      "name": "string",
      "retrySettings": {
        "maximumNumberOfRetries": 3
      },
      "serverHeaderSupport": "DISABLED"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "systemVersion": "string",
  "topic": "string"
}

2.10 Timer Profile

Table 2-34 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Timer Profile POST {apiRoot}/oc-cnpolicy-configuration/v1/services/common/timerprofiles See Table A-3
Get Timer Profile GET ​/oc-cnpolicy-configuration/v1/services/common/timerprofiles/{serviceType} See Table A-1
Update Timer Profile PUT {apiRoot}/oc-cnpolicy-configuration/v1/services/common/timerprofiles/{serviceType} See Table A-2
Export Timer Profiles GET {apiRoot}/oc-cnpolicy-configuration/v1/services/common/timerprofiles/export See Table A-1
Import Timer Profiles POST {apiRoot}/oc-cnpolicy-configuration/v1/services/common/timerprofiles/import See Table A-3
Delete Timer Profile DELETE {apiRoot}/oc-cnpolicy-configuration/v1/services/common/timerprofiles/{serviceType} See Table A-4

Get, Create, and Update Timer Profiles

Table 2-35 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C)aints Description
serviceType string M Defines the service type.
AF.svcTimeoutMapping.notification integer   Timeout value specified in “3gpp-Sbi-Max-Rsp-Time” header for the notification service.
AMF.svcTimeoutMapping.namf-comm integer   Timeout value specified in “3gpp-Sbi-Max-Rsp-Time” header for the namf-comm service.
BSF.svcTimeoutMapping.nbsf-management integer   Timeout value specified in “3gpp-Sbi-Max-Rsp-Time” header for the nbsfmanagement service.
CHF.svcTimeoutMapping.nchf-spendinglimitcontrol integer   Timeout value specified in “3gpp-Sbi-Max-Rsp-Time” header for the nchfspendinglimitcontrol service.
SMF.svcTimeoutMapping.notification integer   Timeout value specified in “3gpp-Sbi-Max-Rsp-Time” header for the notification service.
UDR.svcTimeoutMapping.nudr-dr integer   Timeout value specified in “3gpp-Sbi-Max-Rsp-Time” header for the nudr-dr service.

Sample Request body structure for POST and PUT operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "AF": {
        "svcTimeoutMapping": {
          "notification": 3000
        }
      },
      "AMF": {
        "svcTimeoutMapping": {
          "namf-comm": 3000
        }
      },
      "BSF": {
        "svcTimeoutMapping": {
          "nbsf-management": 3000
        }
      },
      "CHF": {
        "svcTimeoutMapping": {
          "nchf-spendinglimitcontrol": 3000
        }
      },
      "SMF": {
        "svcTimeoutMapping": {
          "notification": 3000
        }
      },
      "UDR": {
        "svcTimeoutMapping": {
          "nudr-dr": 3000
        }
      },
      "serviceType": "string"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "systemVersion": "string",
  "topic": "string"
}

Sample Response body structure for GET, POST, and PUT operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "AF": {
        "svcTimeoutMapping": {
          "notification": 3000
        }
      },
      "AMF": {
        "svcTimeoutMapping": {
          "namf-comm": 3000
        }
      },
      "BSF": {
        "svcTimeoutMapping": {
          "nbsf-management": 3000
        }
      },
      "CHF": {
        "svcTimeoutMapping": {
          "nchf-spendinglimitcontrol": 3000
        }
      },
      "SMF": {
        "svcTimeoutMapping": {
          "notification": 3000
        }
      },
      "UDR": {
        "svcTimeoutMapping": {
          "nudr-dr": 3000
        }
      },
      "serviceType": "string"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Export/Import Timer Profiles

Table 2-36 Request/Response Body Parameters

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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "AF": {
        "svcTimeoutMapping": {
          "notification": 3000
        }
      },
      "AMF": {
        "svcTimeoutMapping": {
          "namf-comm": 3000
        }
      },
      "BSF": {
        "svcTimeoutMapping": {
          "nbsf-management": 3000
        }
      },
      "CHF": {
        "svcTimeoutMapping": {
          "nchf-spendinglimitcontrol": 3000
        }
      },
      "SMF": {
        "svcTimeoutMapping": {
          "notification": 3000
        }
      },
      "UDR": {
        "svcTimeoutMapping": {
          "nudr-dr": 3000
        }
      },
      "serviceType": "string"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "systemVersion": "string",
  "topic": "string"
}

2.11 Retry Profile for PCC

Table 2-37 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create PCC Retry Profile POST {apiRoot}/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/pccretryprofiles See Table A-3
Export PCC Retry Profile GET ​{apiRoot}​/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/pccretryprofiles​/export See Table A-1
Import PCC Retry Profile POST ​{apiRoot}​/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/pccretryprofiles​/import See Table A-3
Get PCC Retry Profile GET ​{apiRoot}​/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/pccretryprofiles​/{pccRetryProfileName} See Table A-1
Update PCC Retry Profile PUT ​{apiRoot}​/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/pccretryprofiles​/{pccRetryProfileName} See Table A-2
Delete PCC Retry Profile DELETE ​{apiRoot}​/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/pccretryprofiles​/{pccRetryProfileName} See Table A-4

Create, Get, and Update Retry Profile for PCC

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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

Sample Request Body structure for POST and PUT operations:

{
  "backOffInterval": 0,
  "description": "string",
  "id": "string",
  "initialRetryInterval": 0,
  "maxRetryAttempt": 0,
  "maxRetryCycles": 0,
  "maxRetryInterval": 0,
  "name": "string",
  "ruleFailureCode": [
    "AN_GW_FAILED"
  ]
}

Sample Response Body structure for GET, POST and PUT operations:

{
  "backOffInterval": 0,
  "description": "string",
  "id": "string",
  "initialRetryInterval": 0,
  "maxRetryAttempt": 0,
  "maxRetryCycles": 0,
  "maxRetryInterval": 0,
  "name": "string",
  "ruleFailureCode": [
    "AN_GW_FAILED"
  ]
}

Export/Import Retry Profile for PCC

Table 2-39 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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 2-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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "backOffInterval": 0,
      "description": "string",
      "id": "string",
      "initialRetryInterval": 0,
      "maxRetryAttempt": 0,
      "maxRetryCycles": 0,
      "maxRetryInterval": 0,
      "name": "string",
      "ruleFailureCode": [
        "AN_GW_FAILED"
      ]
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Delete Retry Profile for PCC

Table 2-40 Request/Response Body Parameters

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

2.12 Retry Profile for ADC

Table 2-41 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create ADC Retry Profile POST {apiRoot}/oc-cnpolicy-configuration/v1/policydata/pcrf/adcretryprofiles See Table A-3
Export ADC Retry Profile GET {apiRoot}/oc-cnpolicy-configuration/v1/policydata/pcrf/adcretryprofiles/export See Table A-1
Import ADC Retry Profile POST ​{apiRoot}/oc-cnpolicy-configuration/v1/policydata/pcrf/adcretryprofiles/export See Table A-3
Get ADC Retry Profile GET ​{apiRoot}/oc-cnpolicy-configuration/v1/policydata/pcrf/adcretryprofiles/{adcRetryProfileName} See Table A-1
Update ADC Retry Profile PUT ​{apiRoot}/oc-cnpolicy-configuration/v1/policydata/pcrf/adcretryprofiles/{adcRetryProfileName} See Table A-2
Delete ADC Retry Profile DELETE ​{apiRoot}/oc-cnpolicy-configuration/v1/policydata/pcrf/adcretryprofiles/{adcRetryProfileName} See Table A-4

Create, Get, and Update Retry Profile for ADC

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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

Sample Request Body structure for POST and PUT operations:

{
  "backOffInterval": 0,
  "description": "string",
  "id": "string",
  "initialRetryInterval": 0,
  "maxRetryAttempt": 0,
  "maxRetryCycles": 0,
  "maxRetryInterval": 0,
  "name": "string",
  "ruleFailureCode": [
    "AN_GW_FAILED"
  ]
}

Sample Response Body structure for GET, POST and PUT operations:

{
  "backOffInterval": 0,
  "description": "string",
  "id": "string",
  "initialRetryInterval": 0,
  "maxRetryAttempt": 0,
  "maxRetryCycles": 0,
  "maxRetryInterval": 0,
  "name": "string",
  "ruleFailureCode": [
    "AN_GW_FAILED"
  ]
}

Export/Import Retry Profile for ADC

Table 2-43 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
errors array    
errors:message string    
errors:name string    
exportData array M Exported list of ADC retry profile.
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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "backOffInterval": 0,
      "description": "string",
      "id": "string",
      "initialRetryInterval": 0,
      "maxRetryAttempt": 0,
      "maxRetryCycles": 0,
      "maxRetryInterval": 0,
      "name": "string",
      "ruleFailureCode": [
        "AN_GW_FAILED"
      ]
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Delete Retry Profile for ADC

Table 2-44 Request/Response Body Parameters

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

2.13 Site Takeover

This section describes the service URIs available to create and configure sites for takeover for Policy.

Table 2-45 Supported REST APIs for Site Takeover

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Export Site Takeovers GET {apiRoot}/oc-cnpolicy-configuration/v1/services/common/sitetakeover/export See Table A-1
Import Site Takeovers POST {apiRoot}/oc-cnpolicy-configuration/v1/services/common/sitetakeover/import See Table A-3

Export or Import Site Takeover

Table 2-46 Response Body Parameters for Import Request

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string O Specifies the current timestamp
errors:message string O Specifies the error message.
errors:name string O Specifies the name of the error.
exportData array M Exported Site Takeover. For more information, see Table 2-29.
key string O Indicates the ID of Site Takeover
sourceVersion string O System version of product from which data is exported
topic string M Topic of each managed object

Sample Request Body structure for Import and Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
         "name": "site1",
        "targetSiteId": "siteid12345"
    }

2.14 NF Profile

Table 2-47 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create the NF Profile POST /oc-cnpolicy-configuration/v1/services/common/producer-nfprofile/{NFType} See Table A-3
Update the NF Profile PUT /oc-cnpolicy-configuration/v1/services/common/producer-nfprofile/{NFType}/{nfInstanceID} See Table A-2
Delete the NF Profile DELETE /oc-cnpolicy-configuration/v1/services/common/producer-nfprofile/{NFType}/{nfInstanceID} See Table A-4
Get All nfInstanceIds GET /oc-cnpolicy-configuration/v1/services/common/producer-nfinstanceids/{NFType} See Table A-1
Get a NF Profile GET /oc-cnpolicy-configuration/v1/services/common/producer-nfprofile/{NFType}/{nfInstanceID} See Table A-1

Table 2-48 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
nfInstanceId NfInstanceId M Unique identity of the NF Instance.
nfType NFType M Type of Network Function
nfStatus NFStatus M Status of the NF Instance
heartBeatTimer Integer C Time in seconds expected between two consecutive heartbeat messages from an NF Instance to the NRF.
plmnList array(PlmnId) C PLMN(s) of the Network Function
sNssais array(Snssai) O S-NSSAIs of the Network Function.
perPlmnSnssaiList array(PlmnSnssai ) O List of S-NSSAIs supported by the Network Function for each PLMN.
nsiList array(string) O NSI identities of the Network Function.
fqdn Fqdn C FQDN of the Network Function
interPlmnFqdn Fqdn C Specifies the FQDN that is used for inter-PLMN routing, if the NF needs to be discoverable by other NFs in a different PLMN.
ipv4Addresses array(Ipv4Addr) C IPv4 address(es) of the Network Function
ipv6Addresses rray(Ipv6Addr) C IPv6 address(es) of the Network Function
allowedPlmns array(PlmnId) O PLMNs allowed to access the NF instance.
allowedNfTypes array(NFType) O Type of the NFs allowed to access the NF instance.
allowedNfDomains array(string) O Pattern representing the NF domain names allowed to access the NF instance. If not provided, any NF domain is allowed to access the NF.
allowedNssais array(Snssai) O S-NSSAI of the allowed slices to access the NF instance.
priority integer O Priority (relative to other NFs of the same type) in the range of 0-65535, to be used for NF selection; lower values indicate a higher priority.
capacity integer O Static capacity information in the range of 0-65535, expressed as a weight relative to other NF instances of the same type.
load integer O Dynamic load information, ranged from 0 to 100, indicates the current load percentage of the NF.
locality string O Operator defined information about the location of the NF instance (e.g. geographic location, data center)
udrInfo UdrInfo O Specific data for the UDR (ranges of SUPI, group ID …)
groupId NfGroupId O Identity of the UDM group that is served by the UDM instance. If not provided, the UDM instance does not pertain to any UDM group.
supiRanges array(SupiRange) O List of ranges of SUPIs whose profile data is available in the UDM instance.
gpsiRanges array(IdentityRan ge) O List of ranges of GPSIs whose profile data is available in the UDM instance.
externalGroupIdentityfiersRanges array(IdentityRan ge) O List of ranges of external groups whose profile data is available in the UDM instance
supportedDataSets array(DataSetId) O List of supported data sets in the UDR instance. If not provided, the UDR supports all data sets.
bsfInfo BsfInfo O Specific data for the BSF
ipv4AddressRanges array(Ipv4Addres sRange) O List of ranges of IPv4 addresses handled by BSF. If not provided, the BSF can serve any IPv4 address.
dnnList array(Dnn) O List of DNNs handled by the BSF If not provided, the BSF can serve any DNN.
ipDomainList array(string) O List of IPv4 address domains.
ipv6PrefixRanges array(Ipv6PrefixR ange) O List of ranges of IPv6 prefixes handled by the BSF. If not provided, the BSF can serve any IPv6 prefix.
chfInfo ChfInfo O specific data for the CHF.
gpsiRangeList array(IdentityRan ge) O List of ranges of GPSI that can be served by the CHF instance. If not provided, the CHF can serve any GPSI.
customInfo Object O Specific data for custom Network Functions
nfProfileChangesSupportInd boolean O NF Profile Changes Support Indicator. This parameter indicates if the NF Service Consumer supports receiving NF Profile Changes in the response or not.
nfProfileChangesInd boolean O NF Profile Changes Indicator. This parameter indicates if the NF Profile contains NF Profile changes or the complete NF Profile.
Sample request body:
{
  "nfInstanceId": "3fa85f64-5717-4562-b3fc-2c963f66afa",
  "nfType": "BSF",
  "nfStatus": "REGISTERED",
  "heartBeatTimer": 0,
  "plmnList": [
    {
      "mcc": "string",
      "mnc": "string"
    }
  ],
  "sNssais": [
    {
      "sst": 0,
      "sd": "string"
    }
  ],
  "perPlmnSnssaiList": [
    {
      "plmnId": {
        "mcc": "string",
        "mnc": "string"
      },
      "sNssaiList": [
        {
          "sst": 0,
          "sd": "string"
        }
      ]
    }
  ],
  "nsiList": [
    "string"
  ],
  "fqdn": "string",
  "interPlmnFqdn": "string",
  "ipv4Addresses": [
    "string"
  ],
  "ipv6Addresses": [
    "string"
  ],
  "allowedPlmns": [
    {
      "mcc": "string",
      "mnc": "string"
    }
  ],
  "allowedNfTypes": [
    "string"
  ],
  "allowedNfDomains": [
    "string"
  ],
  "allowedNssais": [
    {
      "sst": 0,
      "sd": "string"
    }
  ],
  "priority": 0,
  "capacity": 0,
  "load": 0,
  "locality": "string",
  "udrInfo": {
    "groupId": "string",
    "supiRanges": [
      {
        "start": "string",
        "end": "string",
        "pattern": "string"
      }
    ],
    "gpsiRanges": [
      {
        "start": "string",
        "end": "string",
        "pattern": "string"
      }
    ],
    "externalGroupIdentityfiersRanges": [
      {
        "start": "string",
        "end": "string",
        "pattern": "string"
      }
    ],
    "supportedDataSets": [
      "APPLICATION"
    ]
  },
  "bsfInfo": {
    "ipv4AddressRanges": [
      {
        "start": "string",
        "end": "string"
      }
    ],
    "dnnList": [
      "string"
    ],
    "ipDomainList": [
      "string"
    ],
    "ipv6PrefixRanges": [
      {
        "start": "string",
        "end": "string"
      }
    ]
  },
  "chfInfo": {
    "supiRangeList": [
      {
        "start": "string",
        "end": "string",
        "pattern": "string"
      }
    ],
    "gpsiRangeList": [
      {
        "start": "string",
        "end": "string",
        "pattern": "string"
      }
    ]
  },
  "customInfo": {},
  "recoveryTime": "string",
  "nfServicePersistence": true,
  "nfServices": [
    {
      "serviceInstanceId": "string",
      "serviceName": "string",
      "versions": [
        {
          "apiVersionInUri": "string",
          "apiFullVersion": "string",
          "expiry": "string"
        }
      ],
      "scheme": "http",
      "nfServiceStatus": "REGISTERED",
      "fqdn": "string",
      "ipEndPoints": [
        {
          "ipv4Address": "string",
          "ipv6Address": "string",
          "transport": "TCP",
          "port": 0
        }
      ],
      "apiPrefix": "string",
      "allowedNfTypes": [
        "string"
      ],
      "priority": 0,
      "capacity": 0,
      "load": 0
    }
  ],
  "nfProfileChangesSupportInd": true,
  "nfProfileChangesInd": true
}
Sample response body:
{
  "nfInstanceId": "3fa85f64-5717-4562-b3fc-2c963f66afa9",
  "nfType": "BSF",
  "nfStatus": "REGISTERED",
  "heartBeatTimer": 0,
  "plmnList": [
    {
      "mcc": "string",
      "mnc": "string"
    }
  ],
  "sNssais": [
    {
      "sst": 0,
      "sd": "string"
    }
  ],
  "perPlmnSnssaiList": [
    {
      "plmnId": {
        "mcc": "string",
        "mnc": "string"
      },
      "sNssaiList": [
        {
          "sst": 0,
          "sd": "string"
        }
      ]
    }
  ],
  "nsiList": [
    "string"
  ],
  "fqdn": "string",
  "interPlmnFqdn": "string",
  "ipv4Addresses": [
    "string"
  ],
  "ipv6Addresses": [
    "string"
  ],
  "allowedPlmns": [
    {
      "mcc": "string",
      "mnc": "string"
    }
  ],
  "allowedNfTypes": [
    "string"
  ],
  "allowedNfDomains": [
    "string"
  ],
  "allowedNssais": [
    {
      "sst": 0,
      "sd": "string"
    }
  ],
  "priority": 0,
  "capacity": 0,
  "load": 0,
  "locality": "string",
  "udrInfo": {
    "groupId": "string",
    "supiRanges": [
      {
        "start": "string",
        "end": "string",
        "pattern": "string"
      }
    ],
    "gpsiRanges": [
      {
        "start": "string",
        "end": "string",
        "pattern": "string"
      }
    ],
    "externalGroupIdentityfiersRanges": [
      {
        "start": "string",
        "end": "string",
        "pattern": "string"
      }
    ],
    "supportedDataSets": [
      "APPLICATION"
    ]
  },
  "bsfInfo": {
    "ipv4AddressRanges": [
      {
        "start": "string",
        "end": "string"
      }
    ],
    "dnnList": [
      "string"
    ],
    "ipDomainList": [
      "string"
    ],
    "ipv6PrefixRanges": [
      {
        "start": "string",
        "end": "string"
      }
    ]
  },
  "chfInfo": {
    "supiRangeList": [
      {
        "start": "string",
        "end": "string",
        "pattern": "string"
      }
    ],
    "gpsiRangeList": [
      {
        "start": "string",
        "end": "string",
        "pattern": "string"
      }
    ]
  },
  "customInfo": {},
  "recoveryTime": "string",
  "nfServicePersistence": true,
  "nfServices": [
    {
      "serviceInstanceId": "string",
      "serviceName": "string",
      "versions": [
        {
          "apiVersionInUri": "string",
          "apiFullVersion": "string",
          "expiry": "string"
        }
      ],
      "scheme": "http",
      "nfServiceStatus": "REGISTERED",
      "fqdn": "string",
      "ipEndPoints": [
        {
          "ipv4Address": "string",
          "ipv6Address": "string",
          "transport": "TCP",
          "port": 0
        }
      ],
      "apiPrefix": "string",
      "allowedNfTypes": [
        "string"
      ],
      "priority": 0,
      "capacity": 0,
      "load": 0
    }
  ],
  "nfProfileChangesSupportInd": true,
  "nfProfileChangesInd": true
}

2.15 Session Management Service

Table 2-49 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Get Session Management Service GET {apiRoot}/oc-cnpolicy-configuration/v1/services/pcfsm See Table A-1
Update Session Management Service PUT {apiRoot}/oc-cnpolicy-configuration/v1/services/pcfsm See Table A-2
Export Session Management Service GET {apiRoot}/oc-cnpolicy-configuration/v1/services/pcfsm/export See Table A-1
Import Session Management Service POST {apiRoot}/oc-cnpolicy-configuration/v1/services/pcfsm/import See Table A-3

Get and Update Session Management Service

Table 2-50 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O) Description
binding BindingConfiguration O
charging ChargingConfiguration O
imsEmergencySession IMSEmergencySessionConfiguration O
policy Policy O
policyControlRequestTrigger PolicyControlRequestTrigger O
qos QOSConfiguration O
rule RuleConfiguration O
system SystemConfiguration O
traffic TrafficControlConfiguration O
user UserConfiguration O
Audit AuditConfiguration O  
advancedSettings SmAdvancedSettings M  
pendingTransaction PendingTransactionConfiguration O  

Table 2-51 SmAdvancedSettings

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
key string O Specifies the key name.
value string O Specifies the value of the key.

Table 2-52 PendingTransactionConfiguration

Field Name Data Type Mandatory(M)/Optional(O) Description
updateNotifyRetryBackoff integer M Indicates the time between two consecutive retry UpdateNotify messages when UpdateNotify message is held back from being sent to SMF.
updateNotifyRetryCount integer M Indicates the count for UpdateNotify message to be retried when it is held back from being sent to SMF.

Table 2-53 BindingConfiguration

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
abortOnBindingError boolean O Determines if PCF (SM service) should abort terminate session when binding error is received.
bindingOperationEnabled boolean O This determines if binding operation (register and deregister) to the BSF is enabled. Default Value: TRUE
bsfNfCommProfile string O Specifies the NF communication profile used by BSF. For more information about configuring NF communication profiles, see the "NF Communication Profile" section in Oracle Communications Cloud Native Core, Converged Policy User Guide.
bsfRetryProfileForInitMsgs string O Retry Profile to be used when PCF fails to send a create message to a producer node.
bsfRetryProfileForSubsqtMsgs string O Retry Profile to be used when PCF fails to send an in-session message to a producer node.
Note:
  • If both “Retry Profile for Initial Messages” and “Retry Profile for Subsequent Messages” are not configured (default case) no retry is attempted.
  • If both “Retry Profile for Initial Messages” and “Retry Profile for Subsequent Messages” are configured, retries is attempted accordingly.
  • If “Retry Profile for Initial Messages” is configured but “Retry Profile for Subsequent Messages” is not configured then the profile for initial messages is used for subsequent messages. (to be backward compatible with release 1.8.x)
  • If “Retry Profile for Initial Messages” is not configured but “Retry Profile for Subsequent Messages” is configured then retry is not attempted for initial messages but is attempted for subsequent messages.
defaultBindingOperationMode ENUM O Allows users to configure binding operation mode as synchronous or asynchronous.

Note: The mode chosen during the CREATE request remains same during UPDATE and TERMINATE operations for the same SM session.

The default binding operation mode is set to synchronous.

Note: To ensure backward compatibility, if this attribute is not available in the database, the value is set to "Synchronous"

After performing necessary configurations, user may use the policy action - Set Binding Registration Mode to to update configurations for specific policies. For more information, see Oracle Communications Cloud Native Core, Converged Policy Design Guide.

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-54 ChargingConfiguration

Field Name Data Type 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.
primaryChfInstanceId string   Specifies the Instance ID of the primary CHF.
primaryChfSetId string   Specifies the Set ID of the primary CHF.
secondaryChfAddress string O Specifies the secondary CHF address.
secondaryChfInstanceId string   Specifies the Instance ID of the secondary CHF.
secondaryChfSetId string   Specifies the Set ID of the secondary CHF.
useSubscriberDefChgMethod boolean    

Table 2-55 IMSEmergencySessionConfiguration

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
arpPreemptCap ENUM M
arpPreemptVuln boolean M
arpPriorityLevel

integer ($int32)

O
emergencyDNNs string

Any number of values are permitted for Emergency DNNs

O

Table 2-56 Policy

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

Table 2-57 PolicyControlRequestTrigger

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
defaultPolicyControlRequestTriggers string, ENUM 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-58 QOSConfiguration

Field Name Data Type 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

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 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-59 RuleConfiguration

Field Name Data Type 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 O This is the ARP PreemptionCapability of qos of default PCC rule.
  • NOT_PREEMPT
  • MAY_PREEMPT
Default Value: NOT_PREEMPT
defaultPccRuleArpPreemptVuln ENUM 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 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-60 SystemConfiguration

Field Name Data Type 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 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, ENUM O Specifies the list of supported features that can be configured to override system embedded values. For example, SessionRuleErrorHandling, NetLoc, and so on.
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
smfNotificationRetryProfile string    
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

nfCommProfile string O Specifies the NF communication profile used by SMF.

Table 2-61 TrafficControlConfiguration

Field Name Data Type 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-62 UserConfiguration

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
disableSubscriberVariables boolean O If it is set to true, the variables section will not be forwarded to PRE. Default value: true
enableAsyncChfQuery boolean O Determines whether to enable on-demand retrieval of policy counters for a subscriber from OCS.
enableOcsQueryAll boolean O Determines whether to fetch policy counters for a subscriber from OCS.
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

Table 2-63 AuditConfiguration

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
enable boolean O Determines whether to send registration request to Audit service or not. Default Value: True
frequency integer M enter a range in minutes from [1-1440]
maxTtl integer M Defines the maximum age of a SM policy association after which a record is purged from PCF SM database without sending further queries to SM. Default Value: 2880 Enter a range in minutes from [10-20160]
notificationRate integer M Defines the number of stale records which Audit service will notify to Session Management (SM) service in one second. Default Value: 50

Enter a range in seconds from [20-700]
ttl integer M enter a range in minutes from [5-10080]

Sample Request body structure for PUT operations:

{
  "advancedSettings": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "audit": {
    "enable": true,
    "frequency": 330,
    "maxTtl": 2880,
    "notificationRate": 50,
    "ttl": 1440
  },
  "binding": {
    "abortOnBindingError": true,
    "bindingOperationEnabled": true,
    "bsfNfCommProfile": "string",
    "bsfRetryProfileForInitMsgs": "string",
    "bsfRetryProfileForSubsqtMsgs": "string",
    "defaultBindingOperationMode": "SYNCHRONOUS",
    "useHttp2": true,
    "useLocalConfiguredBsfAlways": true,
    "useLocalConfiguredBsfWhenNotDiscovered": true
  },
  "charging": {
    "chgDataIdPrefix": "chgdata_",
    "offline": true,
    "online": true,
    "primaryChfAddress": "string",
    "primaryChfInstanceId": "string",
    "primaryChfSetId": "string",
    "secondaryChfAddress": "string",
    "secondaryChfInstanceId": "string",
    "secondaryChfSetId": "string",
    "useSubscriberDefChgMethod": true
  },
  "imsEmergencySession": {
    "arpPreemptCap": "MAY_PREEMPT",
    "arpPreemptVuln": "NOT_PREEMPTABLE",
    "arpPriorityLevel": 0,
    "emergencyDNNs": [
      "string"
    ]
  },
  "pendingTransaction": {
    "updateNotifyRetryBackoff": 1000,
    "updateNotifyRetryCount": 2
  },
  "policy": {
    "evaluateEnabled": true
  },
  "policyControlRequestTrigger": {
    "defaultPolicyControlRequestTriggers": [
      "AC_TY_CH"
    ]
  },
  "qos": {
    "defaultQos5qi": 9,
    "defaultQosArpPreemptCap": "MAY_PREEMPT",
    "defaultQosArpPreemptVuln": "NOT_PREEMPTABLE",
    "defaultQosArpPriorityLevel": 1,
    "installDefQosIfNotRequested": true,
    "qosDataIdPrefix": "qosdata_",
    "updateDefaultPcfRuleWithAuthDefQos": true
  },
  "rule": {
    "appRulePrecedenceMax": 899,
    "appRulePrecedenceMin": 400,
    "defaultPccRule5qi": 9,
    "defaultPccRuleArpPreemptCap": "NOT_PREEMPT",
    "defaultPccRuleArpPreemptVuln": "PREEMPTABLE",
    "defaultPccRuleArpPriorityLevel": 15,
    "defaultPccRulePrecedence": 3000,
    "defaultPccRuleProfile": "string",
    "installDefaultPccRule": "ALWAYS",
    "packetFilterUsageToTrueForPreliminaryServiceInfo": true,
    "ruleConflictsStrategy": "INSTALL",
    "ruleIdPrefix": "0_",
    "setPacketFilterUsageToTrueForPreliminaryServiceInfo": true,
    "switchFlowInToOutEnabled": true
  },
  "system": {
    "componentTracingEnabled": true,
    "enableCustomJson": true,
    "metricsEnabled": true,
    "nfCommProfile": "string",
    "overrideSupportedFeatures": [
      "3GPP-PS-Data-Off"
    ],
    "pcf_diamidentity": "pcf-smservice.oracle.com",
    "pcf_diamrealm": "oracle.com",
    "pcf_fqdn": "pcf-smservice.oracle.com",
    "smfNotificationRetryProfile": "string",
    "snssai": "0,000000"
  },
  "trafficControl": {
    "tcDataIdPrefix": "tcdata_"
  },
  "user": {
    "disableSubscriberVariables": true,
    "enableAsyncChfQuery": true,
    "enableAsyncOcsQuery": true,
    "enableChfQueryAll": true,
    "enableOcsQueryAll": true,
    "enableOsdQuery": true,
    "enableSmDataQuery": true,
    "ignoreSubsNotificationCheck": true,
    "includeDnnInUserQuery": true,
    "includeSnssaiInUserQuery": true,
    "ldapData.enable": true,
    "operatorSpecificData.subscribeToNotify": true,
    "queryUser": true,
    "queryUserOnDelete": true,
    "queryUserOnReauth": true,
    "queryUserOnUpdate": true,
    "subsToNotifyEnabled": true,
    "validateUser": true
  }
}

Sample Response body structure for GET and PUT operations:

{
  "advancedSettings": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "audit": {
    "enable": true,
    "frequency": 330,
    "maxTtl": 2880,
    "notificationRate": 50,
    "ttl": 1440
  },
  "binding": {
    "abortOnBindingError": true,
    "bindingOperationEnabled": true,
    "bsfNfCommProfile": "string",
    "bsfRetryProfileForInitMsgs": "string",
    "bsfRetryProfileForSubsqtMsgs": "string",
    "defaultBindingOperationMode": "SYNCHRONOUS",
    "useHttp2": true,
    "useLocalConfiguredBsfAlways": true,
    "useLocalConfiguredBsfWhenNotDiscovered": true
  },
  "charging": {
    "chgDataIdPrefix": "chgdata_",
    "offline": true,
    "online": true,
    "primaryChfAddress": "string",
    "primaryChfInstanceId": "string",
    "primaryChfSetId": "string",
    "secondaryChfAddress": "string",
    "secondaryChfInstanceId": "string",
    "secondaryChfSetId": "string",
    "useSubscriberDefChgMethod": true
  },
  "imsEmergencySession": {
    "arpPreemptCap": "MAY_PREEMPT",
    "arpPreemptVuln": "NOT_PREEMPTABLE",
    "arpPriorityLevel": 0,
    "emergencyDNNs": [
      "string"
    ]
  },
  "pendingTransaction": {
    "updateNotifyRetryBackoff": 1000,
    "updateNotifyRetryCount": 2
  },
  "policy": {
    "evaluateEnabled": true
  },
  "policyControlRequestTrigger": {
    "defaultPolicyControlRequestTriggers": [
      "AC_TY_CH"
    ]
  },
  "qos": {
    "defaultQos5qi": 9,
    "defaultQosArpPreemptCap": "MAY_PREEMPT",
    "defaultQosArpPreemptVuln": "NOT_PREEMPTABLE",
    "defaultQosArpPriorityLevel": 1,
    "installDefQosIfNotRequested": true,
    "qosDataIdPrefix": "qosdata_",
    "updateDefaultPcfRuleWithAuthDefQos": true
  },
  "rule": {
    "appRulePrecedenceMax": 899,
    "appRulePrecedenceMin": 400,
    "defaultPccRule5qi": 9,
    "defaultPccRuleArpPreemptCap": "NOT_PREEMPT",
    "defaultPccRuleArpPreemptVuln": "PREEMPTABLE",
    "defaultPccRuleArpPriorityLevel": 15,
    "defaultPccRulePrecedence": 3000,
    "defaultPccRuleProfile": "string",
    "installDefaultPccRule": "ALWAYS",
    "ruleConflictsStrategy": "INSTALL",
    "ruleIdPrefix": "0_",
    "setPacketFilterUsageToTrueForPreliminaryServiceInfo": true,
    "switchFlowInToOutEnabled": true
  },
  "system": {
    "componentTracingEnabled": true,
    "enableCustomJson": true,
    "metricsEnabled": true,
    "nfCommProfile": "string",
    "overrideSupportedFeatures": [
      "3GPP-PS-Data-Off"
    ],
    "pcf_diamidentity": "pcf-smservice.oracle.com",
    "pcf_diamrealm": "oracle.com",
    "pcf_fqdn": "pcf-smservice.oracle.com",
    "smfNotificationRetryProfile": "string",
    "snssai": "0,000000"
  },
  "trafficControl": {
    "tcDataIdPrefix": "tcdata_"
  },
  "user": {
    "disableSubscriberVariables": true,
    "enableAsyncChfQuery": true,
    "enableAsyncOcsQuery": true,
    "enableChfQueryAll": true,
    "enableOcsQueryAll": true,
    "enableOsdQuery": true,
    "enableSmDataQuery": true,
    "ignoreSubsNotificationCheck": true,
    "includeDnnInUserQuery": true,
    "includeSnssaiInUserQuery": true,
    "ldapData.enable": true,
    "operatorSpecificData.subscribeToNotify": true,
    "queryUser": true,
    "queryUserOnDelete": true,
    "queryUserOnReauth": true,
    "queryUserOnUpdate": true,
    "subsToNotifyEnabled": true,
    "validateUser": true
  }
}

Export/Import Session Management Service

Table 2-64 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
errors:message string    
errors:name string    
exportData array   Exported list of session management service. For more information, see Get and Update Session Management Service.
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": {
    "advancedSettings": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "audit": {
      "enable": true,
      "frequency": 330,
      "maxTtl": 2880,
      "notificationRate": 50,
      "ttl": 1440
    },
    "binding": {
      "abortOnBindingError": true,
      "bindingOperationEnabled": true,
      "bsfNfCommProfile": "string",
      "bsfRetryProfileForInitMsgs": "string",
      "bsfRetryProfileForSubsqtMsgs": "string",
      "defaultBindingOperationMode": "SYNCHRONOUS",
      "useHttp2": true,
      "useLocalConfiguredBsfAlways": true,
      "useLocalConfiguredBsfWhenNotDiscovered": true
    },
    "charging": {
      "chgDataIdPrefix": "chgdata_",
      "offline": true,
      "online": true,
      "primaryChfAddress": "string",
      "primaryChfInstanceId": "string",
      "primaryChfSetId": "string",
      "secondaryChfAddress": "string",
      "secondaryChfInstanceId": "string",
      "secondaryChfSetId": "string",
      "useSubscriberDefChgMethod": true
    },
    "imsEmergencySession": {
      "arpPreemptCap": "MAY_PREEMPT",
      "arpPreemptVuln": "NOT_PREEMPTABLE",
      "arpPriorityLevel": 0,
      "emergencyDNNs": [
        "string"
      ]
    },
    "pendingTransaction": {
      "updateNotifyRetryBackoff": 1000,
      "updateNotifyRetryCount": 2
    },
    "policy": {
      "evaluateEnabled": true
    },
    "policyControlRequestTrigger": {
      "defaultPolicyControlRequestTriggers": [
        "AC_TY_CH"
      ]
    },
    "qos": {
      "defaultQos5qi": 9,
      "defaultQosArpPreemptCap": "MAY_PREEMPT",
      "defaultQosArpPreemptVuln": "NOT_PREEMPTABLE",
      "defaultQosArpPriorityLevel": 1,
      "installDefQosIfNotRequested": true,
      "qosDataIdPrefix": "qosdata_",
      "updateDefaultPcfRuleWithAuthDefQos": true
    },
    "rule": {
      "appRulePrecedenceMax": 899,
      "appRulePrecedenceMin": 400,
      "defaultPccRule5qi": 9,
      "defaultPccRuleArpPreemptCap": "NOT_PREEMPT",
      "defaultPccRuleArpPreemptVuln": "PREEMPTABLE",
      "defaultPccRuleArpPriorityLevel": 15,
      "defaultPccRulePrecedence": 3000,
      "defaultPccRuleProfile": "string",
      "installDefaultPccRule": "ALWAYS",
      "packetFilterUsageToTrueForPreliminaryServiceInfo": true,
      "ruleConflictsStrategy": "INSTALL",
      "ruleIdPrefix": "0_",
      "setPacketFilterUsageToTrueForPreliminaryServiceInfo": true,
      "switchFlowInToOutEnabled": true
    },
    "system": {
      "componentTracingEnabled": true,
      "enableCustomJson": true,
      "metricsEnabled": true,
      "nfCommProfile": "string",
      "overrideSupportedFeatures": [
        "3GPP-PS-Data-Off"
      ],
      "pcf_diamidentity": "pcf-smservice.oracle.com",
      "pcf_diamrealm": "oracle.com",
      "pcf_fqdn": "pcf-smservice.oracle.com",
      "smfNotificationRetryProfile": "string",
      "snssai": "0,000000"
    },
    "trafficControl": {
      "tcDataIdPrefix": "tcdata_"
    },
    "user": {
      "disableSubscriberVariables": true,
      "enableAsyncChfQuery": true,
      "enableAsyncOcsQuery": true,
      "enableChfQueryAll": true,
      "enableOcsQueryAll": true,
      "enableOsdQuery": true,
      "enableSmDataQuery": true,
      "ignoreSubsNotificationCheck": true,
      "includeDnnInUserQuery": true,
      "includeSnssaiInUserQuery": true,
      "ldapData.enable": true,
      "operatorSpecificData.subscribeToNotify": true,
      "queryUser": true,
      "queryUserOnDelete": true,
      "queryUserOnReauth": true,
      "queryUserOnUpdate": true,
      "subsToNotifyEnabled": true,
      "validateUser": true
    }
  },
  "sourceVersion": "string",
  "topic": "string"
}

2.16 Session Rule

Table 2-65 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Session Rule POST {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/sessionrules See Table A-3
Export Session Rules GET ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/sessionrules/export See Table A-1
Import Session Rule POST ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/sessionrules/import See Table A-3
Get Session Rule GET {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/sessionrules/{sessionRuleName} See Table A-1
Update Session Rule PUT {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/sessionrules/{sessionRuleName} See Table A-2
Delete Session Rule DELETE ​​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/sessionrules/{sessionRuleName} See Table A-4

Get, Create, and Update Session Rules

Table 2-66 Request/Response Body Parameters

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

Table 2-67 AuthSessAmbr

Field Name Data Type 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

Sample Request body structure for POST and PUT operations:

{
  "authDefQosId": "string",
  "authSessAmbr": {
    "downlink": "string",
    "uplink": "string"
  },
  "description": "string",
  "name": "string",
  "refCondData": "string",
  "sessRuleId": "string"
}

Sample Response body structure for GET, POST, and PUT operations:

{
  "authDefQosId": "string",
  "authSessAmbr": {
    "downlink": "string",
    "uplink": "string"
  },
  "description": "string",
  "name": "string",
  "refCondData": "string",
  "sessRuleProfileId": "string"
}

Delete Session Rule

Table 2-68 Request/Response Body Parameters

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

Export/Import Session Rule

Table 2-69 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
errors:message string   Error message
errors:name string   Name of the error
exportData array   Exported list of session rules. For more information, see Get, Create, and Update Session Rules
key string   Indicates the ID of Session Rule
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "authDefQosId": "string",
      "authSessAmbr": {
        "downlink": "string",
        "uplink": "string"
      },
      "description": "string",
      "name": "string",
      "refCondData": "string",
      "sessRuleId": "string"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

2.17 Session Rule Profile

Table 2-70 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Session Rule Profile POST {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/sessionruleprofiles See Table A-3
Export Session Rule Profiles GET ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/sessionruleprofiles/export See Table A-1
Import Session Rule Profile POST ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/sessionruleprofiles/import See Table A-3
Get Session Rule Profile GET {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/sessionruleprofiles/{sessionRuleProfileName} See Table A-1
Update Session Rule Profile PUT {apiRoot}​​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/sessionruleprofiles/{sessionRuleProfileName} See Table A-2
Delete Session Rule Profile DELETE ​{apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/sessionruleprofiles/{sessionRuleProfileName} See Table A-4

Get, Create, and Update Session Rule Profiles

Table 2-71 Request/Response Body Parameters

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

Table 2-72 AuthSessAmbr

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
downlink

string

O AMBR for downlink
uplink

string

O AMBR for uplink

Sample Request body structure for POST and PUT operations:

{
  "authDefQosId": "string",
  "authSessAmbr": {
    "downlink": "string",
    "uplink": "string"
  },
  "description": "string",
  "name": "string",
  "refCondData": "string",
  "sessRuleProfileId": "string"
}

Sample Response body structure for GET, POST, and PUT operations:

{
  "authDefQosId": "string",
  "authSessAmbr": {
    "downlink": "string",
    "uplink": "string"
  },
  "description": "string",
  "name": "string",
  "refCondData": "string",
  "sessRuleProfileId": "string"
}

Delete Session Rule Profile

Table 2-73 Request/Response Body Parameters

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

Export/Import Session Rule Profile

Table 2-74 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
errors:message string   Error message
errors:name string   Name of the error
exportData array   Exported list of session rule profiles. For more information, see Get, Create, and Update Session Rule Profiles.
key string   Indicates the ID of Session Rule Profile
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "authDefQosId": "string",
      "authSessAmbr": {
        "downlink": "string",
        "uplink": "string"
      },
      "description": "string",
      "name": "string",
      "refCondData": "string",
      "sessRuleProfileId": "string"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

2.18 QoS Information

Table 2-75 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create QoS Information POST {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/qosinformation See Table A-3
Export QoS Information GET ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/qosinformation/export See Table A-1
Import QoS Information POST {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/qosinformation/import See Table A-3
Get QoS Information GET {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/qosinformation/{qosInformationName} See Table A-1
Update QoS Information PUT {apiRoot}​​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/qosinformation/{qosInformationName} See Table A-2
Delete QoS Information DELETE ​{apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/qosinformation/{qosInformationName} See Table A-4

Get, Create, and Update QoS Information

Table 2-76 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C)aints Description
5qi string ($int32)

enter a range in [0-255] number

O 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 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 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-77 Arp

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
preemptCap ENUM 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 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.

Sample Request body structure for POST and PUT operations:

{
  "5qi": "string",
  "arp": {
    "preemptCap": "MAY_PREEMPT",
    "preemptVuln": "NOT_PREEMPTABLE",
    "priorityLevel": 0
  },
  "averWindow": "2000",
  "description": "string",
  "maxDataBurstVol": "2000",
  "name": "string",
  "priorityLevel": "string"
}

Sample Response body structure for GET, POST, and PUT operations:

{
  "5qi": "string",
  "arp": {
    "preemptCap": "MAY_PREEMPT",
    "preemptVuln": "NOT_PREEMPTABLE",
    "priorityLevel": 0
  },
  "averWindow": "2000",
  "description": "string",
  "maxDataBurstVol": "2000",
  "name": "string",
  "priorityLevel": "string"
}

Delete QoS Information

Table 2-78 Request/Response Body Parameters

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

Export/Import QoS Information

Table 2-79 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData array   Exported list of QoS information. For more information, see Get, Create, and Update QoS Information.
key string   Indicates the ID of QoS Information
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "5qi": "string",
      "arp": {
        "preemptCap": "MAY_PREEMPT",
        "preemptVuln": "NOT_PREEMPTABLE",
        "priorityLevel": 0
      },
      "averWindow": "2000",
      "description": "string",
      "maxDataBurstVol": "2000",
      "name": "string",
      "priorityLevel": "string"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

2.19 QoS Data

Table 2-80 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create QoS Data POST {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/qosdata See Table A-3
Export QoS Data GET ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/qosdata/export See Table A-1
Import QoS Data POST {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/qosdata/import See Table A-3
Get QoS Data GET {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/qosdata/{qosDataName} See Table A-1
Update QoS Data PUT {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/qosdata/{qosDataName} See Table A-2
Delete QoS Data DELETE ​{apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/qosdata/{qosDataName} See Table A-4

Get, Create, and Update QoS Data s

Table 2-81 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C)aints Description
5qi string ($int32)

enter a range in [0-255] number

O Identifier for the authorized QoS parameters for the service data flow. It shall be included when the QoS data decision.
arp Arp O ARP information
averwindow string    
defQosFlowIndication boolean O 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 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-82 Arp

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
preemptCap ENUM 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 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.

Sample Request body structure for POST and PUT operations:

{
  "5qi": 0,
  "arp": {
    "preemptCap": "MAY_PREEMPT",
    "preemptVuln": "NOT_PREEMPTABLE",
    "priorityLevel": 0
  },
  "averWindow": 2000,
  "defQosFlowIndication": true,
  "description": "string",
  "gbrDl": "string",
  "gbrUl": "string",
  "maxDataBurstVol": 0,
  "maxPacketLossRateDl": 0,
  "maxPacketLossRateUl": 0,
  "maxbrDl": "string",
  "maxbrUl": "string",
  "name": "string",
  "priorityLevel": 0,
  "qnc": true,
  "qosId": "string",
  "reflectiveQos": true,
  "sharingKeyDl": "string",
  "sharingKeyUl": "string"
}

Sample Response body structure for GET, POST, and PUT operations:

{
  "5qi": 0,
  "arp": {
    "preemptCap": "MAY_PREEMPT",
    "preemptVuln": "NOT_PREEMPTABLE",
    "priorityLevel": 0
  },
  "averWindow": 2000,
  "defQosFlowIndication": true,
  "description": "string",
  "gbrDl": "string",
  "gbrUl": "string",
  "maxDataBurstVol": 0,
  "maxPacketLossRateDl": 0,
  "maxPacketLossRateUl": 0,
  "maxbrDl": "string",
  "maxbrUl": "string",
  "name": "string",
  "priorityLevel": 0,
  "qnc": true,
  "qosId": "string",
  "reflectiveQos": true,
  "sharingKeyDl": "string",
  "sharingKeyUl": "string"
}

Delete QoS Data

Table 2-83 Request/Response Body Parameters

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

Export/Import QoS Data s

Table 2-84 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData array   Exported list of QoS data. For more information, see Get, Create, and Update QoS Data s.
key string   Indicates the ID of QoS Data
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "5qi": 0,
      "arp": {
        "preemptCap": "MAY_PREEMPT",
        "preemptVuln": "NOT_PREEMPTABLE",
        "priorityLevel": 0
      },
      "averWindow": 2000,
      "defQosFlowIndication": true,
      "description": "string",
      "gbrDl": "string",
      "gbrUl": "string",
      "maxDataBurstVol": 0,
      "maxPacketLossRateDl": 0,
      "maxPacketLossRateUl": 0,
      "maxbrDl": "string",
      "maxbrUl": "string",
      "name": "string",
      "priorityLevel": 0,
      "qnc": true,
      "qosId": "string",
      "reflectiveQos": true,
      "sharingKeyDl": "string",
      "sharingKeyUl": "string"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

2.20 Traffic for PCC Rule

Table 2-85 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Traffic PCC Rule POST ​{apiRoot}​/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/pccrules See Table A-3
Export Traffic PCC Rule GET {apiRoot}​​/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/pccrules/export See Table A-1
Import Traffic PCC Rule POST {apiRoot}​/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/pccrules/import See Table A-3
Get Traffic PCC Rule GET ​{apiRoot}/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/pccrules/{trafficPccRuleName} See Table A-1
Update Traffic PCC Rule PUT ​{apiRoot}/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/pccrules/{trafficPccRuleName} See Table A-2
Delete Traffic PCC Rule DELETE ​{apiRoot}/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/pccrules/{trafficPccRuleName} See Table A-4

Create, Get, and Update Traffic for PCC Rule

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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.bearerUsage ENUM O  
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 2-87 param.diameter.pccRule.FlowInformations

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
flowDescription string O  
flowDirection string M Allowed values:
  • -1
  • 0
  • 1
  • 2
  • 3
tos string O  
tosMask string O  

Sample Request Body structure for POST and PUT operations:

{
  "description": "string",
  "name": "string",
  "param.diameter.pccRule.ARP.PreemptionCapability": "0",
  "param.diameter.pccRule.ARP.PreemptionVulnerability": "0",
  "param.diameter.pccRule.ARP.PriorityLevel": "string",
  "param.diameter.pccRule.FlowDescriptions": "string",
  "param.diameter.pccRule.FlowInformations": [
    {
      "flowDescription": "string",
      "flowDirection": "-1",
      "tos": "string",
      "tosMask": "string"
    }
  ],
  "param.diameter.pccRule.FlowStatus": "0",
  "param.diameter.pccRule.MeteringMethod": "0",
  "param.diameter.pccRule.MonitoringKey": "string",
  "param.diameter.pccRule.Offline": "0",
  "param.diameter.pccRule.Online": "0",
  "param.diameter.pccRule.PStoCSSessionContinuity": "0",
  "param.diameter.pccRule.Precedence": "string",
  "param.diameter.pccRule.RatingGroup": "string",
  "param.diameter.pccRule.ReportingLevel": "0",
  "param.diameter.pccRule.RequiredAccessInfo": "1",
  "param.diameter.pccRule.ResourceAllocationNotification": "0",
  "param.diameter.pccRule.ServiceIdentifier": "string",
  "param.diameter.pccRule.applicationServiceProviderIdentity": "string",
  "param.diameter.pccRule.maxAuthDL": "string",
  "param.diameter.pccRule.maxAuthUL": "string",
  "param.diameter.pccRule.minRateDL": "string",
  "param.diameter.pccRule.minRateUL": "string",
  "param.diameter.pccRule.name": "string",
  "param.diameter.pccRule.qci": "1",
  "param.diameter.pccRule.sponsorIdentity": "string",
  "param.diameter.pccRule.tdfApplicationIdentifier": "string",
  "param.diameter.pccRule.tdfMuteNotification": "0",
  "param.diameter.pccRule.tdfRedirectAddressType": "0",
  "param.diameter.pccRule.tdfRedirectServerAddress": "string",
  "param.diameter.pccRule.tdfRedirectSupport": "0"
}

Sample Response Body structure for GET, POST and PUT operations:

{
  "description": "string",
  "name": "string",
  "param.diameter.pccRule.ARP.PreemptionCapability": "0",
  "param.diameter.pccRule.ARP.PreemptionVulnerability": "0",
  "param.diameter.pccRule.ARP.PriorityLevel": "string",
  "param.diameter.pccRule.FlowDescriptions": "string",
  "param.diameter.pccRule.FlowInformations": [
    {
      "flowDescription": "string",
      "flowDirection": "-1",
      "tos": "string",
      "tosMask": "string"
    }
  ],
  "param.diameter.pccRule.FlowStatus": "0",
  "param.diameter.pccRule.MeteringMethod": "0",
  "param.diameter.pccRule.MonitoringKey": "string",
  "param.diameter.pccRule.Offline": "0",
  "param.diameter.pccRule.Online": "0",
  "param.diameter.pccRule.PStoCSSessionContinuity": "0",
  "param.diameter.pccRule.Precedence": "string",
  "param.diameter.pccRule.RatingGroup": "string",
  "param.diameter.pccRule.ReportingLevel": "0",
  "param.diameter.pccRule.RequiredAccessInfo": "1",
  "param.diameter.pccRule.ResourceAllocationNotification": "0",
  "param.diameter.pccRule.ServiceIdentifier": "string",
  "param.diameter.pccRule.applicationServiceProviderIdentity": "string",
  "param.diameter.pccRule.maxAuthDL": "string",
  "param.diameter.pccRule.maxAuthUL": "string",
  "param.diameter.pccRule.minRateDL": "string",
  "param.diameter.pccRule.minRateUL": "string",
  "param.diameter.pccRule.name": "string",
  "param.diameter.pccRule.qci": "1",
  "param.diameter.pccRule.sponsorIdentity": "string",
  "param.diameter.pccRule.tdfApplicationIdentifier": "string",
  "param.diameter.pccRule.tdfMuteNotification": "0",
  "param.diameter.pccRule.tdfRedirectAddressType": "0",
  "param.diameter.pccRule.tdfRedirectServerAddress": "string",
  "param.diameter.pccRule.tdfRedirectSupport": "0"
}

Export/Import Traffic for PCC Rule

Table 2-88 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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 2-86.
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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "description": "string",
      "name": "string",
      "param.diameter.pccRule.ARP.PreemptionCapability": "0",
      "param.diameter.pccRule.ARP.PreemptionVulnerability": "0",
      "param.diameter.pccRule.ARP.PriorityLevel": "string",
      "param.diameter.pccRule.FlowDescriptions": "string",
      "param.diameter.pccRule.FlowInformations": [
        {
          "flowDescription": "string",
          "flowDirection": "-1",
          "tos": "string",
          "tosMask": "string"
        }
      ],
      "param.diameter.pccRule.FlowStatus": "0",
      "param.diameter.pccRule.MeteringMethod": "0",
      "param.diameter.pccRule.MonitoringKey": "string",
      "param.diameter.pccRule.Offline": "0",
      "param.diameter.pccRule.Online": "0",
      "param.diameter.pccRule.PStoCSSessionContinuity": "0",
      "param.diameter.pccRule.Precedence": "string",
      "param.diameter.pccRule.RatingGroup": "string",
      "param.diameter.pccRule.ReportingLevel": "0",
      "param.diameter.pccRule.RequiredAccessInfo": "1",
      "param.diameter.pccRule.ResourceAllocationNotification": "0",
      "param.diameter.pccRule.ServiceIdentifier": "string",
      "param.diameter.pccRule.applicationServiceProviderIdentity": "string",
      "param.diameter.pccRule.maxAuthDL": "string",
      "param.diameter.pccRule.maxAuthUL": "string",
      "param.diameter.pccRule.minRateDL": "string",
      "param.diameter.pccRule.minRateUL": "string",
      "param.diameter.pccRule.name": "string",
      "param.diameter.pccRule.qci": "1",
      "param.diameter.pccRule.sponsorIdentity": "string",
      "param.diameter.pccRule.tdfApplicationIdentifier": "string",
      "param.diameter.pccRule.tdfMuteNotification": "0",
      "param.diameter.pccRule.tdfRedirectAddressType": "0",
      "param.diameter.pccRule.tdfRedirectServerAddress": "string",
      "param.diameter.pccRule.tdfRedirectSupport": "0"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Delete Traffic for PCC Rule

Table 2-89 Request/Response Body Parameters

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

2.21 Traffic for PCC Profile

Table 2-90 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Traffic PCC Profile POST {apiRoot}​​/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/pccruleprofiles See Table A-3
Export Traffic PCC Profile GET {apiRoot}​​/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/pccruleprofiles​/export See Table A-1
Import Traffic PCC Profile POST {apiRoot}​​/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/pccruleprofiles​/import See Table A-3
Get Traffic PCC Profile GET ​{apiRoot}​/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/pccruleprofiles​/{trafficPccProfileName} See Table A-1
Update Traffic PCC Profile PUT ​{apiRoot}​/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/pccruleprofiles​/{trafficPccProfileName} See Table A-2
Delete Traffic PCC Profile DELETE ​{apiRoot}​/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/pccruleprofiles​/{trafficPccProfileName} See Table A-4

Create, Get, and Update Traffic for PCC Profile

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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.bearerUsage ENUM O  
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 2-92 param.diameter.pccProfile.FlowInformations

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
flowDescription string O  
flowDirection string M Allowed values:
  • -1
  • 0
  • 1
  • 2
  • 3
tos string O  
tosMask string O  

Sample Request Body structure for POST and PUT operations:

{
  "description": "string",
  "name": "string",
  "param.diameter.pccProfile.ARP.PreemptionCapability": "0",
  "param.diameter.pccProfile.ARP.PreemptionVulnerability": "0",
  "param.diameter.pccProfile.ARP.PriorityLevel": "string",
  "param.diameter.pccProfile.FlowDescriptions": "string",
  "param.diameter.pccProfile.FlowInformations": [
    {
      "flowDescription": "string",
      "flowDirection": "-1",
      "tos": "string",
      "tosMask": "string"
    }
  ],
  "param.diameter.pccProfile.FlowStatus": "0",
  "param.diameter.pccProfile.MeteringMethod": "0",
  "param.diameter.pccProfile.MonitoringKey": "string",
  "param.diameter.pccProfile.Offline": "0",
  "param.diameter.pccProfile.Online": "0",
  "param.diameter.pccProfile.Precedence": "string",
  "param.diameter.pccProfile.RatingGroup": "string",
  "param.diameter.pccProfile.ReportingLevel": "0",
  "param.diameter.pccProfile.RequiredAccessInfo": "1",
  "param.diameter.pccProfile.ResourceAllocationNotification": "0",
  "param.diameter.pccProfile.ServiceIdentifier": "string",
  "param.diameter.pccProfile.applicationServiceProviderIdentity": "string",
  "param.diameter.pccProfile.maxAuthDL": "string",
  "param.diameter.pccProfile.maxAuthUL": "string",
  "param.diameter.pccProfile.minRateDL": "string",
  "param.diameter.pccProfile.minRateUL": "string",
  "param.diameter.pccProfile.qci": "1",
  "param.diameter.pccProfile.sponsorIdentity": "string",
  "param.diameter.pccProfile.tdfApplicationIdentifier": "string",
  "param.diameter.pccProfile.tdfMuteNotification": "0",
  "param.diameter.pccProfile.tdfRedirectAddressType": "0",
  "param.diameter.pccProfile.tdfRedirectServerAddress": "string",
  "param.diameter.pccProfile.tdfRedirectSupport": "0"
}

Sample Response Body structure for GET, POST and PUT operations:

{
  "description": "string",
  "name": "string",
  "param.diameter.pccProfile.ARP.PreemptionCapability": "0",
  "param.diameter.pccProfile.ARP.PreemptionVulnerability": "0",
  "param.diameter.pccProfile.ARP.PriorityLevel": "string",
  "param.diameter.pccProfile.FlowDescriptions": "string",
  "param.diameter.pccProfile.FlowInformations": [
    {
      "flowDescription": "string",
      "flowDirection": "-1",
      "tos": "string",
      "tosMask": "string"
    }
  ],
  "param.diameter.pccProfile.FlowStatus": "0",
  "param.diameter.pccProfile.MeteringMethod": "0",
  "param.diameter.pccProfile.MonitoringKey": "string",
  "param.diameter.pccProfile.Offline": "0",
  "param.diameter.pccProfile.Online": "0",
  "param.diameter.pccProfile.Precedence": "string",
  "param.diameter.pccProfile.RatingGroup": "string",
  "param.diameter.pccProfile.ReportingLevel": "0",
  "param.diameter.pccProfile.RequiredAccessInfo": "1",
  "param.diameter.pccProfile.ResourceAllocationNotification": "0",
  "param.diameter.pccProfile.ServiceIdentifier": "string",
  "param.diameter.pccProfile.applicationServiceProviderIdentity": "string",
  "param.diameter.pccProfile.maxAuthDL": "string",
  "param.diameter.pccProfile.maxAuthUL": "string",
  "param.diameter.pccProfile.minRateDL": "string",
  "param.diameter.pccProfile.minRateUL": "string",
  "param.diameter.pccProfile.qci": "1",
  "param.diameter.pccProfile.sponsorIdentity": "string",
  "param.diameter.pccProfile.tdfApplicationIdentifier": "string",
  "param.diameter.pccProfile.tdfMuteNotification": "0",
  "param.diameter.pccProfile.tdfRedirectAddressType": "0",
  "param.diameter.pccProfile.tdfRedirectServerAddress": "string",
  "param.diameter.pccProfile.tdfRedirectSupport": "0"
}

Export/Import Traffic for PCC Profile

Table 2-93 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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 2-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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "description": "string",
      "name": "string",
      "param.diameter.pccProfile.ARP.PreemptionCapability": "0",
      "param.diameter.pccProfile.ARP.PreemptionVulnerability": "0",
      "param.diameter.pccProfile.ARP.PriorityLevel": "string",
      "param.diameter.pccProfile.FlowDescriptions": "string",
      "param.diameter.pccProfile.FlowInformations": [
        {
          "flowDescription": "string",
          "flowDirection": "-1",
          "tos": "string",
          "tosMask": "string"
        }
      ],
      "param.diameter.pccProfile.FlowStatus": "0",
      "param.diameter.pccProfile.MeteringMethod": "0",
      "param.diameter.pccProfile.MonitoringKey": "string",
      "param.diameter.pccProfile.Offline": "0",
      "param.diameter.pccProfile.Online": "0",
      "param.diameter.pccProfile.Precedence": "string",
      "param.diameter.pccProfile.RatingGroup": "string",
      "param.diameter.pccProfile.ReportingLevel": "0",
      "param.diameter.pccProfile.RequiredAccessInfo": "1",
      "param.diameter.pccProfile.ResourceAllocationNotification": "0",
      "param.diameter.pccProfile.ServiceIdentifier": "string",
      "param.diameter.pccProfile.applicationServiceProviderIdentity": "string",
      "param.diameter.pccProfile.maxAuthDL": "string",
      "param.diameter.pccProfile.maxAuthUL": "string",
      "param.diameter.pccProfile.minRateDL": "string",
      "param.diameter.pccProfile.minRateUL": "string",
      "param.diameter.pccProfile.qci": "1",
      "param.diameter.pccProfile.sponsorIdentity": "string",
      "param.diameter.pccProfile.tdfApplicationIdentifier": "string",
      "param.diameter.pccProfile.tdfMuteNotification": "0",
      "param.diameter.pccProfile.tdfRedirectAddressType": "0",
      "param.diameter.pccProfile.tdfRedirectServerAddress": "string",
      "param.diameter.pccProfile.tdfRedirectSupport": "0"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Delete Traffic for PCC Profile

Table 2-94 Request/Response Body Parameters

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

2.22 Traffic for Diameter QoS

Table 2-95 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Traffic Diameter QoS POST ​{apiRoot}/oc-cnpolicy-configuration/v1/policydata/pcrf/diameterqos See Table A-3
Export Traffic Diameter QoS GET ​{apiRoot}​/oc-cnpolicy-configuration/v1/policydata/pcrf/diameterqos/export See Table A-1
Import Traffic Diameter QoS POST ​{apiRoot}/oc-cnpolicy-configuration/v1/policydata/pcrf/diameterqos/import See Table A-3
Get Traffic Diameter QoS GET ​{apiRoot}/oc-cnpolicy-configuration/v1/policydata/pcrf/diameterqos/{trafficDiameterQoSName} See Table A-1
Update Traffic Diameter QoS PUT ​{apiRoot}/oc-cnpolicy-configuration/v1/policydata/pcrf/diameterqos/{trafficDiameterQoSName} See Table A-2
Delete Traffic Diameter QoS DELETE ​{apiRoot}/oc-cnpolicy-configuration/v1/policydata/pcrf/diameterqos/{trafficDiameterQoSName} See Table A-4

Create, Get, and Update Traffic for Diameter QoS

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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

Sample Request Body structure for POST and PUT operations:

{
  "description": "string",
  "name": "string",
  "param.diameter.qosProfile.ARP.PreemptionCapability": "0",
  "param.diameter.qosProfile.ARP.PreemptionVulnerability": "0",
  "param.diameter.qosProfile.ARP.PriorityLevel": "string",
  "param.diameter.qosProfile.ResourceAllocationNotification": "0",
  "param.diameter.qosProfile.maxAuthDL": "string",
  "param.diameter.qosProfile.maxAuthUL": "string",
  "param.diameter.qosProfile.minRateDL": "string",
  "param.diameter.qosProfile.minRateUL": "string",
  "param.diameter.qosProfile.qci": "1"
}

Sample Response Body structure for GET, POST and PUT operations:

{
  "description": "string",
  "name": "string",
  "param.diameter.qosProfile.ARP.PreemptionCapability": "0",
  "param.diameter.qosProfile.ARP.PreemptionVulnerability": "0",
  "param.diameter.qosProfile.ARP.PriorityLevel": "string",
  "param.diameter.qosProfile.ResourceAllocationNotification": "0",
  "param.diameter.qosProfile.maxAuthDL": "string",
  "param.diameter.qosProfile.maxAuthUL": "string",
  "param.diameter.qosProfile.minRateDL": "string",
  "param.diameter.qosProfile.minRateUL": "string",
  "param.diameter.qosProfile.qci": "1"
}

Export/Import Traffic for Diameter QoS

Table 2-97 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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 2-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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "description": "string",
      "name": "string",
      "param.diameter.qosProfile.ARP.PreemptionCapability": "0",
      "param.diameter.qosProfile.ARP.PreemptionVulnerability": "0",
      "param.diameter.qosProfile.ARP.PriorityLevel": "string",
      "param.diameter.qosProfile.ResourceAllocationNotification": "0",
      "param.diameter.qosProfile.maxAuthDL": "string",
      "param.diameter.qosProfile.maxAuthUL": "string",
      "param.diameter.qosProfile.minRateDL": "string",
      "param.diameter.qosProfile.minRateUL": "string",
      "param.diameter.qosProfile.qci": "1"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Delete Traffic for Diameter QoS

Table 2-98 Request/Response Body Parameters

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

2.23 Traffic for ADC Rule

Table 2-99 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Traffic Adc Rule POST ​{apiRoot}/oc-cnpolicy-configuration/v1/policydata/pcrf/adcrules See Table A-3
Export Traffic Adc Rule GET ​{apiRoot}/oc-cnpolicy-configuration/v1/policydata/pcrf/adcrules/export See Table A-1
Import Traffic Adc Rule POST {apiRoot}​/oc-cnpolicy-configuration/v1/policydata/pcrf/adcrules/import See Table A-3
Get Traffic Adc Rule GET ​{apiRoot}/oc-cnpolicy-configuration/v1/policydata/pcrf/adcrules/{trafficAdcRuleName} See Table A-1
Update Traffic Adc Rule PUT ​{apiRoot}/oc-cnpolicy-configuration/v1/policydata/pcrf/adcrules/{trafficAdcRuleName} See Table A-2
Delete Traffic Adc Rule DELETE ​{apiRoot}/oc-cnpolicy-configuration/v1/policydata/pcrf/adcrules/{trafficAdcRuleName} See Table A-4

Create, Get, and Update Traffic for ADC Rule

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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

Sample Request Body structure for POST and PUT operations:

{
  "description": "string",
  "name": "string",
  "param.diameter.adcRule.FlowStatus": "0",
  "param.diameter.adcRule.MeteringMethod": "0",
  "param.diameter.adcRule.MonitoringKey": "string",
  "param.diameter.adcRule.Offline": "0",
  "param.diameter.adcRule.Online": "0",
  "param.diameter.adcRule.Precedence": "string",
  "param.diameter.adcRule.RatingGroup": "string",
  "param.diameter.adcRule.ReportingLevel": "0",
  "param.diameter.adcRule.ServiceIdentifier": "string",
  "param.diameter.adcRule.maxAuthDL": "string",
  "param.diameter.adcRule.maxAuthUL": "string",
  "param.diameter.adcRule.name": "string",
  "param.diameter.adcRule.tdfApplicationIdentifier": "string",
  "param.diameter.adcRule.tdfMuteNotification": "0",
  "param.diameter.adcRule.tdfRedirectAddressType": "0",
  "param.diameter.adcRule.tdfRedirectServerAddress": "string",
  "param.diameter.adcRule.tdfRedirectSupport": "0"
}

Sample Response Body structure for GET, POST and PUT operations:

{
  "description": "string",
  "name": "string",
  "param.diameter.adcRule.FlowStatus": "0",
  "param.diameter.adcRule.MeteringMethod": "0",
  "param.diameter.adcRule.MonitoringKey": "string",
  "param.diameter.adcRule.Offline": "0",
  "param.diameter.adcRule.Online": "0",
  "param.diameter.adcRule.Precedence": "string",
  "param.diameter.adcRule.RatingGroup": "string",
  "param.diameter.adcRule.ReportingLevel": "0",
  "param.diameter.adcRule.ServiceIdentifier": "string",
  "param.diameter.adcRule.maxAuthDL": "string",
  "param.diameter.adcRule.maxAuthUL": "string",
  "param.diameter.adcRule.name": "string",
  "param.diameter.adcRule.tdfApplicationIdentifier": "string",
  "param.diameter.adcRule.tdfMuteNotification": "0",
  "param.diameter.adcRule.tdfRedirectAddressType": "0",
  "param.diameter.adcRule.tdfRedirectServerAddress": "string",
  "param.diameter.adcRule.tdfRedirectSupport": "0"
}

Export/Import Traffic for ADC Rule

Table 2-101 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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 Create, Get, and Update Traffic for ADC Rule
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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "description": "string",
      "name": "string",
      "param.diameter.adcRule.FlowStatus": "0",
      "param.diameter.adcRule.MeteringMethod": "0",
      "param.diameter.adcRule.MonitoringKey": "string",
      "param.diameter.adcRule.Offline": "0",
      "param.diameter.adcRule.Online": "0",
      "param.diameter.adcRule.Precedence": "string",
      "param.diameter.adcRule.RatingGroup": "string",
      "param.diameter.adcRule.ReportingLevel": "0",
      "param.diameter.adcRule.ServiceIdentifier": "string",
      "param.diameter.adcRule.maxAuthDL": "string",
      "param.diameter.adcRule.maxAuthUL": "string",
      "param.diameter.adcRule.name": "string",
      "param.diameter.adcRule.tdfApplicationIdentifier": "string",
      "param.diameter.adcRule.tdfMuteNotification": "0",
      "param.diameter.adcRule.tdfRedirectAddressType": "0",
      "param.diameter.adcRule.tdfRedirectServerAddress": "string",
      "param.diameter.adcRule.tdfRedirectSupport": "0"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Delete Traffic for ADC Rule

Table 2-102 Request/Response Body Parameters

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

2.24 Time Period

Table 2-103 Supported REST APIs

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

Create, Get, and Update Time Period

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

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

Table 2-105 timeSlot

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
daysOfMonth string O  
daysOfWeek string O  
endTime string O  
monthsOfYear string O  
startTime string O  
years string O  

Sample Request Body structure for POST and PUT operations:

{
  "description": "string",
  "name": "string",
  "precedence": "string",
  "timeSlot": [
    {
      "daysOfMonth": "string",
      "daysOfWeek": "string",
      "endTime": "string",
      "monthsOfYear": "string",
      "startTime": "string",
      "years": "string"
    }
  ]
}

Sample Response Body structure for GET, POST and PUT operations:

{
  "description": "string",
  "name": "string",
  "precedence": "string",
  "timeSlot": [
    {
      "daysOfMonth": "string",
      "daysOfWeek": "string",
      "endTime": "string",
      "monthsOfYear": "string",
      "startTime": "string",
      "years": "string"
    }
  ]
}

Export/Import Time Period

Table 2-106 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
errors array    
errors:message string    
errors:name string    
exportData array M Exported list of time period.
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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "description": "string",
      "name": "string",
      "precedence": "string",
      "timeSlot": [
        {
          "daysOfMonth": "string",
          "daysOfWeek": "string",
          "endTime": "string",
          "monthsOfYear": "string",
          "startTime": "string",
          "years": "string"
        }
      ]
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Delete Time Period

Table 2-107 Request/Response Body Parameters

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

2.25 Predefined Pcc Rule Base

Table 2-108 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Predefined Pcc Rule Base POST {apiRoot}/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/predefinedpccrulebases See Table A-3
Export Predefined Pcc Rule Base GET {apiRoot}​​/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/predefinedpccrulebases​/export See Table A-1
Import Predefined Pcc Rule Base POST {apiRoot}​/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/predefinedpccrulebases​/import See Table A-3
Get Predefined Pcc Rule Base GET ​{apiRoot}/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/predefinedpccrulebases​/{predefinedPccRuleBaseName} See Table A-1
Update Predefined Pcc Rule Base PUT ​{apiRoot}/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/predefinedpccrulebases​/{predefinedPccRuleBaseName} See Table A-2
Delete Predefined Pcc Rule Base DELETE ​{apiRoot}/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/predefinedpccrulebases​/{predefinedPccRuleBaseName} See Table A-4

Create, Get, and Update Predefined Pcc Rule Base

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
name string M  
param.diameter.pccPredefBaseRule.description string O  
param.diameter.pccPredefBaseRule.name string O  

Sample Request Body structure for POST and PUT operations:

{
  "name": "string",
  "param.diameter.pccPredefBaseRule.description": "string",
  "param.diameter.pccPredefBaseRule.name": "string"
}

Sample Response Body structure for GET, POST and PUT operations:

{
  "name": "string",
  "param.diameter.pccPredefBaseRule.description": "string",
  "param.diameter.pccPredefBaseRule.name": "string"
}

Export/Import Predefined Pcc Rule Base

Table 2-110 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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 2-109.
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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "name": "string",
      "param.diameter.pccPredefBaseRule.description": "string",
      "param.diameter.pccPredefBaseRule.name": "string"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Delete Predefined Pcc Rule Base

Table 2-111 Request/Response Body Parameters

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

2.26 Predefined Pcc Rule

Table 2-112 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Predefined Pcc Rule POST ​{apiRoot}​/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/predefinedpccrules See Table A-3
Export Predefined Pcc Rule GET {apiRoot}​/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/predefinedpccrules​/export See Table A-1
Import Predefined Pcc Rule POST {apiRoot}​/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/predefinedpccrules​/import See Table A-3
Get Predefined Pcc Rule GET ​{apiRoot}/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/predefinedpccrules​/{predefinedPccRuleName} See Table A-1
Update Predefined Pcc Rule PUT ​{apiRoot}/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/predefinedpccrules​/{predefinedPccRuleName} See Table A-2
Delete Predefined Pcc Rule DELETE ​{apiRoot}/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/predefinedpccrules​/{predefinedPccRuleName} See Table A-4

Create, Get, and Update Predefined Pcc Rule

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
name string M  
param.diameter.pccPredefRule.MonitoringKey string O  
param.diameter.pccPredefRule.description string O  
param.diameter.pccPredefRule.name string O  

Sample Request Body structure for POST and PUT operations:

{
  "name": "string",
  "param.diameter.pccPredefRule.MonitoringKey": "string",
  "param.diameter.pccPredefRule.description": "string",
  "param.diameter.pccPredefRule.name": "string"
}

Sample Response Body structure for GET, POST and PUT operations:

{
  "name": "string",
  "param.diameter.pccPredefRule.MonitoringKey": "string",
  "param.diameter.pccPredefRule.description": "string",
  "param.diameter.pccPredefRule.name": "string"
}

Export/Import Predefined Pcc Rule

Table 2-114 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
errors array    
errors:message string    
errors:name string    
exportData array M Exported list of predefined Pcc Rule.
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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "name": "string",
      "param.diameter.pccPredefRule.MonitoringKey": "string",
      "param.diameter.pccPredefRule.description": "string",
      "param.diameter.pccPredefRule.name": "string"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Delete Predefined Pcc Rule

Table 2-115 Request/Response Body Parameters

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

2.27 Predefined Adc Rule Base

Table 2-116 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Predefined Adc Rule Base POST ​{apiRoot}/oc-cnpolicy-configuration/v1/policydata/pcrf/predefinedadcrulebases See Table A-3
Export Predefined Adc Rule Base GET {apiRoot}/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/predefinedadcrulebases​/export See Table A-1
Import Predefined Adc Rule Base POST ​{apiRoot}/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/predefinedadcrulebases​/import See Table A-3
Get Predefined Adc Rule Base GET {apiRoot}/oc-cnpolicy-configuration/v1/policydata/pcrf/predefinedadcrulebases/{predefinedAdcRuleBaseName} See Table A-1
Update Predefined Adc Rule Base PUT {apiRoot}/oc-cnpolicy-configuration/v1/policydata/pcrf/predefinedadcrulebases/{predefinedAdcRuleBaseName} See Table A-2
Delete Predefined Adc Rule Base DELETE {apiRoot}/oc-cnpolicy-configuration/v1/policydata/pcrf/predefinedadcrulebases/{predefinedAdcRuleBaseName} See Table A-4

Create, Get, and Update Predefined Adc Rule Base

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
name string M  
param.diameter.adcPredefBaseRule.description string O  
param.diameter.adcPredefBaseRule.name string O  

Sample Request Body structure for POST and PUT operations:

{
  "name": "string",
  "param.diameter.adcPredefBaseRule.description": "string",
  "param.diameter.adcPredefBaseRule.name": "string"
}

Sample Response Body structure for GET, POST and PUT operations:

{
  "name": "string",
  "param.diameter.adcPredefBaseRule.description": "string",
  "param.diameter.adcPredefBaseRule.name": "string"
}

Export/Import Predefined Adc Rule Base

Table 2-118 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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 unresolvable-reference.html#GUID-13794F2B-2B3A-4DC9-B4FC-1C5B01C32C51__TABLE_JN3_DM5_3MB
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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "name": "string",
      "param.diameter.adcPredefBaseRule.description": "string",
      "param.diameter.adcPredefBaseRule.name": "string"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Delete Predefined Adc Rule Base

Table 2-119 Request/Response Body Parameters

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

2.28 Predefined Adc Rule

Table 2-120 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Predefined Adc Rule POST ​{apiRoot}/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/predefinedadcrules See Table A-3
Export Predefined Adc Rule GET ​{apiRoot}/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/predefinedadcrules​/export See Table A-1
Import Predefined Adc Rule POST {apiRoot}/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/predefinedadcrules​/import See Table A-3
Get Predefined Adc Rule GET {apiRoot}/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/predefinedadcrules​/{predefinedAdcRuleName} See Table A-1
Update Predefined Adc Rule PUT {apiRoot}/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/predefinedadcrules​/{predefinedAdcRuleName} See Table A-2
Delete Predefined Adc Rule DELETE {apiRoot}/oc-cnpolicy-configuration​/v1​/policydata​/pcrf​/predefinedadcrules​/{predefinedAdcRuleName} See Table A-4

Create, Get, and Update Predefined Adc Rule

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
name string M  
param.diameter.adcPredefRule.description string O  
param.diameter.adcPredefRule.name string O  

Sample Request Body structure for POST and PUT operations:

{
  "name": "string",
  "param.diameter.adcPredefRule.description": "string",
  "param.diameter.adcPredefRule.name": "string"
}

Sample Response Body structure for GET, POST and PUT operations:

{
  "name": "string",
  "param.diameter.adcPredefBaseRule.description": "string",
  "param.diameter.adcPredefBaseRule.name": "string"
}

Export/Import Predefined Adc Rule

Table 2-122 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
errors array    
errors:message string    
errors:name string    
exportData array M Exported list of predefined Adc Rule.
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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "name": "string",
      "param.diameter.adcPredefBaseRule.description": "string",
      "param.diameter.adcPredefBaseRule.name": "string"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Delete Predefined Adc Rule

Table 2-123 Request/Response Body Parameters

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

2.29 PCRF Presence Reporting Area

Table 2-124 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create PCRF Pesence Reporting Area POST ​{apiRoot}/oc-cnpolicy-configuration/v1/policydata/pcrf/pras See Table A-3
Export PCRF Pesence Reporting Area GET {apiRoot}/oc-cnpolicy-configuration/v1/policydata/pcrf/pras/export See Table A-1
Import PCRF Pesence Reporting Area POST {apiRoot}/oc-cnpolicy-configuration/v1/policydata/pcrf/pras/import See Table A-3
Get PCRF Pesence Reporting Area GET {apiRoot}​/oc-cnpolicy-configuration/v1/policydata/pcrf/pras/{praPcrfName} See Table A-1
Update PCRF Pesence Reporting Area PUT {apiRoot}​/oc-cnpolicy-configuration/v1/policydata/pcrf/pras/{praPcrfName} See Table A-2
Delete PCRF Pesence Reporting Area DELETE {apiRoot}​/oc-cnpolicy-configuration/v1/policydata/pcrf/pras/{praPcrfName} See Table A-4

Create, Get, and Update Pra

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

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

Core Network pre-configured

Table 2-126 praItems

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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 2-127 cgi

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

Table 2-128 ecgi

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

Table 2-129 home_enodeb

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

Table 2-130 macro_enodeb

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

Table 2-131 rai

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

Table 2-132 sai

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

Table 2-133 tai

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

Sample Request Body structure for POST and PUT operations:

{
  "description": "string",
  "id": "string",
  "name": "string",
  "praItems": [
    {
      "cgi": {
        "ci": "string",
        "lac": "string",
        "mcc": "string",
        "mnc": "string"
      },
      "ecgi": {
        "eci": "string",
        "mcc": "string",
        "mnc": "string"
      },
      "home_enodeb": {
        "henb": "string",
        "mcc": "string",
        "menb": "string",
        "mnc": "string"
      },
      "macro_enodeb": {
        "mcc": "string",
        "menb": "string",
        "mnc": "string"
      },
      "rai": {
        "lac": "string",
        "mcc": "string",
        "mnc": "string",
        "rac": "string"
      },
      "sai": {
        "lac": "string",
        "mcc": "string",
        "mnc": "string",
        "sac": "string"
      },
      "tai": {
        "mcc": "string",
        "mnc": "string",
        "tac": "string"
      },
      "type": "cgi"
    }
  ],
  "type": "Core Network pre-configured"
}

Sample Response Body structure for GET, POST and PUT operations:

{
  "description": "string",
  "id": "string",
  "name": "string",
  "praItems": [
    {
      "cgi": {
        "ci": "string",
        "lac": "string",
        "mcc": "string",
        "mnc": "string"
      },
      "ecgi": {
        "eci": "string",
        "mcc": "string",
        "mnc": "string"
      },
      "home_enodeb": {
        "henb": "string",
        "mcc": "string",
        "menb": "string",
        "mnc": "string"
      },
      "macro_enodeb": {
        "mcc": "string",
        "menb": "string",
        "mnc": "string"
      },
      "rai": {
        "lac": "string",
        "mcc": "string",
        "mnc": "string",
        "rac": "string"
      },
      "sai": {
        "lac": "string",
        "mcc": "string",
        "mnc": "string",
        "sac": "string"
      },
      "tai": {
        "mcc": "string",
        "mnc": "string",
        "tac": "string"
      },
      "type": "cgi"
    }
  ],
  "type": "Core Network pre-configured"
}

Export/Import Pra

Table 2-134 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
errors array    
errors:message string    
errors:name string    
exportData array M Exported list of Pra.
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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "description": "string",
      "id": "string",
      "name": "string",
      "praItems": [
        {
          "cgi": {
            "ci": "string",
            "lac": "string",
            "mcc": "string",
            "mnc": "string"
          },
          "ecgi": {
            "eci": "string",
            "mcc": "string",
            "mnc": "string"
          },
          "home_enodeb": {
            "henb": "string",
            "mcc": "string",
            "menb": "string",
            "mnc": "string"
          },
          "macro_enodeb": {
            "mcc": "string",
            "menb": "string",
            "mnc": "string"
          },
          "rai": {
            "lac": "string",
            "mcc": "string",
            "mnc": "string",
            "rac": "string"
          },
          "sai": {
            "lac": "string",
            "mcc": "string",
            "mnc": "string",
            "sac": "string"
          },
          "tai": {
            "mcc": "string",
            "mnc": "string",
            "tac": "string"
          },
          "type": "cgi"
        }
      ],
      "type": "Core Network pre-configured"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Delete Pra

Table 2-135 Request/Response Body Parameters

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

2.30 Media Profile

Table 2-136 Supported REST APIs

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

Create, Get, and Update Media Profile

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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  

Sample Request Body structure for POST and PUT operations:

{
  "codecName": "string",
  "description": "string",
  "frameSizeInBytes": 0,
  "frameSizeInMS": 0,
  "id": "string",
  "mediaType": "string",
  "name": "string",
  "pTime": 0,
  "payLoad": 0,
  "sampleRate": 0,
  "transportType": "RTP/AVP",
  "useDefaultPTime": true
}

Sample Response Body structure for GET, POST and PUT operations:

{
  "codecName": "string",
  "description": "string",
  "frameSizeInBytes": 0,
  "frameSizeInMS": 0,
  "id": "string",
  "mediaType": "string",
  "name": "string",
  "pTime": 0,
  "payLoad": 0,
  "sampleRate": 0,
  "transportType": "RTP/AVP",
  "useDefaultPTime": true
}

Export/Import Media Profile

Table 2-138 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
errors array    
errors:message string    
errors:name string    
exportData array M Exported list of media profile.
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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "codecName": "string",
      "description": "string",
      "frameSizeInBytes": 0,
      "frameSizeInMS": 0,
      "id": "string",
      "mediaType": "string",
      "name": "string",
      "pTime": 0,
      "payLoad": 0,
      "sampleRate": 0,
      "transportType": "RTP/AVP",
      "useDefaultPTime": true
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Delete Media Profile

Table 2-139 Request/Response Body Parameters

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

2.31 Match List

Table 2-140 Supported REST APIs

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

Export/Import Match List

Table 2-141 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "description": "string",
      "id": "string",
      "items": [
        "string"
      ],
      "name": "string",
      "type": "string"
    }
  ],
  "sourceVersion": "string",
  "topic": "string"
}
Sample cURL GET command
curl -X GET "http://10.75.151.216:30726/api-docs/oc-cnpolicy-configuration/v1/policydata/common/matchList/export" -H "accept: application/json"
Sample cURL POST command
curl -X POST "http://10.75.151.216:30726/api-docs/oc-cnpolicy-configuration/v1/policydata/common/matchList/import" -H "accept: application/problem+json" -H "Content-Type: application/json" -d "{ \"date\": \"string\", \"errors\": [ { \"message\": \"string\", \"name\": \"string\" } ], \"exportData\": [ { \"description\": \"string\", \"id\": \"string\", \"items\": [ \"string\" ], \"name\": \"string\", \"type\": \"string\" } ], \"sourceVersion\": \"string\", \"topic\": \"string\"}"

2.32 Dropdown Blocks

Table 2-142 Supported REST APIs

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

Export/Import Dropdown Blocks

Table 2-143 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "attrName": "string",
      "description": "string",
      "options": [
        {
          "label": "string",
          "value": "string"
        }
      ],
      "topic": "string",
      "type": "DYNAMIC"
    }
  ],
  "sourceVersion": "string",
  "topic": "string"
}

2.33 Custom Vendor

Table 2-144 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Export Custom Vendor GET {apiRoot}/oc-cnpolicy-configuration/v1/policydata/common/customattributes/customvendor/export See Table A-1
Import Custom Vendor POST {apiRoot}/oc-cnpolicy-configuration/v1/policydata/common/customattributes/customvendor/import See Table A-3

Create, Get, and Update Custom Vendor

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
description string O  
name string M  
value string O  

Sample Request Body structure for POST and PUT operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "description": "string",
      "name": "string",
      "value": "string"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Sample Request Body structure for POST and PUT operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "description": "string",
      "name": "string",
      "value": "string"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Export/Import Custom Vendor

Table 2-146 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
errors array    
errors:message string    
errors:name string    
exportData array M Exported list of custom avp.
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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "description": "string",
      "name": "string",
      "value": "string"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

2.34 Custom Schema

Table 2-147 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Export Custom Schema GET {apiRoot}/oc-cnpolicy-configuration/v1/policydata/common/customattributes/customschema/export See Table A-1
Import Custom Schema POST ​{apiRoot}/oc-cnpolicy-configuration/v1/policydata/common/customattributes/customschema/import See Table A-3

Export/Import Custom Schema

Table 2-148 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "name": "string",
      "tag": [
        "string"
      ]
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

2.35 Custom AVP

Table 2-149 Supported REST APIs

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

Create, Get, and Update Custom AVP Name

Table 2-150 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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    

Sample Request body structure for POST and PUT operations:

{
  "VendorSpecificFlag": true,
  "avpCode": "string",
  "avpType": "address",
  "description": "string",
  "mandatoryFlag": true,
  "mayEncryptFlag": true,
  "name": "string",
  "protectFlag": true,
  "rootAvp": "ADC-Rule-Definition:10415",
  "vendorId": "10415",
  "vendorSpecificFlag": true
}

Sample Response body structure for GET, POST, and PUT operations:

{
  "VendorSpecificFlag": true,
  "avpCode": "string",
  "avpType": "address",
  "description": "string",
  "mandatoryFlag": true,
  "mayEncryptFlag": true,
  "name": "string",
  "protectFlag": true,
  "rootAvp": "ADC-Rule-Definition:10415",
  "vendorId": "10415",
  "vendorSpecificFlag": true
}

Delete Custom AVP

Table 2-151 Request/Response Body Parameters

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

Export/Import Custom AVP

Table 2-152 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
errors array    
errors:message string    
errors:name string    
exportData array M Exported list of custom avp.
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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "VendorSpecificFlag": true,
      "avpCode": "string",
      "avpType": "address",
      "description": "string",
      "mandatoryFlag": true,
      "mayEncryptFlag": true,
      "name": "string",
      "protectFlag": true,
      "rootAvp": "ADC-Rule-Definition:10415",
      "vendorId": "10415",
      "vendorSpecificFlag": true
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

2.36 Charging Server

Table 2-153 Supported REST APIs

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

Get, Create, and Update Charging Server

Table 2-154 Request/Response Body Parameters

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

radius

tacacs+
security boolean    
transport string M tcp

udp

sctp

Sample Request body structure for POST and PUT operations:

{
  "description": "string",
  "hostName": "string",
  "name": "string",
  "port": "string",
  "protocol": "diameter",
  "security": true,
  "transport": "sctp"
}

Sample Response body structure for GET, POST, and PUT operations:

{
  "description": "string",
  "hostName": "string",
  "name": "string",
  "port": "string",
  "protocol": "diameter",
  "security": true,
  "transport": "sctp"
}

Delete Charging Server

Table 2-155 Request/Response Body Parameters

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

Export/Import Charging Server

Table 2-156 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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 Get, Create, and Update Charging Server.
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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "description": "string",
      "hostName": "string",
      "name": "string",
      "port": "string",
      "protocol": "diameter",
      "security": true,
      "transport": "sctp"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

2.37 PCRF Public Log

Table 2-157 Supported REST APIs

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

Get and Update PCRF Public Log

Table 2-158 Request/Response Body Parameters

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

Table 2-159 packageLogLevel

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

Export/Import PCRF Public Log

Table 2-160 Request/Response Body Parameters

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

2.38 User Service

Table 2-161 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Get User Service GET {apiRoot}/oc-cnpolicy-configuration/v1/services/pcfuser See Table A-1
Update User Service PUT {apiRoot}/oc-cnpolicy-configuration/v1/services/pcfuser See Table A-2
Export User Service GET {apiRoot}/oc-cnpolicy-configuration/v1/services/pcfuser/export See Table A-1
Import User Service POST {apiRoot}/oc-cnpolicy-configuration/v1/services/pcfuser/import See Table A-3

Get and Update User Service

Table 2-162 Request/Response Body Parameters

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

Table 2-163 chf Configuration

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
chf.retryProfileForInitMsgs String O Specifies the retry or alternate routing options to communicate with CHF.
chf.retryProfileForSubsqtMsgs String O Specifies the retry or alternate routing options to send subsequent messages to CHF.
chf.nfCommProfile String O Indicates whether to assign a profile created on the NF Communication Profile page to CHF.
chf.pcfServiceName String O

Specifies the custom/3gpp defined PCF service name to be included in the Binding Header in the subscription request or notification responses sent towards CHF.

Possible values:
  • Aggregate or custom service name that represents a group of PCF services with aggregated service level information.

    For example: npcf-custom-service

  • Any of the 3GPP defined PCF service names such as npcf-smpolicycontrol or npcf-am-policy-control

By default, the value of this parameter is empty.

Table 2-164 CommonConfiguration

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
requestTimeout

string

example: 1000

O
resourceGetSub

boolean

O

Table 2-165 DBConfiguration

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
indexing Indexing O
keysPrecedence ENUM O
userIndexKeys ENUM O

Table 2-166 Indexing

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

Table 2-167 UserSystemConfiguration

Field Name Data Type 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 O Indicates the log level of PCF Session Management (SM) service. Default Value: WARN

Table 2-168 UDR Configuration

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
udr.retryProfileForInitMsgs string O  
udr.baseUri

string

example: /nudr-dr/v1

O
udr.supportedFeatures

string

example: f

O
udr.smDataVSANames sting O
udr.amDataUri

string

example: /policy-data/ues/{ueId}/am-data

O
udr.uePolicySetUri

string

example: /policy-data/ues/{ueId}/ue-policy-set

O
udr.smDataUri

string

example: /policy-data/ues/{ueId}/sm-data

O
udr.usageMonUri

string

example: /policy-data/ues/{ueId}/sm-data/{usageMonId}

O
udr.subsToNotifyUri

string

example: /policy-data/subs-to-notify

O
udr.subsToNotifySubsIdUri

string

example: /policy-data/subs-to-notify/{subsId}

O
udr.retryProfileForSubsqtMsgs string    
udr.smDataSubscriptionResource integer    
smDataSubscriptionResource string, ENUM    
udr.discoverUdrWithPolicyAsSupportedDataSet boolean   udr
udr.requestTimeout

string

example: 1000

O
udr.explodeSnssai boolean O  
udr.enableDiscoveryOnDemand boolean O
udr.retrySubscriptionAs string O  
udr.nfCommProfile String O Indicates whether to assign a profile created on the NF Communication Profile page to UDR.
udr.sendTargetAPIRouteInSubsToNotify boolean O Specifies whether to send target API route header in subscribe to notify request towards UDR.
udr.sendInitDiscParamsInSubsToNotify boolean O Specifies whether to send discovery parameters in subscribe to notify request towards UDR.
udr.sendProdIdInSubsToNotify boolean O Specifies whether to send producer Id in Discovery header in subscribe to notify request towards UDR.
enableHttp11 boolean O

Sample Request body structure for PUT operations:

{
  "system": {
    "apiRoot": "string"
  },
  "common": {
    "requestTimeout": "1000"
  },
  "db": {
    "keysPrecedence": [
      "MSISDN"
    ],
    "userIndexKeys": [
      "msisdn"
    ],
    "indexing": {
      "indexByMsisdn": true,
      "indexByExtid": true,
      "indexByImsi": true,
      "indexByNai": true
    }
  },
  "udr": {
    "retryProfileForInitMsgs": "string",
    "baseUri": "/nudr-dr/v1",
    "supportedFeatures": "f",
    "smDataVSANames": "string",
    "amDataUri": "/policy-data/ues/{ueId}/am-data",
    "uePolicySetUri": "/policy-data/ues/{ueId}/ue-policy-set",
    "smDataUri": "/policy-data/ues/{ueId}/sm-data",
    "usageMonUri": "/policy-data/ues/{ueId}/sm-data/{usageMonId}",
    "subsToNotifyUri": "/policy-data/subs-to-notify",
    "subsToNotifySubsIdUri": "/policy-data/subs-to-notify/{subsId}",
    "retryProfileForSubsqtMsgs": "string",
    "smDataSubscriptionResource": "1",
    "discoverUdrWithPolicyAsSupportedDataSet": true,
    "requestTimeout": "1000",
    "explodeSnssai": true,
    "enableDiscoveryOnDemand": true,
    "retrySubscriptionAs": "subsequent",
    "nfCommProfile": "string",
    "sendTargetAPIRouteInSubsToNotify": true,
    "sendInitDiscParamsInSubsToNotify": false,
    "sendProdIdInSubsToNotify": false
  },
  "chf": {
    "retryProfileForInitMsgs": "string",
    "retryProfileForSubsqtMsgs": "string",
    "nfCommProfile": "string"
    "pcfServiceName": "string"

  },
  "advancedSettings": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

Sample Response body structure for GET and PUT operations:

{
  "system": {
    "apiRoot": "string"
  },
  "common": {
    "requestTimeout": "1000"
  },
  "db": {
    "keysPrecedence": [
      "MSISDN"
    ],
    "userIndexKeys": [
      "msisdn"
    ],
    "indexing": {
      "indexByMsisdn": true,
      "indexByExtid": true,
      "indexByImsi": true,
      "indexByNai": true
    }
  },
  "udr": {
    "retryProfileForInitMsgs": "string",
    "baseUri": "/nudr-dr/v1",
    "supportedFeatures": "f",
    "smDataVSANames": "string",
    "amDataUri": "/policy-data/ues/{ueId}/am-data",
    "uePolicySetUri": "/policy-data/ues/{ueId}/ue-policy-set",
    "smDataUri": "/policy-data/ues/{ueId}/sm-data",
    "usageMonUri": "/policy-data/ues/{ueId}/sm-data/{usageMonId}",
    "subsToNotifyUri": "/policy-data/subs-to-notify",
    "subsToNotifySubsIdUri": "/policy-data/subs-to-notify/{subsId}",
    "retryProfileForSubsqtMsgs": "string",
    "smDataSubscriptionResource": "1",
    "discoverUdrWithPolicyAsSupportedDataSet": true,
    "requestTimeout": "1000",
    "explodeSnssai": true,
    "enableDiscoveryOnDemand": true,
    "retrySubscriptionAs": "subsequent",
    "nfCommProfile": "string",
    "sendTargetAPIRouteInSubsToNotify": true,
    "sendInitDiscParamsInSubsToNotify": false,
    "sendProdIdInSubsToNotify": false
  },
  "chf": {
    "retryProfileForInitMsgs": "string",
    "retryProfileForSubsqtMsgs": "string",
    "nfCommProfile": "string"
  },
  "advancedSettings": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

Export/Import User Service

Table 2-169 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData array   Exported list of user service. For more information, see Get and Update User Service.
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": {
    "chf": {
      "nfCommProfile": "string",
      "retryProfileForInitMsgs": "string",
      "retryProfileForSubsqtMsgs": "string"
    },
    "common": {
      "requestTimeout": 1000,
      "resourceGetSub": true
    },
    "db": {
      "indexing": {
        "indexByExtid": true,
        "indexByImsi": true,
        "indexByMsisdn": true,
        "indexByNai": true
      },
      "keysPrecedence": [
        "EXTID"
      ],
      "userIndexKeys": [
        "extid"
      ]
    },
    "system": {
      "apiRoot": "string"
    },
    "udr": {
      "amDataUri": "/policy-data/ues/{ueId}/am-data",
      "baseUri": "/nudr-dr/v1",
      "discoverUdrWithPolicyAsSupportedDataSet": true,
      "enableDiscoveryOnDemand": true,
      "enableHttp11": true,
      "explodeSnssai": true,
      "nfCommProfile": "string",
      "requestTimeout": 1000,
      "retryProfileForInitMsgs": "string",
      "retryProfileForSubsqtMsgs": "string",
      "sendInitDiscParamsInSubsToNotify": false,
      "sendProdIdInSubsToNotify": false,
      "sendTargetAPIRouteInSubsToNotify": true,
      "smDataSubscriptionResource": "1",
      "smDataUri": "/policy-data/ues/{ueId}/sm-data",
      "subsToNotifySubsIdUri": "/policy-data/subs-to-notify/{subsId}",
      "subsToNotifyUri": "/policy-data/subs-to-notify",
      "supportedFeatures": "f",
      "uePolicySetUri": "/policy-data/ues/{ueId}/ue-policy-set",
      "usageMonUri": "/policy-data/ues/{ueId}/sm-data/{usageMonId}"
    }
  },
  "sourceVersion": "string",
  "topic": "string"
}

2.39 Test Policy Projects

Table 2-170 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Export test policy project GET {apiRoot}/oc-cnpolicy-configuration/v1/policymgmt/policytests/testpolicyproject/export See Table A-1
Import test policy project POST {apiRoot}/oc-cnpolicy-configuration/v1/policymgmt/policytests/testpolicyproject/import See Table A-3

Export/Import Test Policy Projects s

Table 2-171 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData.script string    
exportData.servcieType string    
exportData.suiteName string    
exportData.testcase.fieldVal.basicInfo.caseDesc string    
exportData.testcase.fieldVal.basicInfo.caseName string    
exportData.inputVal string    
exportData.resVal string    
exportData.name string    
exportData.reqDataModel string    
exportData.resDataModel string    
exportData.suiteName string    
exportData.testCaseScript string    
key string    
sourceVersion string   System version of the product from which data is exported
topic string M Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "exportData": [
    {
      "script": "string",
      "serviceType": "string",
      "suiteName": "string",
      "testCase": [
        {
          "fieldVal": {
            "basicInfo": {
              "caseDesc": "string",
              "caseName": "string"
            },
            "inputVal": {},
            "resVal": {}
          },
          "name": "string",
          "reqDataModel": "string",
          "resDataModel": "string",
          "suiteName": "string",
          "testCaseScript": "string"
        }
      ]
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

2.40 Data Model

Table 2-172 Supported REST APIs

Export data model HTTP Method or Custom Operation Resource URI Possible Result Code
Import data model GET {apiRoot}/oc-cnpolicy-configuration/v1/policymgmt/policytests/datamodels/export See Table A-1
Description POST {apiRoot}/oc-cnpolicy-configuration/v1/policymgmt/policytests/datamodels/import See Table A-3

Export/Import Data Model s

Table 2-173 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData.description string    
exportData.enumItems.name string    
exportData.enumItems.value string    
exportData.fields.description string    
exportData.fields.itemType.objectType string    
exportData.fields.itemType.primitiveType string    
exportData.fields.itemType.type string    
exportData.fields.labelName string    
exportData.fields.name string    
exportData.fields.objectType string    
exportData.fields.primitiveType string    
exportData.fields.type string    
exportData.id string    
exportData.labelName string    
exportData.multiValue string    
exportData.name string    
exportData.type string    
key string    
sourceVersion string   System version of the product from which data is exported
topic string M Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "exportData": [
    {
      "description": "string",
      "enumItems": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "fields": [
        {
          "description": "string",
          "itemType": {
            "objectType": "string",
            "primitiveType": "boolean",
            "type": "object"
          },
          "labelName": "string",
          "name": "string",
          "objectType": "string",
          "primitiveType": "string",
          "type": "array"
        }
      ],
      "id": "string",
      "labelName": "string",
      "multiValue": true,
      "name": "string",
      "type": "enum"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

2.41 Policy Projects

Table 2-174 Supported REST APIs - Peer Node

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Import policy projects POST {apiRoot}​​/oc-cnpolicy-configuration​/v1​/policymgmt​/policyprojects​/import See Table A-3
Export Policy Projects GET {apiRoot}/oc-cnpolicy-configuration/v1/policymgmt/policyprojects/export See Table A-1
Get policy project GET {apiRoot}/oc-cnpolicy-configuration/v1/policymgmt/policyprojects?policyProjectName=projectName&serviceName=service

where, serviceName is a mandatory query Parameter and policyProjectName is an optional parameter.

See Table A-1
Expot Policy GET {apiRoot}/oc-cnpolicy-configuration/v1/policymgmt/policyprojects/policy/export/{serviceName}/{policyProjectName}/{policyName} See Table A-1
Import Policy POST {apiRoot}/oc-cnpolicy-configuration/v1/policymgmt/policyprojects/policy/import See Table A-3
Delete policy project DELETE {apiRoot}/oc-cnpolicy-configuration/v1/policymgmt/policyprojects/{serviceName}/{policyProjectName} See Table A-4
Update Policy Project State PUT {apiRoot}/oc-cnpolicy-configuration/v1/policymgmt/policyprojects/{serviceName}/{policyProjectName} See Table A-2

Get, Create, and Update Policy Projects

Table 2-175 Request/Response Body Parameters

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

Sample Response body structure for GET, POST, and PUT operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "description": "string",
      "entrance": true,
      "key": "string",
      "layout": "string",
      "name": "string",
      "outputModels": [
        "string"
      ],
      "policy": [
        {
          "entrance": true,
          "layout": "string",
          "name": "string",
          "outputModels": [
            "string"
          ],
          "script": "string"
        }
      ],
      "projectId": "string",
      "script": "string",
      "serviceType": "string"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Delete Policy Projects

Table 2-176 Request/Response Body Parameters

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

Export/Import Policy Projects

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "description": "string",
      "entrance": true,
      "key": "string",
      "layout": "string",
      "name": "string",
      "outputModels": [
        "string"
      ],
      "policy": [
        {
          "entrance": true,
          "layout": "string",
          "name": "string",
          "outputModels": [
            "string"
          ],
          "script": "string"
        }
      ],
      "projectId": "string",
      "script": "string",
      "serviceType": "string"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

2.42 Policy Library

Table 2-177 Supported REST APIs - Peer Node

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Export Policy Library GET {apiRoot}/oc-cnpolicy-configuration/v1/policymgmt/policylibrary/export See Table A-1
Import Policy Library POST {apiRoot}​/oc-cnpolicy-configuration/v1/policymgmt/policylibrary/import See Table A-3

Export/Import Policy Library

Table 2-178 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData.hasReturn boolean    
exportData.layout string    
exportData.library string    
exportData.name string    
exportData.paramList array    
exportData.script string    
exportData.service string    
sourceVersion string   System version of the product from which data is exported
topic string M Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "exportData": [
    {
      "hasReturn": true,
      "layout": "string",
      "library": "string",
      "name": "string",
      "paramList": [
        "string"
      ],
      "script": "string",
      "service": "string"
    }
  ],
  "sourceVersion": "string",
  "topic": "string"
}

2.43 Policy Data

Table 2-179 Supported REST APIs

  HTTP Method or Custom Operation   Possible Result Code
Export Policy Data with or without Dependencies POST {apiRoot}/oc-cnpolicy-configuration/v1/policymgmt/policydata/export See Table A-3

Note:

The Policy Data export API returns a ResourceId in response to the POST request. The ResourceId is the background task id for the POST operation. This id can be used to track the policy data export requests, and download the export data.

For example, the POST API for Policy Data export operation takes the project name, policy name, and service type as input. The response of this API contains the resource id of the file created for export. You can use this resource Id to download the export data at any point of time. For more information about the API to download the export data, see Bulk Import Export Controller.

Export Policy Data

Table 2-180 Request Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
name string M Name of the project.
policies array M Name of the policies.
serviceType string   Service type.

Note: Only AM and SM service types are supported.

includeDependencies boolean O This is a flag to decide, if dependencies must be included with export data. Provide any of the following values:
  • true: Export all the dependent MOs of the policy names provided in the policies field
  • false: Does not export all the dependent MOs of the policy names provided in the policies field

Sample Request Body structure for Export operations:

[
  {
    "policyProjects": [
      {
        "name": "string",
        "policies": [
          "string"
        ]
      }
    ],
    "serviceType": "string"
  }
]
Below are the status displayed by Polcy Data export:
  • INIT: The policies are being validated and export of MOs is not started.
  • IN_PROGRESS: The export is running.
  • DONE: The export is complete. Following are the possible status if the export is in DONE status:
    • SUCCESS : The export is successful
    • FAILED : When error exist in all the Policies exported.
    • PARTIAL_SUCCESS : The export is partially successful

2.44 URSP

Table 2-181 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create URSP POST {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfue/ursps See Table A-3
Export URSP GET {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfue/ursps/export See Table A-1
Import URSP POST ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfue/ursps/import See Table A-3
Get URSP GET {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfue/ursps/{urspName} See Table A-1
Update URSP PUT {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfue/ursps/{urspName} See Table A-2
Delete URSP DELETE {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfue/ursps/{urspName} See Table A-4

Get, Create, and Update URSPs

Table 2-182 Request/Response Body Parameters

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

Table 2-183 UrspRouteSelectionDescriptorList

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

Table 2-184 UrspRouteSelectionDescriptorList

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

Table 2-185 RouteSelectionDescriptorComponentIE

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

Table 2-186 TrafficDescriptorIE

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

Table 2-187 RouteSelectionDescriptorComponentIE

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

Sample Request body structure for POST and PUT operations:

{
  "name": "string",
  "precedence": 0,
  "routeSelectionDescriptorList": [
    {
      "routePrecedence": 0,
      "routeSelectionDescriptorComponents": [
        {
          "routeSelectionDescriptorType": "DNN",
          "value": {}
        }
      ]
    }
  ],
  "trafficDescriptors": [
    {
      "trafficDescriptorType": "CONNECTION_CAPABILITIES",
      "value": {}
    }
  ]
}

Sample Response body structure for GET, POST, and PUT operations:

{
  "name": "string",
  "precedence": 0,
  "routeSelectionDescriptorList": [
    {
      "routePrecedence": 0,
      "routeSelectionDescriptorComponents": [
        {
          "routeSelectionDescriptorType": "DNN",
          "value": {}
        }
      ]
    }
  ],
  "trafficDescriptors": [
    {
      "trafficDescriptorType": "CONNECTION_CAPABILITIES",
      "value": {}
    }
  ]
}

Delete URSP

Table 2-188 Request/Response Body Parameters

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

Export/Import URSP

Table 2-189 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData array   Exported list of URSPervice. For more information, see Get, Create, and Update URSPs.
key string   Indicates the ID of URSP
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "name": "string",
      "precedence": 0,
      "routeSelectionDescriptorList": [
        {
          "routePrecedence": 0,
          "routeSelectionDescriptorComponents": [
            {
              "routeSelectionDescriptorType": "DNN",
              "value": {}
            }
          ]
        }
      ],
      "trafficDescriptors": [
        {
          "trafficDescriptorType": "CONNECTION_CAPABILITIES",
          "value": {}
        }
      ]
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

2.45 UPSI

Table 2-190 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create UPSI POST {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfue/upsis See Table A-3
Export UPSI GET ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfue/upsis/export See Table A-1
Import UPSI POST ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfue/upsis/import See Table A-3
Get UPSI GET {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfue/upsis/{upsiName} See Table A-1
Update UPSI PUT {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfue/upsis/{upsiName} See Table A-2
Delete UPSI DELETE {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfue/upsis/{upsiName} See Table A-4

Get, Create, and Update UPSIs

Table 2-191 Request/Response Body Parameters

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

Table 2-192 Plmn

Field Name Data Type 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.

Sample Request body structure for POST and PUT operations:

{
  "name": "string",
  "plmn": {
    "mcc": "string",
    "mnc": "string"
  },
  "upsc": 0,
  "urspRules": [
    "string"
  ]
}

Sample Response body structure for GET, POST, and PUT operations:

{
  "name": "string",
  "plmn": {
    "mcc": "string",
    "mnc": "string"
  },
  "upsc": 0,
  "urspRules": [
    "string"
  ]
}

Delete UPSI

Table 2-193 Request/Response Body Parameters

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

Export/Import UPSI

Table 2-194 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
errors:message string    
errors:name string    
exportData array   Exported list of UPSI service. For more information, see Get, Create, and Update UPSIs.
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "name": "string",
      "plmn": {
        "mcc": "string",
        "mnc": "string"
      },
      "upsc": 0,
      "urspRules": [
        "string"
      ]
    }
  ],
  "sourceVersion": "string",
  "topic": "string"
}

2.46 Traffic Control Data

Table 2-195 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Traffic Control Data POST {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/trafficcontroldata See Table A-3
Export Traffic Control Data GET {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/trafficcontroldata/export See Table A-1
Import Traffic Control Data POST ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/trafficcontroldata/import See Table A-3
Get Traffic Control Data GET {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/trafficcontroldata/{trafficControlDataName} See Table A-1
Update Traffic Control Data PUT {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/trafficcontroldata/{trafficControlDataName} See Table A-2
Delete Traffic Control Data DELETE ​{apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/trafficcontroldata/{trafficControlDataName} See Table A-4

Get, Create, and Update Traffic Control Data

Table 2-196 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C)aints Description
description string O The description of the Traffic Control policy data.
flowStatus ENUM 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 The name of the Traffic Control policy data.
redirectInfo RedirectInfo O 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-197 RedirectInfo

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
redirectAddressType ENUM 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-198 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-199 RouteInfo

Field Name Data Type 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-200 UpPathChgEvent

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
dnaiChgType ENUM 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

Sample Request body structure for POST and PUT operations:

{
  "description": "string",
  "flowStatus": "DISABLED",
  "muteNotif": true,
  "name": "string",
  "redirectInfo": {
    "redirectAddressType": "IPV4_ADDR",
    "redirectEnabled": true,
    "redirectServerAddress": "string"
  },
  "routeToLocs": [
    {
      "dnai": "string",
      "routeInfo": {
        "ipv4Addr": "string",
        "ipv6Addr": "string",
        "portNumber": 0
      },
      "routeProfId": "string"
    }
  ],
  "tcId": "string",
  "trafficSteeringPolIdDl": "string",
  "trafficSteeringPolIdUl": "string",
  "upPathChgEvent": {
    "dnaiChgType": "EARLY",
    "notifCorreId": "string",
    "notificationUri": "string"
  }
}

Sample Response body structure for GET, POST, and PUT operations:

{
  "description": "string",
  "flowStatus": "DISABLED",
  "muteNotif": true,
  "name": "string",
  "redirectInfo": {
    "redirectAddressType": "IPV4_ADDR",
    "redirectEnabled": true,
    "redirectServerAddress": "string"
  },
  "routeToLocs": [
    {
      "dnai": "string",
      "routeInfo": {
        "ipv4Addr": "string",
        "ipv6Addr": "string",
        "portNumber": 0
      },
      "routeProfId": "string"
    }
  ],
  "tcId": "string",
  "trafficSteeringPolIdDl": "string",
  "trafficSteeringPolIdUl": "string",
  "upPathChgEvent": {
    "dnaiChgType": "EARLY",
    "notifCorreId": "string",
    "notificationUri": "string"
  }
}

Delete Traffic Control Data

Table 2-201 Request/Response Body Parameters

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

Export/Import Traffic Control Data

Table 2-202 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData array   Exported list of traffic control data service. For more information, see Get, Create, and Update Traffic Control Data.
key string   Indicates the ID of Traffic Control Data
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "description": "string",
      "flowStatus": "DISABLED",
      "muteNotif": true,
      "name": "string",
      "redirectInfo": {
        "redirectAddressType": "IPV4_ADDR",
        "redirectEnabled": true,
        "redirectServerAddress": "string"
      },
      "routeToLocs": [
        {
          "dnai": "string",
          "routeInfo": {
            "ipv4Addr": "string",
            "ipv6Addr": "string",
            "portNumber": 0
          },
          "routeProfId": "string"
        }
      ],
      "tcId": "string",
      "trafficSteeringPolIdDl": "string",
      "trafficSteeringPolIdUl": "string",
      "upPathChgEvent": {
        "dnaiChgType": "EARLY",
        "notifCorreId": "string",
        "notificationUri": "string"
      }
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

2.47 PCC Rule

Table 2-203 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create PCC Rule POST {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/pccrules See Table A-3
Export PCC Rules GET ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/pccrules/export See Table A-1
Import PCC Rule POST {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/pccrules/import See Table A-3
Get PCC Rule GET {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/pccrules/{pccRuleName} See Table A-1
Update PCC Rule PUT {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/pccrules/{pccRuleName} See Table A-2
Delete PCC Rule DELETE {apiRoot}​​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/pccrules/{pccRuleName} See Table A-4

Get, Create, and Update PCC Rules

Table 2-204 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C)aints Description
afSigProtocol ENUM O 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.
qosFlowUsage ENUM O Indicates the QoS flow usage. The default value is not applicable for this field. Users can select GENERAL or IMS_SIG from the drop down list as per the requirement.
appId string O A reference to the application detection filter configured at the UPF.
appReloc boolean O 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 Indicates the content version of the PCC rule.
description string O The description of the PCC rule
flowInfos FlowInfos O 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 O

Table 2-205 FlowInfos

Field Name Data Type 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 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-206 ethFlowDescription

Field Name Data Type 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 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.

Sample Request body structure for POST and PUT operations:


{
  "afSigProtocol": "NO_INFORMATION",
  "appId": "string",
  "appReloc": true,
  "contVer": "string",
  "description": "string",
  "flowInfos": [
    {
      "ethFlowDescription": {
        "destMacAddr": "string",
        "ethType": "string",
        "fDesc": "string",
        "fDir": "BIDIRECTIONAL",
        "fdesc": "string",
        "fdir": "BIDIRECTIONAL",
        "sourceMacAddr": "string",
        "vlanTags": [
          "string"
        ]
      },
      "flowDescription": "string",
      "flowDirection": "BIDIRECTIONAL",
      "flowLabel": "string",
      "name": "string",
      "packFiltId": "string",
      "packetFilterUsage": true,
      "spi": "string",
      "tosTrafficClass": "string"
    }
  ],
  "name": "string",
  "pccRuleId": "string",
  "precedence": "string",
  "refChgData": [
    "string"
  ],
  "refCondData": "string",
  "refQosData": [
    "string"
  ],
  "refTcData": [
    "string"
  ],
  "refUmData": [
    "string"
  ],
  "type": "DYNAMIC"
}

Sample Response body structure for GET, POST, and PUT operations:

{
  "afSigProtocol": "NO_INFORMATION",
  "appId": "string",
  "appReloc": true,
  "contVer": "string",
  "description": "string",
  "flowInfos": [
    {
      "ethFlowDescription": {
        "destMacAddr": "string",
        "ethType": "string",
        "fDesc": "string",
        "fDir": "BIDIRECTIONAL",
        "fdesc": "string",
        "fdir": "BIDIRECTIONAL",
        "sourceMacAddr": "string",
        "vlanTags": [
          "string"
        ]
      },
      "flowDescription": "string",
      "flowDirection": "BIDIRECTIONAL",
      "flowLabel": "string",
      "name": "string",
      "packFiltId": "string",
      "packetFilterUsage": true,
      "spi": "string",
      "tosTrafficClass": "string"
    }
  ],
  "name": "string",
  "pccRuleId": "string",
  "precedence": "string",
  "refChgData": [
    "string"
  ],
  "refCondData": "string",
  "refQosData": [
    "string"
  ],
  "refTcData": [
    "string"
  ],
  "refUmData": [
    "string"
  ],
  "type": "DYNAMIC"
}

Delete PCC Rule

Table 2-207 Request/Response Body Parameters

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

Export/Import PCC Rule s

Table 2-208 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData array   Exported list of PCC Rule. For more information, see Get, Create, and Update PCC Rules .
key string   Indicates the ID
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "afSigProtocol": "NO_INFORMATION",
      "appId": "string",
      "appReloc": true,
      "contVer": "string",
      "description": "string",
      "flowInfos": [
        {
          "ethFlowDescription": {
            "destMacAddr": "string",
            "ethType": "string",
            "fDesc": "string",
            "fDir": "BIDIRECTIONAL",
            "fdesc": "string",
            "fdir": "BIDIRECTIONAL",
            "sourceMacAddr": "string",
            "vlanTags": [
              "string"
            ]
          },
          "flowDescription": "string",
          "flowDirection": "BIDIRECTIONAL",
          "flowLabel": "string",
          "name": "string",
          "packFiltId": "string",
          "packetFilterUsage": true,
          "spi": "string",
          "tosTrafficClass": "string"
        }
      ],
      "name": "string",
      "pccRuleId": "string",
      "precedence": "string",
      "refChgData": [
        "string"
      ],
      "refCondData": "string",
      "refQosData": [
        "string"
      ],
      "refTcData": [
        "string"
      ],
      "refUmData": [
        "string"
      ],
      "type": "DYNAMIC"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

2.48 PCC Rule Profile

Table 2-209 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create PCC Rule Profile POST ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/pccruleprofiles See Table A-3
Export PCC Rule Profiles GET ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/pccruleprofiles/export See Table A-1
Import PCC Rule Profile POST ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/pccruleprofiles/import See Table A-3
Get PCC Rule Profile GET {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/pccruleprofiles/{pccRuleProfileName} See Table A-1
Update PCC Rule Profile PUT {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/pccruleprofiles/{pccRuleProfileName} See Table A-2
Delete PCC Rule Profile DELETE ​{apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/pccruleprofiles/{pccRuleProfileName} See Table A-4

Get, Create, and Update PCC Rule Profile

Table 2-210 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C)aints Description
afSigProtocol ENUM O Specifies the protocol used for signaling between the UE and the AF.
qosFlowUsage ENUM O Indicates the QoS flow usage. The default value is not applicable for this field. Users can select GENERAL or IMS_SIG from the drop down list as per the requirement.
appId string O A reference to the application detection filter configured at the UPF.
appReloc boolean O Specifies application relocation possibility.
contVer string O Specifies the content version of the PCC rule.
description string O Description of PCC Rule Profile.
flowInfos FlowInfos O 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 Possible values are:
  • DYNAMIC
  • PREDEFINED

Table 2-211 FlowInfos

Field Name Data Type 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 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-212 ethFlowDescription

Field Name Data Type 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

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.

Sample Request body structure for POST and PUT operations:

{
  "afSigProtocol": "NO_INFORMATION",
  "appId": "string",
  "appReloc": true,
  "contVer": "string",
  "description": "string",
  "flowInfos": [
    {
      "ethFlowDescription": {
        "destMacAddr": "string",
        "ethType": "string",
        "fDesc": "string",
        "fDir": "BIDIRECTIONAL",
        "fdesc": "string",
        "fdir": "BIDIRECTIONAL",
        "sourceMacAddr": "string",
        "vlanTags": [
          "string"
        ]
      },
      "flowDescription": "string",
      "flowDirection": "BIDIRECTIONAL",
      "flowLabel": "string",
      "name": "string",
      "packFiltId": "string",
      "packetFilterUsage": true,
      "spi": "string",
      "tosTrafficClass": "string"
    }
  ],
  "id": "string",
  "name": "string",
  "precedence": "string",
  "refChgData": [
    "string"
  ],
  "refCondData": "string",
  "refQosData": [
    "string"
  ],
  "refTcData": [
    "string"
  ],
  "refUmData": [
    "string"
  ],
  "type": "DYNAMIC"
}

Sample Response body structure for GET, POST, and PUT operations:


  {
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "afSigProtocol": "NO_INFORMATION",
      "appId": "string",
      "appReloc": true,
      "contVer": "string",
      "description": "string",
      "flowInfos": [
        {
          "ethFlowDescription": {
            "destMacAddr": "string",
            "ethType": "string",
            "fDesc": "string",
            "fDir": "BIDIRECTIONAL",
            "fdesc": "string",
            "fdir": "BIDIRECTIONAL",
            "sourceMacAddr": "string",
            "vlanTags": [
              "string"
            ]
          },
          "flowDescription": "string",
          "flowDirection": "BIDIRECTIONAL",
          "flowLabel": "string",
          "name": "string",
          "packFiltId": "string",
          "packetFilterUsage": true,
          "spi": "string",
          "tosTrafficClass": "string"
        }
      ],
      "id": "string",
      "name": "string",
      "precedence": "string",
      "refChgData": [
        "string"
      ],
      "refCondData": "string",
      "refQosData": [
        "string"
      ],
      "refTcData": [
        "string"
      ],
      "refUmData": [
        "string"
      ],
      "type": "DYNAMIC"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Delete PCC Rule Profile

Table 2-213 Request/Response Body Parameters

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

Export/Import PCC Rule Profile

Table 2-214 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData array   Exported list of PCC Rule Profile. For more information, see Get, Create, and Update PCC Rule Profile .
key string   Indicates the ID
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "afSigProtocol": "NO_INFORMATION",
      "appId": "string",
      "appReloc": true,
      "contVer": "string",
      "description": "string",
      "flowInfos": [
        {
          "ethFlowDescription": {
            "destMacAddr": "string",
            "ethType": "string",
            "fDesc": "string",
            "fDir": "BIDIRECTIONAL",
            "fdesc": "string",
            "fdir": "BIDIRECTIONAL",
            "sourceMacAddr": "string",
            "vlanTags": [
              "string"
            ]
          },
          "flowDescription": "string",
          "flowDirection": "BIDIRECTIONAL",
          "flowLabel": "string",
          "name": "string",
          "packFiltId": "string",
          "packetFilterUsage": true,
          "spi": "string",
          "tosTrafficClass": "string"
        }
      ],
      "id": "string",
      "name": "string",
      "precedence": "string",
      "refChgData": [
        "string"
      ],
      "refCondData": "string",
      "refQosData": [
        "string"
      ],
      "refTcData": [
        "string"
      ],
      "refUmData": [
        "string"
      ],
      "type": "DYNAMIC"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

2.49 Condition Data

Table 2-215 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Condition Data POST {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/conditiondata See Table A-3
Export Condition Data GET {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/conditiondata/export See Table A-1
Import Condition Data POST {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/conditiondata/import See Table A-3
Get Condition Data GET ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/conditiondata/{conditionDataName} See Table A-1
Update Condition Data PUT {apiRoot}​​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/conditiondata/{conditionDataName} See Table A-2
Delete Condition Data DELETE {apiRoot}​​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/conditiondata/{conditionDataName} See Table A-4

Get, Create, and Update Condition Data

Table 2-216 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C)aints Description
activationTime

string,

example : YYYY-MM-DDTHH:MM:SS

O The time when the decision data shall be activated.
condId string O Specifies the condition ID.
deactivationTime string

example : YYYY-MM-DDTHH:MM:SS

O The time when the decision data shall be deactivated.
description string O The description of the Condition Data policy data.
name string M The name of the Condition Data policy data.

Sample Request body structure for POST and PUT operations:

{
  "activationTime": "YYYY-MM-DDTHH:MM:SS",
  "condId": "string",
  "deactivationTime": "YYYY-MM-DDTHH:MM:SS",
  "description": "string",
  "name": "string"
}

Sample Response body structure for GET, POST, and PUT operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "activationTime": "YYYY-MM-DDTHH:MM:SS",
      "condId": "string",
      "deactivationTime": "YYYY-MM-DDTHH:MM:SS",
      "description": "string",
      "name": "string"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Delete Condition Data

Table 2-217 Request/Response Body Parameters

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

Export/Import Condition Data

Table 2-218 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData array   Exported list of condition data. For more information, see Get, Create, and Update Condition Data .
key string   Indicates the ID
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "activationTime": "YYYY-MM-DDTHH:MM:SS",
      "condId": "string",
      "deactivationTime": "YYYY-MM-DDTHH:MM:SS",
      "description": "string",
      "name": "string"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

2.50 Charging Data

Table 2-219 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Charging Data POST {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/chargingdata See Table A-3
Export Charging Data GET {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/chargingdata/export See Table A-1
Import Charging Data POST {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/chargingdata/import See Table A-3
Get Charging Data GET {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/chargingdata/{chargingDataName} See Table A-1
Update Condition Data PUT {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/chargingdata/{chargingDataName} See Table A-2
Delete Charging Data DELETE ​{apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfsm/chargingdata/{chargingDataName} See Table A-4

Get, Create, and Update Charging Data

Table 2-220 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C)aints Description
afChargingIdentifiercgiList

integer ($int64), Enter a value between 0 and 4294967295

O Univocally identifies the charging control policy data within a PDU session.
appSvcProvId string O Indicates the application service provider identity.
chgId string M Specifies the charging id.
description string O The description of the Charging Data.
meteringMethod ENUM O 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 The name of the Charging Data.
offline boolean O 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 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 The charging key for the PCC rule used for rating purposes.
reportingLevel ENUM O 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.
sdfHandl boolean    
serviceId integer ($int64), Enter a value between 0 and 4294967295 O Indicates the identifier of the service or service component the service data flow in a PCC rule relates to.
sponsorId string O Indicates the sponsor identity.

Sample Request body structure for POST and PUT operations:

{
  "afChargingIdentifier": 0,
  "appSvcProvId": "string",
  "chgId": "string",
  "description": "string",
  "meteringMethod": "DURATION",
  "name": "string",
  "offline": true,
  "online": true,
  "ratingGroup": 0,
  "reportingLevel": "RAT_GR_LEVEL",
  "sdfHandl": true,
  "serviceId": 0,
  "sponsorId": "string"
}

Sample Response body structure for GET, POST, and PUT operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "afChargingIdentifier": 0,
      "appSvcProvId": "string",
      "chgId": "string",
      "description": "string",
      "meteringMethod": "DURATION",
      "name": "string",
      "offline": true,
      "online": true,
      "ratingGroup": 0,
      "reportingLevel": "RAT_GR_LEVEL",
      "sdfHandl": true,
      "serviceId": 0,
      "sponsorId": "string"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Delete Charging Data

Table 2-221 Request/Response Body Parameters

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

Export/Import Charging Data

Table 2-222 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData array   Exported list of charging data. For more information, see Get, Create, and Update Charging Data.
key string   Indicates the ID
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "afChargingIdentifier": 0,
      "appSvcProvId": "string",
      "chgId": "string",
      "description": "string",
      "meteringMethod": "DURATION",
      "name": "string",
      "offline": true,
      "online": true,
      "ratingGroup": 0,
      "reportingLevel": "RAT_GR_LEVEL",
      "sdfHandl": true,
      "serviceId": 0,
      "sponsorId": "string"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

2.51 Service Area Restriction

Table 2-223 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Service Area Restriction POST {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfam/servicearearestrictions See Table A-3
Export All Service Area Restrictions GET ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfam/servicearearestrictions/export See Table A-1
Import All Service Area Restrictions POST ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfam/servicearearestrictions/import See Table A-3
Get Service Area Restriction GET ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/pcfam/servicearearestrictions/{serviceAreaRestrictionName} See Table A-1
Update Service Area Restriction PUT {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfam/servicearearestrictions/{serviceAreaRestrictionName} See Table A-2
Delete Service Area Restriction DELETE ​{apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/pcfam/servicearearestrictions/{serviceAreaRestrictionName} See Table A-4

Get, Create, and Update Service Area Restriction s

Table 2-224 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
areas ServiceAreaRestrictionAreas O
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 Specifies description of the Service Area Restriction
maxNumOfTAs boolean O Specifies maximum number of TAs
name string M Specifies name of the Service Area Restriction
restrictionType ENUM O
Possible values are:
  • ALLOWED_AREAS
  • NOT_ALLOWED_AREAS

Table 2-225 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.

Sample Request body structure for POST/PUT operation:

{
  "areas": [
    {
      "areaCodes": "string",
      "tacs": [
        "string"
      ]
    }
  ],
  "description": "string",
  "maxNumOfTAs": 0,
  "name": "string",
  "restrictionType": "ALLOWED_AREAS"
}

Sample Response body structure for GET, POST, and PUT operations:

[
  {
    "date": "string",
    "errors": [
      {
        "message": "string",
        "name": "string"
      }
    ],
    "exportData": [
      {
        "areas": [
          {
            "areaCodes": "string",
            "tacs": [
              "string"
            ]
          }
        ],
        "description": "string",
        "maxNumOfTAs": 0,
        "name": "string",
        "restrictionType": "ALLOWED_AREAS"
      }
    ],
    "key": "string",
    "sourceVersion": "string",
    "topic": "string"
  }
]

Delete Service Area Restriction s

Table 2-226 Request/Response Body Parameters

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

Export/Import Service Area Restrictions

Table 2-227 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData array   Exported list of service area restrictions. For more information, see Get, Create, and Update Service Area Restriction s
key string   Indicates the ID
sourceVersion string   System version of product from which data is exported
systemVersion      
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

[
  {
    "date": "string",
    "errors": [
      {
        "message": "string",
        "name": "string"
      }
    ],
    "exportData": [
      {
        "areas": [
          {
            "areaCodes": "string",
            "tacs": [
              "string"
            ]
          }
        ],
        "description": "string",
        "maxNumOfTAs": 0,
        "name": "string",
        "restrictionType": "ALLOWED_AREAS"
      }
    ],
    "key": "string",
    "sourceVersion": "string",
    "topic": "string"
  }
]

2.52 PCF Presence Reporting Area

Table 2-228 Supported REST APIs

HTTP Method or Custom Operation Description Resource URI Possible Result Code
POST Create Presence Reporting Area {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/common/pras See Table A-3
GET Export Presence Reporting Area ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/common/pras/export See Table A-1
POST Import Presence Reporting Area ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/common/pras/import See Table A-3
GET Get Presence Reporting Area {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/common/pras/{presenceReportingAreaName} See Table A-1
PUT Update Presence Reporting Area {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/common/pras/{presenceReportingAreaName} See Table A-2
DELETE Delete Presence Reporting Area {apiRoot}​​/oc-cnpolicy-configuration​/v1/policydata​/common/pras/{presenceReportingAreaName} See Table A-4

Get, Create, AND Update Presence Reporting Areas

Table 2-229 Request/Response Body Parameters GET, PUT, and POST operations

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C)aints Description
ecgiList

PresenceReportingAreaEcgiList

O 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 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 The unique name assigned to the PRA.
praId String M The unique identifying number of the PRA list. The ID must be numeric value between 0 and 16777125.
ncgiList PresenceReportingAreaNcgiList O 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 O

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 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-230 PresenceReportingAreaEcgiList

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
ecgiList. 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".

ecgiList. plmnId PlmnId M PLMN Identity

Table 2-231 PresenceReportingAreaglobalRanNodeIdList

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
globalRanNodeIdList.gNbId GNbId This field is included if the RAN Node Id represents a gNB. When present, this field contains the identifier of the gNB.
globalRanNodeIdList.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.

globalRanNodeIdList.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.
globalRanNodeIdList.plmnId PlmnId M Indicates the identity of the PLMN that the RAN node belongs to.

Table 2-232 PlmnId

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

Table 2-233 PresenceReportingAreaNcgiList

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
ncgiList.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".

ncgiList.plmnId PlmnId M PLMN Identity

Table 2-234 PresenceReportingAreaTrackingAreaList

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
trackingAreaList. plmnId PlmnId PLMN Identity
trackingAreaList.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".

Sample Request body structure for POST and PUT operations:

{
  "ecgiList": [
    {
      "eutraCellId": "string",
      "plmnId": {
        "mcc": "string",
        "mnc": "string"
      }
    }
  ],
  "globalRanNodeIdList": [
    {
      "gNbId": {
        "bitLength": 0,
        "gNbValue": "string"
      },
      "n3IwfId": "string",
      "ngeNbId": "string",
      "plmnId": {
        "mcc": "string",
        "mnc": "string"
      }
    }
  ],
  "name": "string",
  "ncgiList": [
    {
      "nrCellId": "string",
      "plmnId": {
        "mcc": "string",
        "mnc": "string"
      }
    }
  ],
  "praId": "string",
  "presenceState": "INACTIVE",
  "trackingAreaList": [
    {
      "plmnId": {
        "mcc": "string",
        "mnc": "string"
      },
      "tac": "string"
    }
  ]
}

Sample Response body structure for GET, POST, and PUT operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "ecgiList": [
        {
          "eutraCellId": "string",
          "plmnId": {
            "mcc": "string",
            "mnc": "string"
          }
        }
      ],
      "globalRanNodeIdList": [
        {
          "gNbId": {
            "bitLength": 0,
            "gNbValue": "string"
          },
          "n3IwfId": "string",
          "ngeNbId": "string",
          "plmnId": {
            "mcc": "string",
            "mnc": "string"
          }
        }
      ],
      "name": "string",
      "ncgiList": [
        {
          "nrCellId": "string",
          "plmnId": {
            "mcc": "string",
            "mnc": "string"
          }
        }
      ],
      "praId": "string",
      "presenceState": "INACTIVE",
      "trackingAreaList": [
        {
          "plmnId": {
            "mcc": "string",
            "mnc": "string"
          },
          "tac": "string"
        }
      ]
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Delete Presence Reporting Areas

Table 2-235 Request/Response Body Parameters for DELETE operation

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

Export/Import Presence Reporting Areas

Table 2-236 Request/Response Body Parameters for Export/Import operations

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData array   Exported list of presence reporting area. For more information, see Get, Create, AND Update Presence Reporting Areas.
key string   Indicates the ID
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "ecgiList": [
        {
          "eutraCellId": "string",
          "plmnId": {
            "mcc": "string",
            "mnc": "string"
          }
        }
      ],
      "globalRanNodeIdList": [
        {
          "gNbId": {
            "bitLength": 0,
            "gNbValue": "string"
          },
          "n3IwfId": "string",
          "ngeNbId": "string",
          "plmnId": {
            "mcc": "string",
            "mnc": "string"
          }
        }
      ],
      "name": "string",
      "ncgiList": [
        {
          "nrCellId": "string",
          "plmnId": {
            "mcc": "string",
            "mnc": "string"
          }
        }
      ],
      "praId": "string",
      "presenceState": "INACTIVE",
      "trackingAreaList": [
        {
          "plmnId": {
            "mcc": "string",
            "mnc": "string"
          },
          "tac": "string"
        }
      ]
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

2.53 Policy Table

Table 2-237 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Get Policy Tables GET ​{apiRoot}/oc-cnpolicy-configuration/v1/policydata/common/policytables See Table A-1
Create Policy Tables POST ​{apiRoot}/oc-cnpolicy-configuration/v1/policydata/common/policytables See Table A-3
Export Policy Tables GET ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/common/policytables/export See Table A-1
Import Policy Tables POST ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/common/policytables/import See Table A-3
Delete Policy Table DELETE ​{apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/common/policytables/{serviceName}/{policyTableName} See Table A-4

Get and Create Policy Table s

Table 2-238 Request/Response Body Parameters

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

Sample Request body structure for POST operation:

[
  {
    "columns": [
      {
        "dataType": "accessType",
        "isKey": true,
        "name": "string"
      }
    ],
    "description": "string",
    "name": "string",
    "rows": [
      {}
    ],
    "serviceName": "string",
    "serviceType": "string"
  }
]

Sample Response body structure for GET and POST operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "columns": [
        {
          "dataType": "accessType",
          "isKey": true,
          "name": "string"
        }
      ],
      "description": "string",
      "name": "string",
      "rows": [
        {}
      ],
      "serviceName": "string"
    }
  ],
  "sourceVersion": "string",
  "topic": "string"
}

Delete Policy Table s

Table 2-239 Request/Response Body Parameters

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

Export and Import Policy Tables

The following table describes the request and response body parameters for Import and Export operations:

Table 2-240 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
errors:message string   Error message.
errors:name string   Error name.
exportData array   Exported list of policy tables. For more information, see Get and Create Policy Table s.
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Supported Actions for Importing Policy Tables

The following table describes the actions supported by Policy when the user imports Policy Tables:

Table 2-241 Supported Actions for Importing Policy Tables

Action Description
ignore On selecting the ignore option, no changes are made to the existing Policy Table. The Policy Table in the imported file is ignored or skipped. No changes are made to the UUIDs and existing policies remain unaffected with this option.
retain On selecting the retain option, no changes are made to the existing Policy Table. The Policy Table in the imported file is ignored or skipped. No changes are made to the UUIDs and existing policies remain unaffected with this option.
replace On selecting the replace option, the existing Policy Table is completely replaced with the Policy table in the imported file. Since UUIDs are re-generated for rows and columns, the user needs to update the existing policies that use the Policy Table being replaced with the new one.
merge On selecting the Merge option, rows of the existing Policy Table are merged with the rows of the Policy table in the imported file only if the schema for key and non-key columns is same for both the Policy Tables. All rows of the existing table with conflict are replaced with the new rows from the imported table.

Note: Two rows are considered to be in conflict when they have same values for the Key columns.

In case of a conflict, the rows of the existing Policy Table are replaced with the rows of the new Policy Table. In this case, the UUIDs remain unaffected and do not impact the existing policies.

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "columns": [
        {
          "dataType": "accessType",
          "isKey": true,
          "name": "string"
        }
      ],
      "description": "string",
      "name": "string",
      "rows": [
        {}
      ],
      "serviceName": "string"
    }
  ],
  "sourceVersion": "string",
  "topic": "string"
}

2.54 Policy Counter Id

Table 2-242 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Policy Control Id POST {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/common/policycounterids See Table A-3
Export Policy Control Id GET ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/common/policycounterids/export See Table A-1
Import Policy Control Id POST ​{apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/common/policycounterids/import See Table A-3
Get Policy Control Id GET {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/common/policycounterids/{policyCounterIdName} See Table A-1
Update Policy Control Id PUT {apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/common/policycounterids/{policyCounterIdName} See Table A-2
Delete Policy Control Id DELETE ​{apiRoot}​/oc-cnpolicy-configuration​/v1/policydata​/common/policycounterids/{policyCounterIdName} See Table A-4

Get, Create, and Update Policy Counter Id s

Table 2-243 Request/Response Body Parameters

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

Sample Request body structure for POST and PUT operations:

[
  {
    "columns": [
      {
        "dataType": "accessType",
        "isKey": true,
        "name": "string"
      }
    ],
    "description": "string",
    "name": "string",
    "rows": [
      {}
    ],
    "serviceName": "string",
    "serviceType": "string"
  }
]

Sample Response body structure for GET, POST, and PUT operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "columns": [
        {
          "dataType": "accessType",
          "isKey": true,
          "name": "string"
        }
      ],
      "description": "string",
      "name": "string",
      "rows": [
        {}
      ],
      "serviceName": "string"
    }
  ],
  "sourceVersion": "string",
  "topic": "string"
}

Delete Policy Counter Id s

Table 2-244 Request/Response Body Parameters

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

Export/Import Policy Counter Id s

Table 2-245 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData array   Exported list of policy control id. For more information, see Get, Create, and Update Policy Counter Id s .
key string   Indicates the ID
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "columns": [
        {
          "dataType": "accessType",
          "isKey": true,
          "name": "string"
        }
      ],
      "description": "string",
      "name": "string",
      "rows": [
        {}
      ],
      "serviceName": "string"
    }
  ],
  "sourceVersion": "string",
  "topic": "string"
}

2.55 Diameter Settings

This section describes the available service URIs to retrieve and update diameter settings.

Table 2-246 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Get Diameter Settings GET {apiRoot}/oc-cnpolicy-configuration/v1/diameter/settings See Table A-1
Update Diameter Settings PUT {apiRoot}/oc-cnpolicy-configuration/v1/diameter/settings See Table A-2
Export Diameter Settings GET {apiRoot}/oc-cnpolicy-configuration/v1/diameter/settings/export See Table A-1
Import Diameter Settings POST {apiRoot}/oc-cnpolicy-configuration/v1/diameter/settings/import See Table A-3

Get and Update Operations

This section describes the body parameters for APIs for diameter settings.

Table 2-247 Request and Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
congestionControl DiamSettingsCongestionControl O Specifies the congestion control configurations.
overloadControl DiamSettingsOverloadControl O Specifies the overload control configurations.
timer timer O Specifies the timer configurations for Diameter Gateway.
transport transport O Specifies the transport protocol configurations for Diameter Gateway.
topologyhiding topologyhiding O Specifies the topology hiding configurations for Diameter Gateway.
messageTimers messageTimers O Specifies the request timer configurations for Diameter applications.

Table 2-248 DiamSettingsCongestionControl

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
congestionLoadSheddingProfile string O Specifies the load shedding profile name for congestion control.
congestionMessagePriorityProfile string O Specifies the message priority profile name for congestion control.

Table 2-249 DiamSettingsOverloadControl

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
overloadLoadSheddingProfile string Optional Specifies the load shedding profile name for overload control.
overloadMessagePriorityProfile string Optional Specifies the message priority profile name for overload control.

Table 2-250 timer

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

Table 2-251 transport

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
protocol string O Specifies the Diameter protocol.

Table 2-252 messageTimers

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
appId array O Specifies the application IDs for which topology hiding feature is to be enabled.
appResponseTimeoutValue boolean O Specifies whether to enable or disable topology hiding for Diameter gateway.
cmdCodeResponseTimeoutValueMap Map(String:String) O Specifies Command Code Response Timeout for AAR, STR, RAR and ASR.

Sample Request body structure for PUT operations:

{
  "advancedSettings": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "congestionControl": {
    "congestionLoadSheddingProfile": "string",
    "congestionMessagePriorityProfile": "string"
  },
  "messageTimers": [
    {
      "appId": 0,
      "appResponseTimeoutValue": 0,
      "cmdCodeResponseTimeoutValueMap": {
        "258": 0,
        "265": 0,
        "274": 0,
        "275": 0
      }
    }
  ],
  "overloadControl": {
    "overloadLoadSheddingProfile": "string",
    "overloadMessagePriorityProfile": "string"
  },
  "timer": {
    "connectionTimeout": 3,
    "reconnectDelay": 3,
    "responseTimeout": 5,
    "watchdogInterval": 6
  },
  "topologyhiding": {
    "AppsToHide": [
      "All"
    ],
    "EnableTopologyHiding": true
  },
  "transport": {
    "protocol": "SCTP"
  }
}

Sample Response body structure for GET and PUT operations:

{
  "advancedSettings": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "congestionControl": {
    "congestionLoadSheddingProfile": "string",
    "congestionMessagePriorityProfile": "string"
  },
  "messageTimers": [
    {
      "appId": 0,
      "appResponseTimeoutValue": 0,
      "cmdCodeResponseTimeoutValueMap": {
        "258": 0,
        "265": 0,
        "274": 0,
        "275": 0
      }
    }
  ],
  "overloadControl": {
    "overloadLoadSheddingProfile": "string",
    "overloadMessagePriorityProfile": "string"
  },
  "timer": {
    "connectionTimeout": 3,
    "reconnectDelay": 3,
    "responseTimeout": 5,
    "watchdogInterval": 6
  },
  "topologyhiding": {
    "AppsToHide": [
      "All"
    ],
    "EnableTopologyHiding": true
  },
  "transport": {
    "protocol": "SCTP"
  }
}

Export and Import Diameter Settings

The following table describes the request and response parameters for export and import operations:

Table 2-253 Request and Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string Optional Specifies the current timestamp.
errors.message string Optional The reason of the failure.
error.name string Optional Name of the components that the user is unable to export or import successfully.
exportData array Mandatory Exported list of diameter settings. For more information, see Get and Update Operations.
sourceVersion string Optional System version of product from which data is exported.
topic string Mandatory Topic of each managed object.

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": {
    "advancedSettings": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "congestionControl": {
      "congestionLoadSheddingProfile": "string",
      "congestionMessagePriorityProfile": "string"
    },
    "messageTimers": [
      {
        "appId": 0,
        "appResponseTimeoutValue": 0,
        "cmdCodeResponseTimeoutValueMap": {
          "258": 0,
          "265": 0,
          "274": 0,
          "275": 0
        }
      }
    ],
    "overloadControl": {
      "overloadLoadSheddingProfile": "string",
      "overloadMessagePriorityProfile": "string"
    },
    "timer": {
      "connectionTimeout": 3,
      "reconnectDelay": 3,
      "responseTimeout": 5,
      "watchdogInterval": 6
    },
    "topologyhiding": {
      "AppsToHide": [
        "All"
      ],
      "EnableTopologyHiding": true
    },
    "transport": {
      "protocol": "SCTP"
    }
  },
  "sourceVersion": "string",
  "topic": "string"
}

2.56 Diameter Routing Table

Table 2-254 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Export Diameter Routing Table GET {apiRoot}​/oc-cnpolicy-configuration​/v1/diameter/routingTable/export See Table A-1
Import Diameter Routing Table POST {apiRoot}​/oc-cnpolicy-configuration​/v1/diameter/routingTable/import See Table A-3
Get Diameter Routing Table GET {apiRoot}/oc-cnpolicy-configuration​/v1/diameter/routingTable See Table A-1
Update Diameter Routing Table PUT {apiRoot}​/oc-cnpolicy-configuration​/v1/diameter/routingTable See Table A-2

Get and Update Operations

Table 2-255 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
defaultRoute      
routeTable  

Table 2-256 defaultRoute

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

Table 2-257 routeTable

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
appIDs
hosts string  
name string O  
priority string O  
realms string    
type Realm    

Sample Request body structure for PUT operations:

"defaultRoute": {
    "serverId": "string"
  },
  "routeTable": [
    {
      "appIds": [
        "All"
      ],
      "hosts": [
        "string"
      ],
      "name": "string",
      "priority": "string",
      "realms": [
        "string"
      ],
      "serverIds": [
        "string"
      ],
      "type": "Host"
    }
  ]
}

Sample Response body structure for GET and PUT operations:

{
  "defaultRoute": {
    "serverId": "string"
  },
  "routeTable": [
    {
      "appIds": [
        "All"
      ],
      "hosts": [
        "string"
      ],
      "name": "string",
      "priority": "string",
      "realms": [
        "string"
      ],
      "serverIds": [
        "string"
      ],
      "type": "Host"
    }
  ]
}

Export/Import Diameter Routing Table

Table 2-258 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData array   Exported list of diamteter routing table. For more information, see Get and Update Operations.
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "exportData": {
    "defaultRoute": {
      "serverId": "string"
    },
    "routeTable": [
      {
        "appIds": [
          "All"
        ],
        "hosts": [
          "string"
        ],
        "name": "string",
        "priority": "string",
        "realms": [
          "string"
        ],
        "serverIds": [
          "string"
        ],
        "type": "Host"
      }
    ]
  },
  "sourceVersion": "string",
  "topic": "string"
}

2.57 Data Sources

Table 2-259 Supported REST APIs

Create Data Sources HTTP Method or Custom Operation Resource URI Possible Result Code
Get All (Export) Data Sources POST {apiRoot}/oc-cnpolicy-configuration​/v1/datasources See Table A-3
Import Data Sources GET ​{apiRoot}/oc-cnpolicy-configuration​/v1/datasources/export See Table A-1
Get Data Sources POST ​{apiRoot}/oc-cnpolicy-configuration​/v1/datasources/import See Table A-3
Update Data Sources GET {apiRoot}/oc-cnpolicy-configuration​/v1/datasources/{datasourceName} See Table A-1
Delete Data Sources PUT {apiRoot}​/oc-cnpolicy-configuration​/v1/datasources/{datasourceName} See Table A-2
Description DELETE ​{apiRoot}​/oc-cnpolicy-configuration​/v1/datasources/{datasourceName} See Table A-4

Get, Create, and Update Data Sources

Table 2-260 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
admin_state boolean O when value is set to true, datasource (Sy) interaction takes place.

Default Value: true

description String O Details about the data source.
enable_subscription boolean O Indicates whether MPE needs to subscribe to notifications from SH.

Default Value: true

name String O Data Source Name
ocs_from_peer_nodes boolean O Selecting diameter peer nodes as primary, secondary, tertiary, and quaternary servers for Sy data source type.
primary_server array M Primary data source server. The LDAP connection will be established with primary data source.
quaternary_server array O 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 Number of read connections established with data source.
realm string O Defines the realm of the primary and optional secondary servers to connect (required).
refPeerNodePrimary string O Primary diameter peer node server.
refPeerNodeQuaternary string O Quaternary diameter peer node server.
refPeerNodeSecondary string O Secondary diameter peer node server.
refPeerNodeTertiary string O Tertiary diameter peer node server.
search_criteria array O The criteria on which the data source search will be performed.
search_filter array O  
secondary_server array O Secondary data source server. If Primary server is not reachable, then LDAP connection will be established with secondary (if available).
tertiary_server array O 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  
type string O Type of data source. Possible values are: Sy and LDAP
use_notif_eff boolean O 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.

Sample Request body structure for POST and PUT operations:

{
  "admin_state": true,
  "description": "string",
  "enable_subscription": true,
  "name": "string",
  "ocs_from_peer_nodes": true,
  "primary_server": {
    "addr": "string",
    "identity": "string",
    "port": "string"
  },
  "quaternary_server": {
    "addr": "string",
    "identity": "string",
    "port": "string"
  },
  "read_connection": "1",
  "realm": "string",
  "refPeerNodePrimary": "string",
  "refPeerNodeQuaternary": "string",
  "refPeerNodeSecondary": "string",
  "refPeerNodeTertiary": "string",
  "search_criteria": {
    "baseDN": "string",
    "key_replace_ptn": "string",
    "key_transform_ptn": "string",
    "rootDN": "string",
    "type": "IMSI"
  },
  "search_filter": {
    "apn_filters_expr": [
      "string"
    ],
    "id_filters_expr": [
      "string"
    ],
    "id_filters_type": "IMSI"
  },
  "secondary_server": {
    "addr": "string",
    "identity": "string",
    "port": "string"
  },
  "sh_profile": "v1",
  "tertiary_server": {
    "addr": "string",
    "identity": "string",
    "port": "string"
  },
  "timer_profile": "string",
  "type": "LDAP",
  "use_notif_eff": true
}

Sample Response body structure for GET, POST, and PUT operations:

{
  "admin_state": true,
  "description": "string",
  "enable_subscription": true,
  "name": "string",
  "ocs_from_peer_nodes": true,
  "primary_server": {
    "addr": "string",
    "identity": "string",
    "port": "string"
  },
  "quaternary_server": {
    "addr": "string",
    "identity": "string",
    "port": "string"
  },
  "read_connection": "1",
  "realm": "string",
  "refPeerNodePrimary": "string",
  "refPeerNodeQuaternary": "string",
  "refPeerNodeSecondary": "string",
  "refPeerNodeTertiary": "string",
  "search_criteria": {
    "baseDN": "string",
    "key_replace_ptn": "string",
    "key_transform_ptn": "string",
    "rootDN": "string",
    "type": "IMSI"
  },
  "search_filter": {
    "apn_filters_expr": [
      "string"
    ],
    "id_filters_expr": [
      "string"
    ],
    "id_filters_type": "IMSI"
  },
  "secondary_server": {
    "addr": "string",
    "identity": "string",
    "port": "string"
  },
  "sh_profile": "v1",
  "tertiary_server": {
    "addr": "string",
    "identity": "string",
    "port": "string"
  },
  "timer_profile": "string",
  "type": "LDAP",
  "use_notif_eff": true
}

Delete Data Sources

Table 2-261 Request/Response Body Parameters

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

Export/Import Data Sources

Table 2-262 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData array   Exported list of data sources. For more information, see Get, Create, and Update Data Sources.
key string   Indicates the ID
sourceVersion string   System version of the product from which data is exported
systemVersion string    
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

[
  {
    "date": "string",
    "errors": [
      {
        "message": "string",
        "name": "string"
      }
    ],
    "exportData": [
      {
        "admin_state": true,
        "description": "string",
        "enable_subscription": true,
        "name": "string",
        "ocs_from_peer_nodes": true,
        "primary_server": {
          "addr": "string",
          "identity": "string",
          "port": "string"
        },
        "quaternary_server": {
          "addr": "string",
          "identity": "string",
          "port": "string"
        },
        "read_connection": "1",
        "realm": "string",
        "refPeerNodePrimary": "string",
        "refPeerNodeQuaternary": "string",
        "refPeerNodeSecondary": "string",
        "refPeerNodeTertiary": "string",
        "search_criteria": {
          "baseDN": "string",
          "key_replace_ptn": "string",
          "key_transform_ptn": "string",
          "rootDN": "string",
          "type": "IMSI"
        },
        "search_filter": {
          "apn_filters_expr": [
            "string"
          ],
          "id_filters_expr": [
            "string"
          ],
          "id_filters_type": "IMSI"
        },
        "secondary_server": {
          "addr": "string",
          "identity": "string",
          "port": "string"
        },
        "sh_profile": "v1",
        "tertiary_server": {
          "addr": "string",
          "identity": "string",
          "port": "string"
        },
        "timer_profile": "string",
        "type": "LDAP",
        "use_notif_eff": true
      }
    ],
    "key": "string",
    "sourceVersion": "string",
    "topic": "string"
  }
]

2.58 Bulk Import Export Controller

Table 2-263 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Bulk Import POST {apiRoot}/oc-cnpolicy-configuration​/v1/administration/import

200: OK

201: Created

401: Unauthorized

403: Forbidden

404: Not Found
Import Status GET {apiRoot}/oc-cnpolicy-configuration​/v1/administration/import/{importResourceId}/status

200: OK

401: Unauthorized

403: Forbidden

404: Not Found
Import Report GET {apiRoot}/oc-cnpolicy-configuration​/v1/administration/import/{importResourceId}/report

200: OK

401: Unauthorized

403: Forbidden

404: Not Found
Import Resource Ids GET ​{apiRoot}/oc-cnpolicy-configuration​/v1/administration/import

200: OK

401: Unauthorized

403: Forbidden

404: Not Found
Bulk Export POST {apiRoot}​/oc-cnpolicy-configuration​/v1/administration/export

200: OK

201: Created

401: Unauthorized

403: Forbidden

404: Not Found
Export Status for Policy GET {apiRoot}/oc-cnpolicy-configuration​/v1/administration/export/{exportResourceId}/status

200: OK

401: Unauthorized

403: Forbidden

404: Not Found
Export Report for Policy GET {apiRoot}/oc-cnpolicy-configuration​/v1/administration/export/{exportResourceId}/report

200: OK

401: Unauthorized

403: Forbidden

404: Not Found
Download Exported File GET {apiRoot}​/oc-cnpolicy-configuration​/v1/administration/export/{exportResourceId}/download

200: OK

401: Unauthorized

403: Forbidden

404: Not Found
Export Resource Ids GET {apiRoot}​/oc-cnpolicy-configuration​/v1/administration/export

200: OK

401: Unauthorized

403: Forbidden

404: Not Found

Note:

The Bulk Import/Export APIs return a ResourceId in response to the POST request. The ResourceId is the background task id for the POST operations. This id can be used to track the import or export requests, and download the export data.

For example, the POST API for bulk export operation takes MO name as input. The response of this API contains the resource id of the file created for export. You can use this resource Id to download the export data at any point of time.

Below are the status displayed by Bulk import/export:
  • IN_PROGRESS: The import/export is running.
  • DONE: The import/export is finished. Following are the possible status if the import/export is in DONE status:
    • SUCCESS : The import/export is successful
    • FAILED : The import/export is failed
    • PARTIAL_SUCCESS : The import/export is partially successful

2.59 Consistent Logging Level

Table 2-264 Supported REST APIs - Consistent Logging Level

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Get All (Export) Consistent Logging Level GET /oc-cnpolicy-configuration/v1/conLoggingLevelConfig/export/{serviceType} See Table A-1
Import Consistent Logging Level POST /oc-cnpolicy-configuration/v1/conLoggingLevelConfig/import/{serviceType} See Table A-3
Get Consistent Logging Level GET ​/oc-cnpolicy-configuration/v1/conLoggingLevelConfig/{serviceType} See Table A-1
Update Consistent Logging Level PUT ​/oc-cnpolicy-configuration/v1/conLoggingLevelConfig/{serviceType} See Table A-2

Get and Update Consistent Logging Level

Table 2-265 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
appLogLevel String M Defines the application's root log level.
packageLogLevel: logLevelForPackage String O Defines the log level for the package.
packageLogLevel:packageName String O Defines the package name.
serviceType String M Defines the different policy service types.

Sample Request body for Consistent Logging Level PUT operation:

{
  "appLogLevel": "DEBUG",
  "packageLogLevel": [
    {
      "logLevelForPackage": "DEBUG",
      "packageName": "string"
    }
  ]
}

Sample Response body structure for Consistent Logging Level GET and PUT operation:

{
  "appLogLevel": "DEBUG",
  "packageLogLevel": [
    {
      "logLevelForPackage": "DEBUG",
      "packageName": "string"
    }
  ]
}

Import and Export Consistent Logging Level

Table 2-266 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData array   Exported list of Consistent Logging Level. For more information, see Get and Update Consistent Logging Level.
key string   Indicates the ID
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Consistent Logging Level Import and Export operations:

{
  "date": "string",
  "exportData": {
    "appLogLevel": "DEBUG",
    "packageLogLevel": [
      {
        "logLevelForPackage": "DEBUG",
        "packageName": "string"
      }
    ]
  },
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

2.60 Load Shedding Profile

This section describes the available service URIs to create and configure load shedding profiles for CNC Policy.

Table 2-267 Supported REST APIs - Load Shedding Profile

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Load Shedding Profile POST {apiRoot}/oc-cnpolicy-configuration/v1/diameter/loadsheddingprofiles See Table A-3
Get Load Shedding Profile GET {apiRoot}/oc-cnpolicy-configuration/v1/diameter/loadsheddingprofiles/{loadsheddingName} See Table A-1
Update Load Shedding Profile PUT {apiRoot}/oc-cnpolicy-configuration/v1/diameter/loadsheddingprofiles/{loadsheddingName} See Table A-2
Export Load Shedding Profiles GET {apiRoot}/oc-cnpolicy-configuration/v1/diameter/loadsheddingprofiles/export See Table A-1
Import Load Shedding Profiles POST {apiRoot}/oc-cnpolicy-configuration/v1/diameter/loadsheddingprofiles/import See Table A-3
Delete Load Shedding Profile DELETE {apiRoot}/oc-cnpolicy-configuration/v1/diameter/loadsheddingprofiles/{loadsheddingName} See Table A-4

Get, Create, and Update Load Shedding Profile

The following table describes the request and response body parameters used in APIs for load shedding profiles.

Table 2-268 Request and Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
loadSheddingRules CongestionLoadSheddingRules Optional Specifies the list of configured Congestion Load Shedding Rules.
name string Mandatory Specifies the unqiue name of the load shedding profile.
overloadLoadSheddingRules OverloadLoadSheddingRules Optional Specifies the list of configured Overload Load Shedding Rules.
type Enum
The supported values are:
  • Overload Control
  • congestion
 Optional Specifies the type of load shedding profile. The load shedding profile can be one of the following types:
  • Congestion Control
  • Overload Control

Table 2-269 CongestionLoadSheddingRules

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
ansWithResultCode Enum
The supported values are:
  • DIAMETER_TOO_BUSY
  • DIAMETER_UNABLE_TO_COMPLY
  • DIAMETER_UNABLE_TO_DELIVER
  • EXPERIMENTAL_RESULT_CODE
 Optional Specifies the result code, returned in the answer response, when request message is rejected as part of congestion control.
discardPriority integer Mandatory Specifies the discard priority for the congestion load shedding rule. The discard priority value can be a number from 0 to 15. Any request message with equal or lower priority is rejected.
resultCode integer Conditional

Note: Specify a value for this parameter when you choose EXPERIMENTAL_RESULT_CODE value for the ansWithResultCode parameter.

Specifies the custom result code, which is returned in the answer response when service request is rejected due to congestion control.

.
state Enum
The supported values are:
  • CONGESTED
  • DANGER_OF_CONGESTION
 Optional Specifies the type of state for which you are defining the rule.
vendorId integer Conditional

Note: Specify a value for this parameter when you choose EXPERIMENTAL_RESULT_CODE value for the ansWithResultCode parameter.

Specifies the vendor ID, which is returned in the answer response when service request is rejected due to congestion control.

.

Table 2-270 OverloadLoadSheddingRules

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
ansWithResultCode Enum
The supported values are:
  • DIAMETER_TOO_BUSY
  • DIAMETER_UNABLE_TO_COMPLY
  • DIAMETER_UNABLE_TO_DELIVER
  • EXPERIMENTAL_RESULT_CODE
 Optional Specifies the result code, returned in the answer response, when request message is rejected as part of overload control.
discardPriority integer Mandatory Specifies the discard priority for the overload shedding rule. The discard priority value can be a number from 0 to 15. Any request message with equal or lower priority is rejected.
level Enum
The supported values are:
  • L1
  • L2
  • L3
  • L4
 Mandatory Specifies the name of the level. The name specified in this parameter must match the level name in Ingress Gateway's ocdiscardpolicies.
resultCode integer Conditional

Note: Specify a value for this parameter when you choose EXPERIMENTAL_RESULT_CODE value for the ansWithResultCode parameter.

Specifies the custom result code, which is returned in the answer response when service request is rejected due to overload control.

.
vendorId integer Conditional

Note: Specify a value for this parameter when you choose EXPERIMENTAL_RESULT_CODE value for the ansWithResultCode parameter.

Specifies the vendor ID, which is returned in the answer response when service request is rejected due to overload control.

.

Sample Request body for Load Shedding Profile (PUT and POST operations):

{
  "loadSheddingRules": [
    {
      "ansWithResultCode": "DIAMETER_TOO_BUSY",
      "discardPriority": 0,
      "resultCode": 0,
      "state": "CONGESTED",
      "vendorId": 0
    }
  ],
  "name": "string",
  "overloadLoadSheddingRules": [
    {
      "ansWithResultCode": "DIAMETER_TOO_BUSY",
      "discardPriority": 0,
      "level": "L1",
      "resultCode": 0,
      "vendorId": 0
    }
  ],
  "type": "DIAMETER_TOO_BUSY"
}

Sample Response body for Load Shedding Profile (PUT, GET, and POST operation):

{
  "loadSheddingRules": [
    {
      "ansWithResultCode": "DIAMETER_TOO_BUSY",
      "discardPriority": 0,
      "resultCode": 0,
      "state": "CONGESTED",
      "vendorId": 0
    }
  ],
  "name": "string",
  "overloadLoadSheddingRules": [
    {
      "ansWithResultCode": "DIAMETER_TOO_BUSY",
      "discardPriority": 0,
      "level": "L1",
      "resultCode": 0,
      "vendorId": 0
    }
  ],
  "type": "DIAMETER_TOO_BUSY"
}

Import and Export Load Shedding Profile

Table 2-271 Request and Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string Optional Specifies the current timestamp.
errors.message string Optional The reason of the failure.
error.name string Optional Name of the components that the user is unable to export or import successfully.
exportData array Mandatory Exported list of Load Shedding Profiles. For more information, see Get, Create, and Update Load Shedding Profile.
key string Optional Indicates the ID of the load shedding profile.
sourceVersion string Optional System version of product from which data is exported.
topic string Mandatory Topic of each managed object.

Sample Request Body structure for Load Shedding Profile Import and Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "loadSheddingRules": [
        {
          "ansWithResultCode": "DIAMETER_TOO_BUSY",
          "discardPriority": 0,
          "resultCode": 0,
          "state": "CONGESTED",
          "vendorId": 0
        }
      ],
      "name": "string",
      "overloadLoadSheddingRules": [
        {
          "ansWithResultCode": "DIAMETER_TOO_BUSY",
          "discardPriority": 0,
          "level": "L1",
          "resultCode": 0,
          "vendorId": 0
        }
      ],
      "type": "DIAMETER_TOO_BUSY"
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

2.61 Message Priority Profile

Table 2-272 Supported REST APIs - Message Priority Profile

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Message Priority Profile POST {apiRoot}/oc-cnpolicy-configuration/v1/diameter/messagepriorityprofiles See Table A-3
Get Message Priority Profile GET {apiRoot}/oc-cnpolicy-configuration/v1/diameter/messagepriorityprofiles/{messagepriorityName} See Table A-1
Update Message Priority Profile PUT {apiRoot}/oc-cnpolicy-configuration/v1/diameter/messagepriorityprofiles/{messagepriorityName} See Table A-2
Export Message Priority Profiles GET {apiRoot}/oc-cnpolicy-configuration/v1/diameter/messagepriorityprofiles/export See Table A-1
Import Message Priority Profiles POST {apiRoot}/oc-cnpolicy-configuration/v1/diameter/messagepriorityprofiles/import See Table A-3
Delete Message Priority Profile DELETE {apiRoot}/oc-cnpolicy-configuration/v1/diameter/messagepriorityprofiles/{messagepriorityName} See Table A-4

Get, Create, and Update Message Priority Profile

Table 2-273 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
name string Mandatory Unique name of the message priority profile.
priorityRules [] array Optional Specifies configured message priority rules.
priorityRules [].conditions conditions Optional Specifies the conditions for message priority rule.
priorityRules [].conditions.application string Mandatory Specifies the type of application.
priorityRules [].conditions.message string Mandatory Specifies the type of message for the selected application.
priorityRules [].conditions.preDefinedAVPConditions array Optional Specifies the pre-defined AVP conditons.
enableDRMPPriority boolean Optional When this switch is enabled, the priority for the message rule is assigned from DRMP AVP.
messagePriority integer Mandatory Specifies the priority assigned to the message. It can be a number from 0 to 15.
ruleName string Mandatory Specifies the unique name of the message priority rule.
rulePriority integer Mandatory Specifies the priority assigned to the message priority rule.

Sample Request body for Message Priority Profile PUT operation:

{
  "name": "string",
  "priorityRules": [
    {
      "conditions": {
        "application": "Gx",
        "message": "CCR",
        "preDefinedAVPConditions": [
          {
            "conditionCCRTValue": "UPDATE_REQUEST",
            "conditionCSIDValue": [
              "string"
            ],
            "conditionMCPTTIdValue": [
              "string"
            ],
            "conditionMCVideoIdValue": [
              "string"
            ],
            "conditionMPSIdValue": [
              "string"
            ],
            "conditionName": "CC-Request-Type",
            "conditionReservPriorityValue": [
              "string"
            ],
            "conditionRxRTValue": [
              "INITIAL_REQUEST"
            ],
            "conditionSNRTypeValue": [
              "ABORT_SESSION_REQUEST"
            ],
            "conditionServiceURNIDValue": [
              "string"
            ]
          }
        ]
      },
      "enableDRMPPriority": true,
      "messagePriority": 8,
      "ruleName": "string",
      "rulePriority": 3
    }
  ]
}

Sample Response body structure for Message Priority Profile GET and PUT operation:

{
  "name": "string",
  "priorityRules": [
    {
      "conditions": {
        "application": "Gx",
        "message": "CCR",
        "preDefinedAVPConditions": [
          {
            "conditionCCRTValue": "UPDATE_REQUEST",
            "conditionCSIDValue": [
              "string"
            ],
            "conditionMCPTTIdValue": [
              "string"
            ],
            "conditionMCVideoIdValue": [
              "string"
            ],
            "conditionMPSIdValue": [
              "string"
            ],
            "conditionName": "CC-Request-Type",
            "conditionReservPriorityValue": [
              "string"
            ],
            "conditionRxRTValue": [
              "INITIAL_REQUEST"
            ],
            "conditionSNRTypeValue": [
              "ABORT_SESSION_REQUEST"
            ],
            "conditionServiceURNIDValue": [
              "string"
            ]
          }
        ]
      },
      "enableDRMPPriority": true,
      "messagePriority": 8,
      "ruleName": "string",
      "rulePriority": 3
    }
  ]
}

Import and Export Message Priority Profile

Table 2-274 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
errors.message string   The reason of the failure.
errors.name string   Name of the components that failed to export or import.
exportData array   Exported list of Message Priority Profile. For more information, see Get, Create, and Update Message Priority Profile.
key string   Indicates the ID
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Message Priority Profile Import and Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "name": "string",
      "priorityRules": [
        {
          "conditions": {
            "application": "Gx",
            "message": "CCR",
            "preDefinedAVPConditions": [
              {
                "conditionCCRTValue": "UPDATE_REQUEST",
                "conditionCSIDValue": [
                  "string"
                ],
                "conditionMCPTTIdValue": [
                  "string"
                ],
                "conditionMCVideoIdValue": [
                  "string"
                ],
                "conditionMPSIdValue": [
                  "string"
                ],
                "conditionName": "CC-Request-Type",
                "conditionReservPriorityValue": [
                  "string"
                ],
                "conditionRxRTValue": [
                  "INITIAL_REQUEST"
                ],
                "conditionSNRTypeValue": [
                  "ABORT_SESSION_REQUEST"
                ],
                "conditionServiceURNIDValue": [
                  "string"
                ]
              }
            ]
          },
          "enableDRMPPriority": true,
          "messagePriority": 8,
          "ruleName": "string",
          "rulePriority": 3
        }
      ]
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

2.62 Congestion Threshold

Table 2-275 Supported REST APIs - Congestion Threshold

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Get Congestion Threshold GET {apiRoot}/oc-cnpolicy-configuration/v1/threshold/{serviceType} See Table A-1
Update Congestion Threshold PUT {apiRoot}/oc-cnpolicy-configuration/v1/threshold/{serviceType} See Table A-2
Export Congestion Thresholds GET {apiRoot}/oc-cnpolicy-configuration/v1/threshold/export/{serviceType} See Table A-1
Import Congestion Thresholds POST {apiRoot}/oc-cnpolicy-configuration/v1/threshold/import/{serviceType} See Table A-3

Get and Update Congestion Threshold

Table 2-276 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
stateCalculationInterval integer Mandatory

Specifies the interval at which congestion state is calculated.
stateChangeSampleCount integer Mandatory Specifies the continuous sample counts for which calculated state remains the same.
thresholds[] array   An array to define threshold values for each resource for a given state,
thresholds[].state string   Specifies the congestion state.
thresholds[].resourceUsageLimit     Specifies the resource usage limit for a defined state.
thresholds[].resourceUsageLimit.cpu integer   Specifies the threshold value for CPU message.
thresholds[].resourceUsageLimit.memory integer   Specifies the threshold value for memory message.
thresholds[].resourceUsageLimit.queue integer   Specifies the threshold value for number of messages in the queue.

Sample Request body for Congestion Threshold PUT operation:


      {
  "stateCalculationInterval": 100,
  "stateChangeSampleCount": 10,
  "thresholds": [
    {
      "state": "CONGESTED",
      "resourceUsageLimit": {
        "cpu": 80,
        "memory": 80,
        "queue": 50
      }
    },
    {
      "state": "DANGER_OF_CONGESTION",
      "resourceUsageLimit": {
        "cpu": 60,
        "memory": 60,
        "queue": 30
      }
    }
  ]
}

Sample Response body structure for Congestion Threshold GET and PUT operation:

{
  "stateCalculationInterval": 100,
  "stateChangeSampleCount": 10,
  "thresholds": [
    {
      "state": "CONGESTED",
      "resourceUsageLimit": {
        "cpu": 80,
        "memory": 80,
        "queue": 50
      }
    },
    {
      "state": "DANGER_OF_CONGESTION",
      "resourceUsageLimit": {
        "cpu": 60,
        "memory": 60,
        "queue": 30
      }
    }
  ]
}

Import and Export Congestion Threshold

Table 2-277 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
errors.message     The reason of the failure.
errors.name     Name of the components that failed to export or import.
exportData array   Exported list of Congestion Threshold. For more information, see Get and Update Congestion Threshold.
key string   Indicates the ID
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Congestion Threshold Import and Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": {
    "stateCalculationInterval": 100,
    "stateChangeSampleCount": 10,
    "thresholds": [
      {
        "state": "CONGESTED",
        "resourceUsageLimit": {
          "cpu": 80,
          "memory": 80,
          "queue": 50
        }
      },
      {
        "state": "DANGER_OF_CONGESTION",
        "resourceUsageLimit": {
          "cpu": 60,
          "memory": 60,
          "queue": 30
        }
      }
    ]
  },
  "sourceVersion": "string",
  "topic": "string"
}

2.63 Peer Node Sets

(Required) <Enter introductory text here, including the definition and purpose of the concept.>

Table 2-278 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Peer Node Set POST {apiRoot}​​/oc-cnpolicy-configuration/v1/diameter/peernodesets See Table A-3
Get Peer Node Set GET ​{apiRoot}​/oc-cnpolicy-configuration/v1/diameter/peernodesets/{peerNodeSetName} See Table A-1
Update Peer Node Set PUT {apiRoot}​/oc-cnpolicy-configuration/v1/diameter/peernodesets/{peernodesetName} See Table A-2
Delete Peer Node Set DELETE ​{apiRoot}​​/oc-cnpolicy-configuration/v1/diameter/peernodesets/{peerNodeSetName} See Table A-4

Get, Create, and Update Peer Nodes

Table 2-279 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
description String O Description of the Peer Node Set
name String O Unique Name of the Peer Node Set.
realm String O The realm name, that is, FQDNs to all of that computers that transact diameter traffic.
Primary Server String O The primary server for a TDF client.
Secondary Server String O The Secondary server for a TDF client.
Tertiary Server String O The Tertiary server for a TDF client.
Quaternary Server String O The Quaternary server for a TDF client.

Sample Request body structure for POST and PUT operations:

{
  "description": "string",
  "name": "string",
  "realm": "string",
  "refPeerNodePrimary": "string",
  "refPeerNodeQuaternary": "string",
  "refPeerNodeSecondary": "string",
  "refPeerNodeTertiary": "string",
  "type": "tdf"
}

Sample Response body structure for GET, POST, and PUT operations:

{
  "description": "string",
  "name": "string",
  "realm": "string",
  "refPeerNodePrimary": "string",
  "refPeerNodeQuaternary": "string",
  "refPeerNodeSecondary": "string",
  "refPeerNodeTertiary": "string",
  "type": "tdf"
}

2.64 Peer Nodes

Table 2-280 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Peer Node POST {apiRoot}​​/oc-cnpolicy-configuration​/v1/diameter/peernodes See Table A-3
Get All (Export) Peer Nodes GET ​{apiRoot}​/oc-cnpolicy-configuration​/v1/diameter/peernodes/export See Table A-1
Import Peer Nodes POST ​{apiRoot}​/oc-cnpolicy-configuration​/v1/diameter/peernodes/import See Table A-3
Get Peer Node GET ​{apiRoot}​/oc-cnpolicy-configuration​/v1/diameter/peernodes/{peernodeName} See Table A-1
Update Peer Node PUT {apiRoot}​​​/oc-cnpolicy-configuration​/v1/diameter/peernodes/{peernodeName} See Table A-2
Delete Peer Node DELETE ​{apiRoot}​​/oc-cnpolicy-configuration​/v1/diameter/peernodes/{peernodeName} See Table A-4

Get, Create, and Update Peer Nodes

Table 2-281 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
diamName String O Unique Name of the Peer Node
dtype String O 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 The host name. Enter a FQDN, ipv4 or ipv6 address available for establishing diameter transport connections to the peer node.
identity String O An identity to define a node in a realm.
initiateConnection boolean O Set it to True to initiate a connection for this peer node.

Default Value: FALSE

port Number O The port number. Enter a number from 0 to 65535.
realm String O The realm name, that is, FQDNs to all of that computers that transact diameter traffic.
reconnectLimit Number    

Sample Request body structure for POST and PUT operations:

{
  "diamName": "string",
  "dtype": "af",
  "host": "string",
  "identity": "string",
  "initiateConnection": true,
  "port": "3868",
  "realm": "string",
  "reconnectLimit": "3"
}

Sample Response body structure for GET, POST, and PUT operations:

{
  "diamName": "string",
  "dtype": "af",
  "host": "string",
  "identity": "string",
  "initiateConnection": true,
  "port": "3868",
  "realm": "string",
  "reconnectLimit": "3"
}

Delete Peer Nodes

DELETE - delete peer node

Table 2-282 Request/Response Body Parameters

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

Export/Import Peer Nodes

Table 2-283 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData array   Exported list of peer nodes. For more information, see Get, Create, and Update Peer Nodes.
key string   Indicates the ID
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

[
  {
    "date": "string",
    "errors": [
      {
        "message": "string",
        "name": "string"
      }
    ],
    "exportData": [
      {
        "diamName": "string",
        "dtype": "af",
        "host": "string",
        "identity": "string",
        "initiateConnection": true,
        "port": "3868",
        "realm": "string",
        "reconnectLimit": "3"
      }
    ],
    "key": "string",
    "sourceVersion": "string",
    "topic": "string"
  }
]

2.65 Access and Mobility Service

Table 2-284 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Get Access and Mobility Service GET ​ {apiRoot}/oc-cnpolicy-configuration/v1/services/pcfam See Table A-1
Update Access and Mobility Service PUT {apiRoot}/oc-cnpolicy-configuration/v1/services/pcfam See Table A-2
Export Access and Mobility Management Service GET {apiRoot}/oc-cnpolicy-configuration/v1/services/pcfam/export See Table A-1
Import Access and Mobility Service POST {apiRoot}/oc-cnpolicy-configuration/v1/services/pcfam/import See Table A-3

Get and Update Access and Mobility Service

Table 2-285 Request/Response Body Parameters

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

Table 2-286 AppConfiguration

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

Table 2-287 AMServiceSystemConfiguration

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
amfNotificationRetryProfile string O Specifies the retry profile configuration for Access and Mobility service.
amNfCommProfile string O Specifies the NF communication profile used by AMF.
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 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
enableLimitingSessionByPerUser boolean O Specifies whether to enable the Limiting the Number of Sessions functionality.

Default value: false

maxSessionLimitUser integer C Enables to configure the maximum number of sessions to be limited by the user if Enable Max Session Limit flag is enabled.

The value of this parameter ranges between 1 and 2.

Default value: 1

Table 2-288 AMServiceSystemConfigurationLogList

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
level ENUM O
name string M

Table 2-289 UserConfiguration

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
validateUser   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
queryUserOnCreate boolean O

Determines if user query from UDR is enabled. When this option is enabled, PDS queries the UDR about the subscriber contained in the UE Association create request by sending a GET request for “ue-policy-set” resource on the nudr-dr service.

Default Value: true
subscribeToNotify boolean O

When Subscribe to Notify is enabled, Policy subscribes with the UDR to get notified on changes in subscriber profile.

Default Value: true
queryUserOnUpdate boolean O

Determines if user query from UDR on update is enabled. When this option is enabled, PDS queries the UDR about the subscriber present in the UE Association update request by sending a GET request for “ue-policy-set” resource on the nudr-dr service.

Default Value: false
queryUserOnTerminate boolean O

Determines if user query from UDR on delete is enabled. When this option is enabled, PCF queries the UDR about the subscriber present in the UE Association delete request by sending a GET request for “ue-policy-set” resource on the nudr-dr service.

Default Value: false

Sample Request body structure for POST and PUT operations:

{
    "system": {
        "enableLimitingSessionByPerUser": true,
        "maxSessionLimitUser": 1
    },
    "user": {
        "validateUser": false,
        "queryUserOnCreate": true,
        "subscribeToNotify": true,
        "queryUserOnUpdate": false,
        "queryUserOnTerminate": false
    },
    "policy": {
        "evaluate": true
    },
    "rules": {
        "defaultServAreaResCfgId": "",
        "defaultTriggers": []
    },
    "audit": {
        "enable": true,
        "queryAMF": false,
        "notificationRate": 50,
        "ttl": 1440,
        "maxTtl": 2880,
        "frequency": 10
    }
}

Sample Response body structure for GET, POST, and PUT operations:

{
  "audit": {
    "enable": true,
    "frequency": 330,
    "maxTtl": 2880,
    "notificationRate": 50,
    "queryAMF": true,
    "ttl": 1440
  },
  "policy": {
    "evaluate": true
  },
  "rules": {
    "defaultRfsp": 3,
    "defaultServAreaResCfgId": "string",
    "defaultTriggers": [
      "LOC_CH"
    ]
  },
  "system": {
    "amNfCommProfile": "string",
    "amfNotificationRetryProfile": "string"
  },
  "user": {
    "queryUserOnCreate": true,
    "queryUserOnTerminate": true,
    "queryUserOnUpdate": true,
    "subscribeToNotify": true,
    "validateUser": true
  }
}

Export/Import Access and Mobility Service

Table 2-290 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
errors:message string    
errors:name string    
exportData array   Exported list of access and mobility management service. For more information, see Get and Update Access and Mobility Service.
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": {
    "audit": {
      "enable": true,
      "frequency": 330,
      "maxTtl": 2880,
      "notificationRate": 50,
      "queryAMF": true,
      "ttl": 1440
    },
    "policy": {
      "evaluate": true
    },
    "rules": {
      "defaultRfsp": 3,
      "defaultServAreaResCfgId": "string",
      "defaultTriggers": [
        "LOC_CH"
      ]
    },
    "system": {
      "amNfCommProfile": "string",
      "amfNotificationRetryProfile": "string"
    },
    "user": {
      "queryUserOnCreate": true,
      "queryUserOnTerminate": true,
      "queryUserOnUpdate": true,
      "subscribeToNotify": true,
      "validateUser": true
    }
  },
  "sourceVersion": "string",
  "topic": "string"
}

2.66 Policy Authorization Service

Table 2-291 Supported REST APIs

Description HTTP Method or Custom Operation ​ {apiRoot}/oc-cnpolicy-configuration/v1/services/pcfpa Possible Result Code
Get Policy Authorization Service GET {apiRoot}/oc-cnpolicy-configuration/v1/services/pcfpa See Table A-1
Update Policy Authorization Service PUT {apiRoot}/oc-cnpolicy-configuration/v1/services/pcfpa See Table A-2
Export All Policy Authorization Service GET {apiRoot}/oc-cnpolicy-configuration/v1/services/pcfpa/export See Table A-1
Import Policy Authorization Service POST {apiRoot}/oc-cnpolicy-configuration/v1/services/pcfpa/import See Table A-3

Get and Update Policy Authorization Service

Table 2-292 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C)aints Description
imsEmergencySession IMSEmergencySessionPAServiceConfiguration O
system System Configuration O

Table 2-293 IMSEmergencySessionPAServiceConfiguration

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

Any number of values are permitted for Emergency Service URNs

O Specifies the Uniform Resource Name (URN) values for emergency and other well-known services.
reservationPriorityTypes ENUM O Specifies the IMS Signalling Priority.

Table 2-294 System Configuration

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
afDirectReply boolean O Specifies, if reply must be sent to AF before the PCF that sends the policy decision to SMF, after successful session binding.
afNotificationsRetryProfile string   Specifies the retry profile configuration for Policy Authorization.
afSubsNotifySegment string example: termination O Specifies AF subscription notify uri segment appended to AF subs notify uri. For example, {NotificationUri}/notify. "notify" is the subscription notify uri segment.
afTerminateUriSegment string example: termination O Specifies AF notify to terminate uri segment appended to AF notify uri. For example, {NotificationUri}/termination. "termination" is the terminate uri segment.
overrideSupportedFeatures string O Defines the supported features that can be configured to override system embedded values. Represent a string separated by comma. For example, "InfluenceOnTrafficRouting,SponsoredConnectivity".

The "" means an empty supported feature set.
paNfCommProfile string O Specifies the NF communication profile used by AF.
dataCompressionScheme string O  
authorizationLifetime Long O

If included implies authorization lifetime feature is to be negotiated, includes a value higher than 0 specifying Authorization Lifetime AVP.

Default Value: null

reportPartialFailedEvent      

Sample Request body structure for PUT operations:

{
  "imsEmergencySession": {
    "emergencyServiceURNs": [
      "string"
    ],
    "reservationPriorityTypes": [
      "PRIO_1"
    ]
  },
  "system": {
    "afDirectReply": true,
    "overrideSupportedFeatures": "string",
    "afTerminateUriSegment": "terminate",
    "afSubsNotifySegment": "notify",
    "afNotificationsRetryProfile": "string",
    "paNfCommProfile": "string",
    "dataCompressionScheme": "string",
    "authLifetime": true,
    "reportPartialFailedEvent": "INDICATION_OF_LOSS_OF_BEARER"
  }
}

Sample Response body structure for GET, POST, and PUT operations:

{
  "imsEmergencySession": {
    "emergencyServiceURNs": [
      "string"
    ],
    "reservationPriorityTypes": [
      "PRIO_1"
    ]
  },
  "system": {
    "afDirectReply": true,
    "overrideSupportedFeatures": "string",
    "afTerminateUriSegment": "terminate",
    "afSubsNotifySegment": "notify",
    "afNotificationsRetryProfile": "string",
    "paNfCommProfile": "string",
    "dataCompressionScheme": "string",
    "authLifetime": true,
    "reportPartialFailedEvent": "INDICATION_OF_LOSS_OF_BEARER"
  }
}

Export/Import Policy Authorization Service

Table 2-295 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData array   Exported list of policy authorization service. For more information, see Get and Update Policy Authorization Service.
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": {
    "imsEmergencySession": {
      "emergencyServiceURNs": [
        "string"
      ],
      "reservationPriorityTypes": [
        "PRIO_1"
      ]
    },
    "system": {
      "afDirectReply": true,
      "afNotificationsRetryProfile": "string",
      "afSubsNotifySegment": "notify",
      "afTerminateUriSegment": "terminate",
      "overrideSupportedFeatures": "string",
      "paNfCommProfile": "string",
      "reportPartialFailedEvent": "INDICATION_OF_FAILED_RESOURCES_ALLOCATION"
    }
  },
  "sourceVersion": "string",
  "topic": "string"
}

Audit Authorization Service

Table 2-296 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
enable boolean O

Specifies whether to enable or disable the stale Rx session audit and deletion.

When this parameters is enabled, SM Service registers with Audit service for monitoring Rx sessions.

Default Value: false

ttl integer O

Specifies the Time To Live (TTL) of Rx sessions.

Range: 0-21600

Default Value: 1440

maxTtl integer O

Specifies the maximum Time To Live (TTL) of Rx sessions.

Default Value: 4320

Range: 0-21600

notificationRate integer O

Maximum amount of app session cleanup requests per second.

Default Value: 50

frequency integer O

Specifies how long the Audit Service waits for next audit cycle.

Default Value: 10

nullAsStale boolean O

If EXPIRY_TIMESTAMP or SITEID contains NULL value, (legacy stale records after upgrade) they will be considered in the next audit cycle as TTL expired.

Default Value: false

Sample Request Body structure for GET/PUT operations:

{
  "system": {
    "afDirectReply": true,
    "overrideSupportedFeatures": "string",
    "afTerminateUriSegment": "terminate",
    "afSubsNotifySegment": "notify",
    "afNotificationsRetryProfile": "string",
    "paNfCommProfile": "string",
    "dataCompressionScheme": "string",
    "authLifetime": true,
    "reportPartialFailedEvent": "INDICATION_OF_LOSS_OF_BEARER"
  },
  "imsEmergencySession": {
    "Any number of values are permitted for Emergency Service URNs": [
      "string"
    ],
    "reservationPriorityTypes": [
      "PRIO_1"
    ]
  },
  "nwdaf": {
    "enableNwdafData": true
  },
  "audit": {
    "enable": true,
    "ttl": 1440,
    "maxTtl": 4320,
    "notificationRate": 50,
    "frequency": 10,
    "nullAsStale": true
  },
  "advancedSettings": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}
}

2.67 UE Policy

Table 2-297 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Get UE Policy Service GET ​{apiRoot}/oc-cnpolicy-configuration/v1/services/pcfue See Table A-1
Update UE Policy Service PUT {apiRoot}/oc-cnpolicy-configuration/v1/services/pcfue See Table A-2
Export All UE Policy Service GET {apiRoot}/oc-cnpolicy-configuration/v1/services/pcfue/export See Table A-1
Import UE Policy Service POST {apiRoot}/oc-cnpolicy-configuration/v1/services/pcfue/import See Table A-3

Get and Update UE Policy

Table 2-298 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C)aints Description
amf AMFConfiguration O
system UEPolicyServiceSystemConfiguration O
user UserUEPolicyServiceConfiguration O
homePLMN HomePLMNConfiguration O  
n1MsgTransferSettings N1MessageTransferSettingsConfiguration O  
timerSettings TimerSettingsConfiguration O  
n1MsgRetransmissionSettings N1MessageRetransmissionSettingsConfiguration O  
audit AuditConfiguration O  

Table 2-299 AMFConfiguration

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

integer ($int32)

O Enter a range in [0-65535] number
amf.ueAMFCommProfile string O Specifies the NF communication profile used by AMF.
amf.ueNASCommProfile string O Specifies the NF communication profile used by NAS.
amf.ueAMFRetryProfileNotification string O  
amf.ueNASRetryProfileInitial string O  
amf.ueNASRetryProfileSubs string O  
amf.ueAMFDiscoveryCriteria string O  
amf.sendSbiBhForN1N2TransferReq String O
Indicates when to send the SBI binding header for N1N2Transfer request. The options can be:
  • When binding information changes: Sends the binding header in the HTTP request only whenever there is a change in the binding information.
  • Always: Sends the binding header in all the N1N2Transfer requests.
  • Never: Never includes the binding header in any N1N2Transfer request.

Default value: When binding information changes

Note: This configuration will override the values being set towards NF Communication Profile under NAS (The NF Communication Profile for NAS is mandatory to be set in UE service configuration).

amf.sendRoutingBhForN1N2TransferReq String O
Indicates when to send the routing binding header for N1N2Transfer request. The options can be:
  • Always: Sends the routing binding header in all the N1N2Transfer requests.
  • Never: Never sends the routing binding header in any N1N2Transfer request.

Default value: There is no default value configured for this field.

Note:
  • This configuration will override the values being set towards NF Communication Profile under NAS (The NF Communication Profile for NAS is mandatory to be set in UE service configuration).

  • To rollback the value of the parameter from "ALWAYS"/"NEVER" to default value, click Please Select.

amf.sendDiscHeaderForN1N2TransferReq String O
Indicates whether to send the discovery header for N1N2Transfer request when the routing binding information is not present. The options can be:
  • Always: Sends the discovery header in all the N1N2Transfer requests when the routing binding header is not included.
  • Never: Never sends the discovery header in any N1N2Transfer request.

Default value: There is no default value configured for this field.

Note:
  • This configuration will override the values being set towards NF Communication Profile under NAS (The NF Communication Profile for NAS is mandatory to be set in UE service configuration).

  • To rollback the value of the parameter from "ALWAYS"/"NEVER" to default value, click Please Select.

Table 2-300 UEPolicyServiceSystemConfiguration

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
loglevel String, ENUM O Indicates the log level of PCF Session Management (SM) service. Default Value: WARN
notifUriRoot string O
enableLimitingSessionByPerUser boolean O Specifies whether to enable the Limiting the Number of Sessions functionality.

Default value: false

maxSessionLimitUser integer C Enables to configure the maximum number of sessions to be limited by the user if Enable Max Session Limit flag is enabled.

The value of this parameter ranges between 1 and 2.

Default value: 1

Table 2-301 UserUEPolicyServiceConfiguration

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
asyncChfQueryEnabled Boolean O

When this button is enabled, PCF interacts with CHF in Asynchronous mode.
chfQueryEnabled Boolean O If this switch is enabled, PCF fetches policy counters from CHF.
isChfQueryEnabled Boolean O If this switch is enabled, PCF fetches policy counters from CHF.
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
queryUserOnCreate boolean O

Determines if user query from UDR is enabled. When this option is enabled, PDS queries the UDR about the subscriber contained in the UE Association create request by sending a GET request for “ue-policy-set” resource on the nudr-dr service.

Default Value: true
subscribeToNotify boolean O

When Subscribe to Notify is enabled, Policy subscribes with the UDR to get notified on changes in subscriber profile.

Default Value: true
queryUserOnUpdate boolean O

Determines if user query from UDR on update is enabled. When this option is enabled, PDS queries the UDR about the subscriber present in the UE Association update request by sending a GET request for “ue-policy-set” resource on the nudr-dr service.

Default Value: false
queryUserOnTerminate boolean O

Determines if user query from UDR on delete is enabled. When this option is enabled, PCF queries the UDR about the subscriber present in the UE Association delete request by sending a GET request for “ue-policy-set” resource on the nudr-dr service.

Default Value: false
uePolicyDataEnabled Boolean O

If this switch is enabled, PCF fetches UEPolicyData from nUDR.

Table 2-302 HomePLMNConfiguration

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
mcc Number O The Mobile Country Code and Mobile Network Code of the Home PLMN.

Default Value: NA

mnc Number O The Mobile Country Code and Mobile Network Code of the Home PLMN.

Default Value: NA

Table 2-303 N1MessageTransferSettings

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
n1MsgMaxSize Number O Maximum number of URSP Rules to be encoded in a single UE Policy Section (UPSI) container.

Default Value: 2000

uePolicySectionMaxSize Number O The maximum size in bytes of a "MANAGE UE POLICY COMMAND" after encoding to send out to AMF for delivery to UE.

Default Value: 2000

maxNoOfURSPRules Number O Maximum number of URSP Rules to be encoded in a single UE Policy Section (UPSI) container.

Default Value: 4

upscStart Number O This fields indicate the range of UPSC allocation by PCF and can be used to maintain a dedicated range of UPSCs used by PCF generated UPSIs.

Configuring these fields avoids the conflict of UPSCs between the UE built-in UPSC and the PCF delivered UPSC.

Note: If the UPSI based policy action is also used for non-fragmented URSP delivery, then the range of UPSCs used by that method should be outside the range configured here.

Default Value: Start: 0

upscEnd Number O This fields indicate the range of UPSC allocation by PCF and can be used to maintain a dedicated range of UPSCs used by PCF generated UPSIs.

Configuring these fields avoids the conflict of UPSCs between the UE built-in UPSC and the PCF delivered UPSC.

Note: If the UPSI based policy action is also used for non-fragmented URSP delivery, then the range of UPSCs used by that method should be outside the range configured here.

Default Value: End: 65535

Table 2-304 TimerSettings

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
T 3501 Timer Duration Number O

If it's value is zero, T 3501 Timer handling functionality will be disabled. If a non-zero value is configured, then the timer will be initiated after every N1 transfer received successfully from AMF from the N1 Notify.

Default Value: 5000

backOffTimerDuration Number O The action to be taken by PCF when the AMF notifies the PCF that it could not deliver the "MANAGE UE POLICY COMMAND" message to UE.

Default Value: 15000

Table 2-305 N1MessageRetransmissionSettings

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
On T 3501 Timer Expiry Enumeration O

The action to be taken by PCF when N1 notification is not received within configured duration defined in T 3501 Timer Duration.

Default Value: Abort N1 Delivery

onTransactionFailureNotification Number O The action to be taken by PCF when the AMF notifies the PCF that it could not deliver the "MANAGE UE POLICY COMMAND" message to UE.

Default Value: Abort

The value for the Skip Fragment label must be "SKIP".

The value for the Re-Transmit N1 Message label must be "RETRANSMIT".

The value for the Abort N1 Delivery label must be "ABORT".
onUEPolicyCommandReject Enumeration O The action to be taken by PCF when the UE notifies the PCF that it could not process the "MANAGE UE POLICY COMMAND" message.

Default Value: Abort

The value for the Skip Fragment label must be "SKIP".

The value for the Re-Transmit N1 Message label must be "RETRANSMIT".

The value for the Abort N1 Delivery label must be "ABORT".
maxNoOfRetransmissions Enumeration O Maximum number of re-transmissions to be attempted (excluding the initial attempt) after which UE service shall not try further to re-send the same fragment to AMF

Default Value: 2

The value of the drop down items are as follows:
  • Re-Transmit N1 Message- RETRANSMIT
  • Skip Fragment- SKIP
  • Abort N1 Delivery- ABORT
reTransmissionFailureBehavior Enumeration O The behavior of PCF UE service if the N1 message is not delivered to the UE after a maximum number of re-transmissions have been tried.

Default Value: Abort

The value for the Skip Fragment label must be "SKIP".

The value for the Abort N1 Delivery label must be "ABORT".

Table 2-306 AuditConfiguration

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
enable boolean O

If this flag is enabled, UE service registers with Audit service for auditing the records in UEPolicyAssociation table. Once the registration is successful, a record for UE service is created in the AuditRegistration table.

Default Value: False

query AMF boolean O

If this flag is enabled, the UE service sends the stale session notification received from Audit service to AMF to check if the session is present in AMF.

Default Value: False

notificationRate integer M

Defines the maximum number of stale records, which Audit Service notifies to UE service in one second.

Value of this parameter ranges between 20 and 700.

Default Value: 50

ttl integer M

Defines the age of the UE Policy Association, after which a record is considered to be stale on PCF and the AMF is queried (if query AMF is set to TRUE) for presence of such associations.

Value of this parameter ranges between 1 and 10080.

Default Value: 1440

maxTtl integer M

Defines the maximum age of a UE Policy Association, after which a record is considered as stale and is purged from PCF UE database without sending further queries to AMF.

Value of this parameter ranges between 1 and 20160.

Default Value: 2880

frequency integer M

Defines the time when next audit for the UE service table is done after delta time if auditing this table has been finished before this specified time.

Value of this parameter ranges between 1 and 1440.

Default Value: 10

Sample Request body structure for PUT operations:

{
  "amf": {
    "ueAMFCommProfile": "string",
    "ueAMFRetryProfileNotification": "string",
    "ueNASCommProfile": "string",
    "ueNASRetryProfileInitial": "string",
    "ueNASRetryProfileSubs": "string"
  },
  "audit": {
    "enable": true,
    "frequency": 5,
    "maxTtl": 2880,
    "notificationRate": 50,
    "queryAMF": true,
    "ttl": 1440
  },
  "homePLMN": {
    "mcc": 0,
    "mnc": 0
  },
  "n1MsgRetransmissionSettings": {
    "maxNoOfRetransmissions": 2,
    "onT3501TimerExpiry": "ABORT",
    "onTransactionFailureNotification": "ABORT",
    "onUEPolicyCommandReject": "ABORT",
    "reTransmissionFailureBehavior": "ABORT"
  },
  "n1MsgTransferSettings": {
    "maxNoOfURSPRules": 4,
    "n1MsgMaxSize": 2000,
    "uePolicySectionMaxSize": 2000,
    "upscEnd": 65535,
    "upscStart": 0
  },
  "system": {
    "enableLimitingSessionByPerUser": true,
    "maxSessionLimitUser": 1,
    "notifUriRoot": "string"
  },
  "timerSettings": {
    "backOffTimerDuration": 15000,
    "t3501TimerDuration": 5000
  },
  "user": {
    "asyncChfQueryEnabled": true,
    "chfQueryEnabled": true,
    "isChfQueryEnabled": true,
    "queryUserOnCreate": true,
    "queryUserOnTerminate": true,
    "queryUserOnUpdate": true,
    "subscribeToNotify": true,
    "uePolicyDataEnabled": true,
    "validateUser": true
  }
}

Sample Response body structure for GET and PUT operations:

{
    "system": {
        "enableLimitingSessionByPerUser": true,
        "maxSessionLimitUser": 1
    },
    "user": {
        "validateUser": false,
        "queryUserOnCreate": false,
        "subscribeToNotify": false,
        "queryUserOnUpdate": false,
        "queryUserOnTerminate": false
    },
    "homePLMN": {
        "mcc": "0",
        "mnc": "0"
    },
    "n1MsgTransferSettings": {
        "n1MsgMaxSize": 2000,
        "uePolicySectionMaxSize": 2000,
        "maxNoOfURSPRules": 4,
        "upscStart": 0,
        "upscEnd": 65535
    },
    "timerSettings": {
        "backOffTimerDuration": 15000  
        "t3501TimerDuration": 5000
    },
    "n1MsgRetransmissionSettings": {
        "onTransactionFailureNotification": "ABORT",
        "onT3501TimerExpiry": "ABORT",
        "onUEPolicyCommandReject": "ABORT",
        "maxNoOfRetransmissions": 2,
        "reTransmissionFailureBehavior": "ABORT"
    },
    "audit": {
        "enable": false,
        "queryAMF": false,
        "notificationRate": 50,
        "ttl": 1440,
        "maxTtl": 2880,
        "frequency": 10
    }
}

Export/Import UE Policy

Table 2-307 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData array   Exported list of UE policy service. For more information, see Get and Update UE Policy
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "amf": {
    "ueAMFCommProfile": "string",
    "ueAMFRetryProfileNotification": "string",
    "ueNASCommProfile": "string",
    "ueNASRetryProfileInitial": "string",
    "ueNASRetryProfileSubs": "string"
  },
  "audit": {
    "enable": true,
    "frequency": 5,
    "maxTtl": 2880,
    "notificationRate": 50,
    "queryAMF": true,
    "ttl": 1440
  },
  "homePLMN": {
    "mcc": 0,
    "mnc": 0
  },
  "n1MsgRetransmissionSettings": {
    "maxNoOfRetransmissions": 2,
    "onT3501TimerExpiry": "ABORT",
    "onTransactionFailureNotification": "ABORT",
    "onUEPolicyCommandReject": "ABORT",
    "reTransmissionFailureBehavior": "ABORT"
  },
  "n1MsgTransferSettings": {
    "maxNoOfURSPRules": 4,
    "n1MsgMaxSize": 2000,
    "uePolicySectionMaxSize": 2000,
    "upscEnd": 65535,
    "upscStart": 0
  },
  "system": {
    "enableLimitingSessionByPerUser": true,
    "maxSessionLimitUser": 1,
    "notifUriRoot": "string"
  },
  "timerSettings": {
    "backOffTimerDuration": 15000,
    "t3501TimerDuration": 5000
  },
  "user": {
    "asyncChfQueryEnabled": true,
    "chfQueryEnabled": true,
    "isChfQueryEnabled": true,
    "queryUserOnCreate": true,
    "queryUserOnTerminate": true,
    "queryUserOnUpdate": true,
    "subscribeToNotify": true,
    "uePolicyDataEnabled": true,
    "validateUser": true
  }
}

2.68 Core Service

Table 2-308 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Get PCRF Core Service GET ​{apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pcrfcore​/settings See Table A-1
Update PCRF Core Service PUT ​{apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pcrfcore​/settings See Table A-2
Export PCRF Core Service GET {apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pcrfcore​/settings​/export See Table A-1
Import PCRF Core Service POST {apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pcrfcore​/settings​/import See Table A-3

Get and Update Core Service

Table 2-309 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C)aints Description
advancedSettings   O
user O

Table 2-310 advancedSettings

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
key string O
value string O

Table 2-311 user

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
enable boolean M Determines whether to send registration request to Audit service or not.

By default, this switch is enabled.

frequency integer   Defines the frequency by which Audit service notifies to PCRF Core service in one second.
gxSessionMaxTtl integer   Defines the maximum age of a Gx session after which a record is purged from PCRF Core database (Gx Session table) without sending further queries to PGW.
gxSessionTtl integer   Defines the age of a Gx session after which a record is considered to be stale on PCRF Core and the PGW is queried for presence of such associations.
notificationRate integer   Defines the number of stale records which Audit service notifies to PCRF Core service in one second.
rxSessionMaxTtl integer   Defines the maximum age of an Rx session after which a record is purged from PCRF Core database (Rx Session table) without sending further queries to PGW.
rxSessionTtl integer   Defines the age of an Rx session after which a record is considered to be stale on PCRF Core and the PGW is queried for presence of such associations.
sessionMaxTtl integer    

Table 2-312 user

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
enableSubscriberVariables boolean O  
ldapData.enable boolean O If this is true, PCRF-Core fetches user profile from LDAP through PDS.
ocsSpendingLimit.enable boolean O If this is true, PCRF-Core fetches user profile from 4G OCS.
ocsSpendingLimit.asyncQuery boolean O When this switch is enabled, PCRF Core performs on-demand lookup of Policy Counters for a subscriber.
shData.enable boolean   If this is true, PCRF-Core fetches user profile from 4G UDR.
smPolicyData.enable boolean   If this value is true, PCRF-Core fetches SMPolicyData from nUDR.
smPolicyData.queryOnDelete boolean   Determines if user query from UDR on delete is enabled. When this option is true, PCRF Core queries the UDR about the subscriber present in the SM Association delete request by sending a GET request for “SmPolicyData” resource on the nudr-dr service.
smPolicyData.queryOnReauth boolean   Determines if user query from UDR on reauth is enabled. When this option is true, PCRF Core queries the UDR about the subscriber, when it receives a Reauthorization request, such as Rx or Policy Authorization request by sending a GET request for “SmPolicyData” resource on the nudr-dr service.
smPolicyData.queryOnUpdate boolean  

Determines if user query from UDR on update is enabled. When this value is true, PCRF Core queries the UDR about the subscriber present in the SM Association update request by sending a GET request for “SmPolicyData” resource on the nudr-dr service.

Note: The PDS caches the subscriber profile when the “Subscribe To Notify” option is enabled, in that case, the PCRF core may not always reach the UDR when the subscriber profile is found in the local cache.

smPolicyData.subscribeToNotify boolean  

When this value is true, PCRF Core subscribes with the UDR to get notified on changes in subscriber profile.
validateUser boolean   If the User profile, for any of the User Data types given under the User Data Types group, are fetched successfully, the user is considered to be a known user. However, if the user profile lookup has failed on all the configured data sources, the user profile is marked as Unknown.

If this value is true and user is marked as Unknown, the session creation requests are rejected.

If this value is false and user is marked as Unknown, the session creation requests are handled and sessions are created successfully.

Sample Request body structure for PUT operations:

{
  "advancedSettings": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "audit": {
    "enable": true,
    "frequency": 330,
    "gxSessionMaxTtl": 0,
    "gxSessionTtl": 1440,
    "notificationRate": 50,
    "rxSessionMaxTtl": 2880,
    "rxSessionTtl": 1440,
    "sessionMaxTtl": 0
  },
  "user": {
    "enableSubscriberVariables": true,
    "ldapData.enable": true,
    "ocsSpendingLimit.asyncQuery": true,
    "ocsSpendingLimit.enable": true,
    "shData.enable": true,
    "smPolicyData.enable": true,
    "smPolicyData.queryOnDelete": true,
    "smPolicyData.queryOnReauth": true,
    "smPolicyData.queryOnUpdate": true,
    "smPolicyData.subscribeToNotify": true,
    "validateUser": true
  }
}

Sample Response body structure for GET and PUT operations:

{
  "advancedSettings": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "audit": {
    "enable": true,
    "frequency": 330,
    "gxSessionMaxTtl": 0,
    "gxSessionTtl": 1440,
    "notificationRate": 50,
    "rxSessionMaxTtl": 2880,
    "rxSessionTtl": 1440,
    "sessionMaxTtl": 0
  },
  "user": {
    "enableSubscriberVariables": true,
    "ldapData.enable": true,
    "ocsSpendingLimit.asyncQuery": true,
    "ocsSpendingLimit.enable": true,
    "shData.enable": true,
    "smPolicyData.enable": true,
    "smPolicyData.queryOnDelete": true,
    "smPolicyData.queryOnReauth": true,
    "smPolicyData.queryOnUpdate": true,
    "smPolicyData.subscribeToNotify": true,
    "validateUser": true
  }
}

Export/Import Core Service

Table 2-313 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData array   Exported list of core service. For more information, see Get and Update UE Policy
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "exportData": {
    "advancedSettings": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "audit": {
      "enable": true,
      "frequency": 330,
      "gxSessionMaxTtl": 0,
      "gxSessionTtl": 1440,
      "notificationRate": 50,
      "rxSessionMaxTtl": 2880,
      "rxSessionTtl": 1440,
      "sessionMaxTtl": 0
    },
    "user": {
      "enableSubscriberVariables": true,
      "ldapData.enable": true,
      "ocsSpendingLimit.asyncQuery": true,
      "ocsSpendingLimit.enable": true,
      "shData.enable": true,
      "smPolicyData.enable": true,
      "smPolicyData.queryOnDelete": true,
      "smPolicyData.queryOnReauth": true,
      "smPolicyData.queryOnUpdate": true,
      "smPolicyData.subscribeToNotify": true,
      "validateUser": true
    }
  },
  "sourceVersion": "string",
  "topic": "string"
}

2.69 Serving Gateway

Table 2-314 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Serving Gateway POST {apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pcrfcore​/sgws See Table A-3
Export Serving Gateway GET {apiRoot}​​​/oc-cnpolicy-configuration​/v1​/services​/pcrfcore​/sgws​/export See Table A-1
Import Serving Gateway POST ​{apiRoot}/oc-cnpolicy-configuration​/v1​/services​/pcrfcore​/sgws​/import See Table A-3
Get Serving Gateway GET ​{apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pcrfcore​/sgws​/{servingGatewayName} See Table A-1
Update Serving Gateway PUT {apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pcrfcore​/sgws​/{servingGatewayName} See Table A-2
Delete Serving Gateway DELETE ​{apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pcrfcore​/sgws​/{servingGatewayName} See Table A-4

Create, Get, and Update Serving Gateway

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
description string    
mccMnc string    
name string M  
sgwIpAddress array    

Sample Request Body structure for POST and PUT operations:

{
  "description": "string",
  "mccMnc": "string",
  "name": "string",
  "sgwIpAddress": [
    "string"
  ]
}

Sample Response Body structure for GET, POST and PUT operations:

{
  "description": "string",
  "mccMnc": "string",
  "name": "string",
  "sgwIpAddress": [
    "string"
  ]
}

Export/Import Serving Gateway

Table 2-316 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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 2-315.
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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "description": "string",
      "mccMnc": "string",
      "name": "string",
      "sgwIpAddress": [
        "string"
      ]
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Delete Serving Gateway

Table 2-317 Request/Response Body Parameters

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

2.70 Network for PGW

Table 2-318 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Network PGW POST {apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pcrfcore​/network​/pgws See Table A-3
Export Network PGW GET ​{apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pcrfcore​/network​/pgws​/export See Table A-1
Import Network PGW POST ​{apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pcrfcore​/network​/pgws​/import See Table A-3
Get Network PGW GET ​{apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pcrfcore​/network​/pgws​/{networkPGWName} See Table A-1
Update Network PGW PUT ​{apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pcrfcore​/network​/pgws​/{networkPGWName} See Table A-2
Delete Network PGW DELETE ​{apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pcrfcore​/network​/pgws​/{networkPGWName} See Table A-4

Create, Get, and Update Network for PGW

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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  

Sample Request Body structure for POST and PUT operations:

{
  "backupHostName": "string",
  "capabilities": [
    "string"
  ],
  "capacity": "string",
  "description": "string",
  "diameterRealm": "string",
  "fqdn": "string",
  "hostName": "string",
  "ipDomainId": "string",
  "name": "string",
  "neDiameterId": [
    "string"
  ]
}

Sample Response Body structure for GET, POST and PUT operations:

{
  "backupHostName": "string",
  "capabilities": [
    "string"
  ],
  "capacity": "string",
  "description": "string",
  "diameterRealm": "string",
  "fqdn": "string",
  "hostName": "string",
  "ipDomainId": "string",
  "name": "string",
  "neDiameterId": [
    "string"
  ]
}

Export/Import Network for PGW

Table 2-320 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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 2-319.
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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "backupHostName": "string",
      "capabilities": [
        "string"
      ],
      "capacity": "string",
      "description": "string",
      "diameterRealm": "string",
      "fqdn": "string",
      "hostName": "string",
      "ipDomainId": "string",
      "name": "string",
      "neDiameterId": [
        "string"
      ]
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Delete Network for PGW

Table 2-321 Request/Response Body Parameters

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

2.71 Network for GGSN

Table 2-322 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create Network GGSN POST ​{apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pcrfcore​/network​/ggsns See Table A-3
Export Network GGSN GET {apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pcrfcore​/network​/ggsns​/export See Table A-1
Import Network GGSN POST {apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pcrfcore​/network​/ggsns​/import See Table A-3
Get Network GGSN GET ​{apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pcrfcore​/network​/ggsns​/{networkGGSNName} See Table A-1
Update Network GGSN PUT ​{apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pcrfcore​/network​/ggsns​/{networkGGSNName} See Table A-2
Delete Network GGSN DELETE ​{apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pcrfcore​/network​/ggsns​/{networkGGSNName} See Table A-4

Create, Get, and Update Network for GGSN

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

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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  

Sample Request Body structure for POST and PUT operations:

{
  "backupHostName": "string",
  "capabilities": [
    "string"
  ],
  "capacity": "string",
  "description": "string",
  "diameterRealm": "string",
  "hostName": "string",
  "ipDomainId": "string",
  "name": "string",
  "neDiameterId": [
    "string"
  ]
}

Sample Response Body structure for GET, POST and PUT operations:

{
  "backupHostName": "string",
  "capabilities": [
    "string"
  ],
  "capacity": "string",
  "description": "string",
  "diameterRealm": "string",
  "hostName": "string",
  "ipDomainId": "string",
  "name": "string",
  "neDiameterId": [
    "string"
  ]
}

Export/Import Network for GGSN

Table 2-324 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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 2-323.
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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "backupHostName": "string",
      "capabilities": [
        "string"
      ],
      "capacity": "string",
      "description": "string",
      "diameterRealm": "string",
      "hostName": "string",
      "ipDomainId": "string",
      "name": "string",
      "neDiameterId": [
        "string"
      ]
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "topic": "string"
}

Delete Network for GGSN

Table 2-325 Request/Response Body Parameters

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

2.72 Audit Service

Table 2-326 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Get Audit Service GET ​ {apiRoot}/oc-cnpolicy-configuration/v1/services/audit See Table A-1
Update Audit Service PUT {apiRoot}/oc-cnpolicy-configuration/v1/services/audit See Table A-2
Export Audit Service Configuration GET {apiRoot}/oc-cnpolicy-configuration/v1/services/audit/export See Table A-1
Import Audit Service Configuration POST {apiRoot}/oc-cnpolicy-configuration/v1/services/audit/import See Table A-3

Get and Update Audit Services

Table 2-327 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C)aints Description
auditEnabled boolean Determines whether to send registration request to Audit service or not.

Default Value: True
auditRate integer Defines the number of stale records which Audit service notifies to Session Management (SM) service in one second.

Default Value: 50
logLevel String   Indicates the log level of PCF Session Management (SM) service.

Sample Request body structure for PUT operation:

{
  "auditEnabled": true,
  "auditRate": 0
}

Sample Response body structure for GET, POST, and PUT operations:

{
  "auditEnabled": true,
  "auditRate": 0
}

Export/Import Audit Service s

Table 2-328 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
exportData array   Exported list of policy audit service. For more information, see Get and Update Audit Services.
sourceVersion string   System version of the product from which data is exported
topic string M Topic of each managed object

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "exportData": {
    "auditEnabled": true,
    "auditRate": 0
  },
  "sourceVersion": "string",
  "topic": "string"
}

Audits Scheduled REST API

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Audit Service Fetch GET ​ {apiRoot}/audits/{serviceName} See Table A-1
Operation Name for Audit PUT {apiRoot}/audit/{operationName} See Table A-2
Audit Service Registration PUT {apiRoot}/audits/{serviceName} See Table A-2
Audit Service Deregistration. DELETE {apiRoot}/audits/{serviceName} See Table A-4

Table 2-329 Request/Response Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
serviceName string M Identifier of the requestor NF service, e.g. pcf-sm
operationName string M Operation name for audit , e.g. NOW/PAUSE/RESUME
tableName string M Table name thats need to be audited.

2.73 Binding Service

Table 2-330 Supported REST APIs - Binding Service

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Get Binding Service GET {apiRoot}/oc-cnpolicy-configuration/v1/services/binding See Table A-1
Update Binding Service PUT {apiRoot}/oc-cnpolicy-configuration/v1/services/binding See Table A-2
Export Binding Services GET {apiRoot}/oc-cnpolicy-configuration/v1/services/binding/export See Table A-1
Import Binding Services POST {apiRoot}/oc-cnpolicy-configuration/v1/services/binding/import See Table A-3

Get and Update Binding Service

Table 2-331 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
abortOnBindingError boolean O Determines if PCF (SM service) should abort terminate session when binding error is received.
bindingOperationEnabled boolean O This determines if binding operation (register and deregister) to the BSF is enabled. Default Value: TRUE
bsfEnabled boolean O Determines if BSF is enabled or disabled.
bindingServiceNfCommProfile String O Specifies the NF communication profile used by BSF.
bsfRetryProfileForInitMsgs string O Retry Profile to be used when PCF fails to send a create message to a producer node .
bsfRetryProfileForSubsqtMsgs string O Retry Profile to be used when PCF fails to send an in-session message to a producer node.
defaultBindingOperationMode Enum O Allows users to configure binding operation mode as synchronous or asynchronous.
enableApnFilterBySnssai boolean O This parameter can be used to enable or disable limiting of number of bindings at DNN + SNSSAI + IP domain level at Binding service.
enableSessionLimitByUser boolean O This parameter can be used to enable or disable user level limiting for bindings at Binding service.
maxSessionLimitByApn integer O This parameter can be used to specify the maximum session limit for DNN + SNSSAI + IP domain level.
maxSessionLimitByUser integer O This parameter can be used to specify the maximum session limit for a particular user.
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

Sample Request body for Binding Service PUT operation:

{
  "abortOnBindingError": true,
  "bindingOperationEnabled": true,
  "bsfEnabled": true,
  "bsfNfCommProfile": "string",
  "bsfRetryProfileForInitMsgs": "string",
  "bsfRetryProfileForSubsqtMsgs": "string",
  "defaultBindingOperationMode": "SYNCHRONOUS",
  "enableApnFilterBySnssai": true,
  "enableSessionLimitByUser": true,
  "maxSessionLimitByApn": 2,
  "maxSessionLimitByUser": 10,
  "useHttp2": true,
  "useLocalConfiguredBsfAlways": true,
  "useLocalConfiguredBsfWhenNotDiscovered": true
}

Sample Response body structure for Binding Service GET and PUT operation:

{
  "abortOnBindingError": true,
  "bindingOperationEnabled": true,
  "bsfEnabled": true,
  "bsfNfCommProfile": "string",
  "bsfRetryProfileForInitMsgs": "string",
  "bsfRetryProfileForSubsqtMsgs": "string",
  "defaultBindingOperationMode": "SYNCHRONOUS",
  "enableApnFilterBySnssai": true,
  "enableSessionLimitByUser": true,
  "maxSessionLimitByApn": 2,
  "maxSessionLimitByUser": 10,
  "useHttp2": true,
  "useLocalConfiguredBsfAlways": true,
  "useLocalConfiguredBsfWhenNotDiscovered": true
}

Import and Export Binding Service

Table 2-332 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string   Current timestamp
errors.message     The reason of the failure.
errors.name     Name of the components that failed to export or import.
exportData array   Exported list of Binding Service. For more information, see Get and Update Binding Service.
key string   Indicates the ID
sourceVersion string   System version of product from which data is exported
topic string   Topic of each managed object

Sample Request Body structure for Binding Service Import and Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": {
    "abortOnBindingError": true,
    "bindingOperationEnabled": true,
    "bsfEnabled": true,
    "bsfNfCommProfile": "string",
    "bsfRetryProfileForInitMsgs": "string",
    "bsfRetryProfileForSubsqtMsgs": "string",
    "defaultBindingOperationMode": "SYNCHRONOUS",
    "enableApnFilterBySnssai": true,
    "enableSessionLimitByUser": true,
    "maxSessionLimitByApn": 2,
    "maxSessionLimitByUser": 10,
    "useHttp2": true,
    "useLocalConfiguredBsfAlways": true,
    "useLocalConfiguredBsfWhenNotDiscovered": true
  },
  "sourceVersion": "string",
  "topic": "string"
}

2.74 NF Communication Profile

This section describes the service URIs available to create and configure NF communication profiles for CNC Policy.

Table 2-333 Supported REST APIs - NF Communication Profile

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Create NF Communication Profile POST {apiRoot}/oc-cnpolicy-configuration/v1/services/common/nfcommprofiles See Table A-3
Get NF Communication Profile GET {apiRoot}/oc-cnpolicy-configuration/v1/services/common/nfcommprofiles/{nfCommunicationProfileName} See Table A-1
Update NF Communication Profile PUT {apiRoot}/oc-cnpolicy-configuration/v1/services/common/nfcommprofiles/{nfCommunicationProfileName} See Table A-2
Export NF Communication Profiles GET {apiRoot}/oc-cnpolicy-configuration/v1/services/common/nfcommprofiles/export See Table A-1
Import NF Communication Profiles POST {apiRoot}/oc-cnpolicy-configuration/v1/services/common/nfcommprofiles/import See Table A-3
Delete NF Communication Profile DELETE {apiRoot}/oc-cnpolicy-configuration/v1/services/common/nfcommprofiles/{nfCommunicationProfileName} See Table A-4

Get, Create, and Update NF Communication Profile

This section describes the request and response parameters used in NF communication profile APIs.

Table 2-334 Request and Response Body Parameters

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

The unique name for the NF communication profile. This name is used to refer to the profile in other service configuration screen, such as SM Service, User Connector, and so on.

The name can only contain the characters A–Z, a–z, 0–9, period (.), hyphen (-), and underline (_). The maximum length is 255 characters.
policyNfCommunicationModel String O Indicates the communication model, in which the Policy NF is deployed.
Provide any of the following values:
  • CUSTOM
  • Model_B
  • Model_C
  • Mode_D

Default value: CUSTOM
nfDiscoverySettings.discoveryParameters DiscoveryParam M
Note: This parameter is mandatory when either of the following attributes is set to true:
  • sendDiscoveryHeaderInitMsg
  • sendDiscoveryHeaderSubsMsg
 Indicates the discovery parameter to be used in the 3gpp-sbi-discovery-<discovery-parameter>.

This parameter is ignored when the "policyNfCommunicationModel" is set to MODEL_B.

nfDiscoverySettings.sendDiscoveryHeaderInitMsg boolean O This value indicates if PCF must include the following 3gpp-sbi-discovery-<discovery-parameter> parameters in SBI messages:
  • Parameters that create a subscription, such as POST messages
  • Parameters that do not belong to a subscription, such as GET or PATCH messages

Default value: False, for Custom model.

This attribute is ignored when "policyNfCommunicationModel" is set to any value other than CUSTOM.

nfDiscoverySettings.sendDiscoveryHeaderSubsMsg boolean O This value indicates if PCF must include the following 3gpp-sbi-discovery-<discovery-parameter> parameters in SBI messages:
  • Parameters to update a subscription, such as PUT messages when unable to fill in a 3gpp-sbi-routing-binding header.
  • Parameters to delete a subscription, such as DELETE messages when unable to fill in a 3gpp-sbi-routing-binding header.

Default value: False, for Custom model.

This attribute is ignored when "policyNfCommunicationModel" is set to any value other than CUSTOM.

nfDiscoverySettings.sendTargetApiRootHeaderInitMsg boolean false

Indicates if PCF must include 3gpp-sbi-target-apiroot header in initial request messages.

If the user selects Model D for Policy NF Communication Model, the value for this parameter must be set to false. For other Policy NF Communication Model values, the default value is true.
onDemandDiscoveryCaching.forceDiscovery String O

Indicates whether to cache the NF profiles in NRF clinet or to skip caching and receive the response directly from NRF.

Value of this parameter can be 0 or 1.

    • When the value of OC-Force-Rediscovery parameter is set to 0, it enables the feature and caches the NF profiles details received from NRF in NRF Client.
    • When the value of OC-Force-Rediscovery parameter is set to 1, it disables the feature and retrieves the NF profiles directly from NRF while responding to the query from the backend services.

Default value: 0

onDemandDiscoveryCaching.retentionPeriod String O

Indicates whether to cache the NF profiles in NRF clinet or to skip caching and receive the response directly from NRF.

Value of this parameter can be 0 or 1.

    • When the value of OC-Force-Rediscovery parameter is set to 0, it enables the feature and caches the NF profiles details received from NRF in NRF Client.
    • When the value of OC-Force-Rediscovery parameter is set to 1, it disables the feature and retrieves the NF profiles directly from NRF while responding to the query from the backend services.

Default value: 0

nfBindingSettings.bindingLevel boolean M

Note: This parameter is mandatory when the sendBindingHeader parameter is set to true.

Indicates the binding level that must to be included in the 3gpp-sbi-binding header when PCF adds this header in a message to another NF.

Provide any of the following values:

  • NF_SET
  • NF_INSTANCE
nfBindingSettings.sendBindingHeader boolean O Indicates if PCF includes the 3gpp-sbi-binding header in SBI messages for the subscription creation, modification, or notification requests and responses, as applicable.

Default value: False, for Custom model.

This attribute is ignored when "policyNfCommunicationModel" is set to any value other than "Custom".
nfBindingSettings.sendServiceName boolean O

Indicates whether to enable or disable the support for sending service name in binding header.

Possible values:
  • true: includes svcname in the Binding Header sent towards NFs such as UDR, AMF, or BSF (customized) except for CHF, which contains the 3GPP defined PCF service name.
  • false: does not include svcname in the Binding Header.

Default value : false

nfBindingSettings.sendRoutingBindingHeader boolean O Indicates if PCF includes the 3gpp-sbi-routing-binding header in SBI messages for the subscription creation, modification, or notification requests, as applicable.

Default value: False
nfBindingSettings.sendCallbackHeader boolean O Indicates if PCF includes the 3gpp-sbi-callback header in SBI messages for the subscription creation, modification, or notification requests, as applicable.

Default value: False, for Custom model.

This attribute is ignored when "policyNfCommunicationModel" is set to any value other than CUSTOM. For more information, see Table 2-335
nfServerSettings NFServerSettings O Specifies the server header settings for the NF communication profile.
nfServerSettings.sendServerHeader Boolean O Indicates if services Converged Policy microservices include server header while sending an error response.
nfServerSettings.serverHeaderErrorCodes String O Specifies the error codes for which service header is generated. The error codes can be from 100 to 999.

Note: If no error is specified, then Converged Policy sends server header for all error responses.

retryAndAlternateRoutingSettings.retryProfileInitMsg string O Specifies the retry or alternate routing options when an SBI message is not delivered successfully in any of the following scenarios:
  • POST operation to create a subscription
  • GET or PATCH request not belonging to a subscription
retryAndAlternateRoutingSettings.retryProfileSubsMsg string O Specifies the retry or alternate routing options when an SBI message that updates, deletes or notifies a subscription is not delivered successfully.
nfCorrelationSettings.sendCorrelationHeader string O Indicates whether to carry subscriber identifier included in SBI messages and can be used for SBI message correlation.

Default Value: false

nfCorrelationSettings.allowedCorrelationInfoIdType string O Displays the types of values that can be included in Correlation-info Header. Currently only SUPI and GPSI are supported.

Defult Header Values

The following table informs about the default values of Binding headers for each of the supported communication models:

Table 2-335 Defult Header Values for Communication Model

Flags Model B Model C Model D Custom
Send Target Api Root Header in Initial Message True True False True
Send Discovery Header In Initial Messages False False True False
Send Discovery Header In Subsequent Messages False False True False
Send Binding Header True True True False
Send Routing Binding Header False True True False
Send Callback Header False True True False

Sample Request body for NF Communication Profile POST and PUT operations:

{
  "nfCommunicationProfileName": "string",
  "policyNfCommunicationModel": "CUSTOM",
  "nfDiscoverySettings": {
    "discoveryParameters": [
      {
        "paramName": "TARGET_NF_SET_ID",
        "paramValue": "string"
      }
    ],
    "sendDiscoveryHeaderInitMsg": false,
    "sendDiscoveryHeaderSubsMsg": false,
    "sendTargetApiRootHeaderInitMsg": false
  },
 "onDemandDiscoveryCaching": {
    "forceDiscovery": 0,
    "retentionPeriod": 10000
  },
  "nfBindingSettings": {
    "bindingLevel": "NF_SET",
    "sendBindingHeader": false,
    "sendServiceName": false
    "sendRoutingBindingHeader": false,
    "sendCallbackHeader": false
  },
  "nfServerSettings": {
    "sendServerHeader": true,
    "serverHeaderErrorCodes": [
      0
    ]
  },
  "retryAndAlternateRoutingSettings": {
    "retryProfileInitMsg": "string",
    "retryProfileSubsMsg": "string"
  },
  "nfCorrelationSettings": {
    "sendCorrelationHeader": true,
    "allowedCorrelationInfoIdType": [
      "imsi"
    ]
  }
}

Sample Response body structure for NF Communication Profile GET, POST, and PUT operation:

{
  "nfCommunicationProfileName": "string",
  "policyNfCommunicationModel": "CUSTOM",
  "nfDiscoverySettings": {
    "discoveryParameters": [
      {
        "paramName": "TARGET_NF_SET_ID",
        "paramValue": "string"
      }
    ],
    "sendDiscoveryHeaderInitMsg": false,
    "sendDiscoveryHeaderSubsMsg": false,
    "sendTargetApiRootHeaderInitMsg": false
  },
 "onDemandDiscoveryCaching": {
    "forceDiscovery": 0,
    "retentionPeriod": 10000
  },
  "nfBindingSettings": {
    "bindingLevel": "NF_SET",
    "sendBindingHeader": false,
    "sendRoutingBindingHeader": false,
    "sendCallbackHeader": false
  },
  "nfServerSettings": {
    "sendServerHeader": true,
    "serverHeaderErrorCodes": [
      0
    ]
  },
  "retryAndAlternateRoutingSettings": {
    "retryProfileInitMsg": "string",
    "retryProfileSubsMsg": "string"
  },
  "nfCorrelationSettings": {
    "sendCorrelationHeader": true,
    "allowedCorrelationInfoIdType": [
      "imsi"
    ]
  }
}

Import and Export NF Communication Profile

Table 2-336 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date string O Current timestamp
error.message string O The reason of the failure.
error.name string O Name of the components that failed to export or import.
exportData array M Exported list of NF Communication Profile. For more information, see Get, Create, and Update NF Communication Profile.
key string O Indicates the ID of NF Communication Profile.
sourceVersion string O System version of product from which data is exported
topic string M Topic of each managed object

Sample Request Body structure for NF Communication Profile Import and Export operations:

{
  "date": "string",
  "errors": [
    {
      "message": "string",
      "name": "string"
    }
  ],
  "exportData": [
    {
      "nfBindingSettings": {
        "bindingLevel": "NF_SET",
        "sendBindingHeader": false,
        "sendCallbackHeader": false,
        "sendRoutingBindingHeader": false
      },
      "nfCommunicationProfileName": "string",
      "nfDiscoverySettings": {
        "discoveryParameters": [
          {
            "paramName": "DATA_SET",
            "paramValue": "string"
          }
        ],
        "sendDiscoveryHeaderInitMsg": false,
        "sendDiscoveryHeaderSubsMsg": false,
        "sendTargetApiRootHeaderInitMsg": false
      },
      "nfServerSettings": {
        "sendServerHeader": true,
        "serverHeaderErrorCodes": [
          0
        ]
      },
      "policyNfCommunicationModel": "CUSTOM",
      "retryAndAlternateRoutingSettings": {
        "retryProfileInitMsg": "string",
        "retryProfileSubsMsg": "string"
      }
    }
  ],
  "key": "string",
  "sourceVersion": "string",
  "systemVersion": "string",
  "topic": "string"
}

2.75 PDS Settings

Table 2-337 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Export PDS Settings GET {apiRoot}​​/oc-cnpolicy-configuration​/v1​/services​/pds​/pdsSettings​/export See Table A-1
Import PDS Settings POST {apiRoot}​​/oc-cnpolicy-configuration​/v1​/services​/pds​/pdsSettings​/import See Table A-3
Get PDS Settings GET {apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pds​/pdsSettings See Table A-1
Update PDS Settings PUT {apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pds​/pdsSettings See Table A-2

Get and Update PDS Settings

Table 2-338 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
audit.enable boolean O Specifies whether to send registration request to Audit service or not.
audit.notificationRate integer M Specifies the number of stale records which Audit service notifies to PDS service in one second.
audit.pdsProfileMinAuditPassInterval integer M Specifies the minimum interval (in minutes) between start times of two consecutive audit passes for the pdssubscriber table.
audit.pdsProfileSessionAge integer M Specifies the age (in minutes) of PDS profile (GPSI-SUPI-NAI mapping) after which the profile is considered to be stale in Policy and PDS subscriber table is queried for presence of such associations.
audit.pdsProfileSessionMaxAge integer M Specifies the age (in minutes) of PDS profile (GPSI-SUPI-NAI mapping) after which the profile is purged from the database without sending any queries to PDS subscriber table.
audit.subscriberMinAuditPassInterval integer M Specifies the minimum interval (in minutes) between start times of two consecutive audit passes for the pdssubscriber table.
audit.subscriberSessionAge integer M Specifies the age (in minutes) of PDS subscriber entry after which a record is considered to be stale on Policy and services (SM, AM, UE, and PCRF Core) are queried for presence of such associations.
audit.subscriberSessionMaxAge integer M Specifies the age (in minutes) of PDS subscriber entry after which a record is purged from the database and no query requests are sent to services for presence of such associations.
common.enableFetchAndResubscribe boolean O If the value for this parameter is set to true, PDS refetches the data and revalidates the subscription when the number of sessions exceeds the configured limit at PDS.
common.enableHttp2 boolean O If the value for this parameter is set to true, the HTTP2 remains enabled. By default, HTTP2 remains disabled.
common.requestTimeout string O If PDS Setting is updated then set the timeout as 3000 for the initial flow to succeed.
common.typeOfSearch string O Specifies the PDS query search for a PdsProfile. By default, Multi-UE ID Search is set.
common.preferenceOrder array O If typeOfSearch parameter is set to Preferential Search, then the user can select the search index in order of their preference. Possible values for preferenceOrder are : [ "SUPI", "GPSI"], [ "GPSI", "SUPI"], ["GPSI"], [ "SUPI"].
common.sessionCountPerDnnList SessionCountPerDnnList O If enableFetchAndResubscribe parameter is set to true, user can configure the number of sessions per DNN using this group of parameters.
pcrf_core_bas_uri string O Specifies the base URI of the PCRF Core service.
remoteSSVRootPath.amPolicyData string M Specifies the root path of subscriber state variables under amPolicyData.
remoteSSVRootPath.enableEndSessionSSVRemoteToUDR boolean O Specifies if the dynamic write should happen at the time of policy execution or at the end of the last session for a subscirber.
remoteSSVRootPath.operatorSpecificData string M Specifies the path of subscriber state variables under operatorSpecificData.
remoteSSVRootPath.smPolicyData string M Specifies the path of subscriber state variables under SMPolicyData.

You can provide multiple paths separated by commas.
remoteSSVRootPath.spendingLimitData string M Specifies the path of subscriber state variables under SpendingLimitData.
remoteSSVRootPath.uePolicySet string M Specifies the path of subscriber state variables under uePolicySet.

Table 2-339 SessionCountPerDnnList

Parameter Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
dnn string O Specifies the Data Network Name. The allowed expression for DNN is [^[A-Za-z0-9-.]+$]. Spaces and other characters are not allowed. (NA allowed)
maxSessionsCount integer O Specifies the number of sessions after which PDS refetches and revalidates subscriptions. You can enter a number from 1 to 20.
sd string O Specifies the Slice Differentiator Name. The allowed expression for SD is ^([A-Fa-f0-9]+|NA)$. Spaces and other characters are not allowed.
sst string O Specifies the Slice or Service Type name in the S-NSSAI. You can enter a number from 0 to 255 or NA.

Sample Request body structure for PUT operations:

{
  "audit": {
    "enable": true,
    "notificationRate": 50,
    "pdsProfileAge": 4500,
    "pdsProfileMaxAge": 8820,
    "pdsProfileMinAuditPassInterval": 1170,
    "subscriberMinAuditPassInterval": 390,
    "subscriberSessionAge": 1500,
    "subscriberSessionMaxAge": 2940
  },
  "common": {
    "enableFetchAndResubscribe": true,
    "enableHttp2": true,
    "requestTimeout": "string",
    "typeOfSearch": "Preferential Search",    
    "preferenceOrder": [     
        "SUPI",     
        "GPSI"    ],
    "sessionCountPerDnnList": [
      {
        "dnn": "string",
        "maxSessionsCount": 1,
        "sd": "string",
        "sst": 0
      }
    ]
  },
  "remoteSSVRootPath": {
    "amPolicyData": [
      "string"
    ],
    "enableEndSessionSSVRemoteToUDR": true,
    "operatorSpecificData": [
      "string"
    ],
    "smPolicyData": [
      "string"
    ],
    "spendingLimitData": [
      "string"
    ],
    "uePolicySet": [
      "string"
    ]
  }
}

Sample Response body structure for GET and PUT operations:

{
  "audit": {
    "enable": true,
    "notificationRate": 50,
    "pdsProfileAge": 4500,
    "pdsProfileMaxAge": 8820,
    "pdsProfileMinAuditPassInterval": 1170,
    "subscriberMinAuditPassInterval": 390,
    "subscriberSessionAge": 1500,
    "subscriberSessionMaxAge": 2940
  },
  "common": {
    "enableFetchAndResubscribe": true,
    "enableHttp2": true,
    "requestTimeout": "string",
    "sessionCountPerDnnList": [
      {
        "dnn": "string",
        "maxSessionsCount": 1,
        "sd": "string",
        "sst": 0
      }
    ]
  },
  "remoteSSVRootPath": {
    "amPolicyData": [
      "string"
    ],
    "enableEndSessionSSVRemoteToUDR": true,
    "operatorSpecificData": [
      "string"
    ],
    "smPolicyData": [
      "string"
    ],
    "spendingLimitData": [
      "string"
    ],
    "uePolicySet": [
      "string"
    ]
  }
}
Sample Response Body structure for PUT and POST operations for SessionCountPerDnnList 
{
  "remoteSSVRootPath": {},
  "common": {
    "enableHttp2": false,
    "requestTimeout": "1000",
    "enableFetchAndResubscribe": true,
    "sessionCountPerDnnList": [
      {
        "sst": "11",
        "sd": "abc123",
        "dnn": "internet",
        "maxSessionsCount": 1
      }
    ]
  },
  "audit": {
    "enable": true,
    "notificationRate": 50,
    "subscriberSessionAge": 1500,
    "subscriberSessionMaxAge": 2940,
    "subscriberMinAuditPassInterval": 10,
    "pdsProfileAge": 4500,
    "pdsProfileMaxAge": 8820,
    "pdsProfileMinAuditPassInterval": 10
  },
  "advancedSettings": []
}
Sample Response Body structure for PUT and POST operations for SessionCountPerDnnList (subscription revalidation of uePolicySetData and amPolicyData
{
  "remoteSSVRootPath": {},
  "common": {
    "enableHttp2": false,
    "requestTimeout": "1000",
    "enableFetchAndResubscribe": true,
    "sessionCountPerDnnList": [
      {
        "sst": "NA",
        "sd": "NA",
        "dnn": "NA",
        "maxSessionsCount": 1
      }
    ]
  },
  "audit": {
    "enable": true,
    "notificationRate": 50,
    "subscriberSessionAge": 1500,
    "subscriberSessionMaxAge": 2940,
    "subscriberMinAuditPassInterval": 10,
    "pdsProfileAge": 4500,
    "pdsProfileMaxAge": 8820,
    "pdsProfileMinAuditPassInterval": 10
  },
  "advancedSettings": []
}

Export and Import PDS Settings

Table 2-340 Request and Response Body Parameters

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

Sample Request Body structure for Import and Export operations:

{
  "date": "string",
  "exportData": {
    "audit": {
      "enable": true,
      "notificationRate": 50,
      "pdsProfileAge": 4500,
      "pdsProfileMaxAge": 8820,
      "pdsProfileMinAuditPassInterval": 1170,
      "subscriberMinAuditPassInterval": 390,
      "subscriberSessionAge": 1500,
      "subscriberSessionMaxAge": 2940
    },
    "common": {
      "enableFetchAndResubscribe": true,
      "enableHttp2": true,
      "requestTimeout": "string",
      "sessionCountPerDnnList": [
        {
          "dnn": "string",
          "maxSessionsCount": 1,
          "sd": "string",
          "sst": 0
        }
      ]
    },
    "remoteSSVRootPath": {
      "amPolicyData": [
        "string"
      ],
      "enableEndSessionSSVRemoteToUDR": true,
      "operatorSpecificData": [
        "string"
      ],
      "smPolicyData": [
        "string"
      ],
      "spendingLimitData": [
        "string"
      ],
      "uePolicySet": [
        "string"
      ]
    }
  },
  "sourceVersion": "string",
  "topic": "string"
}

2.76 PDS Workflow

Table 2-341 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Export PDS Workflows GET {apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pds​/pdsWorkflow​/export See Table A-1
Import PDS Workflows POST {apiRoot}​/oc-cnpolicy-configuration​/v1​/services​/pds​/pdsWorkflow​/import See Table A-3
Get PDS Workflows GET {apiRoot}​oc-cnpolicy-configuration​/v1​/services​/pds​/pdsWorkflow See Table A-1
Update PDS Workflows PUT {apiRoot}​oc-cnpolicy-configuration​/v1​/services​/pds​/pdsWorkflow See Table A-2

Get and Update PDS Workflows

Table 2-342 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
workflows boolean    

Sample Request body structure for PUT operations:

{
  "workflows": {}
}

Sample Response body structure for GET and PUT operations:

{
  "workflows": {}
}

Export/Import PDS Workflows

Table 2-343 Request/Response Body Parameters

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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "exportData": {
    "workflows": {}
  },
  "sourceVersion": "string",
  "topic": "string"
}

2.77 Policy Engine

Table 2-344 Supported REST APIs

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

Export/Import Policy Engine

Table 2-345 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) 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

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "exportData": {
    "logLevel": "WARN",
    "supportedServices": [
      {
        "relativeUrl": "string",
        "serviceLabel": "string",
        "serviceName": "string"
      }
    ]
  },
  "sourceVersion": "string",
  "topic": "string"
}

2.78 NWDAF Agent

Table 2-346 Supported REST APIs

Description HTTP Method or Custom Operation Resource URI Possible Result Code
Get NWDAF Agent Service configuration GET {apiRoot}/oc-cnpolicy-configuration/v1/services/nwdafAgent See Table A-1
Update NWDAF Agent Service configuration PUT {apiRoot}/oc-cnpolicy-configuration/v1/services/nwdafAgent See Table A-2
Export NWDAF Agent Service configuration GET {apiRoot}/oc-cnpolicy-configuration/v1/services/nwdafAgent/export See Table A-1
Import NWDAF Agent Service configuration POST {apiRoot}/oc-cnpolicy-configuration/v1/services/nwdafAgent/import See Table A-3
Create Autonomous Subscription POST {apiRoot}/oc-cnpolicy-configuration/v1/autonomousSubscription/sliceLoadLevel See Table A-3
Get Autonomous Subscription GET {apiRoot}/oc-cnpolicy-configuration/v1/autonomousSubscription/sliceLoadLevel/{sliceLoad} See Table A-1
Update Autonomous Subscription PUT {apiRoot}/oc-cnpolicy-configuration/v1/autonomousSubscription/sliceLoadLevel/{sliceLoad} See Table A-2
Delete Autonomous Subscription DELETE {apiRoot}/oc-cnpolicy-configuration/v1/autonomousSubscription/sliceLoadLevel/{sliceLoad} See Table A-4
Get All Autonomous Subscription GET {apiRoot} ​/oc-cnpolicy-configuration​/v1​/autonomousSubscription​/sliceLoadLevel​/export See Table A-1
Import Autonomous Subscription POST {apiRoot}​/oc-cnpolicy-configuration​/v1​/autonomousSubscription​/sliceLoadLevel​/import See Table A-3

Get and Update NWDAF Agent

Table 2-347 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O) Description
advancedSettings array M List of key/value pair

Table 2-348 SmAdvancedSettings

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
key string O Specifies the key name.
value string O Specifies the value of the key.

Sample Request body structure for GET and PUT operations:

{
  "advancedSettings": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

Export/Import Session Management Service

Table 2-349 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
date String O Current timestamp
exportData.advancedSettings array O List of key/value pair
exportData.advancedSettings.key string O Specifies the key name
exportData.advancedSettings.value string O Specifies the value of the key
sourceVersion String O Version of the source
systemVersion String O Version of the system
topic String M  

Sample Request Body structure for Import/Export operations:

{
  "date": "string",
  "exportData": {
    "advancedSettings": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "sourceVersion": "string",
  "systemVersion": "string",
  "topic": "string"
}

Slice Load Level

Table 2-350 Get, Put, Post, and Update Slice Load Level

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
immRep Boolean O Indication of immediate reporting
snssai String M Identification of network slice to which the subscription applies.
threshold Integer M Indication of slice load level in percentage

Sample Request body structure for GET and PUT operations:

{
  "immRep": true,
  "snssai": "string",
  "threshold": 0
}

Export/Import Slice Load Level

Table 2-351 Request/Response Body Parameters

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
Date string O Current timestamp
Errors array O List of errors
Errors.Message string O Error message
Errors.Name string O Name of the error
exportData array O Exported list of session rule profiles.
exportData.immRep Boolean O Indication of immediate reporting
exportData.snssai String O Identification of network slice to which the subscription applies.
exportData.threshold Integer O Indication of slice load level in percentage
sourceVersion string O System version of product from which data is exported
topic string M Topic of each managed object
Sample Request Body structure for Import/Export operations:
[
  {
    "date": "string",
    "errors": [
      {
        "message": "string",
        "name": "string"
      }
    ],
    "exportData": [
      {
        "immRep": true,
        "snssai": "string",
        "threshold": 0
      }
    ],
    "sourceVersion": "string",
    "topic": "string"
  }
]

2.79 Notifier Service

This section describes the APIs used to configure Notifier Service.

2.79.1 Notifier Configurations

This URI is used to configure the Notifier Service from CNC Console to send SMPP messages to external notification servers.

Table 2-352 Supported REST APIs that can be configured from CNC Console

Description HTTP Method or Custom Operation Resource URI
To update Notifier Service configuration PUT

{apiRoot}/oc-cnpolicy-configuration/v1/services/notifier

For details on Request/Response Body Parameters for PUT notify, see Table 2-353.

To get individual Notifier Service configuration GET

{apiRoot}/oc-cnpolicy-configuration/v1/services/notifier

For details on Request/Response Body Parameters for GET smsGateway, see Table 2-353.

To export Notifier Service configuration. GET

{apiRoot}/oc-cnpolicy-configuration/v1/services/notifier /export
To import Notifier Service configuration. POST

{apiRoot}/oc-cnpolicy-configuration/v1/services/notifier/import

For details on Request/Response Body Parameters for POST smsGateway, see Table 2-353

Table 2-353 Request/Response Body Parameters for Notifier Configurations

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
smppConfiguration.isEnabled string M

Enables the Subscriber Notification using SMPP Protocol.

Default Value: false

smppConfiguration.sourceAddr

string

 O

ESME Source Address.

By default this field is empty.
smppConfiguration.defaultSmsGatewayGroup String M

All the SMS Gateways that are created in SMS GATEWAY CONFIGURATION page.
smppConfiguration.connectTimeoutMillis String M

Indicates the SMS Gateway Connection Timeout in milliseconds.

Range: 1-60000

Default Value: 30000

smppConfiguration.responseTimeoutMillis String M

Indicates the timeout (in milliseconds) for the response going towards SMS Gateway.

Range: 1-60000

Default Value: 10000

smppConfiguration.sourceAddrTON

string

 O
Indicates the ESME Source address type of number:
  • UNKNOWN
  • INTERNATIONAL
  • NATIONAL
  • NETWORK_SPECIFIC
  • SUBSCRIBER_NUMBER
  • ALPHANUMERIC
  • ABBREVIATED

Default Value: UNKNOWN

smppConfiguration.sourceAddrNpi String O
ESME Source Address Number Plan Indicator:
  • UNKNOWN
  • ISDN (E163/E164)
  • DATA (X, 121)
  • TELEX
  • LAND_MOBILE
  • NATIONAL
  • PRIVATE
  • ERMES
  • INTERNET
  • WAP

Default Value: UNKNOWN

advancedSettings     To configure the Keys and values for advanced settings.

Sample Request/Response body structure for PUT operation:

{
"smppConfiguration": {
"isEnabled": true,
"sourceAddr": "3.3.2.2", 
"defaultSmsGatewayGroup": "gateway1", 
"connectTimeoutMillis": 30000, 
"responseTimeoutMillis": 10000, 
"sourceAddrTon": "UNKNOWN", 
"sourceAddrNpi": "UNKNOWN"
},
"advancedSettings": [] 
}

2.79.2 SMS Gateway

This URI is used to configure the SMS Gateway.

Table 2-354 Supported REST APIs to configure SMS Gateway

Description HTTP Method or Custom Operation Resource URI
To get the configuration of a particular SMS Gateway. GET

{apiRoot}/oc-cnpolicy-configuration/v1/smsGateway/{smsGatewayName}

Where <smsGatewayName> is the SMS Gateway name.
To delete the configuration of a particular SMS Gateway. DELETE

{apiRoot}/oc-cnpolicy-configuration/v1/smsGateway/{smsGatewayName}

Where <smsGatewayName> is the SMS Gateway name.
To update the configuration of a particular SMS Gateway. PUT

{apiRoot}/oc-cnpolicy-configuration/v1/smsGateway/{smsGatewayName}

Where <smsGatewayName> is the SMS Gateway name.

For details on Request/Response Body Parameters for PUT smsGateway, see Table 2-355
To create a new SMS Gateway. POST

{apiRoot}/oc-cnpolicy-configuration/v1/smsGateway/

For details on Request/Response Body Parameters for POST smsGateway, see Table 2-355
To export the list of all the SMS Gateways. GET

{apiRoot}/oc-cnpolicy-configuration/v1/smsGateway/{export}
To import the list of all the SMS Gateways. POST

{apiRoot}/oc-cnpolicy-configuration/v1/smsGateway/{import}

For details on Request/Response Body Parameters for POST smsGateway.import, see Table 2-355

Table 2-355 Request/Response Body Parameters for PUT/POST operations on smsGateway

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
description

string

 O Free-form text that identifies the SMS Gateway server within the network. Enter up to 250 characters.

By default, the value is left empty.
name   M Enter the name of the SMS Gateway server.

The name can be lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character.

By default, the value is left empty.
primarySmscHost   M Enter the Host Name of the primary SMSC Host server.

By default, the value is left empty.
requestDeliveryReceipt   O

Specify the mode of delivery receipt.

This field accepts the following integer values:
  • 0 to indicate REQUEST_DELIVERY_RECEIPT_NO
  • 1 to indicate REQUEST_DELIVERY_RECEIPT_SUCCESS_FAILURE
  • 2 to indicate REQUEST_DELIVERY_RECEIPT_FAILURE

Default Value: 0

maxByteLength   O

Maximum number of bytes allowed for the message.

The length of the message can range between 1 to 254 bytes.

Default Value: 140

longMsgMaxByteLength   O

Maximum number of bytes allowed in a long message.

The length of the message can range between 1 to 999 bytes.

Default Value: 500

longMessageEnabled   M

Enables the long messages.

Default Value: true

longMessageDeliveryMethod   M Specify the long message delivery method. It can take the following integer values:
  • 0 to indicate SEGMENTATION AND REASSEMBLY (SAR) to deliver the long messages in segments
  • 1 to indicate the MESSAGE_PAYLOAD to deliver the long messages in payload

Default Value: 0

truncateLongMessages   M

Indicates whether to truncate messages longer than the specified length.

Default Value: false

failMaxMessageSize   M

Specifies the maximum length of the message after which the message fails.

Default Value: true

Sample Request/Response body structure for PUT smsGateWay operation:


{

    "description": "testing",
  "name": "test",
  "primarySmscHost": "host_3",
  "requestDeliveryReceipt": 2,
  "maxByteLength": 140,
  "longMsgMaxByteLength": 500,
  "longMessageEnabled": true,
  "longMessageDeliveryMethod": 0,
  "truncateLongMessages": false,
  "failMaxMessageSize": true

}

Sample Request/Response body structure for POST smsGateWay.import operation:


{
   "topic": "common.notifierservice.smsgateway",
  "sourceVersion": "1.6.0",
  "date": "2023-03-14T08:01:48Z",
  "exportData": [
    {

    "description": "testing",
  "name": "test",
  "primarySmscHost": "host_3",
  "requestDeliveryReceipt": 2,
  "maxByteLength": 140,
  "longMsgMaxByteLength": 500,
  "longMessageEnabled": true,
  "longMessageDeliveryMethod": 0,
  "truncateLongMessages": false,
  "failMaxMessageSize": true

}]

}

2.79.3 SMSC HOST Info

This URI is used to configure the SMSC Host.

Table 2-356 Supported REST APIs to configure SMS Gateway

Description HTTP Method or Custom Operation Resource URI
To get the SMSC Host name. GET

{apiRoot}/oc-cnpolicy-configuration/v1/smscHostInfo/{smscHostName}
To delete the SMSC Host name. DELETE

{apiRoot}/oc-cnpolicy-configuration/v1/smscHostInfo/{smscHostName}
To update the configuration of a particular SMSC Host. PUT

{apiRoot}/oc-cnpolicy-configuration/v1/smscHostInfo/{smscHostName}

For details on Request/Response Body Parameters for PUT smscHostInfo.smscHostName, see Table 2-357
To create a new SMSC Host. POST

{apiRoot}/oc-cnpolicy-configuration/v1/smscHostInfo/{smscHostName}

For details on Request/Response Body Parameters for POST smscHostInfo.smscHostName, see Table 2-357
To export the list of all the SMSC Hosts. GET

{apiRoot}/oc-cnpolicy-configuration/v1/smscHostInfo/{export}
To import the list of all the SMSC Hosts. POST

{apiRoot}/oc-cnpolicy-configuration/v1/smscHostInfo/{import}

For details on Request/Response Body Parameters for POST smsHostInfo.import, see Table 2-357

Table 2-357 Request/Response Body Parameters for PUT/POST smscHostInfo.smscHostName.

Field Name Data Type Mandatory(M)/Optional(O)/Conditional(C) Description
name

string

 M Enter the name of the SMSC Host server.

The name can be lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character.

By default, the value is left empty.
host String M Enter the Host Name of the SMSC server.

The host can be Ipv4, Ipv6 or FQDN with optional port value.

By default, the value is left empty.
port Integer M Enter the Port number of the SMSC server.

Range: 0-65535

By default, the value is left empty.

Sample Request/Response body structure for PUT/POST operations:

{
    "name": "host_2",
    "host": "1.1.1.9",
    "port": 8002

}

Sample Request/Response body structure for POST operation to import the details:

{

"topic": "common.notifierservice.smschost",
  "sourceVersion": "1.6.0",
  "date": "2023-03-15T13:21:02Z",
  "exportData": [
    {
      "name": "host_4",
      "host": "1.1.1.7",
      "port": "8000"
    }]

}

2.80 Usage Monitoring

This section describes the APIs used to configure Usage Monitoring service.

2.80.1 Usage Monitoring Service

Table 2-358 Supported operations:

HTTP Method or Custom Operation Description Resource URI
GET Get Usage Monitoring Service {apiRoot}/oc-cnpolicy-configuration​/v1/services​/pcfum

For details on the Request/Response Body Parameters, see Table 2-359
PUT Update Usage Monitoring Service {apiRoot}/oc-cnpolicy-configuration​/v1/services​/pcfum

For details on the Request/Response Body Parameters, see Table 2-359
POST Import Usage Monitoring Service {apiRoot}/oc-cnpolicy-configuration​/v1/services​/pcfum/import

For details on the Request/Response Body Parameters, see Table 2-359
GET Export Usage Monitoring Service {apiRoot}/oc-cnpolicy-configuration​/v1/services​/pcfum/export

For details on the Request/Response Body Parameters, see Table 2-359

Table 2-359 Request/Response Body Parameters for GET/PUT/POST operations

Field Name Data Type Mandatory(M)/ Optional (O)/ Conditional (C) Description
enablePRE Boolean M Indicates whether to enable or disable interaction with PRE for Policy evaluation as per the match list.
minimumVolumeGrant Integer M Enter the minimum grant value (in bytes) that can be approved for volume based usage monitoring. If the grant value published by PRE is less than the value for this field, then Policy considers the minimum grant value out of the two.

After deducting the current grant, if the remaining grant value is less than the minimum grant value, then the remaining grant is also added to the current grant.

Default value: 2048

Range: 512 - 1048576 (1MB)

maximumVolumeGrant Integer M Enter the maximum grant value (in bytes) that can be approved for volume based usage monitoring. If the grant value published by PRE is greater than the value for this field, then Policy considers the maximum grant value out of the two.

Default value: 2048

Range: 1024 - 107374182400 (100 GB)

minimumTimeGrant Integer M Enter the minimum grant value (in seconds) that can be approved for time based usage monitoring. If the grant value published by PRE is less than the value for this field, then Policy considers the minimum grant value out of the two.

After deducting the current grant, if the remaining grant value is less than the minimum grant value, then the remaining grant is also added to the current grant.

Default value: 300

Range: 30 - 3600 (1 hour)

maximumTimeGrant Integer M Enter the maximum grant value (in seconds) that can be approved for time based usage monitoring. If the grant value published by PRE is greater than the value for this field, then Policy considers the maximum grant value out of the two.

Default value: 300

Range: 60 - 86400 (1 hour)

inactivityTime Integer O Enter the time interval (in seconds) during which if no packets are received for a given monitoring key, PGW or SMF stops measuring the time.

Default value: 86400

Range: 0 - 604800 (7 Days)

usageAccumulationStartDateTime Enumeration O Select the start time and date from when the Usage Monitoring service starts counting the usage reset periodicity. The values are:
  • Plan Start Date and Time: Counted from the plan start date and time as provisioned on the UDR.
  • Plan Activation Date and Time: Counted from the plan activation date and time as provisioned on the UDR.
  • Period Start Date and Time: Counted from the period start date and time.
weekStartDay Enumeration O Enter the starting day of the week.

Default value: Sunday

defaultVolumeGrant.grantVolumeSource Enumeration O Note: This field becomes active when you select Grant Unit as Percent.

Accepts one of the following values:

  • Initial Volume: Calculate grant volume from the initial volume.
  • Used Volume: Calculate grant volume from the used volume.
  • Remaining Volume: Calculate grant volume from the remaining volume.

Default value: Initial Volume

defaultVolumeGrant.grantVolumeUnit Enumeration O

Accepts one of the following values:

  • Percent: Grant volume is calculated as a percentage.
  • Bytes: Grant volume is calculated as an absolute value.

Default value: Percent

defaultVolumeGrant.grantVolumeValue Integer M If Grant Unit is Percent:

Enter the default Grant Volume in percentage, which is considered when PRE is not invoked or PRE does not return a decision.

This value is applied to the Total Volume and divided equally among the Uplink and Downlink Volumes when available.

Default value: 10

Range: 1-100

When the grant value is 0 and Grant is not calculated by PRE, then volume based Usage Monitoring is disabled for the session.

If Grant Unit is Bytes:

Enter the default Grant Volume in Bytes, which is considered when PRE is not invoked or PRE does not return a decision.

This value is applied to the Total Volume and divided equally among the Uplink and Downlink Volumes when available.

Default value: 2048

Range: 512 - 1048576 (1 MB)

When the grant value is 0 and Grant is not calculated by PRE, then volume based Usage Monitoring is disabled for the session.
defaultTimeGrant.grantTimeSource Enumeration O Note: This field becomes active when you select Grant Unit as Percent.

Accepts one of the following values:

  • Initial Duration: Calculate grant time from the initial duration.
  • Used Duration: Calculate grant time from the used duration.
  • Remaining Duration: Calculate grant time from the remaining duration.

Default value: Initial Volume

defaultTimeGrant.grantTimeUnit Enumeration O

Accepts one of the following values:

  • Percent: Grant time is calculated as a percentage.
  • Seconds: Grant time is calculated as an absolute value.

Default value: Percent

defaultTimeGrant.grantTimeValue Integer M

If Grant Unit is Percent:

Enter the default Grant time in percentage, which is considered when PRE is not invoked or PRE does not return a decision.

Default value: 10

Range: 1-100

When the grant value is 0 and grant is not calculated by PRE, then time based Usage Monitoring is disabled for the session.

If Grant Unit is Seconds:

Enter the default Grant time in seconds, which is considered when PRE is not invoked or PRE does not return a decision.

Default value: 3600

Range: 30 - 86400 (1 day)

When the grant value is 0 and grant is not calculated by PRE, then time based Usage Monitoring is disabled for the session.
defaultUsageLevels.minorUsageLevel Integer M Enter threshold value in percentage indicating minor usage.

Default value: 50

defaultUsageLevels.majorUsageLevel Integer M Enter threshold value in percentage indicating major usage.

Default value: 75

defaultUsageLevels.criticalUsageLevel Integer M Enter threshold value in percentage indicating critical usage.

Default value: 95

defaultUsageLevels.exhaustedUsageLevel Integer M Enter threshold value in percentage indicating usage level has exhausted allowed limit.

Default value: 100

customAttributeMapping.resetDay String O Enter a string identifying the custom attribute in UDR response that represents the usage reset day.

Example: SmPolicyData/umDataLimits/{limitId}/billingDay
customAttributeMapping.dataPlanName String O Maps the custom attribute available in the UDR provided data limit to name. A "name" associated with the data limit can be used in a Selection Profile to select the plan to apply when multiple active plans are found.Default vlaue: SmPolicyData/umDataLimits/{limitId}/name
customAttributeMapping.dataPlanPriority String O Maps the custom attribute available in the UDR provided data limit to priority. A "priority" associated with the data limit would help to select the plan to apply when multiple active plans are found.

Possible values allowed in this field in UDR Data Limit are: any integer.

Default value: SmPolicyData/umDataLimits/{limitId}/priority

customAttributeMapping.dataPlanType String O Maps the custom attribute available in the UDR provided data limit to type. A "type" associated with the data limit would help to order the selection of the plan.

Possible values allowed in this field in UDR Data Limit are: "base", "pass", "top-up".

A separate configuration would order the selection, for example: Pass > Base Plan > Top-up.

Default value: SmPolicyData/umDataLimits/{limitId}/type

Default value to apply if this mapped attribute is absent: base

The Plan Type, Priority within that Plan Type and the Selection Order of Plan Types together decide the order of selection of Data Plans.
customAttributeMapping.dataRollover String O Maps the custom attribute available in the UDR provided data limit to indicate whether rollover is enabled for this data limit.

Possible values allowed in this field in UDR Data Limit are: "true" and "false".

Default value: SmPolicyData/umDataLimits/{limitId}/rollover

Default value to apply if this mapped attribute is absent: false
conflictResolution.enableEtag Boolean O Indicates if the ETag functionality is enabled or disabled between PDS and UDR. By default, this is disabled. Following scenarios may occur if it is enabled:
  • When the Usage Monitoring service sends a GET request for the first time, then PDS will fetch latest ETag details from UDR and update it in THE pdssubscriber table.
  • when the Usage Monitoring service sends PATCH request to PDS, PDS sends the request to UDR using if-match header. UDR matches the ETag of PDS with UDR. If it matches, then UDR replies with the latest ETag that gets udpated on PDS.
  • If the If-Match headers failS, it means ETag on PDS does not match with UDR. UDR replies with 412 error response and based on the response code, Usage Monitoring service sends a force request to PDS to get the latest ETag from UDR and update it on PDS database.
conflictResolution.conflictRetryAttempt Integer O Specifies the number of retry the Usage Monitoring service will do when if-match will fail on UDR.Default value: 5
dataLimitSelection Reference O Indicates the data limit selection profile to use while selecting a data limit among more than one active data limits provided by UDR.

Sample Request/Response body structure for GET operation:

{
  "enablePRE": false,
  "minimumVolumeGrant": 512,
  "maximumVolumeGrant": 1000000,
  "minimumTimeGrant": 300,
  "maximumTimeGrant": 300,
  "inactivityTime": 86400,
  "usageAccumulationStartDateTime": "PLAN_ACTIVATION",
  "weekStartDay": "SUNDAY",
  "defaultVolumeGrant": {
    "grantVolumeSource": "INITIAL_VOLUME",
    "grantVolumeUnit": "VOLUME_PERCENT",
    "grantVolumeValue": 100
  },
  "defaultTimeGrant": {
    "grantTimeSource": "INITIAL_DURATION",
    "grantTimeUnit": "TIME_PERCENT",
    "grantTimeValue": 100
  },
  "defaultUsageLevels": {
    "minorUsageLevel": 50,
    "majorUsageLevel": 75,
    "criticalUsageLevel": 95,
    "exhaustedUsageLevel": 100
  },
  "customAttributeMapping": {
    "resetDay": "SmPolicyData/umDataLimits/{limitId}/billingDay",
    "dataPlanName": "SmPolicyData/umDataLimits/{limitId}/name",
    "dataPlanPriority": "SmPolicyData/umDataLimits/{limitId}/priority",
    "dataPlanType": "SmPolicyData/umDataLimits/{limitId}/type",
    "dataRollover": "SmPolicyData/umDataLimits/{limitId}/rollover",
    "dataRolloverProfileLimit": "SmPolicyData/umDataLimits/{limitId}/rolloverProfile"
  },
  "conflictResolution": {
    "enableEtag": false,
    "conflictRetryAttempt": 5
  },
"dataLimitSelection": 
{
    "selectionRules": [
      {
        "Enter Integer Value": 0,
        "limitIdentifier": "string",
        "conditions": [
          {
            "Parameter Name should be SERVING_NODE_LOCATION.": "SERVING_NODE_LOCATION",
            "Operator should be one of MATCH or EQUAL.": "MATCH",
            "value": "string"
          }
        ]
      }
    ],
    "sortingRules": [
      {
        "Enter Integer Value": 0,
        "Sorting Parameter Name should be one of RESET_PERIOD, START_DATE, END_DATE.": "RESET_PERIOD",
        "Sorting Order should be one of ASC, DSC.": "ASC"
      }
    ],
    "defaultDataLimitSelectionProfile": "string",
    "defaultDataLimitProfile": "string",
    "defaultDataLimitSortProfile": "string",
    "selectionOrder1": "base",
    "selectionOrder2": "base",
    "selectionOrder3": "base"
  }
}
}

2.80.2 Attribute Forwarding Profile

Table 2-360 Supported operations

HTTP Method or Custom Operation Description Resource URI
GET Get Attribute Forwarding Profile {apiRoot}/oc-cnpolicy-configuration​/v1/services​/common/attributeForwardingProfiles/{attributeForwardingProfileName}

where <attributeForwardingProfileName> is the attribute forwarding profile name.

PUT Update Attribute Forwarding Profile {apiRoot}/oc-cnpolicy-configuration​/v1/services​/common/attributeForwardingProfiles/{attributeForwardingProfileName}

where <attributeForwardingProfileName> is the attribute forwarding profile name.

DELETE Delete Attribute Forwarding Profile {apiRoot}/oc-cnpolicy-configuration​/v1/services​/common/attributeForwardingProfiles/{attributeForwardingProfileName}

where <attributeForwardingProfileName> is the attribute forwarding profile name.

POST Create Attribute Forwarding Profile {apiRoot}/oc-cnpolicy-configuration​/v1/services​/common/attributeForwardingProfiles/

For details on the Request/Response Body Parameters, see Table 2-361.

POST Import Attribute Forwarding Profile {apiRoot}/oc-cnpolicy-configuration​/v1/services​/common/attributeForwardingProfiles/import

For details on the Request/Response Body Parameters, see Table 2-361.

GET Export Attribute Forwarding Profile {apiRoot}/oc-cnpolicy-configuration​/v1/services​/common/attributeForwardingProfiles/export

For details on the Request/Response Body Parameters, see Table 2-361.

Table 2-361 Request/Response Body Parameters for GET and POST operations

Field Name Data Type Mandatory(M)/ Optional (O)/ Conditional (C) Description
forwardedAttribute.attributeName String C Name of the attribute.
forwardedAttribute.attributeSource Enumeration M

Source of the attribute to be forwarded.

Attribute Source provides the following options:

  • Request Message: The incoming request message such as Gx CCR message or SM Policy Association Create message.
  • User Data: Data received from different data sources such as UDR and CHF.
  • Session Data: Data saved in the session (association) previously, such as saved APN/DNN value.
forwardedAttribute.attributeSelection Enumeration M

Attribute Selection can be:

  • Predefined
  • Custom
forwardedAttribute.predefinedAttributeLocation String C

This parameter can be filled when the Attribute Selection is of Predefined type.

It indicates the path/location at which this attribute can be found by the source (forwarder) micro-service.
forwardedAttribute.attributeLocation String C

This parameter can be filled when the Attribute Selection is of Custom type.

It indicates the path/location at which this attribute can be found by the source (forwarder) micro-service.

Sample Request/Response body structure for GET operation:

{
  "name": "string",
  "forwardedAttribute": [
    {
      "attributeName": "string",
      "attributeSource": "enter any one value from [\"REQUEST\",\"UDR\",\"SESSION\"] ",
      "attributeSelection": "enter value from [\"PREDEFINED\",\"CUSTOM\"]",
      "predefinedAttributeLocation": "string",
      "attributeLocation": "string"
    }
  ]
}

2.80.3 UM Data Limit Selection Profile

Table 2-362 Supported Operations

HTTP Method or Custom Operation Description Resource URI
GET Get Usage Monitoring Data Limit Selection Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/datalimitselectionprofiles/{umDataLimitSelectionProfileName}

where <umDataLimitSelectionProfileName> is the Data Limit Selection profile name.

PUT Update Usage Monitoring Data Limit Selection Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/datalimitselectionprofiles/{umDataLimitSelectionProfileName}

where <umDataLimitSelectionProfileName> is the Data Limit Selection profile name.

DELETE Delete Usage Monitoring Data Limit Selection Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/datalimitselectionprofiles/{umDataLimitSelectionProfileName}

where <umDataLimitSelectionProfileName> is the Data Limit Selection profile name.

POST Create Usage Monitoring Data Limit Selection Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/datalimitselectionprofiles

For details on the Request/Response Body Parameters, see Table 2-363.

POST Import Usage Monitoring Data Limit Selection Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/datalimitselectionprofiles/import

For details on the Request/Response Body Parameters, see Table 2-363.

GET Export Usage Monitoring Data Limit Selection Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/datalimitselectionprofiles/export

For details on the Request/Response Body Parameters, see Table 2-363.

Table 2-363 Request/Response Body Parameters for GET operation

Field Name Data Type Mandatory(M)/ Optional (O)/ Conditional (C) Description
name String M Unique name to identify the Data Limit Selection Profile.
selectionRules.type Enumeration O Indicates the selection rules type.
selectionRules.priority Integer M Indicates the selection rule priority.
selectionRules.alwaysMatch Boolean M

When this is true, no conditions shall be evaluated. This can be used as a CATCH ALL Selection Rule.

Default: False
selectionRules.dataLimitProfile String C Uniquely identifies the UM Data Limit Profile by a name. This field is for configuration purpose only and not transmitted over the network.
selectionRules.limitIdentifier String C Specifies the limit identifier. Multiple limit identifiers may have the same priority.
selectionRules.conditions Object M  
selectionRules.conditions.parameterType    

Indicates the type of parameter on which the condition will be applied.

  • Forwarded Attribute - Am attribute forwarded by the core service, for e.g. Serving Gateway MCCMNC / IP Address, APN etc.
  • Policy Decision Tag - A Tag applied by the policy.
selectionRules.conditions.attributeName String C This field is displayed when Parameter Type is "Forwarded Attribute".
selectionRules.conditions.operator     Accepts the following values:
  • Equals
  • Not Equals
  • Less Than
  • Greater Than
  • Matches
selectionRules.conditions.value String   Displays the list of configured Match Lists when the Operator is "Matches".

Sample Request/Response body structure for GET operation:

{
  "name": "string",
  "selectionRules": [
    {
      "type": "DATA_LIMIT_PROFILE",
      "priority": 0,
      "alwaysMatch": true,
      "dataLimitProfile": "string",
      "limitIdentifier": "string",
      "conditions": [
        {
          "application": "Gx",
          "message": "CCR",
          "preDefinedAVPConditions": [
            {
              "conditionName": "CC-Request-Type",
              "conditionCSIDValue": [
                "5PuJiOlfDwxZihAhm6NDNp3rY7ikjSQ0zH.x0CSRJcJciVjiGvx7Iom88Ollacqa4nYh5Hjka8AT6GH5PX7lEvmEBk?N3H-7.S.-,3GBkb1pSVVDAPUUpkVc6pdLFV0JmRFVj9gsX?19G2O0oWAuUz,pte7QohKf*D.ktAh7vnMv, EynrpYPQeH?EUuRKReKIKzkF, YEUMYAUC9gPPdz4j6Y**j?BLP3Xa7CJsQZRUB5PdSBPsn2tsB6a-sqJFU*dX89.wtQclY.9AzpdxyzGOFTWxCGvm, 1a?dm?z5w2jrJyKG-GZbVLzYufX.t,1oVj3QJbMK4Y*vLph?KhAsd7ruIAXTueMkvR94OBhHAQunvrjJalArfIy?EslIIQSOrL04,Q-AWRGLoHqn*2QEW3gMnUFtB.pK,PvSQenBHhQCXX1LXa06DFScU?k9kZowN.YJj?O, 0RDkmNRXEBVSw1M8-8EDltiNZC.McRX?6kFUHb?um0PMokL,09zwYjVPlz79CMcV7y-*o*mbDcjpwQz,5dCwwVMVL.C07olXnHHeMmovtGtJgOR1Mtbl5E7ChzIq?hd6sXVNsOxIPf8W2anEce3daMbokR,PjRd9Gp?yAest8tbPHqTiT?6Hby*k6YoTIZ9c2OckZvoBBN,I780p0n5.olzVYArGFC-oc1G5, lID?nmOFRiMgFsWFZUruE1QV26oRPbuIQskynUrL.jWi9ZlBfI6lf.5DGKK.dDizZO,LYG1?JmHmlKoOQ.mWN1al.GhPtlkh340aUjcDN?er84neX07yoLFz-TfBL1vdOoR?6Ss9fLOhSegQotbN*n7Ry4tkOzaMaMXE, FOdwTd?mfoi2KJgq5Soq4CMBJCPJh3*Bjz.I5iX9zJPnCK5sqA2I7OqT9zINN?MS7SBfcEU.65oDMKSLi9pxf, 9J.bxbhlzxS*uL,7zQxMU7-E0.UvSswCvehTx.zSdro?iPUfjEIyx8aUOn3RUN58S7E*k0Bhdv7Pt?3G9l6gTR.lBb2EgyIpQV*h,XLqE?m*t1YlgeTb, J9124-LKRRWOP,kfpW*4k?P8wT-cBowa,Dwj*Esm1m23.J0Gw1Ed-TQF*SSoVaEav?-UqPfXV6nvArIUBnBzJMUqCQwMXDLCM,6vUhHjmyDW?vcnu, euBYyTo5IBxAGOvEyza*wBDjnGiw?NEqP*QIjoAjdoAjSKA,FdbezK3Cjy4tAHG0ra.7JRyuNT5yxP.vou214201aSy*YeYWhXad?.Vid*xOws44hAWT7JByXr4Af8sfvj48nlIGN, AKmPvd7EYo-N.mOYShwpTs-Vi6UmxtL9u5tli*Ob5RbyNUS,GpnM, LY*juuKhM9Sgu?jkSAds3IS8.2Qzp, C6BRbywARsHJb6ba4ml20DY.7LIVsKPcG8G.emPqN29sfXnuXAIi3*SL35CTGQp?q6E-jZwe.45LZt4ILLYt68r*thkd8v32ot,7rQAJnHVB?UO.o7YvNmktOx.ciYr7Gj3xq70O249ni1SSGauK-QCxCoWcUW9Z.I1jfGzu8wpyeZYxQqvKaRhM?17ua42r6A, XvLzXPbufOctdRw*w3s4B2x7Al*wVJJ9Ia?5k4xvdPKTGi, UZVg-ru6HaNWMSl816b5xHTjgO68kdRGT1TaS1Zt1XZ.G2OhuosmCllCYURb, 4qGLNr6Ta.95ralc46qHWlHQSwFwTtQnAD13LW.4*7WDQNk, tyIXQuZ610fA*tNRMQg,iUB0Nvd8lPXmR1M, 5GlY.9.fGiWcl-mnubYWUOvKxta,Ut5EY8hyPckHzCULO9c54Bx-Vp3sOI0PTJujddv*nNAPG?hhXb-lB.Ft02lEH4SknKOWT-44rkvKvyZF3msz4oskJpwArCCEc1, *nY.qw?Wel, j*S9zMJHwvpsdPoV.46dWO44eIwNyYT7YzQXaSt1q-f1IRNyo1uGC4fPQPg.U0BzVkiqCOIcDI2r8MEO9haDGb6EU, XNZAJ.HivrBOtMr3LFvCOKIyN?tXAyw-CCS*PEg, IwQnNRcICfUnAnIidRhj,ES3eJo2*3xhNc6lJRv*51HoORhDPCpdVgJ.IUV*jpgMlVzkVT4oeR?5tHOn-F, XtoBTW8j90sZWf36kV6VFxe, qdLVk6SEDSegGunGEZhvulLf01L8.?ADZ0o*OrfCUIzJEfu5j4LMjGheNtnjgh4B5,A2LKDqSkT3DkXVbJu5Q8YQhEEsjSKCmR,1F8TlHDG4BAVnq5*anQpC5tK7hHy.I*Pftn4UZuE0j, a, v4zUGHixr.r*St16Xncs3QKFIaU.T,nCt-4uF, PhRFYU8G4Nc7VHJpvFQExLMA7sQl4ls-nkFtMuBjMXO*6V.?P6Xg, .yJbwc-2P8T-,-FAlpkvcmBATTv88nK.1OuJNuQeglkE4xqs,JryE0c-SmixRXk3GJfPf,*cN.Zr6n3IlckTnLlnIaQ.ysiqutpvnIGOr0ZpSjpBVYK?7u.E-JKWAhvH8nMrZC6nhVpGpmnnvsHzz.qfQ0JIdsdthm6YLuSZ, 1i7jHTDynSj-T90.mT3egbaVBr*n8-eZVeUfhavn.yELKjbEPSuygrH93pZnZsLXlxcI4afvV1jw8po0lt,0f, i7YK68T6dqZ6j*WbK6zgPQ73ARnP6PO1cNO, XvUUiwH00?9?Rz4Hp4UCE9gxHnGy,dWaT7*5ibyG,Jq6MZk8PQzR0LJl5mWhiANdpb8rhy8cPemL7PF?OPyhFDJdI,Dbh1?*zybcqAmBg9-E4PzG0.oSrRraGWv11ND-OY?dhVgaUj6VJpnHk6N, N?p7AXv.-8mA6JfG-yc15tnHhqyPBCpMBc1S0,yFpLMhFHqCTKy4TMwbyD8FvwC6bIYNdZdNLF62?5Zy5l,qX..0-ommdbaAPmD9kint6SdjIPrbli2,yw1--71B0eSjY6jGNpNR8FNR91rLMch7oZgetxM*gtK, 1CyvRijp,9p0LA,ESEfBchgXXx1bOKkIV7A55J4mNlcIDaTwZUXqrpiG-sMMG6cxhk6T-otFghPnd4,A-JAshdlc4.yJP*XuyZHOLDRcNf, HhsPiLy?NmixbpEx-6Hf1s6dU7UEpFV?CFVV3PupWL*bllQk4L454d-zm4xWkaVGwQbtQVqfAY3t4mFxtVCQbvPh2uffhfE, ZrbXhJTz5IFnm26BTIcpB,FPsCxBP9mNmWT?bySieohK0YR?Fp7hXIobGruyPKzTkNvFKVVVAmb73V7?sJ7NTLiGsR2L4xIt5saE1p.AKW.P,W1WfcshFbi?cT3Khh-wiziCS5fz4nZd2uWnd-1FSd1rcJoIB5vnTkcQjqJ9z29y.MH8K0f6Yq,zAWXxKnF5yXSX8iFpqz4jnJ1if?*N6LnCxDTs6Z, -TShlFXHVYol786*39e3o9?425Q, 0CzKiUXp5N7FtBLEbn8pxdL1DDjgK,JmzzXR7RfG.qE8bidWwO7PayykvzcWHH3kyfPbY6xMUGLwtH938qQ3t6t0GGvz15ZCWR?kUC?Kcu1Oj?YXkA3,R3gxDFWiEb4ITqFSEw, E5RBdIP, dJM9GxsKtsUZlIlLub20O5*UAN7c-BIEczWwGKz0a2zfr7tySHmcxbXRM9Tex3gdv6utZwUCkrVji8pj95OUwMO7vprAU"
              ],
              "conditionCCRTValue": "UPDATE_REQUEST",
              "conditionRxRTValue": [
                "INITIAL_REQUEST"
              ],
              "conditionServiceURNIDValue": [
                "r,Vnj9p.MZlxvBFiLr*YRHTOxCfC*Y*kGmw-kB-8j1JqfnDcgqkfeKHFN1-GdHS4fvPx*AX5EagP4Xvx0Q2w*dBJrOpT5V, hF847pVFbHqx*yMYr7svKCj2TC?utLpLemQsq?Ikm0AINKaYbcrOzyZb3AzX?W-i.dnbl7iY80Wvd2.vL1V-5,NBBoxA-MTK67f9wQ2HDnNsizzFCD8lqH.T,jMurlbEhksKqTZkiaNWodBq8rTw9tBmRVJGeafW?BjsKNUoM4*F4R-o?, oi-J*D.Bj?JAv0puz0A2ESszsijiU6A-z2vHqpecCqzKCUsRlToqsNc893aVA.ew3POfG,H5P*BMKAhUpwTRtYHw0C3.?-hbGuJOSwWmDl6hKgc, 2a*xOi56aFNLcDPndiz, w3QBy95lwZe0c*TJw.2B7lG9L2um0sE59cToEvuu0SUNLMX4rKaPMqT6*.*VrN*XF, oUQYzJEEpZSPtmCWU-YkoWuh,jMCmrcRw-nRrBlu7Ci-EDqWW*?wjgbL-W2ODRfUXW*iIcIFKJwhuW0jk4p1OlJYf03m*7THq4GsdjhF-QNHYv,7jaCi70sg.XPXsqne9d,3J1Rl*-dfTT4m8?E.D.eYb4h8y*jqmYhblDv08HSF-T13eXUqOi0KBEvE--rMN,bo?HO9Iy--wXkBktsx9GBOWZFBcvfGFhUHADsi.lOLRKVBuIVaqQMm6i700feaUpMpFtaiVDw11K??0r8I.r?stWQ4U,cxKXwGZSZhclPy?XlzQGWgXkyhu1bKm9VXDj5nmAACInhZgk, 3ekMCjB..re2u4?2DjOyoCNz0J0SJ0eemy9cUPVJx9y7ION8YTvThy7wPsPKQSZvmZe-Ba9bQ*k,mExi2kiTTTtVbNid-m9jZkH0e5bcR?I2ICD7qvUwlbMLRg1*6pw.MwB5wWXOK8bnoA6LFXdOJfzS7Rmz-l3wIbjjAFg53U,?RXQ8lQ6LyNVfCut-WX9eadTgpW1iQy*a3ZtL5l7JJrVDsK7gB98OWj8Mxs9kuRUV,VQVRh0iRHPf21c2HoL1J7uqNQVpfXJgL?4lM2KhbIHAjKxfvbsV.v5UD8Cl, vEDZjr9N3PW3DgUgnwlsfpIE8dSv5lrFTYCmfm5xY4HISpgvLcwoOnR*9yj.,Vja26gB7J0A3N,OBMeELFhseaZ4bvRWizJeUoc3t4YSo., 3zDXsJ3p8uX7WC?LmYfdo6y, GHoE?2EVniTNRmeaPL7*gnzv3voUCRCJ64xepuMWQDba5GGyTfQ4ZB?ekWUNsW"
              ],
              "conditionMPSIdValue": [
                "string"
              ],
              "conditionMCPTTIdValue": [
                "string"
              ],
              "conditionMCVideoIdValue": [
                "string"
              ],
              "conditionReservPriorityValue": [
                "string"
              ],
              "conditionSNRTypeValue": [
                "ABORT_SESSION_REQUEST"
              ]
            }
          ]
        }
      ]
    }
  ],
  "sortingRules": [
    {
      "index": 0,
      "parameterType": "START_DATE",
      "attributeName": "string",
      "order": "string"
    }
  ]
}

2.80.4 UM Data Limit Profile

Table 2-364 Supported operations

HTTP Method or Custom Operation Description Resource URI
GET Get Usage Monitoring Data Limit Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/datalimitprofiles/{umDataLimitProfileName}

where <umDataLimitProfileName> is the Data Limit profile name.

PUT Update Usage Monitoring Data Limit Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/datalimitprofiles/{umDataLimitProfileName}

where <umDataLimitProfileName> is the Data Limit profile name.

DELETE Delete Usage Monitoring Data Limit Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/datalimitprofiles/{umDataLimitProfileName}

where <umDataLimitProfileName> is the Data Limit profile name.

POST Create Usage Monitoring Data Limit Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/datalimitprofiles

For details on the Request/Response Body Parameters, see Table 2-365.

POST Import Usage Monitoring Data Limit Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/datalimitprofiles/import

For details on the Request/Response Body Parameters, see Table 2-365.

GET Export Usage Monitoring Data Limit Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/datalimitprofiles/export

For details on the Request/Response Body Parameters, see Table 2-365.

Table 2-365 Request/Response Body Parameters for GET and POST operations

Field Name Data Type Mandatory(M)/ Optional (O)/ Conditional (C) Description
name String M Uniquely identifies the UM Data Limit Profile by a name. This field is for configuration purpose only and not transmitted over the network.
limitIdentifier String   Specifies the limit identifier. Multiple limit identifiers may have the same priority.
priority Integer O

A Priority to weigh it with other Data Limit Profiles and/or UDR provisioned Data Limits of the same Plan Type. The priority can be used by Policy or Data Limit Selection Profile for choosing among different candidate profiles.

The Plan Type, Priority within that Plan Type and the Selection Order of Plan Types together decide the order of selection of Data Plans.
umLevel Enumeration M

Indicates the level of the usage monitoring instance (PDU Session level or per Service).

Default value: Session Level

profileType Enumeration M

Type of the Data Limit Profile.

Default value: SUBSCRIBER

Note: Striked-out entries are for future.

planType Enumeration M

Type of the Plan such as Base, Top-up, and Pass. This help to determine the priority in selecting the plan over other types. The priority is configurable in service configuration screen.

Default value: Base

parentPlan Reference O Identifies a Data Limit Profile as a parent data plan. Any attribute that is not explicitly configured in this plan shall be taken from the parent plan (if present).
usageLimit Integer O

Indicates usage limit for this Data Limit Profile.

Default value: False

resetPeriod Enumeration O

Indicates whether the periodicity is "YEARLY", "MONTHLY", "WEEKLY", "DAILY" or "HOURLY".

Default value: Monthly

resetDay     Enter a string identifying the custom attribute in UDR response that represents the usage reset day.

Example: SmPolicyData/umDataLimits/{limitId}/billingDay
excessUsageLimit.percentage Integer O

Indicates the percentage of base volume/time up to which excess usage is allowed.

Range: 100 - 1500

Note: If all the Excess Usage Limit fields are left empty, the grant shall continue indefinitely.

excessUsageLimit.duration Integer O

Indicates the length of time in seconds. This is inclusive of the base duration. That is the value in this field indicates the total duration to be consumed including base + excess.

Range: 3600 - 31536000 (1 Year)

Note: If all the Excess Usage Limit fields are left empty, the grant shall continue indefinitely.

excessUsageLimit.volumeTotal Integer O

Total data octets for both downlink and uplink. This is inclusive of the base total volume.

Range: 512 - 1073741824000 (1000 GB)

Note: If all the Excess Usage Limit fields are left empty, the grant shall continue indefinitely.

excessUsageLimit.volumeUplink Integer O

Uplink data octets. This is inclusive of the base uplink volume.

Range: 512 - 1073741824000 (1000 GB)

Note: If all the Excess Usage Limit fields are left empty, the grant shall continue indefinitely.

excessUsageLimit.volumeDownlink Integer O

Downlink data octets. This is inclusive of the base downlink volume.

Range: 512 - 1073741824000 (1000 GB)

Note: If all the Excess Usage Limit fields are left empty, the grant shall continue indefinitely.

inactivityTime Integer O Enter the time interval (in seconds) during which if no packets are received for a given monitoring key, PGW or SMF stops measuring the time.

Default value: 86400

Range: 0 - 604800 (7 Days)

dataRolloverProfile Reference O To map the custom attribute available in the UDR provided data limit to a pre-configured rollover profile. See "Data Rollover Profile" for more information.

Possible values allowed in this field in UDR Data Limit are: A "Data Rollover Profile" name pre-configured on Policy.

Default value: SmPolicyData/umDataLimits/{limitId}/rolloverProfile

reversePriority Boolean O Indicates the priority consideration order.

When this flag is enabled: Higher number indicates lower priority

When this flag is disabled: Higher number indicates higher priority

Default value: true

allowExcessUsage Boolean O

Indicates whether or not excess usage is allowed for this Data Limit Profile. When Excess Usage is allowed, Usage Monitoring shall continue to grant and accumulate usage even after consuming 100% of allocated volume/time. The QoS, Charging etc. parameters can be controlled at PCRF Core Policy on account of the consumed usage.

Default value: False

Sample Request/Response body structure for GET operation:

{
  "name": "string",
  "limitIdentifier": "string",
  "monitoringKey": "string",
  "priority": "string",
  "umLevel": "SESSION_LEVEL",
  "profileType": "SUBSCRIBER",
  "planType": "BASE",
  "parentPlan": "string",
  "usageLimit": {
    "Enter in range [3600-2592000]": 3600,
    "Enter in range [512-107374182400]": 512
  },
  "resetPeriod": {
    "period": "MONTHLY",
    "Enter a number": 3
  },
  "resetDay": {
    "type": "FIRST_DAY",
    "day": 0,
    "Enter time in HH:MM:SS format": "00:00:00"
  },
  "excessUsageLimit": {
    "percentage": 1000,
    "duration": 2592000,
    "volumeTotal": 107374182400,
    "volumeUplink": 107374182400,
    "volumeDownlink": 107374182400
  },
  "inactivityTime": "string",
  "dataRolloverProfile": "string",
  "enableQuotaMigration": true,
  "reversePriority": true,
  "allowExcessUsage": true
}

2.80.5 Data Limit Sorting Profile

Table 2-366 Supported operations

HTTP Method or Custom Operation Description Resource URI
GET Get Data Limit Sorting Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/dataLimitSortingProfiles/{dataLimitSortingProfileName}

where <dataLimitSortingProfileName> is the Data Limit Sorting profile name.

PUT Update Data Limit Sorting Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/dataLimitSortingProfiles/{dataLimitSortingProfileName}

where <dataLimitSortingProfileName> is the Data Limit Sorting profile name.

DELETE Delete Data Limit Sorting Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/dataLimitSortingProfiles/{dataLimitSortingProfileName}

where <dataLimitSortingProfileName> is the Data Limit Sorting profile name.

POST Create Data Limit Sorting Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/dataLimitSortingProfiles

For details on the Request/Response Body Parameters, see Table 2-367.

POST Import Data Limit Sorting Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/dataLimitSortingProfiles/import

For details on the Request/Response Body Parameters, see Table 2-367.

GET Export Data Limit Sorting Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/dataLimitSortingProfiles/export

For details on the Request/Response Body Parameters, see Table 2-367.

Table 2-367 Request/Response Body Parameters for GET and POST operations

Field Name Data Type Mandatory(M)/ Optional (O)/ Conditional (C) Description
name String M Name of the Data Limit Sorting Profile
sortingRules.index Integer M Specifies the index. The sorting rules are applied in the order of index.
sortingRules.parameterType     Specifies the type of the parameter.
sortingRules.attributeName String C Specifies the name of the attribute.
sortingRules.order String O Specifies the order.

Sample Request/Response body structure for GET operation:

{
  "name": "string",
  "sortingRules": [
    {
      "index": 0,
      "parameterType": "START_DATE",
      "attributeName": "string",
      "order": "string"
    }
  ]
}

2.80.6 Data Rollover Profile

Table 2-368 Supported operations

HTTP Method or Custom Operation Description Resource URI
GET Get Data Rollover Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/dataRolloverProfiles/{dataRolloverProfileName}

where <dataRolloverProfileName> is the Data Rollover profile name.

PUT Update Data Rollover Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/dataRolloverProfiles/{dataRolloverProfileName}

where <dataRolloverProfileName> is the Data Rollover profile name.

DELETE Delete Data Rollover Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/dataRolloverProfiles/{dataRolloverProfileName}

where <dataRolloverProfileName> is the Data Rollover profile name.

POST Create Data Rollover Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/dataRolloverProfile

For details on the Request/Response Body Parameters, see Table 2-369.

POST Import Data Rollover Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/dataRolloverProfiles/import

For details on the Request/Response Body Parameters, see Table 2-369.

GET Export Data Rollover Profile {apiRoot}/oc-cnpolicy-configuration​/v1/policydata​/usagemon/dataRolloverProfiles/export

For details on the Request/Response Body Parameters, see Table 2-369.

Table 2-369 Request/Response Body Parameters for GET and POST operations

Field Name Data Type Mandatory(M)/ Optional (O)/ Conditional (C) Description
name String M Uniquely identifies the Data Rollover Profile by a name.
dataRolloverEnabled Boolean M Indicates whether to enable or disable the data rollover.
rolloverDataConsumption Enumeration M Indicates when to consume the rollover data.
maximumNumberOfRollovers Integer M

Indicates how many cycles the data plan can rollover. A value of 0 means there is not limit to the number of cycles the left over data can rollover.

Range: 0 to 24

Default value: 0 (No limit)

dataRolloverPercentage Integer M

This field indicates the percentage of left over data volume/time to rollover to the next cycle.

Range: 0 to 100

Default value: 100.

rolloverCap Boolean M Indicates whether to enable or disable a cap (maximum limit) on the total data volume/time to be allotted for the next billing cycle or period. The maximum cap shall be applied on the total of base plan volume/time and total accumulated rolled over volume/time.
maximunRolloverThreshold.baseDataPercentage Integer O

Indicates the percentage of base plan data volume/time that is allowed as rollover data volume/time.

Range: 0 to 100

maximunRolloverThreshold.maximunDurationThreshold Integer O

Indicates the length of time in seconds.

Range: 3600 - 2592000 (30 Days)

maximunRolloverThreshold.maximunVolumeTotalThreshold Integer O

Total data octets for both downlink and uplink.

Range: 512 - 107374182400 (100 GB)

maximunRolloverThreshold.maximunVolumeUplinkThreshold Integer O

Uplink data octets.

Range: 512 - 107374182400 (100 GB)

maximunRolloverThreshold.maximunVolumeDownlinkThreshold Integer O

Downlink data octets.

Range: 512 - 107374182400 (100 GB)

minimunRolloverThreshold.minimunDurationThreshold Integer O

Indicates the length of time in seconds. The remaining duration if applicable shall be rolled over to the next period if it is greater than the threshold value configured here.

Range: 0 - 2592000 (30 Days)

minimunRolloverThreshold.minimunVolumeTotalThreshold Integer O

Total data octets for both downlink and uplink. The remaining total volume if applicable shall be rolled over to the next period if it is greater than the threshold value configured here.

Range: 0 - 107374182400 (100 GB)

minimunRolloverThreshold.minimunVolumeUplinkThreshold Integer O

Uplink data octets. The remaining uplink volume if applicable shall be rolled over to the next period if it is greater than the threshold value configured here.

Range: 0 - 107374182400 (100 GB)

minimunRolloverThreshold.minimunVolumeDownlinkThreshold Integer O

Downlink data octets. The remaining downlink volume if applicable shall be rolled over to the next period if it is greater than the threshold value configured here.

Range: 0 - 107374182400 (100 GB)

rolloverCapSettings.duration Integer C

Indicates the length of time in seconds.

Range: 3600 - 2592000 (30 Days)

rolloverCapSettings.volumeTotal Integer C

Total data octets for both downlink and uplink.

Range: 512 - 107374182400 (100 GB)

rolloverCapSettings.volumeUplink Integer C

Uplink data octets.

Range: 512 - 107374182400 (100 GB)

rolloverCapSettings.volumeDownlink Integer C

Downlink data octets.

Range: 512 - 107374182400 (100 GB)

Sample Request/Response body structure for GET operation:

{
  "name": "string",
  "dataRolloverEnabled": true,
  "rolloverDataConsumption": "BEFORE_PARENT_PLAN",
  "maximumNumberOfRollovers": 0,
  "dataRolloverPercentage": 0,
  "rolloverCap": true,
  "maximunRolloverThreshold": {
    "baseDataPercentage": 100,
    "maximunDurationThreshold": 2592000,
    "maximunVolumeTotalThreshold": 107374182400,
    "maximunVolumeUplinkThreshold": 107374182400,
    "maximunVolumeDownlinkThreshold": 107374182400
  },
  "minimunRolloverThreshold": {
    "minimunDurationThreshold": 2592000,
    "minimunVolumeTotalThreshold": 107374182400,
    "minimunVolumeUplinkThreshold": 107374182400,
    "minimunVolumeDownlinkThreshold": 107374182400
  },
  "rolloverCapSettings": {
    "duration": 2592000,
    "volumeTotal": 107374182400,
    "volumeUplink": 107374182400,
    "volumeDownlink": 107374182400
  }
}