REST API Specification
This appendix provides a sample of REST API specification in PCF.
swagger: '2.0'
info:
description: 'The restAPI to update/get/delete/create PCF Configuration '
version: 1.0.0
title: Pcf Configurations
contact:
email: xxxxxx@oracle.com
license:
name: Oracle
url: 'http://www.oracle.com'
host: 'localhost:8443'
basePath: /
tags:
- name: diameter-api-controller
description: the diameter API
- name: global-api-controller
description: the global API
- name: policy-api-controller
description: the policy API
- name: service-api-controller
description: the service API
paths:
/ocpm/pcf/v1/configuration/diameter/peernode:
post:
tags:
- Peer Node
summary: Create Peer Node
operationId: createPeerNode
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/PeerNode'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PeerNode'
'201':
description: Created
schema:
$ref: '#/definitions/PeerNode'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
'/ocpm/pcf/v1/configuration/diameter/peernode/{peernodeName}':
get:
tags:
- Peer Node
summary: Get Peer Node
operationId: getPeerNode
produces:
- application/json
parameters:
- name: peernodeName
in: path
description: Peer Node Name
required: true
type: string
responses:
'200':
description: OK.Peer Node is returned
schema:
$ref: '#/definitions/PeerNode'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
put:
tags:
- Peer Node
summary: Update Peer Node
operationId: updatePeerNode
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/PeerNode'
- name: peernodeName
in: path
description: Peer Node Name
required: true
type: string
responses:
'200':
description: Updated Peer Node
schema:
$ref: '#/definitions/PeerNode'
'201':
description: Created
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
delete:
tags:
- Peer Node
summary: Delete Peer Node
operationId: deletePeerNode
produces:
- '*/*'
parameters:
- name: peernodeName
in: path
description: Peer Node Name
required: true
type: string
responses:
'200':
description: OK
'204':
description: Peer Node was succesfully deleted
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
/ocpm/pcf/v1/configuration/diameter/settings:
get:
tags:
- Diameter Settings
summary: Get Diameter Settings
operationId: getDiamSettings
produces:
- application/json
responses:
'200':
description: OK.Diameter Settings are returned
schema:
$ref: '#/definitions/DiamSettings'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
put:
tags:
- Diameter Settings
summary: Update Diameter Settings
operationId: updateDiamSettings
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/DiamSettings'
responses:
'200':
description: Updated.
schema:
$ref: '#/definitions/DiamSettings'
'201':
description: Created
schema:
$ref: '#/definitions/DiamSettings'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
/ocpm/pcf/v1/configuration/global:
get:
tags:
- Global Configurations
summary: Get Individual Global Configuration
operationId: getGlobalConfiguration
produces:
- application/json
responses:
'200':
description: OK.Global configuration is returned
schema:
$ref: '#/definitions/PCFGlobalConfigurations'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
put:
tags:
- Global Configurations
summary: Update Global Configuration.
operationId: updateGlobalConfiguration
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/PCFGlobalConfigurations'
responses:
'200':
description: Ok
schema:
$ref: '#/definitions/PCFGlobalConfigurations'
'201':
description: Created
schema:
$ref: '#/definitions/PCFGlobalConfigurations'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
/ocpm/pcf/v1/configuration/policy/am/servicearearestrictions:
post:
tags:
- Service Area Restriction
summary: Create Service Area Restriction
operationId: createServiceAreaRestriction
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/ServiceAreaRestriction'
responses:
'200':
description: OK. Resource representation is returned
schema:
$ref: '#/definitions/ServiceAreaRestriction'
'201':
description: Created
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
'/ocpm/pcf/v1/configuration/policy/am/servicearearestrictions/{serviceAreaRestrictionName}':
get:
tags:
- Service Area Restriction
summary: Get Service Area Restriction
operationId: getServiceAreaRestriction
produces:
- application/json
parameters:
- name: serviceAreaRestrictionName
in: path
description: Service Area Restriction Name
required: true
type: string
responses:
'200':
description: Resource fetched successfully
schema:
$ref: '#/definitions/ServiceAreaRestriction'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
put:
tags:
- Service Area Restriction
summary: Update Service Area Restriction
operationId: updateServiceAreaRestriction
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/ServiceAreaRestriction'
- name: serviceAreaRestrictionName
in: path
description: Service Area Restriction Name
required: true
type: string
responses:
'200':
description: OK. Resource representation is returned
schema:
$ref: '#/definitions/ServiceAreaRestriction'
'201':
description: Created
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
delete:
tags:
- Service Area Restriction
summary: Delete Service Area Restriction
operationId: deleteServiceAreaRestriction
produces:
- '*/*'
parameters:
- name: serviceAreaRestrictionName
in: path
description: Service Area Restriction Name
required: true
type: string
responses:
'200':
description: Resource deleted successfully
'204':
description: No Content
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
/ocpm/pcf/v1/configuration/policy/common/pras:
post:
tags:
- Presence Reporting Area
summary: Create Presence Reporting Area
operationId: createPresenceReportingArea
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/PresenceReportingArea'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PresenceReportingArea'
'201':
description: Created
schema:
$ref: '#/definitions/PresenceReportingArea'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
'/ocpm/pcf/v1/configuration/policy/common/pras/{presenceReportingAreaName}':
get:
tags:
- Presence Reporting Area
summary: Get Presence Reporting Area
operationId: getPresenceReportingArea
produces:
- application/json
parameters:
- name: presenceReportingAreaName
in: path
description: Presence Reporting Area Name
required: true
type: string
responses:
'200':
description: OK. Presence Reporting Area is returned
schema:
$ref: '#/definitions/PresenceReportingArea'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
put:
tags:
- Presence Reporting Area
summary: Update Presence Reporting Area
operationId: updatePresenceReportingArea
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/PresenceReportingArea'
- name: presenceReportingAreaName
in: path
description: Presence Reporting Area Name
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PresenceReportingArea'
'201':
description: Updated
schema:
$ref: '#/definitions/PresenceReportingArea'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
delete:
tags:
- Presence Reporting Area
summary: Delete Presence Reporting Area
operationId: deletePresenceReportingArea
produces:
- '*/*'
parameters:
- name: presenceReportingAreaName
in: path
description: Presence Reporting Area Name
required: true
type: string
responses:
'200':
description: OK
'204':
description: No Content. Presence Reporting Area was succesfully deleted
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
/ocpm/pcf/v1/configuration/policy/smpolicy/chargingdata:
post:
tags:
- Charging Data
summary: Create Charging Data
operationId: createChargingData
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/ChargingData'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ChargingData'
'201':
description: Created
schema:
$ref: '#/definitions/ChargingData'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
'/ocpm/pcf/v1/configuration/policy/smpolicy/chargingdata/{chargingDataName}':
get:
tags:
- Charging Data
summary: Get Charging Data
operationId: getChargingData
produces:
- application/json
parameters:
- name: chargingDataName
in: path
description: Charging Data Name
required: true
type: string
responses:
'200':
description: OK.Charging Data is returned
schema:
$ref: '#/definitions/ChargingData'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
put:
tags:
- Charging Data
summary: Update Charging Data
operationId: updateChargingData
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/ChargingData'
- name: chargingDataName
in: path
description: Charging Data Name
required: true
type: string
responses:
'200':
description: Update Charging Data
schema:
$ref: '#/definitions/ChargingData'
'201':
description: Created
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
delete:
tags:
- Charging Data
summary: Delete Charging Data
operationId: deleteChargingData
produces:
- '*/*'
parameters:
- name: chargingDataName
in: path
description: Charging Data Name
required: true
type: string
responses:
'200':
description: OK
'204':
description: Charging Data was succesfully deleted
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
/ocpm/pcf/v1/configuration/policy/smpolicy/conditiondata:
post:
tags:
- Condition Data
summary: Create Condition Data
operationId: createConditionData
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/ConditionData'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ConditionData'
'201':
description: Created
schema:
$ref: '#/definitions/ConditionData'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
'/ocpm/pcf/v1/configuration/policy/smpolicy/conditiondata/{conditionDataName}':
get:
tags:
- Condition Data
summary: Get Condition Data
operationId: getConditionData
produces:
- application/json
parameters:
- name: conditionDataName
in: path
description: Condition Data Name
required: true
type: string
responses:
'200':
description: OK.Condition Data is returned
schema:
$ref: '#/definitions/ConditionData'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
put:
tags:
- Condition Data
summary: Update Condition Data
operationId: updateConditionData
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/ConditionData'
- name: conditionDataName
in: path
description: Condition Data Name
required: true
type: string
responses:
'200':
description: Updated Condition Data
schema:
$ref: '#/definitions/ConditionData'
'201':
description: Created
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
delete:
tags:
- Condition Data
summary: Delete Condition Data
operationId: deleteConditionData
produces:
- '*/*'
parameters:
- name: conditionDataName
in: path
description: Condition Data Name
required: true
type: string
responses:
'200':
description: OK
'204':
description: Condition Data was succesfully deleted
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
/ocpm/pcf/v1/configuration/policy/smpolicy/pccruleprofiles:
post:
tags:
- PCC Rule Profile
summary: Create PCC Rule Profile
operationId: createPccRuleProfile
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/PccRuleProfile'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PccRuleProfile'
'201':
description: Created
schema:
$ref: '#/definitions/PccRuleProfile'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
'/ocpm/pcf/v1/configuration/policy/smpolicy/pccruleprofiles/{pccRuleProfileId}':
get:
tags:
- PCC Rule Profile
summary: Get PCC Rule Profile
operationId: getPccRuleProfile
produces:
- application/json
parameters:
- name: pccRuleProfileId
in: path
description: PCC Rule Profile Id
required: true
type: string
responses:
'200':
description: OK.PCC Rule Profile is returned
schema:
$ref: '#/definitions/PccRuleProfile'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
put:
tags:
- PCC Rule Profile
summary: Update Pcc Rule Profile
operationId: updatePccRuleProfile
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/PccRuleProfile'
- name: pccRuleProfileId
in: path
description: PCC Rule Profile Id
required: true
type: string
responses:
'200':
description: Updated PCC Rule Profile
schema:
$ref: '#/definitions/PccRuleProfile'
'201':
description: Created
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
delete:
tags:
- PCC Rule Profile
summary: Delete PCC Rule Profile
operationId: deletePCCRuleProfile
produces:
- '*/*'
parameters:
- name: pccRuleProfileId
in: path
description: PCC Rule Profile Id
required: true
type: string
responses:
'200':
description: OK
'204':
description: PCC Rule Profile was succesfully deleted
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
/ocpm/pcf/v1/configuration/policy/smpolicy/pccrules:
post:
tags:
- PCC Rule
summary: Create PCC Rule
operationId: createPccRule
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/PccRule'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PccRule'
'201':
description: Created
schema:
$ref: '#/definitions/PccRule'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
'/ocpm/pcf/v1/configuration/policy/smpolicy/pccrules/{pccRuleId}':
get:
tags:
- PCC Rule
summary: Get PCC Rule
operationId: getPCCRule
produces:
- application/json
parameters:
- name: pccRuleId
in: path
description: PCC Rule Id
required: true
type: string
responses:
'200':
description: OK.PCC Rule is returned
schema:
$ref: '#/definitions/PccRule'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
put:
tags:
- PCC Rule
summary: Update PCC Rule
operationId: updatePCCRule
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/PccRule'
- name: pccRuleId
in: path
description: PCC Rule Id
required: true
type: string
responses:
'200':
description: Updated PCC Rule
schema:
$ref: '#/definitions/PccRule'
'201':
description: Created
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
delete:
tags:
- PCC Rule
summary: Delete PCC Rule
operationId: deletePCCRule
produces:
- '*/*'
parameters:
- name: pccRuleId
in: path
description: PCC Rule Id
required: true
type: string
responses:
'200':
description: OK
'204':
description: PCC Rule was succesfully deleted
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
/ocpm/pcf/v1/configuration/policy/smpolicy/policycounterids:
post:
tags:
- Policy Counter Id
summary: Create Policy Counter Id
operationId: createPolicyCounterId
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/PolicyCounterId'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PolicyCounterId'
'201':
description: Created
schema:
$ref: '#/definitions/PolicyCounterId'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
'/ocpm/pcf/v1/configuration/policy/smpolicy/policycounterids/{policyCounterIdName}':
get:
tags:
- Policy Counter Id
summary: Get Policy Counter Id
operationId: getPolicyCounterId
produces:
- application/json
parameters:
- name: policyCounterIdName
in: path
description: Policy Counter Id's Name
required: true
type: string
responses:
'200':
description: OK.Policy Counter Id is returned
schema:
$ref: '#/definitions/PolicyCounterId'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
put:
tags:
- Policy Counter Id
summary: Update Policy Counter Id
operationId: updatePolicyCounterId
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/PolicyCounterId'
- name: policyCounterIdName
in: path
description: Policy Counter Id Name
required: true
type: string
responses:
'200':
description: Updated Policy Counter Id
schema:
$ref: '#/definitions/PolicyCounterId'
'201':
description: Created
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
delete:
tags:
- Policy Counter Id
summary: Delete Policy Counter Id
operationId: deletePolicyCounterId
produces:
- '*/*'
parameters:
- name: policyCounterIdName
in: path
description: Policy Counter Id's Name
required: true
type: string
responses:
'200':
description: OK
'204':
description: Policy Counter Id was succesfully deleted
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
/ocpm/pcf/v1/configuration/policy/smpolicy/qosdata:
post:
tags:
- Qos Data
summary: Create Qos Data
operationId: createQosData
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/QosData'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/QosData'
'201':
description: Created
schema:
$ref: '#/definitions/QosData'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
'/ocpm/pcf/v1/configuration/policy/smpolicy/qosdata/{qosDataName}':
get:
tags:
- Qos Data
summary: Get Qos Data
operationId: getQosData
produces:
- application/json
parameters:
- name: qosDataName
in: path
description: Qos Data Name
required: true
type: string
responses:
'200':
description: OK.Qos Data is returned
schema:
$ref: '#/definitions/QosData'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
put:
tags:
- Qos Data
summary: Update Qos Data
operationId: updateQosData
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/QosData'
- name: qosDataName
in: path
description: Qos Data Name
required: true
type: string
responses:
'200':
description: Updated Qos Data
schema:
$ref: '#/definitions/QosData'
'201':
description: Created
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
delete:
tags:
- Qos Data
summary: Delete Qos Data
operationId: deleteQosData
produces:
- '*/*'
parameters:
- name: qosDataName
in: path
description: Qos Data Name
required: true
type: string
responses:
'200':
description: OK
'204':
description: Qos Data was succesfully deleted
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
/ocpm/pcf/v1/configuration/policy/smpolicy/qosinformation:
post:
tags:
- Qos Information
summary: Create Qos Information
operationId: createQosInformation
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/QosInformation'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/QosInformation'
'201':
description: Created
schema:
$ref: '#/definitions/QosInformation'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
'/ocpm/pcf/v1/configuration/policy/smpolicy/qosinformation/{qosInformationName}':
get:
tags:
- Qos Information
summary: Get Qos Information
operationId: getQosInformation
produces:
- application/json
parameters:
- name: qosInformationName
in: path
description: Qos Information Name
required: true
type: string
responses:
'200':
description: OK. Qos Information is returned
schema:
$ref: '#/definitions/QosInformation'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
put:
tags:
- Qos Information
summary: Update Qos Information
operationId: updateQosInformation
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/QosInformation'
- name: qosInformationName
in: path
description: Qos Information Name
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/QosInformation'
'201':
description: Updated
schema:
$ref: '#/definitions/QosInformation'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
delete:
tags:
- Qos Information
summary: Delete Qos Information
operationId: deleteQosInformation
produces:
- '*/*'
parameters:
- name: qosInformationName
in: path
description: Qos Information Name
required: true
type: string
responses:
'200':
description: OK
'204':
description: Qos Information was succesfully deleted
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
/ocpm/pcf/v1/configuration/policy/smpolicy/sessionruleprofiles:
post:
tags:
- Session Rule Profile
summary: Create Session Rule Profile
operationId: createSessionRuleProfile
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/SessionRuleProfile'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/SessionRuleProfile'
'201':
description: Created
schema:
$ref: '#/definitions/SessionRuleProfile'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
'/ocpm/pcf/v1/configuration/policy/smpolicy/sessionruleprofiles/{sessionRuleProfileId}':
get:
tags:
- Session Rule Profile
summary: Get Session Rule Profile
operationId: getSessionRuleProfile
produces:
- application/json
parameters:
- name: sessionRuleProfileId
in: path
description: Session Rule Profile Id
required: true
type: string
responses:
'200':
description: OK. Session Rule Profile is returned
schema:
$ref: '#/definitions/SessionRuleProfile'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
put:
tags:
- Session Rule Profile
summary: Update Session Rule Profile
operationId: updateSessionRuleProfile
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/SessionRuleProfile'
- name: sessionRuleProfileId
in: path
description: Session Rule Profile Id
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/SessionRuleProfile'
'201':
description: Updated
schema:
$ref: '#/definitions/SessionRuleProfile'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
delete:
tags:
- Session Rule Profile
summary: Delete Session Rule Profile
operationId: deleteSessionRuleProfile
produces:
- '*/*'
parameters:
- name: sessionRuleProfileId
in: path
description: Session Rule Profile Id
required: true
type: string
responses:
'200':
description: OK
'204':
description: Session Rule Profile was succesfully deleted
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
/ocpm/pcf/v1/configuration/policy/smpolicy/sessionrules:
post:
tags:
- Session Rule
summary: Create Session Rule
operationId: createSessionRule
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/SessionRule'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/SessionRule'
'201':
description: Created
schema:
$ref: '#/definitions/SessionRule'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
'/ocpm/pcf/v1/configuration/policy/smpolicy/sessionrules/{sessionRuleId}':
get:
tags:
- Session Rule
summary: Get Session Rule
operationId: getSessionRule
produces:
- application/json
parameters:
- name: sessionRuleId
in: path
description: Session Rule Id
required: true
type: string
responses:
'200':
description: OK. Session Rule is returned
schema:
$ref: '#/definitions/SessionRule'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
put:
tags:
- Session Rule
summary: Update Session Rule
operationId: updateSessionRule
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/SessionRule'
- name: sessionRuleId
in: path
description: Session Rule Id
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/SessionRule'
'201':
description: Updated
schema:
$ref: '#/definitions/SessionRule'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
delete:
tags:
- Session Rule
summary: Delete Session Rule
operationId: deleteSessionRule
produces:
- '*/*'
parameters:
- name: sessionRuleId
in: path
description: Session Rule Id
required: true
type: string
responses:
'200':
description: OK
'204':
description: No Content. Session Rule was succesfully deleted
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
/ocpm/pcf/v1/configuration/policy/smpolicy/trafficcontroldata:
post:
tags:
- Traffic Control Data
summary: Create Traffic Control Data
operationId: createTrafficControlData
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/TrafficControlData'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/TrafficControlData'
'201':
description: Created
schema:
$ref: '#/definitions/TrafficControlData'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
'/ocpm/pcf/v1/configuration/policy/smpolicy/trafficcontroldata/{trafficControlDataName}':
get:
tags:
- Traffic Control Data
summary: Get Traffic Control Data
operationId: getTrafficControlData
produces:
- application/json
parameters:
- name: trafficControlDataName
in: path
description: Traffic Control Data Name
required: true
type: string
responses:
'200':
description: OK.Traffic Control Data is returned
schema:
$ref: '#/definitions/TrafficControlData'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
put:
tags:
- Traffic Control Data
summary: Update Traffic Control Data
operationId: updateTrafficControlData
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/TrafficControlData'
- name: trafficControlDataName
in: path
description: Traffic Control Data Name
required: true
type: string
responses:
'200':
description: Updated Traffic Control Data
schema:
$ref: '#/definitions/TrafficControlData'
'201':
description: Created
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
delete:
tags:
- Traffic Control Data
summary: Delete Traffic Control Data
operationId: deleteTrafficControlData
produces:
- '*/*'
parameters:
- name: trafficControlDataName
in: path
description: Traffic Control Data Name
required: true
type: string
responses:
'200':
description: OK
'204':
description: Traffic Control Data was succesfully deleted
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
/ocpm/pcf/v1/configuration/policy/smpolicy/usagemonitoringdata:
post:
tags:
- Usage Monitoring Data
summary: Create Usage Monitoring Data
operationId: createUsageMonitoringData
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/UsageMonitoringData'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/UsageMonitoringData'
'201':
description: Created
schema:
$ref: '#/definitions/UsageMonitoringData'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
'/ocpm/pcf/v1/configuration/policy/smpolicy/usagemonitoringdata/{usageMonitoringDataName}':
get:
tags:
- Usage Monitoring Data
summary: Get Usage Monitoring Data
operationId: getUsageMonitoringData
produces:
- application/json
parameters:
- name: usageMonitoringDataName
in: path
description: Usage Monitoring Data Name
required: true
type: string
responses:
'200':
description: OK.Usage Monitoring Data is returned
schema:
$ref: '#/definitions/UsageMonitoringData'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
put:
tags:
- Usage Monitoring Data
summary: Update Usage Monitoring Data
operationId: updateUsageMonitoringData
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/UsageMonitoringData'
- name: usageMonitoringDataName
in: path
description: Usage Monitoring Data Name
required: true
type: string
responses:
'200':
description: Updated Usage Monitoring Data
schema:
$ref: '#/definitions/UsageMonitoringData'
'201':
description: Created
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
delete:
tags:
- Usage Monitoring Data
summary: Delete Usage Monitoring Data
operationId: deleteUsageMonitoringData
produces:
- '*/*'
parameters:
- name: usageMonitoringDataName
in: path
description: Usage Monitoring Data Name
required: true
type: string
responses:
'200':
description: OK
'204':
description: Usage Monitoring Data was succesfully deleted
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
/ocpm/pcf/v1/configuration/policy/userpolicy/upsis:
post:
tags:
- UPSI
summary: Create UPSI
operationId: createUpsi
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/Upsi'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Upsi'
'201':
description: Created
schema:
$ref: '#/definitions/Upsi'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
'/ocpm/pcf/v1/configuration/policy/userpolicy/upsis/{upsiName}':
get:
tags:
- UPSI
summary: Get UPSI
operationId: getUPSI
produces:
- application/json
parameters:
- name: upsiName
in: path
description: UPSI Name
required: true
type: string
responses:
'200':
description: OK.UPSI is returned
schema:
$ref: '#/definitions/Upsi'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
put:
tags:
- UPSI
summary: Update UPSI
operationId: updateUpsi
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/Upsi'
- name: upsiName
in: path
description: UPSI Name
required: true
type: string
responses:
'200':
description: Updated UPSI
schema:
$ref: '#/definitions/Upsi'
'201':
description: Created
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
delete:
tags:
- UPSI
summary: Delete UPSI
operationId: deleteUPSI
produces:
- '*/*'
parameters:
- name: upsiName
in: path
description: UPSI Name
required: true
type: string
responses:
'200':
description: OK
'204':
description: UPSI was succesfully deleted
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
/ocpm/pcf/v1/configuration/policy/userpolicy/ursps:
post:
tags:
- URSP
summary: Create URSP
operationId: createUrsp
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/Ursp'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Ursp'
'201':
description: Created
schema:
$ref: '#/definitions/Ursp'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
'/ocpm/pcf/v1/configuration/policy/userpolicy/ursps/{urspName}':
get:
tags:
- URSP
summary: Get URSP
operationId: getURSP
produces:
- application/json
parameters:
- name: urspName
in: path
description: URSP Nane
required: true
type: string
responses:
'200':
description: OK.URSP is returned
schema:
$ref: '#/definitions/Ursp'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
put:
tags:
- URSP
summary: Update URSP
operationId: updateURSP
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/Ursp'
- name: urspName
in: path
description: URSP Name
required: true
type: string
responses:
'200':
description: Updated URSP
schema:
$ref: '#/definitions/Ursp'
'201':
description: Created
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
delete:
tags:
- URSP
summary: Delete URSP
operationId: deleteURSP
produces:
- '*/*'
parameters:
- name: urspName
in: path
description: URSP Name
required: true
type: string
responses:
'200':
description: OK
'204':
description: URSP was succesfully deleted
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
/ocpm/pcf/v1/configuration/service/am:
get:
tags:
- Access and Mobility Service
summary: Get Access and Mobility Service
operationId: getAccessandMobilityService
produces:
- application/json
responses:
'200':
description: OK. Access and Mobility Service returned
schema:
$ref: '#/definitions/AccessandMobilityService'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
put:
tags:
- Access and Mobility Service
summary: Update Access and Mobility Service
operationId: updateAccessandMobilityService
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/AccessandMobilityService'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/AccessandMobilityService'
'201':
description: Updated
schema:
$ref: '#/definitions/AccessandMobilityService'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
/ocpm/pcf/v1/configuration/service/pa:
get:
tags:
- Policy Authorization Service
summary: Get Policy Authorization Service
operationId: getPolicyAuthorizationService
produces:
- application/json
responses:
'200':
description: OK. Resource representation is returned
schema:
$ref: '#/definitions/PolicyAuthorizationService'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
put:
tags:
- Policy Authorization Service
summary: Update Policy Authorization Service
operationId: updatePolicyAuthorizationService
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/PolicyAuthorizationService'
responses:
'200':
description: Updated.
schema:
$ref: '#/definitions/PolicyAuthorizationService'
'201':
description: Created
schema:
$ref: '#/definitions/PolicyAuthorizationService'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
/ocpm/pcf/v1/configuration/service/sm:
get:
tags:
- Session Management Service
summary: Get Session Management Service
operationId: getSessionManagementService
produces:
- application/json
responses:
'200':
description: OK. Session Management Service returned
schema:
$ref: '#/definitions/SessionManagementService'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
put:
tags:
- Session Management Service
summary: Update Session Management Service
operationId: updateSessionManagementService
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/SessionManagementService'
responses:
'200':
description: Updated.
schema:
$ref: '#/definitions/SessionManagementService'
'201':
description: Created
schema:
$ref: '#/definitions/SessionManagementService'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
/ocpm/pcf/v1/configuration/service/ue:
get:
tags:
- UE Policy Service
summary: Get UE Policy Service
operationId: getUEPolicyService
produces:
- application/json
responses:
'200':
description: OK. Resource representation is returned
schema:
$ref: '#/definitions/UEPolicyService'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
put:
tags:
- UE Policy Service
summary: Update UE Policy Service
operationId: updateUEPolicyService
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/UEPolicyService'
responses:
'200':
description: Updated.
schema:
$ref: '#/definitions/UEPolicyService'
'201':
description: Created
schema:
$ref: '#/definitions/UEPolicyService'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
/ocpm/pcf/v1/configuration/service/user:
get:
tags:
- User Service
summary: Get User Service
operationId: getUserService
produces:
- application/json
responses:
'200':
description: OK. Resource representation is returned
schema:
$ref: '#/definitions/UserService'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'429':
description: Too Many Requests
'500':
description: Internal Server Error
'503':
description: Service Unavailable
deprecated: false
put:
tags:
- User Service
summary: User Service
operationId: updateUserService
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: body
required: true
schema:
$ref: '#/definitions/UserService'
responses:
'200':
description: Updated.
schema:
$ref: '#/definitions/UserService'
'201':
description: Created
schema:
$ref: '#/definitions/UserService'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'406':
description: Not Acceptable
'408':
description: Request Timeout
'409':
description: Conflict
'412':
description: Precondition Failed
'500':
description: Internal Server Error
'503':
description: Service Unavailable
'504':
description: Gateway Timeout
deprecated: false
definitions:
AMFConfiguration:
type: object
properties:
enableHttp11Client:
type: boolean
naSMsgTransferMaxSize:
type: integer
format: int32
title: AMFConfiguration
AMServiceSystemConfiguration:
type: object
required:
- rootLogLevel
properties:
enableHttp2Client:
type: boolean
isSubscribe:
type: boolean
isValidateUser:
type: boolean
logList:
type: array
items:
$ref: '#/definitions/AMServiceSystemConfigurationLogList'
rootLogLevel:
type: string
enum:
- TRACE
- DEBUG
- INFO
- WARN
- ERROR
- ALWAYS
usePolicyService:
type: boolean
useUserPolicy:
type: boolean
title: AMServiceSystemConfiguration
AMServiceSystemConfigurationLogList:
type: object
required:
- name
properties:
level:
type: string
enum:
- TRACE
- DEBUG
- INFO
- WARN
- ERROR
- ALWAYS
name:
type: string
title: AMServiceSystemConfigurationLogList
AccessandMobilityService:
type: object
properties:
app:
$ref: '#/definitions/AppConfiguration'
system:
$ref: '#/definitions/AMServiceSystemConfiguration'
title: AccessandMobilityService
AppConfiguration:
type: object
properties:
defaultRfsp:
type: string
defaultServAreaResCfgId:
type: string
defaultTriggers:
type: array
items:
type: string
enum:
- LOC_CH
- PRA_CH
- SERV_AREA_CH
- RFSP_CH
- UE_POLICY
title: AppConfiguration
Arp:
type: object
required:
- preemptCap
- preemptVuln
- priorityLevel
properties:
preemptCap:
type: string
enum:
- NOT_PREEMPT
- MAY_PREEMPT
preemptVuln:
type: string
enum:
- NOT_PREEMPTABLE
- PREEMPTABLE
priorityLevel:
type: integer
format: int32
description: 'enter a range in [1-15] number'
title: Arp
AuthSessAmbr:
type: object
properties:
downlink:
type: string
description: Enter a value starting with number and ending bps or Kbps or Mbps or Gbps or Tbps
uplink:
type: string
description: Enter a value starting with number and ending bps or Kbps or Mbps or Gbps or Tbps
title: AuthSessAmbr
BindingConfiguration:
type: object
properties:
bindingOperationEnabled:
type: boolean
useHttp2:
type: boolean
useLocalConfiguredBsfAlways:
type: boolean
useLocalConfiguredBsfWhenNotDiscovered:
type: boolean
title: BindingConfiguration
ChargingConfiguration:
type: object
properties:
chgDataIdPrefix:
type: string
example: chgdata_
offline:
type: boolean
online:
type: boolean
primaryChfAddress:
type: string
secondaryChfAddress:
type: string
title: ChargingConfiguration
ChargingData:
type: object
required:
- name
properties:
afChargingIdentifier:
type: integer
format: int64
description: Enter a value between 0 and 4294967295
appSvcProvId:
type: string
description:
type: string
meteringMethod:
type: string
enum:
- DURATION
- VOLUME
- DURATION_VOLUME
- EVENT
name:
type: string
offline:
type: boolean
online:
type: boolean
ratingGroup:
type: integer
format: int64
description: Enter a value between 0 and 4294967295
reportingLevel:
type: string
enum:
- SER_ID_LEVEL
- RAT_GR_LEVEL
- SPON_CON_LEV
serviceId:
type: integer
format: int64
description: Enter a value between 0 and 4294967295
sponsorId:
type: string
title: ChargingData
CommonConfiguration:
type: object
properties:
requestTimeout:
type: string
example: 1000
resourceGetSub:
type: boolean
title: CommonConfiguration
ConditionData:
type: object
required:
- name
properties:
activationTime:
type: string
example: 'YYYY-MM-DDTHH:MM:SS'
deactivationTime:
type: string
example: 'YYYY-MM-DDTHH:MM:SS'
description:
type: string
name:
type: string
title: ConditionData
DBConfiguration:
type: object
properties:
indexing:
$ref: '#/definitions/Indexing'
keysPrecedence:
type: array
items:
type: string
enum:
- MSISDN
- IMSI
- NAI
- EXTID
userIndexKeys:
type: array
items:
type: string
enum:
- msisdn
- imsi
- nai
- extid
title: DBConfiguration
DiamSettings:
type: object
properties:
timer:
$ref: '#/definitions/DiamSettingsTimer'
title: DiamSettings
DiamSettingsTimer:
type: object
properties:
connectionTimeout:
type: string
example: 3
description: enter number of seconds.
reconnectDelay:
type: string
example: 3
description: enter number of seconds.
responseTimeout:
type: string
example: 5
description: enter number of seconds.
watchdogInterval:
type: string
example: 6
description: enter number of seconds.
title: DiamSettingsTimer
EthFlowDescription:
type: object
properties:
destMacAddr:
type: string
description: 'enter a MAC address ,such as''3D-F2-C9-A6-B3-4F''.'
ethType:
type: string
fDesc:
type: string
fDir:
type: string
enum:
- DOWNLINK
- UPLINK
- BIDIRECTIONAL
- UNSPECIFIED
fdesc:
type: string
fdir:
type: string
enum:
- DOWNLINK
- UPLINK
- BIDIRECTIONAL
- UNSPECIFIED
sourceMacAddr:
type: string
description: 'enter a MAC address ,such as''3D-F2-C9-A6-B3-4F'''
vlanTags:
type: array
items:
type: string
title: EthFlowDescription
FlowInfos:
type: object
required:
- name
properties:
ethFlowDescription:
$ref: '#/definitions/EthFlowDescription'
flowDescription:
type: string
flowDirection:
type: string
enum:
- DOWNLINK
- UPLINK
- BIDIRECTIONAL
- UNSPECIFIED
flowLabel:
type: string
name:
type: string
packFiltId:
type: string
packetFilterUsage:
type: boolean
spi:
type: string
tosTrafficClass:
type: string
title: FlowInfos
GNbId:
type: object
required:
- bitLength
- gNbValue
properties:
bitLength:
type: integer
format: int32
gNbValue:
type: string
description: You must enter 6 to 8 A-F or a-f letter or number.
title: GNbId
IMSEmergencySessionConfiguration:
type: object
required:
- arpPreemptCap
- arpPreemptVuln
properties:
arpPreemptCap:
type: string
enum:
- NOT_PREEMPT
- MAY_PREEMPT
arpPreemptVuln:
type: string
enum:
- NOT_PREEMPTABLE
- PREEMPTABLE
arpPriorityLevel:
type: integer
format: int32
emergencyDNNs:
type: array
description: Any number of values are permitted for Emergency DNNs
items:
type: string
title: IMSEmergencySessionConfiguration
IMSEmergencySessionPAServiceConfiguration:
type: object
properties:
emergencyServiceURNs:
type: array
description: Any number of values are permitted for Emergency Service URNs
items:
type: string
reservationPriorityTypes:
type: array
items:
type: string
enum:
- PRIO_1
- PRIO_2
- PRIO_3
- PRIO_4
- PRIO_5
- PRIO_6
- PRIO_7
- PRIO_8
- PRIO_9
- PRIO_10
- PRIO_11
- PRIO_12
- PRIO_13
- PRIO_14
- PRIO_15
- PRIO_16
title: IMSEmergencySessionPAServiceConfiguration
Indexing:
type: object
properties:
indexByExtid:
type: boolean
indexByImsi:
type: boolean
indexByMsisdn:
type: boolean
indexByNai:
type: boolean
title: Indexing
PAServiceSystemConfiguration:
type: object
properties:
afDirectReply:
type: boolean
afSubsNotifySegment:
type: string
example: termination
afTerminateUriSegment:
type: string
example: termination
overrideSupportedFeatures:
type: string
title: PAServiceSystemConfiguration
PCFGlobalConfigurations:
type: object
properties:
apiGatewayHost:
type: string
apiGatewayPort:
type: number
example: 80
enableMetrics:
type: boolean
enableTls:
type: boolean
enableTracing:
type: boolean
title: PCFGlobalConfigurations
PccRule:
type: object
required:
- name
- pccRuleId
- type
properties:
afSigProtocol:
type: string
enum:
- NO_INFORMATION
- SIP
appId:
type: string
appReloc:
type: boolean
contVer:
type: string
description:
type: string
flowInfos:
type: array
items:
$ref: '#/definitions/FlowInfos'
name:
type: string
pccRuleId:
type: string
precedence:
type: string
refChgData:
type: array
items:
type: string
refCondData:
type: string
refQosData:
type: array
items:
type: string
refTcData:
type: array
items:
type: string
refUmData:
type: array
items:
type: string
type:
type: string
enum:
- DYNAMIC
- PREDEFINED
title: PccRule
PccRuleProfile:
type: object
required:
- id
- name
- type
properties:
afSigProtocol:
type: string
enum:
- NO_INFORMATION
- SIP
appId:
type: string
appReloc:
type: boolean
contVer:
type: string
description:
type: string
flowInfos:
type: array
items:
$ref: '#/definitions/FlowInfos'
id:
type: string
name:
type: string
precedence:
type: string
refChgData:
type: array
items:
type: string
refCondData:
type: string
refQosData:
type: array
items:
type: string
refTcData:
type: array
items:
type: string
refUmData:
type: array
items:
type: string
type:
type: string
enum:
- DYNAMIC
- PREDEFINED
title: PccRuleProfile
PeerNode:
type: object
required:
- diamName
- dtype
- initiateConnection
properties:
diamName:
type: string
dtype:
type: string
enum:
- af
- dra
host:
type: string
description: 'enter a FQDN, ipv4 or ipv6 address''.'
identity:
type: string
description: Enter valid FQDN.
initiateConnection:
type: boolean
port:
type: string
example: 3868
description: 'Enter a range in [0-65535].'
realm:
type: string
description: Enter valid FQDN.
title: PeerNode
Plmn:
type: object
required:
- mcc
- mnc
properties:
mcc:
type: string
description: 'Valid Range [0-999]'
mnc:
type: string
description: 'Valid Range [0-999]'
title: Plmn
PlmnId:
type: object
required:
- mcc
- mnc
properties:
mcc:
type: string
description: enter a 3 digit number
mnc:
type: string
description: enter a 2 or 3 digit number
title: PlmnId
Policy:
type: object
properties:
evaluateEnabled:
type: boolean
title: Policy
PolicyAuthorizationService:
type: object
properties:
imsEmergencySession:
$ref: '#/definitions/IMSEmergencySessionPAServiceConfiguration'
system:
$ref: '#/definitions/PAServiceSystemConfiguration'
title: PolicyAuthorizationService
PolicyControlRequestTrigger:
type: object
properties:
defaultPolicyControlRequestTriggers:
type: array
items:
type: string
enum:
- PLMN_CH
- RES_MO_RE
- AC_TY_CH
- UE_IP_CH
- UE_MAC_CH
- AN_CH_COR
- US_RE
- APP_STA
- APP_STO
- AN_INFO
- CM_SES_FAIL
- PS_DA_OFF
- DEF_QOS_CH
- SE_AMBR_CH
- QOS_NOTIF
- NO_CREDIT
- PRA_CH
- SAREA_CH
- SCNN_CH
- RE_TIMEOUT
- RES_RELEASE
- SUCC_RES_ALLO
- RAT_TY_CH
- REF_QOS_IND_CH
title: PolicyControlRequestTrigger
PolicyCounterId:
type: object
required:
- name
properties:
defaultStatus:
type: string
desc:
type: string
name:
type: string
title: PolicyCounterId
PresenceReportingArea:
type: object
required:
- name
- praId
properties:
ecgiList:
type: array
items:
$ref: '#/definitions/PresenceReportingAreaEcgiList'
globalRanNodeIdList:
type: array
items:
$ref: '#/definitions/PresenceReportingAreaGlobalRanNodeIdList'
name:
type: string
ncgiList:
type: array
items:
$ref: '#/definitions/PresenceReportingAreaNcgiList'
praId:
type: string
presenceState:
type: string
enum:
- IN_AREA
- OUT_OF_AREA
- UNKNOWN
- INACTIVE
trackingAreaList:
type: array
items:
$ref: '#/definitions/PresenceReportingAreaTrackingAreaList'
title: PresenceReportingArea
PresenceReportingAreaEcgiList:
type: object
required:
- plmnId
properties:
eutraCellId:
type: string
description: enter a 7 digit hexadecimal value
plmnId:
$ref: '#/definitions/PlmnId'
title: PresenceReportingAreaEcgiList
PresenceReportingAreaGlobalRanNodeIdList:
type: object
properties:
gNbId:
$ref: '#/definitions/GNbId'
n3IwfId:
type: string
description: enter a 1 or more digit hexadecimal value
ngeNbId:
type: string
description: Enter a value starting with 'MacroNGeNB-' or 'SMacroNGeNB-' and ending with a 5 hexadecimal value or starting with 'LMacroNGeNB-' and ending with a 6 hexadecimal value
plmnId:
$ref: '#/definitions/PlmnId'
title: PresenceReportingAreaGlobalRanNodeIdList
PresenceReportingAreaNcgiList:
type: object
properties:
nrCellId:
type: string
description: enter a 9 digit hexadecimal value
plmnId:
$ref: '#/definitions/PlmnId'
title: PresenceReportingAreaNcgiList
PresenceReportingAreaTrackingAreaList:
type: object
properties:
plmnId:
$ref: '#/definitions/PlmnId'
tac:
type: string
description: enter a 4 or 6 digit hexadecimal value
title: PresenceReportingAreaTrackingAreaList
QOSConfiguration:
type: object
properties:
defaultQos5qi:
type: string
example: 9
defaultQosArpPreemptCap:
type: string
example: MAY_PREEMPT
enum:
- NOT_PREEMPT
- MAY_PREEMPT
defaultQosArpPreemptVuln:
type: string
example: NOT_PREEMPTABLE
enum:
- PREEMPTABLE
- NOT_PREEMPTABLE
defaultQosArpPriorityLevel:
type: string
example: 1
installDefQosIfNotRequested:
type: boolean
qosDataIdPrefix:
type: string
example: qosdata_
updateDefaultPcfRuleWithAuthDefQos:
type: boolean
title: QOSConfiguration
QosData:
type: object
required:
- arp
- name
properties:
5qi:
type: integer
format: int32
description: 'enter a range in [0-255] number'
arp:
$ref: '#/definitions/Arp'
averWindow:
type: integer
format: int32
example: 2000
description: Enter a value between 1 and 4095
defQosFlowIndication:
type: boolean
description:
type: string
gbrDl:
type: string
description: Enter a value starting with number and ending bps or Kbps or Mbps or Gbps or Tbps
gbrUl:
type: string
description: Enter a value starting with number and ending bps or Kbps or Mbps or Gbps or Tbps
maxDataBurstVol:
type: integer
format: int32
description: Enter a value between 1 and 4095
maxPacketLossRateDl:
type: integer
format: int32
description: Enter a value between 0 and 1000
maxPacketLossRateUl:
type: integer
format: int32
description: Enter a value between 0 and 1000
maxbrDl:
type: string
description: Enter a value starting with number and ending bps or Kbps or Mbps or Gbps or Tbps
maxbrUl:
type: string
description: Enter a value starting with number and ending bps or Kbps or Mbps or Gbps or Tbps
name:
type: string
priorityLevel:
type: integer
format: int32
description: Enter a value between 1 and 127
qnc:
type: boolean
reflectiveQos:
type: boolean
sharingKeyDl:
type: string
sharingKeyUl:
type: string
title: QosData
QosInformation:
type: object
required:
- name
properties:
5qi:
type: string
description: 'enter a range in [0-255] number'
arp:
$ref: '#/definitions/Arp'
averWindow:
type: string
example: 2000
description:
type: string
maxDataBurstVol:
type: string
example: 2000
name:
type: string
priorityLevel:
type: string
description: 'enter a range in [1-127] number'
title: QosInformation
RedirectInfo:
type: object
properties:
redirectAddressType:
type: string
enum:
- IPV4_ADDR
- IPV6_ADDR
- URL
- SIP_URI
redirectEnabled:
type: boolean
redirectServerAddress:
type: string
title: RedirectInfo
RouteInfo:
type: object
properties:
ipv4Addr:
type: string
ipv6Addr:
type: string
portNumber:
type: integer
format: int32
description: Enter a number greater than or equal to 0
title: RouteInfo
RouteSelectionDescriptorComponent:
type: object
title: RouteSelectionDescriptorComponent
RouteSelectionDescriptorComponentIE:
type: object
properties:
routeSelectionDescriptorType:
type: string
enum:
- SSC_MODE
- SNSSAI
- DNN
- PDU_SESSION_TYPE
- PREFERRED_ACCESS_TYPE
- NON_SEAMLESS_NON_3GPP_OFFLOAD_INDICATION
value:
$ref: '#/definitions/RouteSelectionDescriptorComponent'
title: RouteSelectionDescriptorComponentIE
RouteToLocs:
type: object
properties:
dnai:
type: string
routeInfo:
$ref: '#/definitions/RouteInfo'
routeProfId:
type: string
title: RouteToLocs
RuleConfiguration:
type: object
properties:
appRulePrecedenceMax:
type: string
example: 899
appRulePrecedenceMin:
type: string
example: 400
defaultPccRule5qi:
type: string
example: 9
defaultPccRuleArpPreemptCap:
type: string
example: NOT_PREEMPT
enum:
- NOT_PREEMPT
- MAY_PREEMPT
defaultPccRuleArpPreemptVuln:
type: string
example: PREEMPTABLE
enum:
- PREEMPTABLE
- NOT_PREEMPTABLE
defaultPccRuleArpPriorityLevel:
type: string
example: 15
defaultPccRulePrecedence:
type: string
example: 3000
installDefaultPccRule:
type: string
enum:
- ALWAYS
- IF_NO_PROVISIONED_RULE
- IF_NO_RULE
- NEVER
ruleIdPrefix:
type: string
example: 0_
switchFlowInToOutEnabled:
type: boolean
title: RuleConfiguration
ServiceAreaRestriction:
type: object
required:
- name
properties:
areas:
type: array
items:
$ref: '#/definitions/ServiceAreaRestrictionAreas'
description:
type: string
maxNumOfTAs:
type: number
name:
type: string
restrictionType:
type: string
enum:
- ALLOWED_AREAS
- NOT_ALLOWED_AREAS
title: ServiceAreaRestriction
ServiceAreaRestrictionAreas:
type: object
properties:
areaCodes:
type: string
tacs:
type: array
items:
type: string
title: ServiceAreaRestrictionAreas
SessionManagementService:
type: object
properties:
binding:
$ref: '#/definitions/BindingConfiguration'
charging:
$ref: '#/definitions/ChargingConfiguration'
imsEmergencySession:
$ref: '#/definitions/IMSEmergencySessionConfiguration'
policy:
$ref: '#/definitions/Policy'
policyControlRequestTrigger:
$ref: '#/definitions/PolicyControlRequestTrigger'
qos:
$ref: '#/definitions/QOSConfiguration'
rule:
$ref: '#/definitions/RuleConfiguration'
system:
$ref: '#/definitions/SystemConfiguration'
trafficControl:
$ref: '#/definitions/TrafficControlConfiguration'
user:
$ref: '#/definitions/UserConfiguration'
title: SessionManagementService
SessionRule:
type: object
required:
- name
- sessRuleId
properties:
authDefQosId:
type: string
authSessAmbr:
$ref: '#/definitions/AuthSessAmbr'
description:
type: string
name:
type: string
sessRuleId:
type: string
title: SessionRule
SessionRuleProfile:
type: object
required:
- name
- sessRuleProfileId
properties:
authDefQosId:
type: string
authSessAmbr:
$ref: '#/definitions/AuthSessAmbr'
description:
type: string
name:
type: string
sessRuleProfileId:
type: string
title: SessionRuleProfile
SystemConfiguration:
type: object
properties:
apiRoot:
type: string
componentTracingEnabled:
type: boolean
logLevel:
type: string
enum:
- DEBUG
- INFO
- WARN
- ERROR
metricsEnabled:
type: boolean
overrideSupportedFeatures:
type: string
pcf_diamidentity:
type: string
example: pcf-smservice
pcf_diamrealm:
type: string
example: pcf-smservice.svc
pcf_fqdn:
type: string
example: pcf-smservice.pcf
process400as200:
type: boolean
smfTerminateUriSegment:
type: string
example: terminate
smfUpdateUriSegment:
type: string
example: update
snssai:
type: string
example: '0,000000'
title: SystemConfiguration
TrafficControlConfiguration:
type: object
properties:
tcDataIdPrefix:
type: string
example: tcdata_
title: TrafficControlConfiguration
TrafficControlData:
type: object
required:
- name
properties:
description:
type: string
flowStatus:
type: string
enum:
- ENABLED-UPLINK
- ENABLED-DOWNLINK
- ENABLED
- DISABLED
- REMOVED
muteNotif:
type: boolean
name:
type: string
redirectInfo:
$ref: '#/definitions/RedirectInfo'
routeToLocs:
type: array
items:
$ref: '#/definitions/RouteToLocs'
trafficSteeringPolIdDl:
type: string
trafficSteeringPolIdUl:
type: string
upPathChgEvent:
$ref: '#/definitions/UpPathChgEvent'
title: TrafficControlData
TrafficDescriptorComponent:
type: object
title: TrafficDescriptorComponent
TrafficDescriptorIE:
type: object
properties:
trafficDescriptorType:
type: string
enum:
- MATCH_ALL
- OS_ID_OS_APP_ID
- IPV4_REMOTE_ADDRESS
- IPV6_REMOTE_ADDRESS
- PROTOCOL_IDENTIFIER
- SINGLE_REMOTE_PORT
- REMOTE_PORT_RANGE
- SECURITY_PARAMETER_INDEX
- TYPE_OF_SERVICE_CLASS
- FLOW_LABEL
- DESTINATION_MAC_ADDRESS
- T_802_1Q_C_TAG_VID
- T_802_1Q_S_TAG_VID
- ETHERTYPE
- DNN
- CONNECTION_CAPABILITIES
- DESTINATION_FQDN
- OS_APP_ID
- T_802_1Q_C_TAG_PCP_DEI
- T_802_1Q_S_TAG_PCP_DEI
value:
$ref: '#/definitions/TrafficDescriptorComponent'
title: TrafficDescriptorIE
UDRConfiguration:
type: object
properties:
amDataUri:
type: string
example: '/policy-data/ues/{ueId}/am-data'
baseUri:
type: string
example: /nudr-dr/v1
enableDiscoveryOnDemand:
type: boolean
enableHttp11:
type: boolean
explodeSnssai:
type: boolean
requestTimeout:
type: string
example: 1000
smDataUri:
type: string
example: '/policy-data/ues/{ueId}/sm-data'
subsToNotifySubsIdUri:
type: string
example: '/policy-data/subs-to-notify/{subsId}'
subsToNotifyUri:
type: string
example: /policy-data/subs-to-notify
supportedFeatures:
type: string
example: f
uePolicySetUri:
type: string
example: '/policy-data/ues/{ueId}/ue-policy-set'
usageMonUri:
type: string
example: '/policy-data/ues/{ueId}/sm-data/{usageMonId}'
title: UDRConfiguration
UEPolicyService:
type: object
properties:
amf:
$ref: '#/definitions/AMFConfiguration'
system:
$ref: '#/definitions/UEPolicyServiceSystemConfiguration'
user:
$ref: '#/definitions/UserUEPolicyServiceConfiguration'
title: UEPolicyService
UEPolicyServiceSystemConfiguration:
type: object
properties:
loglevel:
type: string
example: WARN
enum:
- DEBUG
- INFO
- WARN
- ERROR
notifUriRoot:
type: string
title: UEPolicyServiceSystemConfiguration
UpPathChgEvent:
type: object
properties:
dnaiChgType:
type: string
enum:
- EARLY
- EARLY_LATE
- LATE
notifCorreId:
type: string
notificationUri:
type: string
title: UpPathChgEvent
Upsi:
type: object
required:
- name
- plmn
- upsc
properties:
name:
type: string
plmn:
$ref: '#/definitions/Plmn'
upsc:
type: integer
format: int32
description: Enter a value between 0 and 65535.
urspRules:
type: array
items:
type: string
title: Upsi
Ursp:
type: object
required:
- name
- precedence
properties:
name:
type: string
precedence:
type: integer
format: int32
description: Enter a value between 0 and 255.
routeSelectionDescriptorList:
type: array
items:
$ref: '#/definitions/UrspRouteSelectionDescriptorList'
trafficDescriptors:
type: array
items:
$ref: '#/definitions/TrafficDescriptorIE'
title: Ursp
UrspRouteSelectionDescriptorList:
type: object
properties:
routePrecedence:
type: integer
format: int32
routeSelectionDescriptorComponents:
type: array
items:
$ref: '#/definitions/RouteSelectionDescriptorComponentIE'
title: UrspRouteSelectionDescriptorList
UsageMonitoringData:
type: object
required:
- name
properties:
description:
type: string
exUsagePccRuleIds:
type: array
items:
type: string
inactivityTime:
type: string
monitoringTime:
type: string
name:
type: string
nextTimeThreshold:
type: string
nextVolThreshold:
type: integer
format: int64
description: Enter a value between 0 and 9223372036854775807
nextVolThresholdDownlink:
type: integer
format: int64
description: Enter a value between 0 and 9223372036854775807
nextVolThresholdUplink:
type: integer
format: int64
description: Enter a value between 0 and 9223372036854775807
timeThreshold:
type: string
volumeThreshold:
type: integer
format: int64
description: Enter a value between 0 and 9223372036854775807
volumeThresholdDownlink:
type: integer
format: int64
description: Enter a value between 0 and 9223372036854775807
volumeThresholdUplink:
type: integer
format: int64
description: Enter a value between 0 and 9223372036854775807
title: UsageMonitoringData
UserConfiguration:
type: object
properties:
enableChfQueryAll:
type: boolean
ignoreSubsNotificationCheck:
type: boolean
queryUser:
type: boolean
queryUserOnDelete:
type: boolean
queryUserOnReauth:
type: boolean
queryUserOnUpdate:
type: boolean
subsToNotifyEnabled:
type: boolean
validateUser:
type: boolean
title: UserConfiguration
UserService:
type: object
properties:
common:
$ref: '#/definitions/CommonConfiguration'
db:
$ref: '#/definitions/DBConfiguration'
system:
$ref: '#/definitions/UserSystemConfiguration'
udr:
$ref: '#/definitions/UDRConfiguration'
title: UserService
UserSystemConfiguration:
type: object
properties:
apiRoot:
type: string
logLevel:
type: string
enum:
- DEBUG
- INFO
- WARN
- ERROR
title: UserSystemConfiguration
UserUEPolicyServiceConfiguration:
type: object
properties:
queryUser:
type: boolean
validateUser:
type: boolean
title: UserUEPolicyServiceConfiguration
