B Open API Specification for nudr-config
The open API specification for nudr-config is as follows:
openapi: 3.0.0
info:
version: 25.1.100.0.0
title: OCUDR CONFIGURATION API SPECIFICATION
tags:
- name: OCUDR CONFIGURATION
description: Configuration Controller
paths:
/nudr-config/v1/udr.nudrservice.cfg/DR-SERVICE:
get:
tags:
- OCUDR CONFIGURATION
summary: >-
Returns configuration of Data repository service with DR-SERVICE as key
and udr.nudrservice.cfg as topic
operationId: getConfiguredValuesForDR
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DrServiceConfiguration'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- OCUDR CONFIGURATION
summary: >-
Updates configuration of Data Repository service with DR-SERVICE key and
as udr.nudrservice.cfg topic
operationId: putConfiguredValuesForDR
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DrServiceConfiguration'
description: DR Service Configuration
required: true
responses:
'201':
description: CREATED
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/udr.nudrprovservice.cfg/DR-PROV-SERVICE:
get:
tags:
- OCUDR CONFIGURATION
summary: >-
Returns configuration of Data repository Provisioning service with DR-PROV-SERVICE as key
and udr.nudrprovservice.cfg as topic
operationId: getConfiguredValuesForDRProv
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DrProvServiceConfiguration'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- OCUDR CONFIGURATION
summary: >-
Updates configuration of Data Repository Provisioning service with DR-PROV-SERVICE key and
as udr.nudrprovservice.cfg topic
operationId: putConfiguredValuesForDRProv
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DrProvServiceConfiguration'
description: DR Service Configuration
required: true
responses:
'201':
description: CREATED
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/udr.notifyservice.cfg/NOTIFY-SERVICE:
get:
tags:
- OCUDR CONFIGURATION
summary: >-
Returns configuration of Notify Service with NOTIFY-SERVICE as key and
udr.notifyservice.cfg as topic
operationId: getConfiguredValuesForNotify
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/NotifyServiceConfiguration'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- OCUDR CONFIGURATION
summary: >-
Updates configuration of Notify Service with NOTIFY-SERVICE as Key and
udr.notifyservice.cfg as topic
operationId: putConfiguredValuesForNotify
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotifyServiceConfiguration'
description: Notify Service Configuration
required: true
responses:
'201':
description: CREATED
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/udr.diamgateway.cfg/DIAMETER-GATEWAY:
get:
tags:
- OCUDR CONFIGURATION
summary: >-
Returns configuration of Diamgateway with DIAMETER-GATEWAY key and
udr.diamgateway.cfg as topic
operationId: getConfiguredValuesForDiamgateway
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DiameterConfiguration'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- OCUDR CONFIGURATION
summary: >-
Updates configuration of Diamgateway with DIAMETER-GATEWAY as key and
udr.diamgateway.cfg as topic
operationId: putConfiguredValuesForDiamgateway
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DiameterConfiguration'
description: Diamgateway Service Configuration
required: true
responses:
'201':
description: CREATED
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/udr.global.cfg/GLOBAL:
get:
tags:
- OCUDR CONFIGURATION
summary: >-
Returns Global Configuration with GLOBAL as key and udr.global.cfg as
topic
operationId: getConfiguredValuesForGlobal
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GlobalConfiguration'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/udr.ondemand.cfg/ON-DEMAND:
get:
tags:
- OCUDR CONFIGURATION
summary: >-
Returns configuration of On Demand Migration service with ON-DEMAND as
key and udr.ondemand.cfg as topic
operationId: getConfiguredValuesForOnDemand
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OnDemandMigration'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- OCUDR CONFIGURATION
summary: >-
Updates configuration of On Demand Migration service with ON-DEMAND as
key and udr.ondemand.cfg topic
operationId: putConfiguredValuesForOnDemand
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OnDemandMigration'
description: On Demand Migration Service Configuration
required: true
responses:
'201':
description: CREATED
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/udr.diamgateway.congestion.cfg/DGW-CONGESTION:
get:
tags:
- OCUDR CONFIGURATION
summary: >-
Returns configuration of diamgateway congestion with DGW-CONGESTION as
key and udr.diamgateway.congestion.cfg as topic
operationId: getConfiguredValuesForDC
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DiamgatewayCongestion'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- OCUDR CONFIGURATION
summary: >-
Updates configuration of diamgateway congestion with DGW-CONGESTION as
key and udr.diamgateway.congestion.cfg topic
operationId: putConfiguredValuesForDC
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DiamgatewayCongestion'
description: Diamgateway Congestion Configuration
required: true
responses:
'201':
description: CREATED
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/udr.biservice.cfg/BULK_IMPORT:
get:
tags:
- OCUDR CONFIGURATION
summary: Returns Run time status of Bulk Import files
operationId: getConfiguredValuesForBI
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BIConfiguration'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/udr.bulkimportservice.cfg/BULK_IMPORT_CFG:
get:
tags:
- OCUDR CONFIGURATION
summary: >-
Returns the configurations of bulk import with udr.bulkimportservice.cfg
as topic and BULK_IMPORT_CFG as value
operationId: getBulkImportCfg
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BulkImportCfg'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- OCUDR CONFIGURATION
summary: >-
Updates configuration of subscriber bulk import tool congestion with BULK_IMPORT_CFG as
key and udr.bulkimportservice.cfg as topic
operationId: putBulkImportCfg
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkImportCfg'
description: Subscriber Bulk Import Tool Configuration
required: true
responses:
'201':
description: CREATED
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/udr.exporttool.cfg/EXPORT_TOOL_CFG:
get:
tags:
- OCUDR CONFIGURATION
summary: >-
Returns the configurations of bulk export tool with udr.exporttool.cfg
as topic and EXPORT_TOOL_CFG as Key
operationId: getBulkExportCfg
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BulkExportCfg'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- OCUDR CONFIGURATION
summary: >-
Updates configuration of subscriber bulk export tool congestion with udr.exporttool.cfg as topic and EXPORT_TOOL_CFG as Key
operationId: putBulkExportCfg
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkExportCfg'
description: Subscriber Bulk Export Tool Configuration
required: true
responses:
'201':
description: CREATED
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/udr.exporttoolstatus.cfg/EXPORT_TOOL_STATUS:
get:
tags:
- OCUDR CONFIGURATION
summary: >-
Returns the status of bulk export tool with udr.exporttoolstatus.cfg
as topic and EXPORT_TOOL_STATUS as Key
operationId: getBulkExportToolStatus
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BulkExportToolStatus'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/udr.exporttoolfilestatus.cfg/EXPORT_TOOL_FILE_STATUS:
get:
tags:
- OCUDR CONFIGURATION
summary: >-
Returns the status of bulk export tool with udr.exporttoolfilestatus.cfg
as topic and EXPORT_TOOL_FILE_STATUS as Key
operationId: getBulkExportFileStatus
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BulkExportFileStatus'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/export:
post:
tags:
- OCUDR CONFIGURATION
summary: To export configuration data.
operationId: postExportConfiguration
responses:
'201':
description: CREATED
content:
application/json:
schema:
$ref: '#/components/schemas/ExportConfiguration'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
get:
tags:
- OCUDR CONFIGURATION
summary: To get export id.
operationId: getExportConfiguration
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ExportId'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/export/3e470fab-e131-4dbe-be67-ba7391729254/status:
get:
tags:
- OCUDR CONFIGURATION
summary: Returns Export process status
operationId: getExportStatus
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ExportStatus'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/export/3e470fab-e131-4dbe-be67-ba7391729254/report:
get:
tags:
- OCUDR CONFIGURATION
summary: Returns Export Report
operationId: getExportReport
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ExportReport'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/export/3e470fab-e131-4dbe-be67-ba7391729254/download:
get:
tags:
- OCUDR CONFIGURATION
summary: Returns Exported configuration download
operationId: getExportDownload
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Download'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/import:
post:
tags:
- OCUDR CONFIGURATION
summary: To start Import of UDR Configuration
operationId: postImportConfiguration
responses:
'201':
description: CREATED
content:
application/json:
schema:
$ref: '#/components/schemas/ImportConfiguration'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
get:
tags:
- OCUDR CONFIGURATION
summary: To get import id
operationId: getImportConfiguration
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ImportId'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/import/3e470fab-e131-4dbe-be67-ba7391729254/status:
get:
tags:
- OCUDR CONFIGURATION
summary: Returns Import status
operationId: getImportStatus
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ImportStatus'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/import/3e470fab-e131-4dbe-be67-ba7391729254/report:
get:
tags:
- OCUDR CONFIGURATION
summary: Returns Import report
operationId: getImportReport
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ImportReport'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/nudr-drservice/logging:
get:
tags:
- OCUDR CONFIGURATION
summary: Returns Log level For Data Repository Service
operationId: getLogLevelForDR
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/LogConfiguration'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- OCUDR CONFIGURATION
summary: Updates Log level For Data Repository Service
operationId: putLogLevelForDr
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogConfiguration'
description: Global Service Configuration
required: true
responses:
'201':
description: CREATED
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/nudr-dr-provservice/logging:
get:
tags:
- OCUDR CONFIGURATION
summary: Returns Log level For Data Repository Provisioning Service
operationId: getLogLevelForDRProv
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/LogConfiguration'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- OCUDR CONFIGURATION
summary: Updates Log level For Data Repository Provisioning Service
operationId: putLogLevelForDrProv
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogConfiguration'
description: Global Service Configuration
required: true
responses:
'201':
description: CREATED
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/nudr-notify-service/logging:
get:
tags:
- OCUDR CONFIGURATION
summary: Returns Log Level For Notify Service
operationId: getLogLevelForNotify
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/LogConfiguration'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- OCUDR CONFIGURATION
summary: Updates Log Level For Notify Service
operationId: putLogLevelForNotify
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogConfiguration'
description: Notify Service Configuration
required: true
responses:
'201':
description: CREATED
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/nudr-diameterproxy/logging:
get:
tags:
- OCUDR CONFIGURATION
summary: Returns Log Level of Diameter Proxy Service
operationId: getLogLevelForDiameter
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/LogConfiguration'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- OCUDR CONFIGURATION
summary: Updates Log Level of Diameter Proxy Service
operationId: putLogLevelForDiameter
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogConfiguration'
description: Diameter Proxy Service Configuration
required: true
responses:
'201':
description: CREATED
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/diam-gateway/logging:
get:
tags:
- OCUDR CONFIGURATION
summary: Returns Log Level of Diamgateway Service
operationId: getLogLevelForDiamgateway
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/LogConfiguration'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- OCUDR CONFIGURATION
summary: Updates Log Level of Diamgateway Service
operationId: putLogLevelForDiamgateway
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogConfiguration'
description: Diamgateway Service Configuration
required: true
responses:
'201':
description: CREATED
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/nudr-ondemand-migration/logging:
get:
tags:
- OCUDR CONFIGURATION
summary: Returns Log Level of on demand migration service
operationId: getLogLevelForMigration
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/LogConfiguration'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- OCUDR CONFIGURATION
summary: Updates Log Level of on demand migration service
operationId: putLogLevelForMigration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogConfiguration'
description: Diameter Proxy Service Configuration
required: true
responses:
'201':
description: CREATED
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/nudr-bulk-import/logging:
get:
tags:
- OCUDR CONFIGURATION
summary: Returns Log Level of nudr import service
operationId: getLogLevelForBulkImport
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/LogConfiguration'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- OCUDR CONFIGURATION
summary: Updates Log Level of Bulk Import Microservice
operationId: putLogLevelForBulkImport
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogConfiguration'
description: Diameter Proxy Service Configuration
required: true
responses:
'201':
description: CREATED
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/nudr-export-tool/logging:
get:
tags:
- OCUDR CONFIGURATION
summary: Returns Log Level of nudr export service
operationId: getLogLevelForExportTool
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/LogConfiguration'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- OCUDR CONFIGURATION
summary: Updates Log Level of Bulk Export Microservice
operationId: putLogLevelForExportTool
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogConfiguration'
description: Export Tool Logging Configuration
required: true
responses:
'201':
description: CREATED
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/nudr-config/logging:
get:
tags:
- OCUDR CONFIGURATION
summary: Returns Log Level of nudr config service
operationId: getLogLevelForNudrConfig
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/LogConfiguration'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- OCUDR CONFIGURATION
summary: Updates Log Level of nudr config Microservice
operationId: putLogLevelForNudrConfig
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogConfiguration'
description: Nudr config Logging Configuration
required: true
responses:
'201':
description: CREATED
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/udr/nf-common-component/v1/egw/logging:
get:
tags:
- OCUDR CONFIGURATION
summary: Returns Log Level for Egress Gateway
operationId: getLogLevelForEgress
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GwLogConfiguration'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- OCUDR CONFIGURATION
summary: Updates Log Level for Egress Gateway
operationId: putLogLevelForEgress
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GwLogConfiguration'
description: Diameter Proxy Service Configuration
required: true
responses:
'201':
description: CREATED
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/udr/nf-common-component/v1/alt-route/logging:
get:
tags:
- OCUDR CONFIGURATION
summary: Returns Log Level Of Alternate Route Service
operationId: getLogLevelForAltRoute
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GwLogConfiguration'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- OCUDR CONFIGURATION
summary: Updates Log Level Of Alternate Route Service
operationId: putLogLevelForAltRoute
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GwLogConfiguration'
description: Alternate Route Service Configuration
required: true
responses:
'201':
description: CREATED
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/all/logging:
get:
tags:
- OCUDR CONFIGURATION
summary: Returns Log Level Of All Services
operationId: getLogLevelForAll
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AllLogs'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/udr/nf-common-component/v1/igw/logging:
get:
tags:
- OCUDR CONFIGURATION
summary: Returns Log Level of ingress gateway service
operationId: getLogLevelForIngress
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GwLogConfiguration'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- OCUDR CONFIGURATION
summary: Updates Level of ingress gateway service
operationId: putLogLevelForIngress
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GwLogConfiguration'
description: Alternate Route Service Configuration
required: true
responses:
'201':
description: CREATED
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/udr/nf-common-component/v1/operationalState:
get:
tags:
- OCUDR CONFIGURATION
summary: Returns Operation State of OCUDR
operationId: getOperationalState
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OperationalStateConfiguration'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
put:
tags:
- OCUDR CONFIGURATION
summary: Updates on OperationState Configuration
operationId: putOperationalState
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OperationalStateConfiguration'
description: Operational State Configuration Update
required: true
responses:
'200':
description: OK
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/udr/nf-common-component/v1/operationalStateHistory:
get:
tags:
- OCUDR CONFIGURATION
summary: Returns Operation State of OCUDR
operationId: getOperationalStateHistory
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OperationalStateHistory'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/udr.exporttoolstatus.cfg/EXPORT_TOOL_STATUS/{jobId}:
get:
parameters:
- in: path
name: jobId
schema:
type: string
required: true
tags:
- OCUDR CONFIGURATION
summary: >-
Returns the status of bulk export tool with udr.exporttoolstatus.cfg
as topic and EXPORT_TOOL_STATUS as Key
operationId: getBulkExportToolStatusJobId
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BulkExportToolStatusJobId'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
delete:
parameters:
- in: path
name: jobId
schema:
type: string
required: true
tags:
- OCUDR CONFIGURATION
summary: To delete any export tool job with jobId
operationId: deleteExportToolStatusJobId
responses:
"200":
description: OK
"400":
description: Bad Request
content:
"application/json":
schema:
$ref: "#/components/schemas/ProblemDetails"
"404":
description: Not Found
content:
"application/json":
schema:
$ref: "#/components/schemas/ProblemDetails"
deprecated: false
/nudr-config/v1/migration.tool.cfg/MIGRATION_TOOL:
get:
tags:
- OCUDR CONFIGURATION
summary: >-
Returns configuration of migration tool with MIGRATION_TOOL as key
and migration.tool.cfg as topic
operationId: getMigrationToolConfiguration
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MigrationToolConfiguration'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
/nudr-config/v1/migrationtool.status.cfg/MIGRATION_TOOL_STATUS:
get:
tags:
- OCUDR CONFIGURATION
summary: >-
Returns status of migration tool with MIGRATION_TOOL_STATUS as key
and migrationtool.status.cfg as topic
operationId: getMigrationToolStatus
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MigrationToolStatus'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
servers:
- url: //127.0.0.1:8080/
components:
schemas:
NotifyServiceConfiguration:
type: object
additionalProperties: false
properties:
notifRetryCount:
type: integer
minimum: 0
maximum: 3
NotifRetryInterval:
type: integer
minimum: 1
maximum: 5
retryErrorCodes:
type: string
resourceRemovalNotificationEnabled:
type: boolean
DrServiceConfiguration:
additionalProperties: false
properties:
subscriptionDataSubscriptionsOnly:
type: boolean
defaultGroupIdEnabled:
type: boolean
defaultSLFGroupName:
type: string
onDemandMigrationEnabled:
type: boolean
allowSubscriptionRecreation:
type: boolean
DrProvServiceConfiguration:
additionalProperties: false
properties:
onDemandMigrationEnabled:
type: boolean
provLogsEnabled:
type: boolean
provLogsApiNames:
type: array
minItems: 0
items:
$ref: '#/components/schemas/ProvLogsApiNames'
ProvLogsApiNames:
type: string
OnDemandMigration:
type: object
properties:
enabled:
type: boolean
sourceUDRDeleteSubscriber:
type: boolean
sourceUdrConfig:
$ref: '#/components/schemas/SourceUdrConfig'
SourceUdrConfig:
type: object
properties:
restEndpoint:
type: string
realm:
type: string
identity:
type: string
hostIp:
type: string
hostPort:
type: integer
DiameterConfiguration:
type: object
properties:
reconnectDelay:
type: integer
responseTimeout:
type: integer
connectionTimeOut:
type: integer
watchdogInterval:
type: integer
reconnectLimit:
type: integer
allowedClientNodes:
type: array
minItems: 0
items:
$ref: '#/components/schemas/ClientNodes'
ClientNodes:
type: object
required:
- identity
- realm
properties:
responseOnly:
type: boolean
host:
type: string
port:
type: integer
realm:
type: string
identity:
type: string
type:
type: string
additionalProperties: false
GlobalConfiguration:
additionalProperties: false
type: object
properties:
egressGwEnabled:
type: boolean
snssai:
type: string
dnn:
type: string
sbiCorrelationInfoEnable:
type: boolean
autoCreate:
type: boolean
subscriberActivityEnabled:
type: boolean
autoEnrolOnSignalling:
type: boolean
etagEnabled:
type: boolean
enableControlledShutdown:
type: boolean
keyType:
type: string
keyRange:
type: string
suppressNotificationEnabled:
type: string
configClientConnectTimeout:
type: integer
configClientReadTimeout:
type: integer
defaultResponse:
type: string
accessLogEnabled:
type: boolean
defaultResponseIMEINotFound:
type: string
imsiLookupFallbackEnabled:
type: boolean
s13InterfaceEnabled:
type: boolean
subscriberIdentifers:
type: object
properties:
msisdn:
type: array
items:
type: string
imsi:
type: array
items:
type: string
nai:
type: array
items:
type: string
extid:
type: array
items:
type: string
ProblemDetails:
type: object
properties:
cause:
type: string
detail:
type: string
invalidParams:
type: array
items:
$ref: '#/components/schemas/InvalidParam'
status:
type: integer
format: int32
title:
type: string
title: ProblemDetails
InvalidParam:
type: object
properties:
param:
type: string
reason:
type: string
DiamgatewayCongestion:
additionalProperties: false
type: object
properties:
enabled:
type: boolean
defaultMessagePriority:
type: integer
sampleCount:
type: integer
calculationInterval:
type: integer
loadSheddingRulesMap:
$ref: '#/components/schemas/LoadSheddingRulesMap'
priorityRules:
type: array
minItems: 0
items:
$ref: '#/components/schemas/PriorityRules'
thresholds:
$ref: '#/components/schemas/Thresholds'
LoadSheddingRulesMap:
type: object
properties:
CONGESTED:
$ref: '#/components/schemas/CONGESTED'
DOC:
$ref: '#/components/schemas/DOC'
CONGESTED:
type: object
properties:
state:
type: string
discardPriority:
type: integer
ansWithResultCode:
type: string
DOC:
type: object
properties:
state:
type: string
discardPriority:
type: integer
ansWithResultCode:
type: string
PriorityRules:
type: object
properties:
ruleName:
type: string
messagePriority:
type: integer
conditions:
$ref: '#/components/schemas/Conditions'
Conditions:
type: object
properties:
requestType:
type: string
application:
type: string
Thresholds:
type: object
properties:
CONGESTED:
$ref: '#/components/schemas/ThresholdsCONGESTED'
DOC:
$ref: '#/components/schemas/ThresholdsDOC'
ThresholdsCONGESTED:
type: object
properties:
memory:
type: integer
cpu:
type: integer
queue:
type: integer
ThresholdsDOC:
type: object
properties:
memory:
type: integer
cpu:
type: integer
queue:
type: integer
BulkImportCfg:
additionalProperties: false
type: object
properties:
pollingTimeInterval:
type: number
pdbiFilePath:
type: string
remoteDirPath:
type: string
fileExt:
type: string
deleteFileFromPVC:
type: boolean
BulkExportCfg:
additionalProperties: false
type: object
properties:
frequencyOfPeriodicDump:
type: string
startTime:
type: string
maxNumberOfDumps:
type: integer
fixedDumpFileNameSuffix:
type: string
multiValuedelimiter:
type: string
fieldDelimiter:
type: string
fileExtension:
type: string
exportMode:
type: string
imsiCount:
type: integer
msisdnCount:
type: integer
deleteFromPVC:
type: boolean
remotePath:
type: string
subscriberRangeEnabled:
type: boolean
newFilePerRangeEnabled:
type: boolean
subscriberExportRange:
$ref: '#/components/schemas/SubscriberExportRange'
SubscriberExportRange:
properties:
keyType:
type: string
subscriberRanges:
type: array
BulkExportFileStatus:
type: array
items:
$ref: '#/components/schemas/BEFObject'
BEFObject:
properties:
jobId:
type: string
fileName:
type: string
filePath:
type: string
completeTime:
type: string
startTime:
type: string
status:
type: string
BulkExportToolStatus:
type: array
items:
$ref: '#/components/schemas/BEObject'
BEObject:
properties:
jobId:
type: string
subscriberCount:
type: integer
exportedSubscriberCount:
type: integer
jobProgress:
type: string
status:
type: string
exportState:
type: string
BulkExportToolStatusJobId:
type: object
properties:
jobId:
type: string
subscriberCount:
type: integer
exportedSubscriberCount:
type: integer
jobProgress:
type: string
status:
type: string
exportState:
type: string
exportFileStatusList:
type: array
items:
$ref: '#/components/schemas/BEJobIdObject'
BEJobIdObject:
properties:
jobId:
type: string
fileName:
type: string
filePath:
type: string
completeTime:
type: string
startTime:
type: string
status:
type: string
BIConfiguration:
type: array
items:
$ref: '#/components/schemas/BIObject'
BIObject:
properties:
importFile:
type: string
timeQueued:
type: string
timeStarted:
type: string
timeCompleted:
type: string
progress:
type: number
failedKeys:
type: string
passCount:
type: integer
failCount:
type: integer
totalCount:
type: integer
format: int64
status:
type: string
ExportConfiguration:
type: object
properties:
Exportresourceid:
type: string
ExportId:
type: array
items:
type: string
ImportId:
type: array
items:
type: string
ExportStatus:
type: object
properties:
status:
type: string
exportResourceId:
type: string
createTimeStamp:
type: string
percentage:
type: string
result:
type: string
ExportReport:
type: array
items:
$ref: '#/components/schemas/Report'
Report:
type: object
properties:
status:
type: string
name:
type: string
ImportConfiguration:
type: object
properties:
Exportresourceid:
type: string
ImportStatus:
type: object
properties:
status:
type: string
exportResourceId:
type: string
createTimeStamp:
type: string
percentage:
type: string
result:
type: string
ImportReport:
type: array
items:
$ref: '#/components/schemas/Report'
Download:
type: object
LogConfiguration:
type: object
required:
- appLogLevel
properties:
logSubscriberInfo:
type: string
additionalErrorLogging:
type: string
appLogLevel:
type: string
enum:
- DEBUG
- ERROR
- WARN
- INFO
packageLogLevel:
type: array
items:
$ref: '#/components/schemas/PackageLog'
PackageLog:
type: object
properties:
packageName:
type: string
logLevelForPackage:
type: string
required:
- packageName
- logLevelForPackage
GwLogConfiguration:
type: object
required:
- appLogLevel
properties:
appLogLevel:
type: string
enum:
- DEBUG
- ERROR
- WARN
- INFO
packageLogLevel:
type: array
items:
$ref: '#/components/schemas/PackageLog'
logDiscarding:
$ref: '#/components/schemas/LogDiscarding'
LogDiscarding:
type: object
properties:
enabled:
type: boolean
featureToThresholdMapping:
type: array
minItems: 0
items:
$ref: '#/components/schemas/FeatureToThresholdMapping'
FeatureToThresholdMapping:
type: object
properties:
feature:
type: string
thresholdFactor:
type: string
AllLogs:
type: array
items:
$ref: '#/components/schemas/AllLogCfg'
AllLogCfg:
type: object
properties:
egress-gateway:
type: string
nudr-diameterproxy:
type: string
diam-gateway:
type: string
alternate-route:
type: string
nudr-drservice:
type: string
nudr-ondemand-migration:
type: string
nudr-notify-service:
type: string
ingress-gateway:
type: string
OperationalStateConfiguration:
type: object
properties:
operationalState:
type: string
OperationalStateHistory:
type: object
properties:
operationalState:
type: string
operationalStateHistory:
type: array
items:
$ref: '#/components/schemas/OperationStateHistoryArray'
OperationStateHistoryArray:
type: object
properties:
id:
type: string
timestamp:
type: string
type:
type: string
value:
type: string
status:
type: string
MigrationToolConfiguration:
type: object
properties:
migrationPauseEnabled:
type: boolean
keyType:
type: string
delete4g:
type: boolean
migrationRealm:
type: string
migrationIdentity:
type: string
migrationNodePort:
type: integer
migrationNodeHost:
type: string
migrationRanges:
type : object
MigrationToolStatus:
type: object
properties:
totalNumberOfSubscribers:
type: integer
totalNumberOfSourceUdrSuccess:
type: integer
totalNumberOfSourceUdrFailures:
type: integer
totalNumberOfTargetUdrSuccess:
type: integer
totalNumberOfTargetUdrFailures:
type: integer
totalNumberOfKeyAlreadyExistsTargetUdr:
type: integer
totalNumberOfSourceSubscriberNotFound:
type: integer
status:
type: string
timeStarted:
type: string
timeCompleted:
type: string
progress:
type: integer