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: '-'
Title: 'Unified Data Repository Service API file for subscription data'
Description: 'The API version is defined in 3GPP TS 29.504'
get:
Summary: Retrieves the authentication subscription data of a UE
Operation ID: QueryAuthSubsData
Tags:
- Authentication Data (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: supported-features
In: query
Description: Supported Features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/AuthenticationSubscription'
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
patch:
Summary: modify the authentication subscription data of a UE
Operation ID: ModifyAuthentication
Tags:
- Authentication Data (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
Request Body:
Content:
application/json-patch+json:
Schema:
Type: array
Items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/PatchItem'
Required/Optional: true
Responses:
'204':
Description: Expected response to a valid request
'403':
Description: modification is rejected
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
put:
Summary: To store the Authentication Status data of a UE
Operation ID: CreateAuthenticationStatus
Tags:
- Authentication Status (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
Request Body:
Content:
Application/JSON:
Schema:
Reference: 'TS29503_Nudm_UEAU.yaml#/components/schemas/AuthEvent'
Responses:
'204':
Description: Upon success, an empty response body shall be returned
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
get:
Summary: Retrieves the Authentication Status of a UE
Operation ID: QueryAuthenticationStatus
Tags:
- AuthEvent (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: fields
In: query
Description: attributes to be retrieved
Required/Optional: false
Schema:
Type: array
Items:
Type: string
Min Items: 1
Style: form
Explode: false
- Name: supportedFeatures
Description: Supported Features
In: query
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: 'TS29503_Nudm_UEAU.yaml#/components/schemas/AuthEvent'
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
put:
Summary: To store the SoR acknowledgement information of a UE
Operation ID: CreateAuthenticationSoR
Tags:
- Authentication SoR (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: supported-features
In: query
Description: Supported Features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SorData'
Responses:
'204':
Description: Expected response to a valid request
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
get:
Summary: Retrieves the SoR acknowledgement information of a UE
Operation ID: QueryAuthSoR
Tags:
- Authentication SoR (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: supportedFeatures
In: query
Description: Supported Features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SorData'
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
get:
Summary: Retrieve multiple provisioned data sets of a UE
Operation ID: QueryProvisionedData
Tags:
- Provisioned Data (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: servingPlmnId
In: path
Description: PLMN ID
Required/Optional: true
Schema:
Reference: '#/components/schemas/VarPlmnId'
- Name: dataset-names
In: query
Description: List of dataset names
Schema:
Reference: '#/components/schemas/DatasetNames'
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/ProvisionedDataSets'
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
get:
Summary: Retrieves the access and mobility subscription data of a UE
Operation ID: QueryAmData
Tags:
- Access And Mobility Subscription Data (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: servingPlmnId
In: path
Description: PLMN ID
Required/Optional: true
Schema:
Reference: '#/components/schemas/VarPlmnId'
- Name: fields
In: query
Description: attributes to be retrieved
Required/Optional: false
Schema:
Type: array
Items:
Type: string
Min Items: 1
Style: form
Explode: false
- Name: supported-features
In: query
Description: Supported Features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
- Name: If-None-Match
In: header
Description: Validator for conditional requests, as described in RFC 7232, 3.2
Schema:
Type: string
- Name: If-Modified-Since
In: header
Description: Validator for conditional requests, as described in RFC 7232, 3.3
Schema:
Type: string
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/AccessAndMobilitySubscriptionData'
Headers:
Cache-Control:
Description: Cache-Control containing max-age, as described in RFC 7234, 5.2
Schema:
Type: string
ETag:
Description: Entity Tag, containing a strong validator, as described in RFC 7232, 2.3
Schema:
Type: string
Last-Modified:
Description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2
Schema:
Type: string
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
get:
Summary: Retrieves the SMF selection subscription data of a UE
Operation ID: QuerySmfSelectData
Tags:
- SMF Selection Subscription Data (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: servingPlmnId
In: path
Description: PLMN ID
Required/Optional: true
Schema:
Reference: '#/components/schemas/VarPlmnId'
- Name: fields
In: query
Description: attributes to be retrieved
Required/Optional: false
Schema:
Type: array
Items:
Type: string
Min Items: 1
Style: form
Explode: false
- Name: supported-features
In: query
Description: Supported Features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
- Name: If-None-Match
In: header
Description: Validator for conditional requests, as described in RFC 7232, 3.2
Schema:
Type: string
- Name: If-Modified-Since
In: header
Description: Validator for conditional requests, as described in RFC 7232, 3.3
Schema:
Type: string
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmfSelectionSubscriptionData'
Headers:
Cache-Control:
Description: Cache-Control containing max-age, as described in RFC 7234, 5.2
Schema:
Type: string
ETag:
Description: Entity Tag, containing a strong validator, as described in RFC 7232, 2.3
Schema:
Type: string
Last-Modified:
Description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2
Schema:
Type: string
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
get:
Summary: Retrieves the Session Management subscription data of a UE
Operation ID: QuerySmData
Tags:
- Session Management Subscription Data
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: servingPlmnId
In: path
Description: PLMN ID
Required/Optional: true
Schema:
Reference: '#/components/schemas/VarPlmnId'
- Name: single-nssai
In: query
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/VarSnssai'
Description: single NSSAI
Required/Optional: false
- Name: dnn
In: query
Description: DNN
Required/Optional: false
Schema:
Reference: '#/components/schemas/Dnn'
- Name: fields
In: query
Description: attributes to be retrieved
Required/Optional: false
Schema:
Type: array
Items:
Type: string
Min Items: 1
Style: form
Explode: false
- Name: supported-features
In: query
Description: Supported Features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
- Name: If-None-Match
In: header
Description: Validator for conditional requests, as described in RFC 7232, 3.2
Schema:
Type: string
- Name: If-Modified-Since
In: header
Description: Validator for conditional requests, as described in RFC 7232, 3.3
Schema:
Type: string
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Type: array
Items:
Reference: '#/components/schemas/SessionManagementSubscriptionData'
Min Items: 1
Headers:
Cache-Control:
Description: Cache-Control containing max-age, as described in RFC 7234, 5.2
Schema:
Type: string
ETag:
Description: Entity Tag, containing a strong validator, as described in RFC 7232, 2.3
Schema:
Type: string
Last-Modified:
Description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2
Schema:
Type: string
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
get:
Summary: Retrieves the AMF context data of a UE using 3gpp access
Operation ID: QueryAmfContext3gpp
Tags:
- AMF 3GPP Access Registration (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: fields
In: query
Description: attributes to be retrieved
Required/Optional: false
Schema:
Type: array
Items:
Type: string
Min Items: 1
Style: form
Explode: false
- Name: supported-features
In: query
Description: Supported Features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/Amf3GppAccessRegistration'
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
put:
Summary: To store the AMF context data of a UE using 3gpp access in the UDR
Operation ID: CreateAmfContext3gpp
Tags:
- AMF 3GPP Access Registration (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/Amf3GppAccessRegistration'
Responses:
'204':
Description: Upon success, an empty response body shall be returned
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
patch:
Summary: To modify the AMF context data of a UE using 3gpp access in the UDR
Operation ID: AmfContext3gpp
Tags:
- AMF 3GPP Access Registration (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
Request Body:
Content:
application/json-patch+json:
Schema:
Type: array
Items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/PatchItem'
Required/Optional: true
Responses:
'204':
Description: Expected response to a valid request
'403':
Description: modification is rejected
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
get:
Summary: Retrieves the AMF context data of a UE using non-3gpp access
Operation ID: QueryAmfContextNon3gpp
Tags:
- AMF Non-3GPP Access Registration (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: fields
In: query
Description: attributes to be retrieved
Required/Optional: false
Schema:
Type: array
Items:
Type: string
Min Items: 1
Style: form
Explode: false
- Name: supported-features
In: query
Description: Supported Features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/AmfNon3GppAccessRegistration'
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
put:
Summary: To store the AMF context data of a UE using non-3gpp access in the UDR
Operation ID: CreateAmfContextNon3gpp
Tags:
- AMF Non-3GPP Access Registration (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/AmfNon3GppAccessRegistration'
Responses:
'204':
Description: Upon success, an empty response body shall be returned
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
patch:
Summary: To modify the AMF context data of a UE using non 3gpp access in the UDR
Operation ID: AmfContextNon3gpp
Tags:
- AMF Non-3GPP Access Registration (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
Request Body:
Content:
application/json-patch+json:
Schema:
Type: array
Items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/PatchItem'
Required/Optional: true
Responses:
'204':
Description: Expected response to a valid request
'403':
Description: modification is rejected
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
get:
Summary: Retrieves the SMF registration list of a UE
Operation ID: QuerySmfRegList
Tags:
- SMF Registrations (Collection)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: supported-features
In: query
Description: Supported Features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmfRegList'
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
get:
Summary: Retrieves the individual SMF registration of a UE
Operation ID: QuerySmfRegistration
Tags:
- SMF Registration (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: pduSessionId
In: path
Description: PDU session id
Required/Optional: true
Schema:
Type: string
- Name: fields
In: query
Description: attributes to be retrieved
Required/Optional: false
Schema:
Type: array
Items:
Type: string
Min Items: 1
Style: form
Explode: false
- Name: supported-features
In: query
Description: Supported Features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmfRegistration'
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
put:
Summary: To create an individual SMF context data of a UE in the UDR
Operation ID: CreateSmfContextNon3gpp
Tags:
- SMF Registration (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: pduSessionId
In: path
Description: PDU session id
Required/Optional: true
Schema:
Type: integer
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmfRegistration'
Responses:
'201':
Description: Upon success, a response body containing a representation of the created Individual SmfRegistration resource shall be returned
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
Headers:
Location:
description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nsmf-pdusession/v1/sm-contexts/{smContextRef}/subscription-data/{ueId}/context-data/smf-registrations/{pduSessionId}'
Required/Optional: true
Schema:
Type: string
delete:
Summary: To remove an individual SMF context data of a UE the UDR
Operation ID: DeleteSmfContext
Tags:
- SMF Registration (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: pduSessionId
In: path
Description: PDU session id
Required/Optional: true
Schema:
Type: string
Responses:
'204':
Description: Upon success, an empty response body shall be returned.
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
get:
Summary: Retrieves the operator specific data of a UE
Operation ID: QueryOperSpecData
Tags:
- Operator-Specific Data Container (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: fields
In: query
Description: attributes to be retrieved
Required/Optional: false
Schema:
Type: array
Items:
Type: string
Min Items: 1
Style: form
Explode: false
- Name: supported-features
In: query
Description: Supported Features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
- Name: If-None-Match
In: header
Description: Validator for conditional requests, as described in RFC 7232, 3.2
Schema:
Type: string
- Name: If-Modified-Since
In: header
Description: Validator for conditional requests, as described in RFC 7232, 3.3
Schema:
Type: string
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/OperatorSpecificDataContainer'
Headers:
Cache-Control:
Description: Cache-Control containing max-age, as described in RFC 7234, 5.2
Schema:
Type: string
ETag:
Description: Entity Tag, containing a strong validator, as described in RFC 7232, 2.3
Schema:
Type: string
Last-Modified:
Description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2
Schema:
Type: string
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
patch:
Summary: To modify operator specific data of a UE
Operation ID: AmfContext3gpp
Tags:
- Operator-Specific Data Container (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
Request Body:
Content:
application/json-patch+json:
Schema:
Type: array
Items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/PatchItem'
Required/Optional: true
Responses:
'204':
Description: Expected response to a valid request
'403':
Description: modification is rejected
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
put:
Summary: Create the SMSF context data of a UE via 3GPP access
Operation ID: CreateSmsfContext3gpp
Tags:
- SMSF 3GPP Registration (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmsfRegistration'
Responses:
'204':
Description: Upon success, an empty response body shall be returned
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
delete:
Summary: To remove the SMSF context data of a UE via 3GPP access
Operation ID: DeleteSmsfContext3gpp
Tags:
- SMSF 3GPP Registration (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
Responses:
'204':
Description: Upon success, an empty response body shall be returned
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
get:
Summary: Retrieves the SMSF context data of a UE using 3gpp access
Operation ID: QuerySmsfContext3gpp
Tags:
- SMSF 3GPP Registration (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: fields
In: query
Description: attributes to be retrieved
Required/Optional: false
Schema:
Type: array
Items:
Type: string
Min Items: 1
Style: form
Explode: false
- Name: supported-features
In: query
Description: Supported Features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmsfRegistration'
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
put:
Summary: Create the SMSF context data of a UE via non-3GPP access
Operation ID: CreateSmsfContextNon3gpp
Tags:
- SMSF Non-3GPP Registration (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmsfRegistration'
Responses:
'204':
Description: Upon success, an empty response body shall be returned
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
delete:
Summary: To remove the SMSF context data of a UE via non-3GPP access
Operation ID: DeleteSmsfContextNon3gpp
Tags:
- SMSF Non-3GPP Registration (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
Responses:
'204':
Description: Upon success, an empty response body shall be returned
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
get:
Summary: Retrieves the SMSF context data of a UE using non-3gpp access
Operation ID: QuerySmsfContextNon3gpp
Tags:
- SMSF Non-3GPP Registration (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: fields
In: query
Description: attributes to be retrieved
Required/Optional: false
Schema:
Type: array
Items:
Type: string
Min Items: 1
Style: form
Explode: false
- Name: supported-features
In: query
Description: Supported Features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmsfRegistration'
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
get:
Summary: Retrieves the SMS management subscription data of a UE
Operation ID: QuerySmsMngData
Tags:
- SMS Management Subscription Data (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: servingPlmnId
In: path
Description: PLMN ID
Required/Optional: true
Schema:
Reference: '#/components/schemas/VarPlmnId'
- Name: supported-features
In: query
Description: Supported Features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
- Name: If-None-Match
In: header
Description: Validator for conditional requests, as described in RFC 7232, 3.2
Schema:
Type: string
- Name: If-Modified-Since
In: header
Description: Validator for conditional requests, as described in RFC 7232, 3.3
Schema:
Type: string
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmsManagementSubscriptionData'
Headers:
Cache-Control:
Description: Cache-Control containing max-age, as described in RFC 7234, 5.2
Schema:
Type: string
ETag:
Description: Entity Tag, containing a strong validator, as described in RFC 7232, 2.3
Schema:
Type: string
Last-Modified:
Description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2
Schema:
Type: string
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
get:
Summary: Retrieves the SMS subscription data of a UE
Operation ID: QuerySmsData
Tags:
- SMS Subscription Data (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: servingPlmnId
In: path
Description: PLMN ID
Required/Optional: true
Schema:
Reference: '#/components/schemas/VarPlmnId'
- Name: supported-features
In: query
Description: Supported Features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
- Name: If-None-Match
In: header
Description: Validator for conditional requests, as described in RFC 7232, 3.2
Schema:
Type: string
- Name: If-Modified-Since
In: header
Description: Validator for conditional requests, as described in RFC 7232, 3.3
Schema:
Type: string
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SmsSubscriptionData'
Headers:
Cache-Control:
Description: Cache-Control containing max-age, as described in RFC 7234, 5.2
Schema:
Type: string
ETag:
Description: Entity Tag, containing a strong validator, as described in RFC 7232, 2.3
Schema:
Type: string
Last-Modified:
Description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2
Schema:
Type: string
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
get:
Summary: Read the profile of a given UE
Operation ID: GetppData
Tags:
- Parameter Provision (Document)
Parameters:
- Name: ueId
In: path
Description: pp data for a UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: supported-features
In: query
Description: Supported Features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
- Name: If-None-Match
In: header
Description: Validator for conditional requests, as described in RFC 7232, 3.2
Schema:
Type: string
- Name: If-Modified-Since
In: header
Description: Validator for conditional requests, as described in RFC 7232, 3.3
Schema:
Type: string
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/PpData'
Headers:
Cache-Control:
Description: Cache-Control containing max-age, as described in RFC 7234, 5.2
Schema:
Type: string
ETag:
Description: Entity Tag, containing a strong validator, as described in RFC 7232, 2.3
Schema:
Type: string
Last-Modified:
Description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2
Schema:
Type: string
'403':
Description: Forbidden
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
patch:
Summary: modify the provisioned parameter data
Operation ID: ModifyPpData
Tags:
- ProvisionedParameterData (Document)
Parameters:
- Name: ueId
In: path
Description: pp data for a UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
Request Body:
Content:
application/json-patch+json:
Schema:
Type: array
Items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/PatchItem'
Required/Optional: true
Responses:
'204':
Description: Expected response to a valid request
'403':
Description: modification is rejected
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
get:
Summary: Retrieves the ee subscriptions of a UE
Operation ID: Queryeesubscriptions
Tags:
- Event Exposure Subscriptions (Collection)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: supported-features
In: query
Description: Supported Features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Type: array
Items:
Reference: '#/components/schemas/EeSubscription'
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
Method: Post
Summary: Create individual EE subscription
Operation ID: CreateEeSubscriptions
Tags:
- Event Exposure Subscriptions (Collection)
Parameters:
- Name: ueId
In: path
Description: UE ID
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/EeSubscription'
Required/Optional: true
Responses:
'201':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/EeSubscription'
Headers:
Location:
description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}'
Required/Optional: true
Schema:
Type: string
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
put:
Summary: Stores an individual ee subscriptions of a UE
Operation ID: UpdateEesubscriptions
Tags:
- Event Exposure Subscription (Document)
Parameters:
- Name: ueId
In: path
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: subsId
In: path
Required/Optional: true
Schema:
Type: string
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/EeSubscription'
Responses:
'204':
Description: Upon success, an empty response body shall be returned
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
delete:
Summary: Deletes a eeSubscription
Operation ID: RemoveeeSubscriptions
Tags:
- Event Exposure Subscription (Document)
Parameters:
- Name: ueId
In: path
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: subsId
In: path
Required/Optional: true
Description: Unique ID of the subscription to remove
Schema:
Type: string
Responses:
'204':
Description: Expected response to a successful subscription removal
put:
Summary: Create AmfSubscriptions for an individual ee subscriptions of a UE
Operation ID: Create AMF Subscriptions
Tags:
- AMF Subscription Info (Document)
Parameters:
- Name: ueId
In: path
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: subsId
In: path
Required/Optional: true
Schema:
Type: string
Request Body:
Content:
Application/JSON:
Schema:
Type: array
Items:
Reference: '#/components/schemas/AmfSubscriptionInfo'
Min Items: 1
Required/Optional: true
Responses:
'204':
Description: Upon success, an empty response body shall be returned
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
delete:
Summary: Deletes AMF Subscription Info for an eeSubscription
Operation ID: RemoveAmfSubscriptionsInfo
Tags:
- Event AMF Subscription Info (Document)
Parameters:
- Name: ueId
In: path
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: subsId
In: path
Required/Optional: true
Schema:
Type: string
Responses:
'204':
Description: Expected response to a successful subscription removal
patch:
Summary: modify the AMF Subscription Info
Operation ID: ModifyAmfSubscriptionInfo
Tags:
- AmfSubscriptionInfo (Document)
Parameters:
- Name: ueId
In: path
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: subsId
In: path
Required/Optional: true
Schema:
Type: string
Request Body:
Content:
application/json-patch+json:
Schema:
Type: array
Items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/PatchItem'
Required/Optional: true
Responses:
'204':
Description: Expected response to a valid request
'403':
Description: modification is rejected
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
get:
Summary: Retrieve AMF subscription Info
Operation ID: GetAmfSubscriptionInfo
Tags:
- Query AMF Subscription Info (Document)
Parameters:
- Name: ueId
In: path
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: subsId
In: path
Required/Optional: true
Schema:
Type: string
Responses:
'200':
Description: OK
Content:
Application/JSON:
Schema:
Type: array
Items:
Reference: '#/components/schemas/AmfSubscriptionInfo'
Min Items: 1
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
get:
Summary: Retrieves the ee subscriptions of a group of UEs or any UE
Operation ID: QueryEeGroupSubscriptions
Tags:
- Event Exposure Group Subscriptions (Collection)
Parameters:
- Name: ueGroupId
In: path
Description: Group of UEs or any UE
Required/Optional: true
Schema:
Reference: '#/components/schemas/VarUeGroupId'
- Name: supported-features
In: query
Description: Supported Features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Type: array
Items:
Reference: '#/components/schemas/EeSubscription'
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
Method: Post
Summary: Create individual EE subscription for a group of UEs or any UE
Operation ID: CreateEeGroupSubscriptions
Tags:
- Event Exposure Group Subscriptions (Collection)
Parameters:
- Name: ueGroupId
In: path
Description: Group of UEs or any UE
Required/Optional: true
Schema:
Reference: '#/components/schemas/VarUeGroupId'
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/EeSubscription'
Required/Optional: true
Responses:
'201':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/EeSubscription'
Headers:
Location:
description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/v1/subscription-data/group-data/{ueGroupId}/ee-subscriptions '
Required/Optional: true
Schema:
Type: string
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
put:
Summary: Stores an individual ee subscription of a group of UEs or any UE
Operation ID: UpdateEeGroupSubscriptions
Tags:
- Event Exposure Subscription (Document)
Parameters:
- Name: ueGroupId
In: path
Required/Optional: true
Schema:
Reference: '#/components/schemas/VarUeGroupId'
- Name: subsId
In: path
Required/Optional: true
Schema:
Type: string
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/EeSubscription'
Responses:
'204':
Description: Upon success, an empty response body shall be returned
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
delete:
Summary: Deletes a eeSubscription for a group of UEs or any UE
Operation ID: RemoveEeGroupSubscriptions
Tags:
- Event Exposure Subscription (Document)
Parameters:
- Name: ueGroupId
In: path
Required/Optional: true
Schema:
Reference: '#/components/schemas/VarUeGroupId'
- Name: subsId
In: path
Required/Optional: true
Description: Unique ID of the subscription to remove
Schema:
Type: string
Responses:
'204':
Description: Expected response to a successful subscription removal
get:
Summary: Retrieves the ee profile data of a UE
Operation ID: QueryEEData
Tags:
- Event Exposure Data (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: fields
In: query
Description: attributes to be retrieved
Required/Optional: false
Schema:
Type: array
Items:
Type: string
Style: form
Explode: false
- Name: supportedFeatures
In: query
Description: Supported Features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/EeProfileData'
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
get:
Summary: Retrieves the sdm subscriptions of a UE
Operation ID: Querysdmsubscriptions
Tags:
- SDM Subscriptions (Collection)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: supported-features
In: query
Description: Supported Features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Type: array
Items:
Reference: '#/components/schemas/SdmSubscription'
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
Method: Post
Summary: Create individual sdm subscription
Operation ID: CreateSdmSubscriptions
Tags:
- SDM Subscriptions (Collection)
Parameters:
- Name: ueId
In: path
Description: UE ID
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SdmSubscription'
Required/Optional: true
Responses:
'201':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SdmSubscription'
Headers:
Location:
description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/subscription-data/{ueId}/context-data/sdm-subscriptions/{subsId}'
Required/Optional: true
Schema:
Type: string
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
put:
Summary: Stores an individual sdm subscriptions of a UE
Operation ID: Updatesdmsubscriptions
Tags:
- SDM Subscription (Document)
Parameters:
- Name: ueId
In: path
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: subsId
In: path
Required/Optional: true
Schema:
Type: string
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SdmSubscription'
Responses:
'204':
Description: Upon success, an empty response body shall be returned
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
delete:
Summary: Deletes a sdmsubscriptions
Operation ID: RemovesdmSubscriptions
Tags:
- SDM Subscription (Document)
Parameters:
- Name: ueId
In: path
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: subsId
In: path
Required/Optional: true
Description: Unique ID of the subscription to remove
Schema:
Type: string
Responses:
'204':
Description: Expected response to a successful subscription removal
get:
Summary: retrieve shared data
Operation ID: GetSharedData
Tags:
- Retrieval of shared data
Parameters:
- Name: shared-data-ids
In: query
Description: List of shared data ids
Required/Optional: true
Style: form
Explode: false
Schema:
Reference: 'TS29503_Nudm_SDM.yaml#/components/schemas/SharedDataIds'
- Name: supportedFeatures
In: query
Description: Supported Features
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Type: array
Items:
Reference: 'TS29503_Nudm_SDM.yaml#/components/schemas/SharedData'
Min Items: 1
'400':
Reference: 'TS29571_CommonData.yaml#/components/responses/400'
'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
Method: Post
Summary: Subscription data subscriptions
Operation ID: SubscriptionDataSubscriptions
Tags:
- Subs To Nofify (Collection)
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SubscriptionDataSubscriptions'
Required/Optional: true
Responses:
'201':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SubscriptionDataSubscriptions'
Headers:
Location:
description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/subscription-data/subs-to-notify/{subsId}'
Required/Optional: true
Schema:
Type: string
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
Callbacks:
onDataChange:
'{request.body#/callbackReference}':
Method: Post
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/DataChangeNotify'
Responses:
'204':
Description: Expected response to a valid request
delete:
Summary: Deletes a subscriptionDataSubscriptions
Operation ID: RemovesubscriptionDataSubscriptions
Tags:
- Subs To Notify (Document)
Parameters:
- Name: subsId
In: path
Required/Optional: true
Description: Unique ID of the subscription to remove
Schema:
Type: string
Responses:
'204':
Description: Expected response to a successful subscription removal
get:
Summary: Retrieves the trace configuration data of a UE
Operation ID: QueryTraceData
Tags:
- Trace Data (Document)
Parameters:
- Name: ueId
In: path
Description: UE id
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: servingPlmnId
In: path
Description: PLMN ID
Required/Optional: true
Schema:
Reference: '#/components/schemas/VarPlmnId'
- Name: If-None-Match
In: header
Description: Validator for conditional requests, as described in RFC 7232, 3.2
Schema:
Type: string
- Name: If-Modified-Since
In: header
Description: Validator for conditional requests, as described in RFC 7232, 3.3
Schema:
Type: string
Responses:
'200':
Description: Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/TraceData'
Headers:
Cache-Control:
Description: Cache-Control containing max-age, as described in RFC 7234, 5.2
Schema:
Type: string
ETag:
Description: Entity Tag, containing a strong validator, as described in RFC 7232, 2.3
Schema:
Type: string
Last-Modified:
Description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2
Schema:
Type: string
Default:
Reference: 'TS29571_CommonData.yaml#/components/responses/default'
get:
Summary: Retrieve identity data by SUPI or GPSI
Operation ID: GetIdentityData
Tags:
- Query Identity Data by SUPI or GPSI (Document)
Parameters:
- Name: ueId
In: path
Description: UE ID
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
- Name: If-None-Match
In: header
Description: Validator for conditional requests, as described in RFC 7232, 3.2
Schema:
Type: string
- Name: If-Modified-Since
In: header
Description: Validator for conditional requests, as described in RFC 7232, 3.3
Schema:
Type: string
Responses:
'200':
Description: OK
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/IdentityData'
Headers:
Cache-Control:
Description: Cache-Control containing max-age, as described in RFC 7234, 5.2
Schema:
Type: string
ETag:
Description: Entity Tag, containing a strong validator, as described in RFC 7232, 2.3
Schema:
Type: string
Last-Modified:
Description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2
Schema:
Type: string
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
get:
Summary: Retrieve ODB Data data by SUPI or GPSI
Operation ID: GetOdbData
Tags:
- Query ODB Data by SUPI or GPSI (Document)
Parameters:
- Name: ueId
In: path
Description: UE ID
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
Responses:
'200':
Description: OK
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/OperatorDeterminedBarringData'
Default:
Description: Unexpected error
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
schemas:
AuthenticationSubscription:
Type: object
Required:
- authenticationMethod
- permanentKey
- sequenceNumber
Properties:
authenticationMethod:
Reference: '#/components/schemas/AuthMethod'
permanentKey:
Reference: '#/components/schemas/PermanentKey'
sequenceNumber:
Reference: '#/components/schemas/SequenceNumber'
authenticationManagementField:
Reference: '#/components/schemas/AuthenticationManagementField'
vectorAlgorithm:
Reference: '#/components/schemas/VectorAlgorithm'
milenage:
Reference: '#/components/schemas/Milenage'
tuak:
Reference: '#/components/schemas/Tuak'
opc:
Reference: '#/components/schemas/Opc'
topc:
Reference: '#/components/schemas/Topc'
sharedAuthenticationSubscriptionId:
Reference: 'TS29503_Nudm_SDM.yaml#/components/schemas/SharedData'
SharedAuthenticationSubscription:
Type: object
Required:
- authenticationMethod
- vectorAlgorithm
Properties:
authenticationManagementField:
Reference: '#/components/schemas/AuthenticationManagementField'
vectorAlgorithm:
Reference: '#/components/schemas/VectorAlgorithm'
milenage:
Reference: '#/components/schemas/Milenage'
tuak:
Reference: '#/components/schemas/Tuak'
PermanentKey:
Type: object
Required:
- permanentKeyValue
- encryptionKey
- encryptionAlgorithm
Properties:
permanentKeyValue:
Reference: '#/components/schemas/PermanentKeyValue'
encryptionKey:
Reference: '#/components/schemas/EncryptionKey'
encryptionAlgorithm:
Reference: '#/components/schemas/EncryptionAlgorithm'
Milenage:
Type: object
Properties:
op:
Reference: '#/components/schemas/Op'
rotations:
Reference: '#/components/schemas/Rotations'
constants:
Reference: '#/components/schemas/Constants'
Tuak:
Type: object
Properties:
top:
Reference: '#/components/schemas/Top'
keccakIterations:
Type: integer
Minimum: 1
Maximum: 255
Op:
Type: object
Required:
- opValue
- encryptionKey
- encryptionAlgorithm
Properties:
opValue:
Reference: '#/components/schemas/OpValue'
encryptionKey:
Reference: '#/components/schemas/EncryptionKey'
encryptionAlgorithm:
Reference: '#/components/schemas/EncryptionAlgorithm'
Opc:
Type: object
Required:
- opcValue
- encryptionKey
- encryptionAlgorithm
Properties:
opcValue:
Reference: '#/components/schemas/OpcValue'
encryptionKey:
Reference: '#/components/schemas/EncryptionKey'
encryptionAlgorithm:
Reference: '#/components/schemas/EncryptionAlgorithm'
Top:
Type: object
Required:
- topValue
- encryptionKey
- encryptionAlgorithm
Properties:
topValue:
Reference: '#/components/schemas/TopValue'
encryptionKey:
Reference: '#/components/schemas/EncryptionKey'
encryptionAlgorithm:
Reference: '#/components/schemas/EncryptionAlgorithm'
Topc:
Type: object
Required:
- topcValue
- encryptionKey
- encryptionAlgorithm
Properties:
topcValue:
Reference: '#/components/schemas/TopcValue'
encryptionKey:
Reference: '#/components/schemas/EncryptionKey'
encryptionAlgorithm:
Reference: '#/components/schemas/EncryptionAlgorithm'
Rotations:
Type: object
Required:
- r1
- r2
- r3
- r4
- r5
Properties:
r1:
Reference: '#/components/schemas/RValue'
r2:
Reference: '#/components/schemas/RValue'
r3:
Reference: '#/components/schemas/RValue'
r4:
Reference: '#/components/schemas/RValue'
r5:
Reference: '#/components/schemas/RValue'
Constants:
Type: object
Required:
- c1
- c2
- c3
- c4
- c5
Properties:
c1:
Reference: '#/components/schemas/CValue'
c2:
Reference: '#/components/schemas/CValue'
c3:
Reference: '#/components/schemas/CValue'
c4:
Reference: '#/components/schemas/CValue'
c5:
Reference: '#/components/schemas/CValue'
PermanentKeyValue:
Type: string
Pattern: '^[A-Fa-f0-9]+$'
SequenceNumber:
Type: string
Pattern: '^[A-Fa-f0-9]{12}$'
AuthenticationManagementField:
Type: string
Pattern: '^[A-Fa-f0-9]{4}$'
OpValue:
Type: string
Pattern: '^[A-Fa-f0-9]+$'
OpcValue:
Type: string
Pattern: '^[A-Fa-f0-9]+$'
TopValue:
Type: string
Pattern: '^[A-Fa-f0-9]+$'
TopcValue:
Type: string
Pattern: '^[A-Fa-f0-9]+$'
RValue:
Type: string
Pattern: '^[A-Fa-f0-9]+$'
CValue:
Type: string
Pattern: '^[A-Fa-f0-9]+$'
EncryptionKey:
Type: integer
EncryptionAlgorithm:
Type: integer
VectorAlgorithm:
Type: string
enum:
- MILENAGE
- TUAK
VarPlmnId:
Type: string
Pattern: '^[0-9]{5,6}$'
DatasetNames:
Type: array
Items:
Reference: '#/components/schemas/DataSetName'
minItems: 1
uniqueItems: true
DataSetName:
anyOf:
- type: string
enum:
- AM
- SMF_SEL
- SMS_SUB
- SM
- TRACE
- SMS_MNG
- type: string
ProvisionedDataSets:
Type: object
Properties:
amData:
Reference: '#/components/schemas/AccessAndMobilitySubscriptionData'
smfSelData:
Reference: '#/components/schemas/SmfSelectionSubscriptionData'
smsSubsData:
Reference: '#/components/schemas/SmsSubscriptionData'
smData:
Type: array
Items:
Reference: '#/components/schemas/SessionManagementSubscriptionData'
traceData:
Reference: 'TS29571_CommonData.yaml#/components/schemas/TraceData'
smsMngData:
Reference: '#/components/schemas/SmsManagementSubscriptionData'
AccessAndMobilitySubscriptionData:
Reference: 'TS29503_Nudm_SDM.yaml#/components/schemas/AccessAndMobilitySubscriptionData'
SmfSelectionSubscriptionData:
Reference: 'TS29503_Nudm_SDM.yaml#/components/schemas/SmfSelectionSubscriptionData'
VarSnssai:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
Dnn:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
SessionManagementSubscriptionData:
Reference: 'TS29503_Nudm_SDM.yaml#/components/schemas/SessionManagementSubscriptionData'
Amf3GppAccessRegistration:
Reference: 'TS29503_Nudm_UECM.yaml#/components/schemas/Amf3GppAccessRegistration'
AmfNon3GppAccessRegistration:
Reference: 'TS29503_Nudm_UECM.yaml#/components/schemas/AmfNon3GppAccessRegistration'
SmfRegistration:
Reference: 'TS29503_Nudm_UECM.yaml#/components/schemas/SmfRegistration'
SmsfRegistration:
Reference: 'TS29503_Nudm_UECM.yaml#/components/schemas/SmsfRegistration'
SmsManagementSubscriptionData:
Reference: 'TS29503_Nudm_SDM.yaml#/components/schemas/SmsManagementSubscriptionData'
SmsSubscriptionData:
Reference: 'TS29503_Nudm_SDM.yaml#/components/schemas/SmsSubscriptionData'
OperatorSpecificDataContainer:
Type: object
Properties:
StringTypeElements:
Type: object
additionalProperties:
Type: string
IntegerTypeElements:
Type: object
additionalProperties:
Type: integer
NumberTypeElements:
Type: object
additionalProperties:
Type: number
BooleanTypeElements:
Type: object
additionalProperties:
Type: boolean
AuthMethod:
Type: string
enum:
- 5G_AKA
- EAP_AKA_PRIME
PpData:
Reference: 'TS29503_Nudm_PP.yaml#/components/schemas/PpData'
EeSubscription:
Reference: 'TS29503_Nudm_EE.yaml#/components/schemas/EeSubscription'
VarUeGroupId:
Type: string
Pattern: '^(extgroupid-[^@]+@[^@]+|anyUE)$'
SdmSubscription:
Reference: 'TS29503_Nudm_SDM.yaml#/components/schemas/SdmSubscription'
SmfRegList:
Type: array
Items:
Reference: '#/components/schemas/SmfRegistration'
SubscriptionDataSubscriptions:
Type: object
Required:
- ueId
- callbackReference
- originalCallbackReference
- supported-features
Properties:
ueId:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
callbackReference:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'
originalCallbackReference:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'
monitoredResourceUri:
Type: array
Items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'
expiry:
Reference: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
supported-features:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
DataChangeNotify:
Type: object
Properties:
originalCallbackReference:
Type: array
Items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'
minItems: 1
ueId:
Reference: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
notifyItems:
Type: array
Items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/NotifyItem'
minItems: 1
IdentityData:
Type: object
Properties:
supiList:
Type: array
Items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
minItems: 1
maxItems: 2
gpsiList:
Type: array
Items:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
minItems: 1
SorData:
Type: object
Properties:
sorXmacIue:
Reference: 'TS29509_Nausf_SoRProtection.yaml#/components/schemas/SorMac'
Required:
- sorXmacIue
OperatorDeterminedBarringData:
Reference: 'TS29571_CommonData.yaml#/components/schemas/OdbData'
EeProfileData:
Type: object
Properties:
restrictedEventTypes:
Type: array
Items:
Reference: 'TS29503_Nudm_EE.yaml#/components/schemas/EventType'
supportedFeatures:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
AmfSubscriptionInfo:
Type: object
Required:
- amfInstanceId
- subscriptionId
Properties:
amfInstanceId:
Reference: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
subscriptionId:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'
subsChangeNotifyCorrelationId:
Type: string
Description: 3GPP TS 29.505 V15.2.0; 5G System; Usage of the Unified Data Repository services for Subscription Data; Stage 3
URL: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.505/'