OpenAPI
OpenAPI Version: 3.0.0
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
OpenAPI Version: 3.0.0
Version: '1.0.0'
Title: 'Nudm_PP'
Description: 'Nudm Parameter Provision Service'
URL: '{apiRoot}/nudm-pp/v1'
Variables:
API Root:
Default: https://example.com
Description: apiRoot as defined in subclause subclause 4.4 of 3GPP TS 29.501.
- oAuth2ClientCredentials:
- nudm-pp
- {}
patch:
Summary: provision parameters
Operation ID: Update
Tags:
- Subscription Data Update
Parameters:
- Name: gpsi
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
Request Body:
Content:
application/merge-patch+json:
Schema:
Reference: '#/components/schemas/PpData'
Required/Optional: true
Responses:
'204':
Description: Expected response to a valid request
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
Reference: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
Reference: 'TS29571_CommonData.yaml#/components/responses/404'
'500':
Reference: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
Reference: 'TS29571_CommonData.yaml#/components/responses/503'
Default:
Description: Unexpected error
securitySchemes:
oAuth2ClientCredentials:
Type: oauth2
Flows:
clientCredentials:
tokenUrl: '{nrfApiRoot}/oauth2/token'
scopes:
nudm-pp: Access to the nudm-pp API
schemas:
# COMPLEX TYPES:
PpData:
Type: object
Properties:
communicationCharacteristics:
Reference: '#/components/schemas/CommunicationCharacteristics'
supportedFeatures:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
CommunicationCharacteristics:
Type: object
Properties:
ppSubsRegTimer:
Reference: '#/components/schemas/PpSubsRegTimer'
ppActiveTime:
Reference: '#/components/schemas/PpActiveTime'
ppDlPacketCount:
Reference: '#/components/schemas/PpDlPacketCount'
PpSubsRegTimer:
Type: object
Required:
- subsRegTimer
- afInstanceId
- referenceId
Properties:
subsRegTimer:
Reference: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
afInstanceId:
Reference: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
referenceId:
Reference: '#/components/schemas/ReferenceId'
nullable: true
PpActiveTime:
Type: object
Required:
- activeTime
- afInstanceId
- referenceId
Properties:
activeTime:
Reference: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
afInstanceId:
Reference: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
referenceId:
Reference: '#/components/schemas/ReferenceId'
nullable: true
# SIMPLE TYPES:
ReferenceId:
Type: integer
PpDlPacketCount:
Type: integer
nullable: true
# ENUMS:
Description: 3GPP TS 29.503 Unified Data Management Services, version 15.2.1
URL: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.503/'