A.2 Nudr_DataRepository API for Subscription Data
29.5053GPP5G SystemRelease 18Stage 3TSUsage of the Unified Data Repository services for Subscription Data
For the purpose of referencing entities in the Open API file defined in this Annex, it shall be assumed that this Open API file is contained in a physical file named "TS29505_Subscription_Data.yaml".
openapi: 3.0.0
info:
version: ‘-‘
title: ‘Unified Data Repository Service API file for subscription data’
description: |
Unified Data Repository Service (subscription data).
The API version is defined in 3GPP TS 29.504.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.505 V18.0.0; 5G System; Usage of the Unified Data Repository Service for subscription data; Stage 3
url: ‘https://www.3gpp.org/ftp/Specs/archive/29_series/29.505/’
paths:
/subscription-data/{ueId}/authentication-data/authentication-subscription:
get:
summary: Retrieves the authentication subscription data of a UE
operationId: QueryAuthSubsData
tags:
– Authentication Data (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data:authentication-subscription:read
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/AuthenticationSubscription’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
patch:
summary: modify the authentication subscription data of a UE
operationId: ModifyAuthenticationSubscription
tags:
– Authentication Subscription (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data:authentication-subscription:modify
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
– name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchItem’
required: true
responses:
‘204’:
description: Expected response to a valid request
‘403’:
description: modification is rejected
content:
application/problem+json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchResult’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/authentication-data/authentication-status:
put:
summary: To store the Authentication Status data of a UE
operationId: CreateAuthenticationStatus
tags:
– Authentication Status (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
requestBody:
content:
application/json:
schema:
$ref: ‘TS29503_Nudm_UEAU.yaml#/components/schemas/AuthEvent’
required: true
responses:
‘204’:
description: Upon success, an empty response body shall be returned
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieves the Authentication Status of a UE
operationId: QueryAuthenticationStatus
tags:
– AuthEvent (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
– name: fields
in: query
description: attributes to be retrieved
required: false
schema:
type: array
items:
type: string
minItems: 1
style: form
explode: false
– name: supported-features
description: Supported Features
in: query
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29503_Nudm_UEAU.yaml#/components/schemas/AuthEvent’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
summary: To remove the Authentication Status of a UE
operationId: DeleteAuthenticationStatus
tags:
– AuthEvent (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
responses:
‘204’:
description: Upon success, an empty response body shall be returned.
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/authentication-data/authentication-status/{servingNetworkName}:
put:
summary: To store the individual Authentication Status data of a UE
operationId: CreateIndividualAuthenticationStatus
tags:
– Individual Authentication Status (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
– name: servingNetworkName
in: path
description: Serving Network Name
required: true
schema:
$ref: ‘TS29503_Nudm_UEAU.yaml#/components/schemas/ServingNetworkName’
requestBody:
content:
application/json:
schema:
$ref: ‘TS29503_Nudm_UEAU.yaml#/components/schemas/AuthEvent’
required: true
responses:
‘204’:
description: Upon success, an empty response body shall be returned
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieves the Individual Authentication Status of a UE
operationId: QueryIndividualAuthenticationStatus
tags:
– Individual AuthEvent (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
– name: servingNetworkName
in: path
description: Serving Network Name
required: true
schema:
$ref: ‘TS29503_Nudm_UEAU.yaml#/components/schemas/ServingNetworkName’
– name: fields
in: query
description: attributes to be retrieved
required: false
schema:
type: array
items:
type: string
minItems: 1
style: form
explode: false
– name: supported-features
description: Supported Features
in: query
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29503_Nudm_UEAU.yaml#/components/schemas/AuthEvent’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
summary: To remove the Individual Authentication Status of a UE
operationId: DeleteIndividualAuthenticationStatus
tags:
– Individual AuthEvent (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
– name: servingNetworkName
in: path
description: Serving Network Name
required: true
schema:
$ref: ‘TS29503_Nudm_UEAU.yaml#/components/schemas/ServingNetworkName’
responses:
‘204’:
description: Upon success, an empty response body shall be returned.
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/ue-update-confirmation-data/sor-data:
put:
summary: To store the SoR acknowledgement information of a UE and ME support of SOR CMCI
operationId: CreateAuthenticationSoR
tags:
– Authentication SoR (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/SorData’
required: true
responses:
‘204’:
description: Expected response to a valid request
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieves the SoR acknowledgement information of a UE and ME support of SOR CMCI
operationId: QueryAuthSoR
tags:
– Authentication SoR (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/SorData’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
patch:
summary: Updates the ME support of SOR CMCI information of a UE
operationId: UpdateAuthenticationSoR
tags:
– Authentication SoR (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchItem’
required: true
responses:
‘204’:
description: Expected response to a valid request
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchResult’
‘403’:
description: modification is rejected
content:
application/problem+json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/ue-update-confirmation-data/upu-data:
put:
summary: To store the UPU acknowledgement information of a UE
operationId: CreateAuthenticationUPU
tags:
– Authentication UPU (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/UpuData’
required: true
responses:
‘204’:
description: Expected response to a valid request
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieves the UPU acknowledgement information of a UE
operationId: QueryAuthUPU
tags:
– Authentication UPU (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/UpuData’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/ue-update-confirmation-data/subscribed-snssais:
put:
summary: To store the NSSAI update acknowledgement information of a UE
operationId: CreateOrUpdateNssaiAck
tags:
– NSSAI update ack (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/NssaiAckData’
required: true
responses:
‘204’:
description: Expected response to a valid request
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieves the UPU acknowledgement information of a UE
operationId: QueryNssaiAck
tags:
– NSSAI ACK (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/NssaiAckData’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/ue-update-confirmation-data/subscribed-cag:
put:
summary: To store the CAG update acknowledgement information of a UE
operationId: CreateCagUpdateAck
tags:
– CAG update ack (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/CagAckData’
required: true
responses:
‘204’:
description: Expected response to a valid request
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieves the CAG acknowledgement information of a UE
operationId: QueryCagAck
tags:
– CAG ACK (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/CagAckData’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/{servingPlmnId}/provisioned-data:
get:
summary: Retrieve multiple provisioned data sets of a UE
operationId: QueryProvisionedData
tags:
– Provisioned Data (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: servingPlmnId
in: path
description: PLMN ID
required: true
schema:
$ref: ‘#/components/schemas/VarPlmnId’
– name: dataset-names
in: query
description: List of dataset names
style: form
explode: false
schema:
$ref: ‘#/components/schemas/DatasetNames’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/ProvisionedDataSets’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/am-data:
get:
summary: Retrieves the access and mobility subscription data of a UE
operationId: QueryAmData
tags:
– Access And Mobility Subscription Data (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: servingPlmnId
in: path
description: PLMN ID
required: true
schema:
$ref: ‘#/components/schemas/VarPlmnId’
– name: fields
in: query
description: attributes to be retrieved
required: false
schema:
type: array
items:
type: string
minItems: 1
style: form
explode: false
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘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:
$ref: ‘#/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:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/smf-selection-subscription-data:
get:
summary: Retrieves the SMF selection subscription data of a UE
operationId: QuerySmfSelectData
tags:
– SMF Selection Subscription Data (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: servingPlmnId
in: path
description: PLMN ID
required: true
schema:
$ref: ‘#/components/schemas/VarPlmnId’
– name: fields
in: query
description: attributes to be retrieved
required: false
schema:
type: array
items:
type: string
minItems: 1
style: form
explode: false
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘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:
$ref: ‘#/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:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/sm-data:
get:
summary: Retrieves the Session Management subscription data of a UE
operationId: QuerySmData
tags:
– Session Management Subscription Data
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: servingPlmnId
in: path
description: PLMN ID
required: true
schema:
$ref: ‘#/components/schemas/VarPlmnId’
– name: single-nssai
in: query
content:
application/json:
schema:
$ref: ‘#/components/schemas/VarSnssai’
description: single NSSAI
required: false
– name: dnn
in: query
description: DNN
required: false
schema:
$ref: ‘#/components/schemas/Dnn’
– name: fields
in: query
description: attributes to be retrieved
required: false
schema:
type: array
items:
type: string
minItems: 1
style: form
explode: false
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘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:
$ref: ‘#/components/schemas/SmSubsData’
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:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/context-data/amf-3gpp-access:
get:
summary: Retrieves the AMF context data of a UE using 3gpp access
operationId: QueryAmfContext3gpp
tags:
– AMF 3GPP Access Registration (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: fields
in: query
description: attributes to be retrieved
required: false
schema:
type: array
items:
type: string
minItems: 1
style: form
explode: false
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/Amf3GppAccessRegistration’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
put:
summary: To store the AMF context data of a UE using 3gpp access in the UDR
operationId: CreateAmfContext3gpp
tags:
– AMF 3GPP Access Registration (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data:registrations:write
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/Amf3GppAccessRegistration’
required: true
responses:
‘204’:
description: Upon success, an empty response body shall be returned
‘201’:
description: Created
content:
application/json:
schema:
$ref: ‘#/components/schemas/Amf3GppAccessRegistration’
headers:
Location:
description: ‘Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/subscription-data/{ueId}/context-data/amf-3gpp-access’
required: true
schema:
type: string
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
patch:
summary: To modify the AMF context data of a UE using 3gpp access in the UDR
operationId: AmfContext3gpp
tags:
– AMF 3GPP Access Registration (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data:registrations:write
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchItem’
required: true
responses:
‘204’:
description: Expected response to a valid request
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchResult’
‘403’:
description: modification is rejected
content:
application/problem+json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/context-data/amf-non-3gpp-access:
get:
summary: Retrieves the AMF context data of a UE using non-3gpp access
operationId: QueryAmfContextNon3gpp
tags:
– AMF Non-3GPP Access Registration (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: fields
in: query
description: attributes to be retrieved
required: false
schema:
type: array
items:
type: string
minItems: 1
style: form
explode: false
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/AmfNon3GppAccessRegistration’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
put:
summary: To store the AMF context data of a UE using non-3gpp access in the UDR
operationId: CreateAmfContextNon3gpp
tags:
– AMF Non-3GPP Access Registration (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data:registrations:write
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/AmfNon3GppAccessRegistration’
required: true
responses:
‘204’:
description: Upon success, an empty response body shall be returned
‘201’:
description: Created
content:
application/json:
schema:
$ref: ‘#/components/schemas/Amf3GppAccessRegistration’
headers:
Location:
description: ‘Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/subscription-data/{ueId}/context-data/amf-non-3gpp-access’
required: true
schema:
type: string
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
patch:
summary: To modify the AMF context data of a UE using non 3gpp access in the UDR
operationId: AmfContextNon3gpp
tags:
– AMF Non-3GPP Access Registration (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data:registrations:write
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchItem’
required: true
responses:
‘204’:
description: Expected response to a valid request
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchResult’
‘403’:
description: modification is rejected
content:
application/problem+json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/context-data/smf-registrations:
get:
summary: Retrieves the SMF registration list of a UE
operationId: QuerySmfRegList
tags:
– SMF Registrations (Collection)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/SmfRegList’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/context-data/smf-registrations/{pduSessionId}:
get:
summary: Retrieves the individual SMF registration of a UE
operationId: QuerySmfRegistration
tags:
– SMF Registration (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: pduSessionId
in: path
description: PDU session id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PduSessionId’
– name: fields
in: query
description: attributes to be retrieved
required: false
schema:
type: array
items:
type: string
minItems: 1
style: form
explode: false
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/SmfRegistration’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
put:
summary: To create an individual SMF context data of a UE in the UDR
operationId: CreateOrUpdateSmfRegistration
tags:
– SMF Registration (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data:registrations:write
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: pduSessionId
in: path
description: PDU session id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PduSessionId’
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/SmfRegistration’
required: true
responses:
‘201’:
description: Upon success, a response body containing a representation of the created Individual SmfRegistration resource shall be returned
content:
application/json:
schema:
$ref: ‘#/components/schemas/SmfRegistration’
headers:
Location:
description: ‘Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/subscription-data/{ueId}/context-data/smf-registrations/{pduSessionId}’
required: true
schema:
type: string
‘204’:
description: No content
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
summary: To remove an individual SMF context data of a UE the UDR
operationId: DeleteSmfRegistration
tags:
– SMF Registration (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data:registrations:write
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: pduSessionId
in: path
description: PDU session id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PduSessionId’
responses:
‘204’:
description: Upon success, an empty response body shall be returned.
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
patch:
summary: To modify the SMF context data of a UE in the UDR
operationId: UpdateSmfContext
tags:
– SMF Registration (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data:registrations:write
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: pduSessionId
in: path
description: PDU session id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PduSessionId’
– name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchItem’
required: true
responses:
‘204’:
description: Expected response to a valid request
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchResult’
‘403’:
description: modification is rejected
content:
application/problem+json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/operator-specific-data:
get:
summary: Retrieves the operator specific data of a UE
operationId: QueryOperSpecData
tags:
– Operator-Specific Data Container (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: fields
in: query
description: attributes to be retrieved
required: false
schema:
type: array
items:
type: string
minItems: 1
style: form
explode: false
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘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: object
description: A map(list of key-value pairs) where operator specific data element name serves as key
additionalProperties:
$ref: ‘#/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:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
patch:
summary: To modify operator specific data of a UE
operationId: ModifyOperSpecData
tags:
– Operator-Specific Data Container (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchItem’
required: true
responses:
‘204’:
description: Expected response to a valid request
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchResult’
‘403’:
description: modification is rejected
content:
application/problem+json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
put:
summary: To create an operator-specific data resource of a UE
operationId: CreateOperSpecData
tags:
– Operator-Specific Data Container (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json:
schema:
type: object
description: A map (list of key-value pairs) where operator specific data element name serves as key
additionalProperties:
$ref: ‘#/components/schemas/OperatorSpecificDataContainer’
required: true
responses:
‘201’:
description: Upon success, a response body containing a representation of the created Operator Specific Data resource shall be returned
content:
application/json:
schema:
type: object
description: A map (list of key-value pairs) where operator specific data element name serves as key
additionalProperties:
$ref: ‘#/components/schemas/OperatorSpecificDataContainer’
headers:
Location:
description: ‘Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/subscription-data/{ueId}/operator-specific-data’
required: true
schema:
type: string
‘204’:
description: No content
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
summary: To remove an operator-specific data resource of a UE
operationId: DeleteOperSpecData
tags:
– Operator-Specific Data Container (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
responses:
‘204’:
description: Upon success, an empty response body shall be returned.
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/context-data/smsf-3gpp-access:
put:
summary: Create the SMSF context data of a UE via 3GPP access
operationId: CreateSmsfContext3gpp
tags:
– SMSF 3GPP Registration (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data:registrations:write
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/SmsfRegistration’
required: true
responses:
‘204’:
description: Upon success, an empty response body shall be returned
‘201’:
description: Created
content:
application/json:
schema:
$ref: ‘#/components/schemas/SmsfRegistration’
headers:
Location:
description: ‘Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/subscription-data/{ueId}/context-data/smsf-3gpp-access’
required: true
schema:
type: string
‘200’:
description: Updated
content:
application/json:
schema:
$ref: ‘#/components/schemas/SmsfRegistration’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
summary: To remove the SMSF context data of a UE via 3GPP access
operationId: DeleteSmsfContext3gpp
tags:
– SMSF 3GPP Registration (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data:registrations:write
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
responses:
‘204’:
description: Upon success, an empty response body shall be returned
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieves the SMSF context data of a UE using 3gpp access
operationId: QuerySmsfContext3gpp
tags:
– SMSF 3GPP Registration (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: fields
in: query
description: attributes to be retrieved
required: false
schema:
type: array
items:
type: string
minItems: 1
style: form
explode: false
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/SmsfRegistration’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/context-data/smsf-non-3gpp-access:
put:
summary: Create the SMSF context data of a UE via non-3GPP access
operationId: CreateSmsfContextNon3gpp
tags:
– SMSF Non-3GPP Registration (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data:registrations:write
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/SmsfRegistration’
required: true
responses:
‘204’:
description: Upon success, an empty response body shall be returned
‘201’:
description: Created
content:
application/json:
schema:
$ref: ‘#/components/schemas/SmsfRegistration’
headers:
Location:
description: ‘Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/subscription-data/{ueId}/context-data/smsf-non-3gpp-access’
required: true
schema:
type: string
‘200’:
description: Updated
content:
application/json:
schema:
$ref: ‘#/components/schemas/SmsfRegistration’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
summary: To remove the SMSF context data of a UE via non-3GPP access
operationId: DeleteSmsfContextNon3gpp
tags:
– SMSF Non-3GPP Registration (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data:registrations:write
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
responses:
‘204’:
description: Upon success, an empty response body shall be returned
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieves the SMSF context data of a UE using non-3gpp access
operationId: QuerySmsfContextNon3gpp
tags:
– SMSF Non-3GPP Registration (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: fields
in: query
description: attributes to be retrieved
required: false
schema:
type: array
items:
type: string
minItems: 1
style: form
explode: false
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/SmsfRegistration’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/context-data/ip-sm-gw:
put:
summary: Create the IP-SM-GW context data of a UE
operationId: CreateIpSmGwContext
tags:
– IP-SM-GW Registration (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data:registrations:write
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/IpSmGwRegistration’
required: true
responses:
‘204’:
description: Upon success, an empty response body shall be returned
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
summary: To remove the IP-SM-GW context data of a UE
operationId: DeleteIpSmGwContext
tags:
– IP-SM-GW Registration (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data:registrations:write
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
responses:
‘204’:
description: Upon success, an empty response body shall be returned
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
patch:
summary: Modify the IP-SM-GW context data of a UE
operationId: ModifyIpSmGwContext
tags:
– IP-SM-GW Registration (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data:registrations:write
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchItem’
minItems: 1
required: true
responses:
‘204’:
description: Successful response
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieves the IP-SM-GW context data of a UE
operationId: QueryIpSmGwContext
tags:
– IP-SM-GW Registration (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: fields
in: query
description: attributes to be retrieved
required: false
schema:
type: array
items:
type: string
minItems: 1
style: form
explode: false
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/IpSmGwRegistration’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/context-data/mwd:
put:
summary: Create the Message Waiting Data of the UE
operationId: CreateMessageWaitingData
tags:
– Message Waiting Data (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/MessageWaitingData’
required: true
responses:
‘201’:
description: Created
content:
application/json:
schema:
$ref: ‘#/components/schemas/MessageWaitingData’
headers:
Location:
description: ‘Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/subscription-data/{ueId}/context-data/mwd’
required: true
schema:
type: string
‘204’:
description: Upon success, an empty response body shall be returned
default:
description: Unexpected error
delete:
summary: To remove the Message Waiting Data of the UE
operationId: DeleteMessageWaitingData
tags:
– Message Waiting Data (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
responses:
‘204’:
description: Upon success, an empty response body shall be returned
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
patch:
summary: Modify the Message Waiting Data of the UE
operationId: ModifyMessageWaitingData
tags:
– Message Waiting Data (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchItem’
minItems: 1
required: true
responses:
‘204’:
description: Successful response
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieves the Message Waiting Data of the UE
operationId: QueryMessageWaitingData
tags:
– Message Waiting Data (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: fields
in: query
description: attributes to be retrieved
required: false
schema:
type: array
items:
type: string
minItems: 1
style: form
explode: false
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/MessageWaitingData’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/sms-mng-data:
get:
summary: Retrieves the SMS management subscription data of a UE
operationId: QuerySmsMngData
tags:
– SMS Management Subscription Data (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: servingPlmnId
in: path
description: PLMN ID
required: true
schema:
$ref: ‘#/components/schemas/VarPlmnId’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘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:
$ref: ‘#/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:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/sms-data:
get:
summary: Retrieves the SMS subscription data of a UE
operationId: QuerySmsData
tags:
– SMS Subscription Data (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: servingPlmnId
in: path
description: PLMN ID
required: true
schema:
$ref: ‘#/components/schemas/VarPlmnId’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘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:
$ref: ‘#/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:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/pp-data:
get:
summary: Read the profile of a given UE
operationId: GetppData
tags:
– Parameter Provision (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: pp data for a UE
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘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:
$ref: ‘#/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:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
patch:
summary: modify the provisioned parameter data
operationId: ModifyPpData
tags:
– ProvisionedParameterData (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: pp data for a UE
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchItem’
required: true
responses:
‘204’:
description: Expected response to a valid request
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchResult’
‘403’:
description: modification is rejected
content:
application/problem+json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/pp-profile-data:
get:
summary: Retrieves the parameter provision profile data of a UE
operationId: QueryPPData
tags:
– Parameter Provision profile Data (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/PpProfileData’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/pp-data-store/{afInstanceId}:
put:
summary: create a Provisioning Parameter Data Entry
operationId: Create PP Data Entry
tags:
– ProvisionedParameterDataEntry (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: Identifier of the UE
required: true
schema:
anyOf:
– $ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– $ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId’
– type: string
pattern: ‘^anyUE$’
– name: afInstanceId
in: path
description: Application Function Instance Identifier
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: ‘TS29503_Nudm_PP.yaml#/components/schemas/PpDataEntry’
required: true
responses:
‘201’:
description: Indicating a successful creation of the resource.
content:
application/json:
schema:
$ref: ‘TS29503_Nudm_PP.yaml#/components/schemas/PpDataEntry’
‘204’:
description: Indicating a successful creation of the resource.
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
description: Unexpected error
delete:
summary: Delete a Provisioning Parameter Data Entry
operationId: Delete PP Data Entry
tags:
– ProvisionedParameterDataEntry (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: Identifier of the UE
required: true
schema:
anyOf:
– $ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– $ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId’
– type: string
pattern: ‘^anyUE$’
– name: afInstanceId
in: path
description: Application Function Instance Identifier
required: true
schema:
type: string
responses:
‘204’:
description: Expected response to a valid request
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
description: Unexpected error
get:
summary: get a Parameter Provisioning Data Entry
operationId: Get PP Data Entry
tags:
– ProvisionedParameterDataEntry (Document)
parameters:
– name: ueId
in: path
description: Identifier of the UE
required: true
schema:
anyOf:
– $ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– $ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId’
– type: string
pattern: ‘^anyUE$’
– name: afInstanceId
in: path
description: Application Function Instance Identifier
required: true
schema:
type: string
– name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29503_Nudm_PP.yaml#/components/schemas/PpDataEntry’
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
description: Unexpected error
/subscription-data/{ueId}/pp-data-store:
get:
summary: get a list of Parameter Provisioning Data Entries
operationId: Get Multiple PP Data Entries
tags:
– ProvisionedParameterDataEntries (Collection)
parameters:
– name: ueId
in: path
description: Identifier of the UE
required: true
schema:
anyOf:
– $ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– $ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId’
– type: string
pattern: ‘^anyUE$’
– name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/PpDataEntryList’
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
description: Unexpected error
/subscription-data/{ueId}/context-data/ee-subscriptions:
get:
summary: Retrieves the ee subscriptions of a UE
operationId: Queryeesubscriptions
tags:
– Event Exposure Subscriptions (Collection)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
– name: event-types
in: query
required: false
description: Event Types
schema:
type: array
items:
$ref: ‘TS29503_Nudm_EE.yaml#/components/schemas/EventType’
minItems: 1
style: form
explode: false
– name: nf-identifiers
in: query
description: NF Identifiers
schema:
type: array
items:
$ref: ‘#/components/schemas/NfIdentifier’
minItems: 1
style: form
explode: false
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
type: array
items:
$ref: ‘#/components/schemas/EeSubscriptionExt’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
post:
summary: Create individual EE subscription
operationId: CreateEeSubscriptions
tags:
– Event Exposure Subscriptions (Collection)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE ID
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/EeSubscription’
required: true
responses:
‘201’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/EeSubscription’
headers:
Location:
description: ‘Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}’
required: true
schema:
type: string
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}:
put:
summary: Update an individual ee subscriptions of a UE
operationId: UpdateEesubscriptions
tags:
– Event Exposure Subscription (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/EeSubscription’
required: true
responses:
‘204’:
description: Upon success, an empty response body shall be returned
‘404’:
description: update of non-existing resource is rejected
content:
application/problem+json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
summary: Deletes a eeSubscription
operationId: RemoveeeSubscriptions
tags:
– Event Exposure Subscription (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
description: Unique ID of the subscription to remove
schema:
type: string
responses:
‘204’:
description: Expected response to a successful subscription removal
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
patch:
summary: Modify an individual ee subscription of a UE
operationId: ModifyEesubscription
tags:
– Event Exposure Subscription (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
schema:
type: string
– name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchItem’
minItems: 1
required: true
responses:
‘204’:
description: Successful response
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchResult’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieve a eeSubscription
operationId: QueryeeSubscription
tags:
– Event Exposure Subscription (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
description: Unique ID of the subscription to remove
schema:
type: string
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
items:
$ref: ‘#/components/schemas/EeSubscription’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}/amf-subscriptions:
put:
summary: Create AmfSubscriptions for an individual ee subscriptions of a UE
operationId: Create AMF Subscriptions
tags:
– AMF Subscription Info (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: ‘#/components/schemas/AmfSubscriptionInfo’
minItems: 1
required: true
responses:
‘204’:
description: Upon success, an empty response body shall be returned
‘201’:
description: Upon successful creation, the created resource shall be returned
content:
application/json:
schema:
type: array
items:
$ref: ‘#/components/schemas/AmfSubscriptionInfo’
minItems: 1
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
summary: Deletes AMF Subscription Info for an eeSubscription
operationId: RemoveAmfSubscriptionsInfo
tags:
– Event AMF Subscription Info (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
schema:
type: string
responses:
‘204’:
description: Expected response to a successful subscription removal
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
patch:
summary: modify the AMF Subscription Info
operationId: ModifyAmfSubscriptionInfo
tags:
– AmfSubscriptionInfo (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
schema:
type: string
– name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchItem’
required: true
responses:
‘204’:
description: Expected response to a valid request
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchResult’
‘403’:
description: modification is rejected
content:
application/problem+json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieve AMF subscription Info
operationId: GetAmfSubscriptionInfo
tags:
– Query AMF Subscription Info (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
schema:
type: string
responses:
‘200’:
description: OK
content:
application/json:
schema:
type: array
items:
$ref: ‘#/components/schemas/AmfSubscriptionInfo’
minItems: 1
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}/smf-subscriptions:
put:
summary: Create SMF Subscription Info
operationId: Create SMF Subscriptions
tags:
– SMF Event Subscription Info (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/SmfSubscriptionInfo’
required: true
responses:
‘204’:
description: Upon success, an empty response body shall be returned
‘201’:
description: Upon successful creation, the created resource shall be returned
content:
application/json:
schema:
$ref: ‘#/components/schemas/SmfSubscriptionInfo’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
summary: Delete SMF Subscription Info
operationId: RemoveSmfSubscriptionsInfo
tags:
– SMF Event Subscription Info (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
schema:
type: string
responses:
‘204’:
description: Expected response to a successful subscription removal
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
patch:
summary: Modify SMF Subscription Info
operationId: ModifySmfSubscriptionInfo
tags:
– SMF Event Subscription Info (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
schema:
type: string
– name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchItem’
required: true
responses:
‘204’:
description: Expected response to a valid request
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchResult’
‘403’:
description: modification is rejected
content:
application/problem+json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieve SMF Subscription Info
operationId: GetSmfSubscriptionInfo
tags:
– SMF Event Subscription Info (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
schema:
type: string
responses:
‘200’:
description: OK
content:
application/json:
schema:
$ref: ‘#/components/schemas/SmfSubscriptionInfo’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}/hss-subscriptions:
put:
summary: Create HSS Subscription Info
operationId: Create HSS Subscriptions
tags:
– HSS Event Subscription Info (Document)
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/HssSubscriptionInfo’
required: true
responses:
‘204’:
description: Upon success, an empty response body shall be returned
‘201’:
description: Upon successful creation, the created resource shall be returned
content:
application/json:
schema:
$ref: ‘#/components/schemas/HssSubscriptionInfo’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
summary: Delete HSS Subscription Info
operationId: RemoveHssSubscriptionsInfo
tags:
– HSS Event Subscription Info (Document)
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
schema:
type: string
responses:
‘204’:
description: Expected response to a successful subscription removal
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
patch:
summary: Modify HSS Subscription Info
operationId: ModifyHssSubscriptionInfo
tags:
– HSS Event Subscription Info (Document)
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
schema:
type: string
– name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchItem’
required: true
responses:
‘204’:
description: Expected response to a valid request
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchResult’
‘403’:
description: modification is rejected
content:
application/problem+json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieve HSS Subscription Info
operationId: GetHssSubscriptionInfo
tags:
– HSS Event Subscription Info (Document)
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
schema:
type: string
responses:
‘200’:
description: OK
content:
application/json:
schema:
$ref: ‘#/components/schemas/SmfSubscriptionInfo’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/group-data/{ueGroupId}/ee-subscriptions:
get:
summary: Retrieves the ee subscriptions of a group of UEs or any UE
operationId: QueryEeGroupSubscriptions
tags:
– Event Exposure Group Subscriptions (Collection)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueGroupId
in: path
description: Group of UEs or any UE
required: true
schema:
$ref: ‘#/components/schemas/VarUeGroupId’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
type: array
items:
$ref: ‘#/components/schemas/EeSubscription’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
post:
summary: Create individual EE subscription for a group of UEs or any UE
operationId: CreateEeGroupSubscriptions
tags:
– Event Exposure Group Subscriptions (Collection)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueGroupId
in: path
description: Group of UEs or any UE
required: true
schema:
$ref: ‘#/components/schemas/VarUeGroupId’
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/EeSubscription’
required: true
responses:
‘201’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/EeSubscription’
headers:
Location:
description: ‘Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/subscription-data/group-data/{ueGroupId}/ee-subscriptions’
required: true
schema:
type: string
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId}:
put:
summary: Update an individual ee subscription of a group of UEs or any UE
operationId: UpdateEeGroupSubscriptions
tags:
– Event Exposure Group Subscription (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueGroupId
in: path
required: true
schema:
$ref: ‘#/components/schemas/VarUeGroupId’
– name: subsId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/EeSubscription’
required: true
responses:
‘204’:
description: Upon success, an empty response body shall be returned
‘404’:
description: update of non-existing resource is rejected
content:
application/problem+json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
summary: Deletes a eeSubscription for a group of UEs or any UE
operationId: RemoveEeGroupSubscriptions
tags:
– Event Exposure Group Subscription (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueGroupId
in: path
required: true
schema:
$ref: ‘#/components/schemas/VarUeGroupId’
– name: subsId
in: path
required: true
description: Unique ID of the subscription to remove
schema:
type: string
responses:
‘204’:
description: Expected response to a successful subscription removal
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
patch:
summary: Modify an individual ee subscription for a group of a UEs
operationId: ModifyEeGroupSubscription
tags:
– Event Exposure Group Subscription (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueGroupId
in: path
required: true
schema:
$ref: ‘#/components/schemas/VarUeGroupId’
– name: subsId
in: path
required: true
schema:
type: string
– name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchItem’
minItems: 1
required: true
responses:
‘204’:
description: Successful response
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchResult’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieve a individual eeSubscription for a group of UEs or any UE
operationId: QueryEeGroupSubscription
tags:
– Event Exposure Group Subscription (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueGroupId
in: path
required: true
schema:
$ref: ‘#/components/schemas/VarUeGroupId’
– name: subsId
in: path
required: true
description: Unique ID of the subscription to remove
schema:
type: string
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
items:
$ref: ‘#/components/schemas/EeSubscription’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/group-data/{ueGroupId}/ee-profile-data:
get:
summary: Retrieves the ee profile data profile data of a group or anyUE
operationId: QueryGroupEEData
tags:
– Event Exposure Data for a group (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueGroupId
in: path
description: Group of UEs or any UE
required: true
schema:
$ref: ‘#/components/schemas/VarUeGroupId’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/EeGroupProfileData’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/ee-profile-data:
get:
summary: Retrieves the ee profile data of a UE
operationId: QueryEEData
tags:
– Event Exposure Data (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: fields
in: query
description: attributes to be retrieved
required: false
schema:
type: array
items:
type: string
style: form
explode: false
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/EeProfileData’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/context-data/sdm-subscriptions:
get:
summary: Retrieves the sdm subscriptions of a UE
operationId: Querysdmsubscriptions
tags:
– SDM Subscriptions (Collection)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
type: array
items:
$ref: ‘#/components/schemas/SdmSubscription’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
post:
summary: Create individual sdm subscription
operationId: CreateSdmSubscriptions
tags:
– SDM Subscriptions (Collection)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE ID
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/SdmSubscription’
required: true
responses:
‘201’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/SdmSubscription’
headers:
Location:
description: ‘Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/subscription-data/{ueId}/context-data/sdm-subscriptions/{subsId}’
required: true
schema:
type: string
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/context-data/sdm-subscriptions/{subsId}:
put:
summary: Update an individual sdm subscriptions of a UE
operationId: Updatesdmsubscriptions
tags:
– SDM Subscription (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/SdmSubscription’
required: true
responses:
‘204’:
description: Upon success, an empty response body shall be returned
‘404’:
description: update of non-existing resource is rejected
content:
application/problem+json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
summary: Deletes a sdmsubscriptions
operationId: RemovesdmSubscriptions
tags:
– SDM Subscription (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
description: Unique ID of the subscription to remove
schema:
type: string
responses:
‘204’:
description: Expected response to a successful subscription removal
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
patch:
summary: Modify an individual sdm subscription
operationId: ModifysdmSubscription
tags:
– SDM Subscription (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
schema:
type: string
– name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchItem’
minItems: 1
required: true
responses:
‘204’:
description: Successful response
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchResult’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieves a individual sdmSubscription identified by subsId
operationId: QuerysdmSubscription
tags:
– SDM Subscription (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
description: Unique ID of the subscription to retrieve
schema:
type: string
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
items:
$ref: ‘#/components/schemas/SdmSubscription’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/context-data/sdm-subscriptions/{subsId}/hss-sdm-subscriptions:
put:
summary: Create HSS SDM Subscription Info
operationId: Create HSS SDM Subscriptions
tags:
– HSS SDM Subscription Info (Document)
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/HssSubscriptionInfo’
required: true
responses:
‘204’:
description: Upon success, an empty response body shall be returned
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
summary: Delete HSS SDM Subscription Info
operationId: RemoveHssSDMSubscriptionsInfo
tags:
– HSS SDM Subscription Info (Document)
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
schema:
type: string
responses:
‘204’:
description: Expected response to a successful subscription removal
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
patch:
summary: Modify HSS SDM Subscription Info
operationId: ModifyHssSDMSubscriptionInfo
tags:
– HSS SDM Subscription Info (Document)
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
schema:
type: string
– name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchItem’
required: true
responses:
‘204’:
description: Expected response to a valid request
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchResult’
‘403’:
description: modification is rejected
content:
application/problem+json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieve HSS SDM Subscription Info
operationId: GetHssSDMSubscriptionInfo
tags:
– HSS SDM Subscription Info (Document)
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: subsId
in: path
required: true
schema:
type: string
responses:
‘200’:
description: OK
content:
application/json:
schema:
$ref: ‘#/components/schemas/SmfSubscriptionInfo’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/shared-data:
get:
summary: retrieve shared data
operationId: GetSharedData
tags:
– Retrieval of shared data
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: shared-data-ids
in: query
description: List of shared data ids
required: true
style: form
explode: false
schema:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/SharedDataIds’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
type: array
items:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/SharedData’
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/shared-data/{sharedDataId}:
get:
summary: retrieve individual shared data
operationId: GetIndividualSharedData
tags:
– Retrieval of individual shared data
parameters:
– 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
– name: sharedDataId
in: path
description: Id of the Shared Data
required: true
schema:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/SharedDataId’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/SharedData’
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
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/subs-to-notify:
post:
summary: Subscription data subscriptions
operationId: SubscriptionDataSubscriptions
tags:
– Subs To Notify (Collection)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/SubscriptionDataSubscriptions’
required: true
responses:
‘201’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/SubscriptionDataSubscriptions’
headers:
Location:
description: ‘Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/subscription-data/subs-to-notify/{subsId}’
required: true
schema:
type: string
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
callbacks:
onDataChange:
‘{request.body#/callbackReference}’:
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: ‘#/components/schemas/DataChangeNotify’
responses:
‘204’:
description: Expected response to a valid request
get:
summary: Retrieves the list of subscriptions
operationId: QuerySubsToNotify
tags:
– Subs To Notify (Collection)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ue-id
in: query
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
type: array
items:
$ref: ‘#/components/schemas/SubscriptionDataSubscriptions’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
summary: Deletes subscriptions identified by a given ue-id parameter
operationId: RemoveMultipleSubscriptionDataSubscriptions
tags:
– Subs To Notify (Collection)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ue-id
in: query
required: true
description: UE ID
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: nf-instance-id
in: query
required: false
description: NF Instance ID
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/NfInstanceId’
– name: delete-all-nfs
in: query
required: false
description: Flag to delete subscriptions from all NFs
schema:
type: boolean
– name: implicit-unsubscribe-indication
in: query
required: false
description: Implicit Unsubscribe Indication
schema:
type: boolean
responses:
‘204’:
description: Expected response to a successful subscription removal
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/subs-to-notify/{subsId}:
delete:
summary: Deletes a subscriptionDataSubscriptions
operationId: RemovesubscriptionDataSubscriptions
tags:
– Subs To Notify (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: subsId
in: path
required: true
description: Unique ID of the subscription to remove
schema:
type: string
responses:
‘204’:
description: Expected response to a successful subscription removal
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
patch:
summary: Modify an individual subscriptionDataSubscription
operationId: ModifysubscriptionDataSubscription
tags:
– Subs To Notify (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: subsId
in: path
required: true
schema:
type: string
– name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchItem’
minItems: 1
required: true
responses:
‘204’:
description: Successful response
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
oneOf:
– $ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchResult’
– $ref: ‘#/components/schemas/SubscriptionDataSubscriptions’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieves a individual subscriptionDataSubscription identified by subsId
operationId: QuerySubscriptionDataSubscriptions
tags:
– Subs To Notify (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: subsId
in: path
required: true
description: Unique ID of the subscription to retrieve
schema:
type: string
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
items:
$ref: ‘#/components/schemas/SubscriptionDataSubscriptions’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/trace-data:
get:
summary: Retrieves the trace configuration data of a UE
operationId: QueryTraceData
tags:
– Trace Data (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: servingPlmnId
in: path
description: PLMN ID
required: true
schema:
$ref: ‘#/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:
$ref: ‘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:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/identity-data:
get:
summary: Retrieve identity data by SUPI or GPSI
operationId: GetIdentityData
tags:
– Query Identity Data by SUPI or GPSI (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE ID
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: app-port-id
in: query
description: Application port identifier
content:
application/json:
schema:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/AppPortId’
– 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:
$ref: ‘#/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
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/operator-determined-barring-data:
get:
summary: Retrieve ODB Data data by SUPI or GPSI
operationId: GetOdbData
tags:
– Query ODB Data by SUPI or GPSI (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE ID
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
responses:
‘200’:
description: OK
content:
application/json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/OdbData’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/context-data:
get:
summary: Retrieve multiple context data sets of a UE
operationId: QueryContextData
tags:
– Context Data (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: context-dataset-names
in: query
description: List of context dataset names
style: form
explode: false
required: true
schema:
$ref: ‘#/components/schemas/ContextDatasetNames’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/ContextDataSets’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/group-data/group-identifiers:
get:
summary: Mapping of Group Identifiers
operationId: GetGroupIdentifiers
tags:
– Group Identifiers
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ext-group-id
in: query
description: External Group Identifier
required: false
schema:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId’
– name: int-group-id
in: query
description: Internal Group Identifier
required: false
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/GroupId’
– name: ue-id-ind
in: query
description: Indication whether UE identifiers are required or not
required: false
schema:
type: boolean
default: false
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/GroupIdentifiers’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/group-data/5g-vn-groups:
get:
summary: Retrieves the data of a 5G VN Group
operationId: Query5GVnGroup
tags:
– 5G-VN-Groups (Store)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: gpsis
in: query
description: List of GPSIs
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’
style: form
explode: false
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
type: object
description: A map(list of key-value pairs) where ExtGroupId serves as key
additionalProperties:
$ref: ‘TS29503_Nudm_PP.yaml#/components/schemas/5GVnGroupConfiguration’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/group-data/5g-vn-groups/{externalGroupId}:
put:
summary: Create an individual 5G VN Grouop
operationId: Create5GVnGroup
tags:
– 5GVnGroupConfiguration (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: externalGroupId
in: path
required: true
schema:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId’
requestBody:
content:
application/json:
schema:
$ref: ‘TS29503_Nudm_PP.yaml#/components/schemas/5GVnGroupConfiguration’
required: true
responses:
‘201’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29503_Nudm_PP.yaml#/components/schemas/5GVnGroupConfiguration’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
summary: Deletes the 5GVnGroup
operationId: Delete5GVnGroup
tags:
– Delete 5GVnGroup
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: externalGroupId
in: path
required: true
schema:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId’
responses:
‘204’:
description: Expected response to a successful group removal
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
patch:
summary: modify the 5GVnGroup
operationId: Modify5GVnGroup
tags:
– Modify 5GVnGroup
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: externalGroupId
in: path
required: true
schema:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId’
– name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchItem’
required: true
responses:
‘204’:
description: Expected response to a valid request
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchResult’
‘403’:
description: modification is rejected
content:
application/problem+json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieve a 5GVnGroup configuration
operationId: Get5GVnGroupConfiguration
tags:
– Query 5GVnGroupConfiguration (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: externalGroupId
in: path
required: true
schema:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId’
responses:
‘200’:
description: OK
content:
application/json:
schema:
$ref: ‘TS29503_Nudm_PP.yaml#/components/schemas/5GVnGroupConfiguration’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/lcs-privacy-data:
get:
summary: Retrieves the LCS Privacy subscription data of a UE
operationId: QueryLcsPrivacyData
tags:
– LCS Privacy Subscription Data
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: fields
in: query
description: attributes to be retrieved
required: false
schema:
type: array
items:
type: string
minItems: 1
style: form
explode: false
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘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:
$ref: ‘#/components/schemas/LcsPrivacyData’
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:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/lcs-mo-data:
get:
summary: Retrieves the LCS Mobile Originated subscription data of a UE
operationId: QueryLcsMoData
tags:
– LCS Mobile Originated Subscription Data
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: fields
in: query
description: attributes to be retrieved
required: false
schema:
type: array
items:
type: string
minItems: 1
style: form
explode: false
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘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:
$ref: ‘#/components/schemas/LcsMoData’
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:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/nidd-authorization-data:
get:
summary: Retrieve NIDD Authorization Data GPSI or External Group identifier
operationId: GetNiddAuData
tags:
– Query NIDD Authorization Data GPSI or External Group identifier (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE ID
required: true
schema:
type: string
pattern: ‘^(msisdn-[0-9]{5,15}|.+|extid-[^@]+@[^@]+|extgroupid-[^@]+@[^@]+)$’
– name: single-nssai
in: query
content:
application/json:
schema:
$ref: ‘#/components/schemas/VarSnssai’
description: single NSSAI
required: true
– name: dnn
in: query
description: DNN
required: true
schema:
$ref: ‘#/components/schemas/Dnn’
– name: mtc-provider-information
in: query
description: MTC Provider Information
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation’
– name: af-id
in: query
description: Application Function Identifier
schema:
type: string
– 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:
$ref: ‘#/components/schemas/AuthorizationData’
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’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/coverage-restriction-data:
get:
summary: Retrieves the subscribed enhanced Coverage Restriction Data of a UE
operationId: QueryCoverageRestrictionData
tags:
– Enhanced Coverage Restriction Data
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘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: OK
content:
application/json:
schema:
$ref: ‘#/components/schemas/EnhancedCoverageRestrictionData’
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:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/context-data/location:
get:
summary: Retrieves the UE’s Location Information
operationId: QueryUeLocation
tags:
– UE’s Location Information (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/LocationInfo’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/v2x-data:
get:
summary: Retrieves the subscribed V2X Data of a UE
operationId: QueryV2xData
tags:
– V2X Subscription Data
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘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: OK
content:
application/json:
schema:
$ref: ‘#/components/schemas/V2xSubscriptionData’
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:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/prose-data:
get:
summary: Retrieves the subscribed ProSe service Data of a UE
operationId: QueryPorseData
tags:
– ProSe Service Subscription Data
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘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: OK
content:
application/json:
schema:
$ref: ‘#/components/schemas/ProseSubscriptionData’
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:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/lcs-bca-data:
get:
summary: Retrieves the LCS Broadcast Assistance subscription data of a UE
operationId: QueryLcsBcaData
tags:
– LCS Broadcast Assistance Subscription Data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: servingPlmnId
in: path
description: PLMN ID
required: true
schema:
$ref: ‘#/components/schemas/VarPlmnId’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘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:
$ref: ‘#/components/schemas/LcsBroadcastAssistanceTypesData’
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:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
/subscription-data/group-data/5g-vn-groups/internal:
get:
summary: Retrieves the data of 5G VN Group
operationId: Query5GVnGroupInternal
tags:
– 5G-VN-Groups-Internal (Document)
parameters:
– name: internal-group-ids
in: query
description: List of Internal Group IDs
required: true
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/GroupId’
style: form
explode: false
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
type: object
description: A map (list of key-value pairs) where ExtGroupId serves as key
additionalProperties:
$ref: ‘TS29503_Nudm_PP.yaml#/components/schemas/5GVnGroupConfiguration’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/group-data/5g-vn-groups/pp-profile-data:
get:
summary: Retrieves the parameter provision profile data for 5G VN Group
operationId: Query5GVNGroupPPData
tags:
– Parameter Provision profile Data for 5G VN Group(Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ext-group-ids
in: query
description: List of external VN group identifiers
schema:
type: array
items:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId’
minItems: 1
style: form
explode: false
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/Pp5gVnGroupProfileData’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/context-data/nidd-authorizations:
put:
summary: Create NIDD Authorization Info
operationId: CreateNIDDAuthorizationInfo
tags:
– NIDD Authorization Info (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/NiddAuthorizationInfo’
required: true
responses:
‘204’:
description: Upon success, an empty response body shall be returned
‘201’:
description: Upon successful creation, the created resource shall be returned
content:
application/json:
schema:
$ref: ‘#/components/schemas/NiddAuthorizationInfo’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
summary: Delete NIDD Authorization Info
operationId: RemoveNiddAuthorizationInfo
tags:
– NIDD Authorization Info (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
responses:
‘204’:
description: Expected response to a successful subscription removal
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
patch:
summary: Modify NIDD Authorization Info
operationId: ModifyNiddAuthorizationInfo
tags:
– NIDD Authorization Info (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchItem’
required: true
responses:
‘204’:
description: Expected response to a valid request
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchResult’
‘403’:
description: modification is rejected
content:
application/problem+json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieve NIDD Authorization Info
operationId: GetNiddAuthorizationInfo
tags:
– NIDD Authorization Info (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
responses:
‘200’:
description: OK
content:
application/json:
schema:
$ref: ‘#/components/schemas/NiddAuthorizationInfo’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/5mbs-data:
get:
summary: Retrieves the 5mbs subscription data of a UE
operationId: Query5mbsData
tags:
– 5MBSSubscriptionData (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘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:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/MbsSubscriptionData’
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:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}:
get:
summary: Retrieve multiple subscribed data sets of a UE
operationId: QueryUeSubscribedData
tags:
– UE Subscribed Data (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE Id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: dataset-names
in: query
description: List of dataset names
style: form
explode: false
schema:
$ref: ‘#/components/schemas/DatasetNames’
– name: serving-plmn
in: query
description: Serving PLMN Id
schema:
$ref: ‘#/components/schemas/VarPlmnId’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/UeSubscribedDataSets’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/service-specific-authorization-data/{serviceType}:
get:
summary: Retrieve ServiceSpecific Authorization Data
operationId: GetSSAuData
tags:
– Query Service Specific Authorization Data (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE ID
required: true
schema:
type: string
pattern: ‘^(msisdn-[0-9]{5,15}|.+|extid-[^@]+@[^@]+|extgroupid-[^@]+@[^@]+)$’
– name: serviceType
in: path
description: Service Type
required: true
schema:
$ref: ‘TS29503_Nudm_SSAU.yaml#/components/schemas/ServiceType’
– name: single-nssai
in: query
content:
application/json:
schema:
$ref: ‘#/components/schemas/VarSnssai’
description: single NSSAI
required: true
– name: dnn
in: query
description: DNN
required: true
schema:
$ref: ‘#/components/schemas/Dnn’
– name: mtc-provider-information
in: query
description: MTC Provider Information
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation’
– name: af-id
in: query
description: Application Function Identifier
schema:
type: string
– 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:
$ref: ‘#/components/schemas/AuthorizationData’
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’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/context-data/service-specific-authorizations/{serviceType}:
put:
summary: Create Service Specific Authorization Info
operationId: CreateServiceSpecificAuthorizationInfo
tags:
– Service Specific Authorization Info (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: serviceType
in: path
description: Service Type
required: true
schema:
$ref: ‘TS29503_Nudm_SSAU.yaml#/components/schemas/ServiceType’
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/ServiceSpecificAuthorizationInfo’
required: true
responses:
‘204’:
description: Upon success, an empty response body shall be returned
‘201’:
description: Upon successful creation, the created resource shall be returned
content:
application/json:
schema:
$ref: ‘#/components/schemas/ServiceSpecificAuthorizationInfo’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
summary: Delete Service Specific Authorization Info
operationId: RemoveServiceSpecificAuthorizationInfo
tags:
– Service Specific Authorization Info (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: serviceType
in: path
description: Service Type
required: true
schema:
$ref: ‘TS29503_Nudm_SSAU.yaml#/components/schemas/ServiceType’
responses:
‘204’:
description: Expected response to a successful subscription removal
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
patch:
summary: Modify Service Specific Authorization Info
operationId: ModifyServiceSpecificAuthorizationInfo
tags:
– Service Specific Authorization Info (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: serviceType
in: path
description: Service Type
required: true
schema:
$ref: ‘TS29503_Nudm_SSAU.yaml#/components/schemas/ServiceType’
– name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchItem’
required: true
responses:
‘204’:
description: Expected response to a valid request
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchResult’
‘403’:
description: modification is rejected
content:
application/problem+json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieve Service Specific Authorization Info
operationId: GetServiceSpecificAuthorizationInfo
tags:
– Service Specific Authorization Info (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: serviceType
in: path
description: Service Type
required: true
schema:
$ref: ‘TS29503_Nudm_SSAU.yaml#/components/schemas/ServiceType’
responses:
‘200’:
description: OK
content:
application/json:
schema:
$ref: ‘#/components/schemas/ServiceSpecificAuthorizationInfo’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/context-data/roaming-information:
put:
summary: Update the Roaming Information of the EPC domain
operationId: UpdateRoamingInformation
tags:
– Update the Roaming Information of the EPC domain (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
requestBody:
content:
application/json:
schema:
$ref: ‘TS29503_Nudm_UECM.yaml#/components/schemas/RoamingInfoUpdate’
required: true
responses:
‘201’:
description: Created
content:
application/json:
schema:
$ref: ‘TS29503_Nudm_UECM.yaml#/components/schemas/RoamingInfoUpdate’
headers:
Location:
description: ‘Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/subscription-data/{ueId}/context-data/roaming-information’
required: true
schema:
type: string
‘204’:
description: Upon success, an empty response body shall be returned
default:
description: Unexpected error
get:
summary: Retrieves the Roaming Information of the EPC domain
operationId: QueryRoamingInformation
tags:
– Retrieve the Roaming Information of the EPC domain (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29503_Nudm_UECM.yaml#/components/schemas/RoamingInfoUpdate’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/context-data/pei-info:
put:
summary: Update the PEI Information of the 5GC/EPC domains
operationId: CreateOrUpdatePeiInformation
tags:
– Update the PEI Information of the 5GC/EPC domains (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
requestBody:
content:
application/json:
schema:
$ref: ‘TS29503_Nudm_UECM.yaml#/components/schemas/PeiUpdateInfo’
required: true
responses:
‘201’:
description: Created
content:
application/json:
schema:
$ref: ‘TS29503_Nudm_UECM.yaml#/components/schemas/PeiUpdateInfo’
headers:
Location:
description: ‘Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/subscription-data/{ueId}/context-data/pei-info’
required: true
schema:
type: string
‘204’:
description: Upon success, an empty response body shall be returned
default:
description: Unexpected error
get:
summary: Retrieves the PEI Information of the 5GC/EPC domains
operationId: QueryPeiInformation
tags:
– Retrieve the Roaming Information of the 5GC/EPC domains (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29503_Nudm_UECM.yaml#/components/schemas/PeiUpdateInfo’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId}/amf-subscriptions:
put:
summary: Create AmfSubscriptions for a group of UEs or any UE
operationId: CreateAmfGroupSubscriptions
tags:
– AMF Group Subscription Info (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueGroupId
in: path
required: true
schema:
$ref: ‘#/components/schemas/VarUeGroupId’
– name: subsId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: ‘#/components/schemas/AmfSubscriptionInfo’
minItems: 1
required: true
responses:
‘204’:
description: Upon success, an empty response body shall be returned
‘201’:
description: Upon successful creation, the created resource shall be returned
content:
application/json:
schema:
type: array
items:
$ref: ‘#/components/schemas/AmfSubscriptionInfo’
minItems: 1
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
summary: Deletes AMF Subscription Info for an eeSubscription for a group of UEs or any UE
operationId: RemoveAmfGroupSubscriptions
tags:
– Event AMF Subscription Info (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueGroupId
in: path
required: true
schema:
$ref: ‘#/components/schemas/VarUeGroupId’
– name: subsId
in: path
required: true
schema:
type: string
responses:
‘204’:
description: Expected response to a successful subscription removal
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
patch:
summary: modify the AMF Subscription Info
operationId: ModifyAmfGroupSubscriptions
tags:
– AmfSubscriptionInfo (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueGroupId
in: path
required: true
schema:
$ref: ‘#/components/schemas/VarUeGroupId’
– name: subsId
in: path
required: true
schema:
type: string
– name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchItem’
required: true
responses:
‘204’:
description: Expected response to a valid request
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchResult’
‘403’:
description: modification is rejected
content:
application/problem+json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieve AMF subscription Info for a group of UEs or any UE
operationId: GetAmfGroupSubscriptions
tags:
– Query AMF Subscription Info (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueGroupId
in: path
required: true
schema:
$ref: ‘#/components/schemas/VarUeGroupId’
– name: subsId
in: path
required: true
schema:
type: string
responses:
‘200’:
description: OK
content:
application/json:
schema:
type: array
items:
$ref: ‘#/components/schemas/AmfSubscriptionInfo’
minItems: 1
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId}/smf-subscriptions:
put:
summary: Create SMF Subscription Info for a group of UEs or any YE
operationId: CreateSmfGroupSubscriptions
tags:
– SMF Event Group Subscription Info (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueGroupId
in: path
required: true
schema:
$ref: ‘#/components/schemas/VarUeGroupId’
– name: subsId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/SmfSubscriptionInfo’
required: true
responses:
‘204’:
description: Upon success, an empty response body shall be returned
‘201’:
description: Upon successful creation, the created resource shall be returned
content:
application/json:
schema:
$ref: ‘#/components/schemas/SmfSubscriptionInfo’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
summary: Delete SMF Subscription Info for a group of UEs or any UE
operationId: RemoveSmfGroupSubscriptions
tags:
– SMF Event Subscription Info (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueGroupId
in: path
required: true
schema:
$ref: ‘#/components/schemas/VarUeGroupId’
– name: subsId
in: path
required: true
schema:
type: string
responses:
‘204’:
description: Expected response to a successful subscription removal
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
patch:
summary: Modify SMF Subscription Info for a group of UEs or any UE
operationId: ModifySmfGroupSubscriptions
tags:
– SMF Event Subscription Info (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueGroupId
in: path
required: true
schema:
$ref: ‘#/components/schemas/VarUeGroupId’
– name: subsId
in: path
required: true
schema:
type: string
– name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchItem’
required: true
responses:
‘204’:
description: Expected response to a valid request
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchResult’
‘403’:
description: modification is rejected
content:
application/problem+json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieve SMF Subscription Info for a group of UEs or any UE
operationId: GetSmfGroupSubscriptions
tags:
– SMF Event Subscription Info (Document)
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueGroupId
in: path
required: true
schema:
$ref: ‘#/components/schemas/VarUeGroupId’
– name: subsId
in: path
required: true
schema:
type: string
responses:
‘200’:
description: OK
content:
application/json:
schema:
$ref: ‘#/components/schemas/SmfSubscriptionInfo’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId}/hss-subscriptions:
put:
summary: Create HSS Subscription Info for a group of UEs
operationId: CreateHssGroupSubscriptions
tags:
– HSS Event Group Subscription Info (Document)
parameters:
– name: externalGroupId
in: path
required: true
schema:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId’
– name: subsId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/HssSubscriptionInfo’
required: true
responses:
‘204’:
description: Upon success, an empty response body shall be returned
‘201’:
description: Upon successful creation, the created resource shall be returned
content:
application/json:
schema:
$ref: ‘#/components/schemas/HssSubscriptionInfo’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
summary: Delete HSS Subscription Info
operationId: RemoveHssGroupSubscriptions
tags:
– HSS Event Subscription Info (Document)
parameters:
– name: externalGroupId
in: path
required: true
schema:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId’
– name: subsId
in: path
required: true
schema:
type: string
responses:
‘204’:
description: Expected response to a successful subscription removal
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
patch:
summary: Modify HSS Subscription Info
operationId: ModifyHssGroupSubscriptions
tags:
– HSS Event Subscription Info (Document)
parameters:
– name: externalGroupId
in: path
required: true
schema:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId’
– name: subsId
in: path
required: true
schema:
type: string
– name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchItem’
required: true
responses:
‘204’:
description: Expected response to a valid request
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PatchResult’
‘403’:
description: modification is rejected
content:
application/problem+json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
get:
summary: Retrieve HSS Subscription Info
operationId: GetHssGroupSubscriptions
tags:
– HSS Event Subscription Info (Document)
parameters:
– name: externalGroupId
in: path
required: true
schema:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId’
– name: subsId
in: path
required: true
schema:
type: string
responses:
‘200’:
description: OK
content:
application/json:
schema:
$ref: ‘#/components/schemas/HssSubscriptionInfo’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscription-data/{ueId}/uc-data:
get:
summary: Retrieves the subscribed User Consent Data of a UE
operationId: QueryUserConsentData
tags:
– User Consent Data
security:
– {}
– oAuth2ClientCredentials:
– nudr-dr
– oAuth2ClientCredentials:
– nudr-dr
– nudr-dr:subscription-data
parameters:
– name: ueId
in: path
description: UE id
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
– name: ucPurpose
in: query
description: User consent purpose
schema:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/UcPurpose’
– 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:
$ref: ‘#/components/schemas/UcSubscriptionData’
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:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
components:
schemas:
AuthenticationSubscription:
description: A UE’s authentication data.
type: object
required:
– authenticationMethod
properties:
authenticationMethod:
$ref: ‘#/components/schemas/AuthMethod’
encPermanentKey:
type: string
protectionParameterId:
type: string
sequenceNumber:
$ref: ‘#/components/schemas/SequenceNumber’
authenticationManagementField:
type: string
pattern: ‘^[A-Fa-f0-9]{4}$’
algorithmId:
type: string
encOpcKey:
type: string
encTopcKey:
type: string
vectorGenerationInHss:
type: boolean
default: false
hssGroupId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/NfGroupId’
n5gcAuthMethod:
$ref: ‘#/components/schemas/AuthMethod’
rgAuthenticationInd:
type: boolean
default: false
supi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
akmaAllowed:
type: boolean
default: false
routingId:
type: string
pattern: ‘^[0-9]{1,4}$’
SequenceNumber:
description: Contains the SQN.
type: object
properties:
sqnScheme:
$ref: ‘#/components/schemas/SqnScheme’
sqn:
type: string
pattern: ‘^[A-Fa-f0-9]{12}$’
lastIndexes:
type: object
additionalProperties:
type: integer
minimum: 0
description: A map(list of key-value pairs) where type of node serves as key
indLength:
type: integer
minimum: 0
difSign:
$ref: ‘#/components/schemas/Sign’
SqnScheme:
description: Scheme for generation of Sequence Numbers.
anyOf:
– type: string
enum:
– GENERAL
– NON_TIME_BASED
– TIME_BASED
– type: string
Sign:
description: Sign of the DIF value.
type: string
enum:
– POSITIVE
– NEGATIVE
VarPlmnId:
description: PLMN Id (MCC, MNC) or SNPN Id (MCC, MNC, NID).
type: string
pattern: ‘^[0-9]{5,6}(-[A-Fa-f0-9]{11})?$’
DatasetNames:
description: The list of names of data sets.
type: array
items:
$ref: ‘#/components/schemas/DataSetName’
minItems: 1
uniqueItems: true
DataSetName:
description: The name of data set.
anyOf:
– type: string
enum:
– AM
– SMF_SEL
– SMS_SUB
– SM
– TRACE
– SMS_MNG
– LCS_PRIVACY
– LCS_MO
– LCS_BCA
– V2X
– PROSE
– ODB
– EE_PROF
– PP_PROF
– NIDD_AUTH
– USER_CONSENT
– MBS
– type: string
ProvisionedDataSets:
description: Contains the provisioned data sets.
type: object
properties:
amData:
$ref: ‘#/components/schemas/AccessAndMobilitySubscriptionData’
smfSelData:
$ref: ‘#/components/schemas/SmfSelectionSubscriptionData’
smsSubsData:
$ref: ‘#/components/schemas/SmsSubscriptionData’
smData:
$ref: ‘#/components/schemas/SmSubsData’
traceData:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/TraceData’
smsMngData:
$ref: ‘#/components/schemas/SmsManagementSubscriptionData’
lcsPrivacyData:
$ref: ‘#/components/schemas/LcsPrivacyData’
lcsMoData:
$ref: ‘#/components/schemas/LcsMoData’
lcsBcaData:
$ref: ‘#/components/schemas/LcsBroadcastAssistanceTypesData’
v2xData:
$ref: ‘#/components/schemas/V2xSubscriptionData’
proseData:
$ref: ‘#/components/schemas/ProseSubscriptionData’
odbData:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/OdbData’
eeProfileData:
$ref: ‘#/components/schemas/EeProfileData’
ppProfileData:
$ref: ‘#/components/schemas/PpProfileData’
niddAuthData:
$ref: ‘#/components/schemas/AuthorizationData’
mbsSubscriptionData:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/MbsSubscriptionData’
AccessAndMobilitySubscriptionData:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/AccessAndMobilitySubscriptionData’
SmfSelectionSubscriptionData:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/SmfSelectionSubscriptionData’
VarSnssai:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Snssai’
Dnn:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Dnn’
SmSubsData:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/SmSubsData’
Amf3GppAccessRegistration:
$ref: ‘TS29503_Nudm_UECM.yaml#/components/schemas/Amf3GppAccessRegistration’
AmfNon3GppAccessRegistration:
$ref: ‘TS29503_Nudm_UECM.yaml#/components/schemas/AmfNon3GppAccessRegistration’
SmfRegistration:
$ref: ‘TS29503_Nudm_UECM.yaml#/components/schemas/SmfRegistration’
SmsfRegistration:
$ref: ‘TS29503_Nudm_UECM.yaml#/components/schemas/SmsfRegistration’
LocationInfo:
$ref: ‘TS29503_Nudm_UECM.yaml#/components/schemas/LocationInfo’
SmsManagementSubscriptionData:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/SmsManagementSubscriptionData’
SmsSubscriptionData:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/SmsSubscriptionData’
LcsPrivacyData:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/LcsPrivacyData’
LcsMoData:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/LcsMoData’
AuthorizationData:
description: NIDD Authorization Information
required:
– authorizationData
properties:
authorizationData:
type: array
items:
$ref: ‘TS29503_Nudm_NIDDAU.yaml#/components/schemas/UserIdentifier’
minItems: 1
uniqueItems: true
allowedDnnList:
type: array
items:
anyOf:
– $ref: ‘TS29571_CommonData.yaml#/components/schemas/Dnn’
– $ref: ‘TS29571_CommonData.yaml#/components/schemas/WildcardDnn’
allowedSnssaiList:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Snssai’
allowedMtcProviders:
type: array
items:
$ref: ‘#/components/schemas/MtcProvider’
validityTime:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’
EnhancedCoverageRestrictionData:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/EnhancedCoverageRestrictionData’
V2xSubscriptionData:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/V2xSubscriptionData’
ProseSubscriptionData:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/ProseSubscriptionData’
UcSubscriptionData:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/UcSubscriptionData’
LcsBroadcastAssistanceTypesData:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/LcsBroadcastAssistanceTypesData’
OperatorSpecificDataContainer:
description: Container for operator specific data.
type: object
required:
– dataType
– value
properties:
dataType:
type: string
enum:
– string
– integer
– number
– boolean
– object
– array
dataTypeDefinition:
type: string
value:
oneOf:
– type: string
– type: integer
– type: number
– type: boolean
– type: object
– type: array
supportedFeatures:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
resetIds:
type: array
items:
type: string
minItems: 1
AuthMethod:
description: Contains the Authentication Method.
anyOf:
– type: string
enum:
– 5G_AKA
– EAP_AKA_PRIME
– EAP_TLS
– EAP_TTLS
– NONE
– type: string
PpData:
$ref: ‘TS29503_Nudm_PP.yaml#/components/schemas/PpData’
EeSubscription:
$ref: ‘TS29503_Nudm_EE.yaml#/components/schemas/EeSubscription’
VarUeGroupId:
description: UE group Id or any UE.
type: string
pattern: ‘^(extgroupid-[^@]+@[^@]+|anyUE)$’
SdmSubscription:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/SdmSubscription’
SmfRegList:
description: The list of all the SMF registrations of a UE.
type: array
items:
$ref: ‘#/components/schemas/SmfRegistration’
SubscriptionDataSubscriptions:
description: A subscription to notifications.
type: object
required:
– monitoredResourceUris
– callbackReference
properties:
ueId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
callbackReference:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uri’
originalCallbackReference:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uri’
monitoredResourceUris:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uri’
expiry:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’
sdmSubscription:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/SdmSubscription’
hssSubscriptionInfo:
$ref: ‘#/components/schemas/HssSubscriptionInfo’
subscriptionId:
type: string
uniqueSubscription:
type: boolean
supportedFeatures:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
immediateReport:
type: boolean
default: false
report:
$ref: ‘#/components/schemas/ImmediateReport’
DataChangeNotify:
description: Container for data which have changed and notification was requested when changed.
type: object
properties:
originalCallbackReference:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uri’
minItems: 1
ueId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/VarUeId’
notifyItems:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/NotifyItem’
minItems: 1
sdmSubscription:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/SdmSubscription’
additionalSdmSubscriptions:
type: array
items:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/SdmSubscription’
minItems: 1
subscriptionDataSubscriptions:
type: array
items:
$ref: ‘#/components/schemas/SubscriptionDataSubscriptions’
IdentityData:
description: Identity data corresponds to the provided ueId.
type: object
properties:
supiList:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
minItems: 1
gpsiList:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’
minItems: 1
allowedAfIds:
type: array
items:
type: string
minItems: 1
applicationPortIds:
description: A map (list of key-value pairs where AppPortId serves as key) of GPSIs.
type: object
additionalProperties:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’
minProperties: 1
SorData:
description: Used to store the status of the latest SOR data update.
type: object
properties:
provisioningTime:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’
ueUpdateStatus:
$ref: ‘#/components/schemas/UeUpdateStatus’
sorXmacIue:
$ref: ‘TS29509_Nausf_SoRProtection.yaml#/components/schemas/SorMac’
sorMacIue:
$ref: ‘TS29509_Nausf_SoRProtection.yaml#/components/schemas/SorMac’
meSupportOfSorCmci:
type: boolean
required:
– provisioningTime
– ueUpdateStatus
UpuData:
description: Used to store the status of the latest UPU data update.
type: object
properties:
provisioningTime:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’
ueUpdateStatus:
$ref: ‘#/components/schemas/UeUpdateStatus’
upuXmacIue:
$ref: ‘TS29509_Nausf_UPUProtection.yaml#/components/schemas/UpuMac’
upuMacIue:
$ref: ‘TS29509_Nausf_UPUProtection.yaml#/components/schemas/UpuMac’
required:
– provisioningTime
– ueUpdateStatus
NssaiAckData:
description: Used to store the status of the latest NSSAI data update.
type: object
properties:
provisioningTime:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’
ueUpdateStatus:
$ref: ‘#/components/schemas/UeUpdateStatus’
required:
– provisioningTime
– ueUpdateStatus
CagAckData:
description: Used to store the status of the latest CAG data update.
type: object
properties:
provisioningTime:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’
ueUpdateStatus:
$ref: ‘#/components/schemas/UeUpdateStatus’
required:
– provisioningTime
– ueUpdateStatus
UeUpdateStatus:
description: Status of the procedure.
type: string
enum:
– NOT_SENT
– SENT_NO_ACK_REQUIRED
– WAITING_FOR_ACK
– ACK_RECEIVED
– NEGATIVE_ACK_RECEIVED
EeProfileData:
description: Event Exposure Profile Data.
type: object
properties:
restrictedEventTypes:
type: array
items:
$ref: ‘TS29503_Nudm_EE.yaml#/components/schemas/EventType’
supportedFeatures:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
allowedMtcProvider:
description: A map (list of key-value pairs where EventType serves as key) of MTC provider lists. In addition to defined EventTypes, the key value "ALL" may be used to identify a map entry which contains a list of MtcProviders that are allowed monitoring all Event Types.
type: object
additionalProperties:
type: array
items:
$ref: ‘#/components/schemas/MtcProvider’
minItems: 1
minProperties: 1
iwkEpcRestricted:
type: boolean
default: false
imsi:
type: string
pattern: ‘^[0-9]{5,15}$’
hssGroupId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/NfGroupId’
AmfSubscriptionInfo:
description: Information the UDR stores and retrieves related to active subscriptions at the AMF(s).
type: object
required:
– amfInstanceId
– subscriptionId
properties:
amfInstanceId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/NfInstanceId’
subscriptionId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uri’
subsChangeNotifyCorrelationId:
type: string
contextInfo:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/ContextInfo’
ContextDatasetNames:
description: The name of context data set.
type: array
items:
$ref: ‘#/components/schemas/ContextDataSetName’
minItems: 2
uniqueItems: true
ContextDataSetName:
anyOf:
– type: string
enum:
– AMF_3GPP
– AMF_NON_3GPP
– SDM_SUBSCRIPTIONS
– EE_SUBSCRIPTIONS
– SMSF_3GPP
– SMSF_NON_3GPP
– SUBS_TO_NOTIFY
– SMF_REG
– IP_SM_GW
– ROAMING_INFO
– PEI_INFO
– type: string
ContextDataSets:
description: Contains the context data sets.
type: object
properties:
amf3Gpp:
$ref: ‘#/components/schemas/Amf3GppAccessRegistration’
amfNon3Gpp:
$ref: ‘#/components/schemas/AmfNon3GppAccessRegistration’
sdmSubscriptions:
type: array
items:
$ref: ‘#/components/schemas/SdmSubscription’
minItems: 1
eeSubscriptions:
type: array
items:
$ref: ‘#/components/schemas/EeSubscription’
minItems: 1
smsf3GppAccess:
$ref: ‘#/components/schemas/SmsfRegistration’
smsfNon3GppAccess:
$ref: ‘#/components/schemas/SmsfRegistration’
subscriptionDataSubscriptions:
type: array
items:
$ref: ‘#/components/schemas/SubscriptionDataSubscriptions’
minItems: 1
smfRegistrations:
$ref: ‘#/components/schemas/SmfRegList’
ipSmGw:
$ref: ‘#/components/schemas/IpSmGwRegistration’
roamingInfo:
$ref: ‘TS29503_Nudm_UECM.yaml#/components/schemas/RoamingInfoUpdate’
peiInfo:
$ref: ‘TS29503_Nudm_UECM.yaml#/components/schemas/PeiUpdateInfo’
IpSmGwRegistration:
$ref: ‘TS29503_Nudm_UECM.yaml#/components/schemas/IpSmGwRegistration’
MessageWaitingData:
description: Message Waiting Data list.
type: object
properties:
mwdList:
type: array
items:
$ref: ‘#/components/schemas/SmscData’
minItems: 1
SmscData:
description: Addresses of SM-Service Center entities with SMS wating to be delivered to the UE.
type: object
anyOf:
– required: [ smscMapAddress ]
– required: [ smscDiameterAddress ]
properties:
smscMapAddress:
$ref: ‘TS29503_Nudm_UECM.yaml#/components/schemas/E164Number’
smscDiameterAddress:
$ref: ‘TS29503_Nudm_UECM.yaml#/components/schemas/NetworkNodeDiameterAddress’
SmfSubscriptionInfo:
description: Information related to active subscriptions at the SMF(s)
type: object
required:
– smfSubscriptionList
properties:
smfSubscriptionList:
type: array
items:
$ref: ‘#/components/schemas/SmfSubscriptionItem’
minItems: 1
SmfSubscriptionItem:
description: Contains info about a single SMF event subscription
type: object
required:
– smfInstanceId
– subscriptionId
properties:
smfInstanceId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/NfInstanceId’
subscriptionId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uri’
contextInfo:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/ContextInfo’
MtcProvider:
description: MTC provider information.
type: object
properties:
mtcProviderInformation:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation’
afId:
type: string
HssSubscriptionInfo:
description: Information related to active subscriptions at the HSS(s)
type: object
required:
– hssSubscriptionList
properties:
hssSubscriptionList:
type: array
items:
$ref: ‘#/components/schemas/HssSubscriptionItem’
minItems: 1
HssSubscriptionItem:
description: Contains info about a single HSS event subscription
type: object
required:
– hssInstanceId
– subscriptionId
properties:
hssInstanceId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/NfInstanceId’
subscriptionId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uri’
contextInfo:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/ContextInfo’
EeGroupProfileData:
type: object
properties:
restrictedEventTypes:
type: array
items:
$ref: ‘TS29503_Nudm_EE.yaml#/components/schemas/EventType’
allowedMtcProvider:
description: A map (list of key-value pairs where EventType serves as key) of MTC provider lists. In addition to defined EventTypes, the key value "ALL" may be used to identify a map entry which contains a list of MtcProviders that are allowed monitoring all Event Types.
type: object
additionalProperties:
type: array
items:
$ref: ‘#/components/schemas/MtcProvider’
minItems: 1
minProperties: 1
supportedFeatures:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
iwkEpcRestricted:
type: boolean
default: false
extGroupId:
type: string
pattern: ‘^extgroupid-[^@]+@[^@]+$’
hssGroupId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/NfGroupId’
Pp5gVnGroupProfileData:
type: object
properties:
allowedMtcProviders:
description: A map (list of key-value pairs where external VN group identifier serves as key) of AllowedMtcProviderInfo lists. In addition to defined external VN group identifier, the key value "ALL" may be used to identify a map entry which contains a list of AllowedMtcProviderInfo that are allowed operating all the external group identifiers.
type: object
additionalProperties:
type: array
items:
$ref: ‘#/components/schemas/AllowedMtcProviderInfo’
minItems: 1
minProperties: 1
supportedFeatures:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
PpProfileData:
type: object
properties:
allowedMtcProviders:
description: A map (list of key-value pairs where PpDataType serves as key) of AllowedMtcProviderInfo lists. In addition to defined PpDataType, the key value "ALL" may be used to identify a map entry which contains a list of AllowedMtcProviderInfo that are allowed to provision all types of the PP data for the user using UDM ParameterProvision service.
type: object
additionalProperties:
type: array
items:
$ref: ‘#/components/schemas/AllowedMtcProviderInfo’
minItems: 1
minProperties: 1
supportedFeatures:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
AllowedMtcProviderInfo:
type: object
properties:
mtcProviderInformation:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation’
afId:
type: string
PpDataType:
anyOf:
– type: string
enum:
– COMMUNICATION_CHARACTERISTICS
– EXPECTED_UE_BEHAVIOUR
– EC_RESTRICTION
– ACS_INFO
– TRACE
– STN_SR
– LCS_PRIVACY
– SOR_INFO
– type: string
GroupIdentifiers:
description: External or Internal Group Identifier with a list of group members
type: object
properties:
extGroupId:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId’
intGroupId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/GroupId’
ueIdList:
type: array
items:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/UeId’
minItems: 1
allowedAfIds:
type: array
items:
type: string
minItems: 1
NiddAuthorizationInfo:
description: Information related to active NIDD Authorizations
type: object
required:
– niddAuthorizationList
properties:
niddAuthorizationList:
type: array
items:
$ref: ‘TS29503_Nudm_NIDDAU.yaml#/components/schemas/AuthorizationInfo’
minItems: 1
PpDataEntryList:
description: Contains a list of the Provisioned Parameters entries
type: object
properties:
ppDataEntryList:
type: array
items:
$ref: ‘TS29503_Nudm_PP.yaml#/components/schemas/PpDataEntry’
supportedFeatures:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
UeSubscribedDataSets:
description: Contains the subscribed data sets of a UE.
type: object
properties:
amData:
$ref: ‘#/components/schemas/AccessAndMobilitySubscriptionData’
smfSelData:
$ref: ‘#/components/schemas/SmfSelectionSubscriptionData’
smsSubsData:
$ref: ‘#/components/schemas/SmsSubscriptionData’
smData:
$ref: ‘#/components/schemas/SmSubsData’
traceData:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/TraceData’
smsMngData:
$ref: ‘#/components/schemas/SmsManagementSubscriptionData’
lcsPrivacyData:
$ref: ‘#/components/schemas/LcsPrivacyData’
lcsMoData:
$ref: ‘#/components/schemas/LcsMoData’
lcsBcaData:
$ref: ‘#/components/schemas/LcsBroadcastAssistanceTypesData’
v2xData:
$ref: ‘#/components/schemas/V2xSubscriptionData’
proseData:
$ref: ‘#/components/schemas/ProseSubscriptionData’
odbData:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/OdbData’
eeProfileData:
$ref: ‘#/components/schemas/EeProfileData’
ppProfileData:
$ref: ‘#/components/schemas/PpProfileData’
niddAuthData:
$ref: ‘#/components/schemas/AuthorizationData’
ucData:
$ref: ‘#/components/schemas/UcSubscriptionData’
mbsSubscriptionData:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/MbsSubscriptionData’
ServiceSpecificAuthorizationInfo:
description: Information related to active Service Specific Authorizations
type: object
required:
– serviceSpecificAuthorizationList
properties:
serviceSpecificAuthorizationList:
type: array
items:
$ref: ‘TS29503_Nudm_NIDDAU.yaml#/components/schemas/AuthorizationInfo’
minItems: 1
NfIdentifier:
type: object
required:
– nfType
properties:
nfType:
$ref: ‘TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType’
nfInstanceId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/NfInstanceId’
EeSubscriptionExt:
allOf:
– $ref: ‘TS29503_Nudm_EE.yaml#/components/schemas/EeSubscription’
– $ref: ‘#/components/schemas/AdditionalEeSubsInfo’
AdditionalEeSubsInfo:
type: object
properties:
amfSubscriptionInfoList:
type: array
items:
$ref: ‘#/components/schemas/AmfSubscriptionInfo’
minItems: 1
maxItems: 2
smfSubscriptionInfo:
$ref: ‘#/components/schemas/SmfSubscriptionInfo’
hssSubscriptionInfo:
$ref: ‘#/components/schemas/HssSubscriptionInfo’
ImmediateReport:
oneOf:
– $ref: ‘#/components/schemas/ProvisionedDataSets’
– type: array
items:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/SharedData’
minItems: 0
Annex B (informative):
Change history
|
Change history |
|||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2018-01 |
CT4#82 |
TS skeleton of Usage of the Unified Data Repository service for Subscription Data |
0.0.0 |
||||
|
2018-01 |
CT4#82 |
C4-181397 |
Version after CT4#82 including agreed pCRs |
0.1.0 |
|||
|
2018-03 |
CT4#83 |
C4-182442 |
Version after CT4#83 including agreed pCRs |
0.2.0 |
|||
|
2018-04 |
CT4#84 |
C4-183523 |
Version after CT4#84 including agreed pCRs |
0.3.0 |
|||
|
2018-05 |
CT4#85 |
C4-184638 |
Version after CT4#85 including agreed pCRs |
0.4.0 |
|||
|
2018-06 |
CT#80 |
CP-181103 |
Presented for information and approval |
1.0.0 |
|||
|
2018-06 |
CT#80 |
Approved in CT#80. |
15.0.0 |
||||
|
2018-09 |
CT#81 |
CP-182058 |
0004 |
– |
F |
Path Segment Correction |
15.1.0 |
|
2018-09 |
CT#81 |
CP-182058 |
0005 |
– |
F |
URI variables for the Resource OperatorSpecificData |
15.1.0 |
|
2018-09 |
CT#81 |
CP-182058 |
0008 |
– |
F |
Formatting of query parameter |
15.1.0 |
|
2018-09 |
CT#81 |
CP-182212 |
0009 |
2 |
B |
PATCH method for ProvisionedParamenterData |
15.1.0 |
|
2018-09 |
CT#81 |
CP-182058 |
0010 |
– |
F |
JSON structure in query and missing data type reference |
15.1.0 |
|
2018-09 |
CT#81 |
CP-182058 |
0014 |
– |
F |
Description of Structured data types |
15.1.0 |
|
2018-09 |
CT#81 |
CP-182058 |
0016 |
– |
F |
Implicit Subscriptions |
15.1.0 |
|
2018-09 |
CT#81 |
CP-182058 |
0011 |
1 |
F |
Align security and servers clause in openAPI |
15.1.0 |
|
2018-09 |
CT#81 |
CP-182058 |
0013 |
1 |
F |
VarUeId used in TS 29.505 |
15.1.0 |
|
2018-09 |
CT#81 |
CP-182058 |
0012 |
2 |
F |
OpenAPI schema for SubscriptionData |
15.1.0 |
|
2018-09 |
CT#81 |
CP-182058 |
0018 |
1 |
F |
Supported Features Negotiation |
15.1.0 |
|
2018-09 |
CT#81 |
CP-182041 |
0015 |
1 |
B |
Nudr Id Translation |
15.1.0 |
|
2018-09 |
CT#81 |
CP-182043 |
0001 |
2 |
B |
Add support for 5G Trace to Nudr |
15.1.0 |
|
2018-12 |
CT#82 |
CP-183016 |
0026 |
– |
F |
Corrections in Query Parameters |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183016 |
0030 |
– |
F |
29505 CR data change notification data type |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183016 |
0021 |
1 |
F |
Pattern correction |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183016 |
0022 |
1 |
F |
Session Management Subscription Data |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183016 |
0019 |
1 |
F |
Shared Data |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183016 |
0029 |
1 |
F |
29505 CR cardinality |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183016 |
0025 |
2 |
F |
Clarification of contents of SUPI list |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183016 |
0032 |
– |
F |
Cache control and conditional request header addition |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183016 |
0024 |
3 |
F |
Introduction of Barring of Roaming in 5GC |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183016 |
0037 |
1 |
F |
Session Management Subscription Data |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183016 |
0039 |
1 |
F |
Authorized Event Types |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183016 |
0040 |
1 |
F |
Group Subscriptions |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183016 |
0041 |
1 |
F |
Location header in 201 response |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183016 |
0038 |
2 |
F |
Active AmfSubscriptions storage |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183016 |
0036 |
2 |
F |
lifetime of subscription |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183158 |
0028 |
3 |
F |
Definition of Authentication Data for steering of roaming |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183159 |
0027 |
4 |
F |
Definition of Authentication Status |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183160 |
0020 |
5 |
F |
Definition of Authentication data |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183187 |
0023 |
3 |
F |
Get multiple datasets for ProvisionedData |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183249 |
0042 |
– |
F |
Corrections on openAPI |
15.2.0 |
|
2019-03 |
CT#83 |
CP-190179 |
0043 |
F |
CR 0019r1 was not correctly implemented |
15.3.0 |
|
|
2019-03 |
CT#83 |
CP-190179 |
0044 |
F |
CR 0020r5 was not correctly implemented |
15.3.0 |
|
|
2019-03 |
CT#83 |
CP-190179 |
0045 |
F |
CR 0021r1 was not correctly implemented |
15.3.0 |
|
|
2019-03 |
CT#83 |
CP-190179 |
0046 |
F |
CR 0023r3 was not correctly implemented |
15.3.0 |
|
|
2019-03 |
CT#83 |
CP-190179 |
0047 |
F |
CR 0038r2 was not correctly implemented |
15.3.0 |
|
|
2019-03 |
CT#83 |
CP-190179 |
0048 |
F |
CR 0039r1 was not correctly implemented |
15.3.0 |
|
|
2019-03 |
CT#83 |
CP-190179 |
0049 |
F |
CR 0040r1 was not correctly implemented |
15.3.0 |
|
|
2019-03 |
CT#83 |
CP-190179 |
0050 |
F |
Correction of annex B |
15.3.0 |
|
|
2019-03 |
CT#83 |
CP-190179 |
0052 |
2 |
F |
Clarification on use of PUT |
15.3.0 |
|
2019-03 |
CT#83 |
CP-190179 |
0054 |
F |
Missing Headlines |
15.3.0 |
|
|
2019-03 |
CT#83 |
CP-190179 |
0055 |
2 |
F |
Sequence Number |
15.3.0 |
|
2019-03 |
CT#83 |
CP-190179 |
0056 |
1 |
F |
Retrieval of multiple context data sets |
15.3.0 |
|
2019-03 |
CT#83 |
CP-190179 |
0057 |
3 |
F |
UDR Subscriptions |
15.3.0 |
|
2019-03 |
CT#83 |
CP-190179 |
0058 |
1 |
F |
Data Set Names in URI Query Parameters |
15.3.0 |
|
2019-03 |
CT#83 |
CP-190179 |
0060 |
2 |
F |
AuthenticationSubscription correction |
15.3.0 |
|
2019-03 |
CT#83 |
CP-190179 |
0061 |
2 |
F |
SOR data update status |
15.3.0 |
|
2019-03 |
CT#83 |
CP-190168 |
0062 |
1 |
F |
3GPP TS 29.505 API version update |
15.3.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0065 |
|
F |
CR 0049 was not correctly implemented |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0066 |
|
F |
CR 0050 was not correctly implemented |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0067 |
|
F |
CR 0054 was not correctly implemented |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0068 |
|
F |
CR 0056r1 was not correctly implemented |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0070 |
|
F |
Update of the SubsToNotify |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0071 |
|
F |
Update of the EESubscription |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0064 |
1 |
F |
Update Individual Subscription |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0072 |
1 |
F |
missing enties of data type summary table |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0073 |
1 |
F |
correction on operationId |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0074 |
1 |
F |
404 error response |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0076 |
1 |
F |
Correct the GET Request Body of AmfNon3GppAccessRegistration resource |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0077 |
1 |
F |
Default Notification URI |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0081 |
1 |
F |
OdbData Correction |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0086 |
2 |
F |
Storage of OpenAPI specification files |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0075 |
3 |
F |
CR 0062r1 was not correctly implemented |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0079 |
2 |
F |
Subscriptions Deletion |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0087 |
|
F |
PduSessionId |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0063 |
2 |
F |
UE Parameter Update (UPU) |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0078 |
2 |
F |
Group Identifier Translation |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0080 |
2 |
F |
Authentication Subscription |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0069 |
2 |
F |
CR 0062r1 was not correctly implemented |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0088 |
1 |
F |
Protection Parameter ID |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0089 |
1 |
F |
Copyright Note in YAML file |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191032 |
0083 |
6 |
F |
SubscriptionDataSubscriptions identification |
15.4.0 |
|
2019-09 |
CT#85 |
CP-192229 |
0094 |
1 |
B |
Definition of OperatorSpecificDataContainer |
16.0.0 |
|
2019-09 |
CT#85 |
CP-192123 |
0100 |
– |
F |
Missing supportedFeatures |
16.0.0 |
|
2019-09 |
CT#85 |
CP-192123 |
0090 |
1 |
B |
Network Slicing Subscription Change |
16.0.0 |
|
2019-09 |
CT#85 |
CP-192123 |
0098 |
1 |
F |
UDR Application Errors |
16.0.0 |
|
2019-09 |
CT#85 |
CP-192123 |
0101 |
1 |
B |
Application errors for DELETE method |
16.0.0 |
|
2019-09 |
CT#85 |
CP-192133 |
0095 |
1 |
B |
Closed Access Group |
16.0.0 |
|
2019-09 |
CT#85 |
CP-192027 |
0096 |
2 |
B |
VN-Group parameter provisioning |
16.0.0 |
|
2019-09 |
CT#85 |
CP-192120 |
0104 |
– |
F |
3GPP TS 29.505 externalDoc correction |
16.0.0 |
|
2019-10 |
Corrupted references fixed |
16.0.1 |
|||||
|
2019-12 |
CT#86 |
CP-193029 |
0108 |
|
A |
Monitored Resurce URI |
16.1.0 |
|
2019-12 |
CT#86 |
CP-193029 |
0263 |
1 |
A |
GroupIdentifier resource URI |
16.1.0 |
|
2019-12 |
CT#86 |
CP-193049 |
0112 |
1 |
B |
Id translation for MSISDN-less MO SMS service |
16.1.0 |
|
2019-12 |
CT#86 |
CP-193278 |
0258 |
4 |
B |
NIDD Authorization Data |
16.1.0 |
|
2019-12 |
CT#86 |
CP-193131 |
0257 |
1 |
B |
Authentication Subscription Data |
16.1.0 |
|
2019-12 |
CT#86 |
CP-193055 |
0109 |
2 |
B |
LCS Private |
16.1.0 |
|
2019-12 |
CT#86 |
CP-193055 |
0110 |
3 |
B |
Mobile Originated Data |
16.1.0 |
|
2019-12 |
CT#86 |
CP-193063 |
0105 |
1 |
F |
DataChangeNotify |
16.1.0 |
|
2019-12 |
CT#86 |
CP-193063 |
0106 |
1 |
B |
Patch Report |
16.1.0 |
|
2019-12 |
CT#86 |
CP-193063 |
0259 |
1 |
B |
Feature Negotiation for OperatorSpecificData resource |
16.1.0 |
|
2019-12 |
CT#86 |
CP-193124 |
0265 |
– |
F |
externalDocs correction |
16.1.0 |
|
2020-03 |
CT#87 |
CP-200018 |
0269 |
|
B |
Translation of Group Id to UE identifier list |
16.2.0 |
|
2020-03 |
CT#87 |
CP-200020 |
0271 |
1 |
F |
GET Method to subscriptions |
16.2.0 |
|
2020-03 |
CT#87 |
CP-200020 |
0272 |
|
F |
Add SMFRegistration to ContextDataSet |
16.2.0 |
|
2020-03 |
CT#87 |
CP-200020 |
0266 |
2 |
F |
AuthEvent deletion |
16.2.0 |
|
2020-03 |
CT#87 |
CP-200033 |
0267 |
1 |
B |
Retrieve the status of Enhanced Coverage Restriction |
16.2.0 |
|
2020-03 |
CT#87 |
CP-200020 |
0268 |
1 |
B |
29505 CR optionality of ProblemDetails |
16.2.0 |
|
2020-03 |
CT#87 |
CP-200052 |
0273 |
|
F |
3GPP TS 29.505 Rel16 External doc update |
16.2.0 |
|
2020-06 |
CT#88-e |
CP-201032 |
0275 |
B |
Location information retrieval for GMLC |
16.3.0 |
|
|
2020-06 |
CT#88-e |
CP-201032 |
0276 |
1 |
B |
Resource LcsPrivacySubscriptionData |
16.3.0 |
|
2020-06 |
CT#88-e |
CP-201071 |
0281 |
F |
Storage of YAML files in ETSI Forge |
16.3.0 |
|
|
2020-06 |
CT#88-e |
CP-201049 |
0283 |
B |
Correction on V2X Subscription data |
16.3.0 |
|
|
2020-06 |
CT#88-e |
CP-201033 |
0285 |
B |
Auth Vector Generation for HSS |
16.3.0 |
|
|
2020-06 |
CT#88-e |
CP-201034 |
0286 |
B |
Resource Level Authorization |
16.3.0 |
|
|
2020-06 |
CT#88-e |
CP-201034 |
0282 |
1 |
F |
Authentication results for multiple registrations |
16.3.0 |
|
2020-06 |
CT#88-e |
CP-201032 |
0288 |
1 |
F |
Mobile Originated Data retrieval |
16.3.0 |
|
2020-06 |
CT#88-e |
CP-201048 |
0280 |
1 |
B |
N5GC device Authentication |
16.3.0 |
|
2020-06 |
CT#88-e |
CP-201033 |
0287 |
1 |
B |
Support of SMSoIP |
16.3.0 |
|
2020-06 |
CT#88-e |
CP-201073 |
0290 |
F |
29.505 Rel16 External doc update |
16.3.0 |
|
|
2020-06 |
CT#88-e |
CP-201021 |
0279 |
1 |
A |
Correction of PUT responses |
16.3.0 |
|
2020-09 |
CT#89-e |
CP-202110 |
0291 |
F |
Security for Authentication Subscription Data |
16.4.0 |
|
|
2020-09 |
CT#89-e |
CP-202110 |
0294 |
F |
Corrections to default responses |
16.4.0 |
|
|
2020-09 |
CT#89-e |
CP-202110 |
0295 |
F |
Corrections to the Event Group Subscription |
16.4.0 |
|
|
2020-09 |
CT#89-e |
CP-202112 |
0297 |
1 |
F |
Store Broadcast Location Assistance Data |
16.4.0 |
|
2020-09 |
CT#89-e |
CP-202110 |
0298 |
F |
Correct mismatches of definition between table and yaml |
16.4.0 |
|
|
2020-09 |
CT#89-e |
CP-202111 |
0299 |
F |
Incorrect index type |
16.4.0 |
|
|
2020-09 |
CT#89-e |
CP-202096 |
0301 |
F |
API version and External doc update |
16.4.0 |
|
|
2020-09 |
CT#89-e |
CP-202123 |
0292 |
B |
Resource Level Authorization for SubscriptionData |
17.0.0 |
|
|
2020-09 |
CT#89-e |
CP-202123 |
0293 |
B |
Resource Level Authorization for registrations |
17.0.0 |
|
|
2020-09 |
CT#89-e |
CP-202120 |
0300 |
F |
API version and External doc update |
17.0.0 |
|
|
2020-12 |
CT#90-e |
CP-203048 |
0303 |
A |
Data Removal Notification |
17.1.0 |
|
|
2020-12 |
CT#90-e |
CP-203039 |
0305 |
A |
Retrieval of SUPI from Authentication Data |
17.1.0 |
|
|
2020-12 |
CT#90-e |
CP-203048 |
0307 |
A |
Retrieve Context Data |
17.1.0 |
|
|
2020-12 |
CT#90-e |
CP-203042 |
0309 |
1 |
A |
5G VN Groups |
17.1.0 |
|
2020-12 |
CT#90-e |
CP-203064 |
0310 |
F |
Default Notifications |
17.1.0 |
|
|
2020-12 |
CT#90-e |
CP-203039 |
0312 |
1 |
A |
Pattern alignment for ueId in resource URIs |
17.1.0 |
|
2020-12 |
CT#90-e |
CP-203035 |
0314 |
A |
Storage of YAML files in 3GPP Forge |
17.1.0 |
|
|
2020-12 |
CT#90-e |
CP-203048 |
0316 |
A |
Subs-To-Notify Tag Description |
17.1.0 |
|
|
2020-12 |
CT#90-e |
CP-203048 |
0318 |
A |
Snssai query parameter |
17.1.0 |
|
|
2020-12 |
CT#90-e |
CP-203055 |
0320 |
F |
External doc update |
17.1.0 |
|
|
2021-03 |
CT#91-e |
CP-210021 |
0321 |
1 |
F |
ContextInfo in AMF SubscriptionInfo |
17.2.0 |
|
2021-03 |
CT#91-e |
CP-210021 |
0322 |
1 |
F |
EE Profile Data |
17.2.0 |
|
2021-03 |
CT#91-e |
CP-210043 |
0324 |
A |
Missing requestBody required indication in PUT operations |
17.2.0 |
|
|
2021-03 |
CT#91-e |
CP-210021 |
0325 |
1 |
F |
HSS Group Id |
17.2.0 |
|
2021-03 |
CT#91-e |
CP-210034 |
0326 |
1 |
F |
Description field for map data types |
17.2.0 |
|
2021-03 |
CT#91-e |
CP-210048 |
0328 |
2 |
A |
Event Subscription Storage for SMF |
17.2.0 |
|
2021-03 |
CT#91-e |
CP-210021 |
0329 |
F |
Response 200 OK for SMSF registration |
17.2.0 |
|
|
2021-03 |
CT#91-e |
CP-210026 |
0330 |
1 |
B |
AKMA Subscription Data |
17.2.0 |
|
2021-03 |
CT#91-e |
CP-210029 |
0331 |
F |
29.505 Rel-17 External doc update |
17.2.0 |
|
|
2021-06 |
CT#92-e |
CP-211028 |
0339 |
F |
Resource Structure |
17.3.0 |
|
|
2021-06 |
CT#92-e |
CP-211028 |
0345 |
F |
Corrections on reference |
17.3.0 |
|
|
2021-06 |
CT#92-e |
CP-211028 |
0346 |
1 |
F |
Corrections on Cardinality |
17.3.0 |
|
2021-06 |
CT#92-e |
CP-211028 |
0338 |
1 |
F |
GroupIdentifiers |
17.3.0 |
|
2021-06 |
CT#92-e |
CP-211028 |
0340 |
1 |
F |
Response for MWD resource creation |
17.3.0 |
|
2021-06 |
CT#92-e |
CP-211028 |
0355 |
F |
Nested cardinality |
17.3.0 |
|
|
2021-06 |
CT#92-e |
CP-211028 |
0358 |
F |
Data Types Descriptions |
17.3.0 |
|
|
2021-06 |
CT#92-e |
CP-211039 |
0344 |
1 |
B |
Store ProSe Subscription Data |
17.3.0 |
|
2021-06 |
CT#92-e |
CP-211045 |
0360 |
F |
AmfSubscriptionInfo and SmfSubscriptionInfo creation providing 201 result code |
17.3.0 |
|
|
2021-06 |
CT#92-e |
CP-211050 |
0361 |
F |
29.505 Rel-17 External doc update |
17.3.0 |
|
|
2021-06 |
CT#92-e |
CP-211054 |
0341 |
3 |
B |
API Extension of PP service for Multiple AFs |
17.3.0 |
|
2021-06 |
CT#92-e |
CP-211064 |
0334 |
A |
Event subscription Storage for HSS |
17.3.0 |
|
|
2021-06 |
CT#92-e |
CP-211065 |
0343 |
A |
UPU and SOR negative ack |
17.3.0 |
|
|
2021-06 |
CT#92-e |
CP-211065 |
0357 |
1 |
A |
Monitored Resource URI |
17.3.0 |
|
2021-06 |
CT#92-e |
CP-211067 |
0337 |
A |
References |
17.3.0 |
|
|
2021-06 |
CT#92-e |
CP-211079 |
0354 |
A |
Subscribed PP profile data |
17.3.0 |
|
|
2021-06 |
CT#92-e |
CP-211079 |
0350 |
1 |
A |
Subscribed EE profile data for a group |
17.3.0 |
|
2021-06 |
CT#92-e |
CP-211079 |
0352 |
1 |
A |
Subscribed PP profile data for 5g-VN-group |
17.3.0 |
|
2021-09 |
CT#93-e |
CP-212026 |
0364 |
|
F |
ContextInfo storage |
17.4.0 |
|
2021-09 |
CT#93-e |
CP-212026 |
0368 |
|
B |
Authorization of Identifier Translation |
17.4.0 |
|
2021-09 |
CT#93-e |
CP-212026 |
0370 |
|
F |
MTC Provider and Application ID in NIDD Authorization Data Retrieval |
17.4.0 |
|
2021-09 |
CT#93-e |
CP-212026 |
0375 |
|
F |
ContextInfo in SmfSubscriptionInfo and HssSubscriptionInfo |
17.4.0 |
|
2021-09 |
CT#93-e |
CP-212026 |
0363 |
1 |
F |
Application Port ID |
17.4.0 |
|
2021-09 |
CT#93-e |
CP-212026 |
0367 |
1 |
B |
Retrieval of odbData as ProvisionedDataSet |
17.4.0 |
|
2021-09 |
CT#93-e |
CP-212026 |
0369 |
1 |
B |
Authorization of Group Identifier Translation |
17.4.0 |
|
2021-09 |
CT#93-e |
CP-212026 |
0371 |
1 |
F |
Allow changing NIDD Authorization data |
17.4.0 |
|
2021-09 |
CT#93-e |
CP-212026 |
0372 |
1 |
F |
NIDD Authorization data storage |
17.4.0 |
|
2021-09 |
CT#93-e |
CP-212026 |
0374 |
1 |
B |
Batch Fetching of Service Profiles |
17.4.0 |
|
2021-09 |
CT#93-e |
CP-212026 |
0377 |
1 |
F |
HssSubscriptionInfo creation providing 201 result code |
17.4.0 |
|
2021-09 |
CT#93-e |
CP-212026 |
0379 |
1 |
F |
Corrections on ProvisionedParamenterDataEntry |
17.4.0 |
|
2021-09 |
CT#93-e |
CP-212049 |
0380 |
1 |
B |
Get the PP data of mutiple Afs |
17.4.0 |
|
2021-09 |
CT#93-e |
CP-212049 |
0381 |
1 |
B |
Get the specific EE data |
17.4.0 |
|
2021-09 |
CT#93-e |
CP-212056 |
0373 |
|
F |
EE profile of the EPC Domain for a group |
17.4.0 |
|
2021-09 |
CT#93-e |
CP-212059 |
0384 |
|
F |
29.505 Rel-17 External doc update |
17.4.0 |
|
2021-09 |
CT#93-e |
CP-212063 |
0366 |
|
A |
SDM subscription Storage for HSS |
17.4.0 |
|
2021-09 |
CT#93-e |
CP-212064 |
0387 |
1 |
A |
SharedDataId Resource |
17.4.0 |
|
2021-12 |
CT#94-e |
CP-213085 |
0390 |
|
F |
Error responses to the modification of SubscriptionDataSubscription |
17.5.0 |
|
2021-12 |
CT#94-e |
CP-213085 |
0398 |
|
F |
Shared Session Management Subscription Data |
17.5.0 |
|
2021-12 |
CT#94-e |
CP-213085 |
0395 |
1 |
B |
Update of SMF Registration |
17.5.0 |
|
2021-12 |
CT#94-e |
CP-213085 |
0389 |
1 |
F |
Correction of the response to modification of SubscriptionDataSubscription |
17.5.0 |
|
2021-12 |
CT#94-e |
CP-213086 |
0397 |
1 |
B |
UE Subscription Data Sets Retrieve |
17.5.0 |
|
2021-12 |
CT#94-e |
CP-213086 |
0399 |
|
F |
Alignment of GET response data type |
17.5.0 |
|
2021-12 |
CT#94-e |
CP-213086 |
0405 |
|
B |
Missing operations on Operator Specific Data resource |
17.5.0 |
|
2021-12 |
CT#94-e |
CP-213087 |
0408 |
|
B |
Update Roaming Status in EPC |
17.5.0 |
|
2021-12 |
CT#94-e |
CP-213088 |
0403 |
1 |
A |
Naming Convention |
17.5.0 |
|
2021-12 |
CT#94-e |
CP-213093 |
0396 |
|
F |
ECS Address Configuration |
17.5.0 |
|
2021-12 |
CT#94-e |
CP-213093 |
0391 |
3 |
B |
Support for Service Specific Authorization |
17.5.0 |
|
2021-12 |
CT#94-e |
CP-213097 |
0388 |
1 |
B |
5MBS Subscription Data |
17.5.0 |
|
2021-12 |
CT#94-e |
CP-213106 |
0406 |
1 |
B |
SOR-CMCI suppport |
17.5.0 |
|
2021-12 |
CT#94-e |
CP-213107 |
0407 |
1 |
B |
Routing Indicator |
17.5.0 |
|
2021-12 |
CT#94-e |
CP-213121 |
0409 |
|
F |
29.505 Rel-17 External doc update |
17.5.0 |
|
2022-03 |
CT#95-e |
CP-220023 |
0414 |
|
F |
Operator-Specific Data |
17.6.0 |
|
2022-03 |
CT#95-e |
CP-220023 |
0415 |
|
F |
Style corrections and missing clauses |
17.6.0 |
|
2022-03 |
CT#95-e |
CP-220023 |
0417 |
1 |
F |
Update on missing roaming information |
17.6.0 |
|
2022-03 |
CT#95-e |
CP-220024 |
0413 |
1 |
B |
Group Subscription Storage |
17.6.0 |
|
2022-03 |
CT#95-e |
CP-220026 |
0419 |
|
A |
Missing path parameter |
17.6.0 |
|
2022-03 |
CT#95-e |
CP-220026 |
0423 |
1 |
A |
Chapter and OperationId Updates |
17.6.0 |
|
2022-03 |
CT#95-e |
CP-220026 |
0424 |
1 |
A |
One SDM Subscription |
17.6.0 |
|
2022-03 |
CT#95-e |
CP-220031 |
0421 |
|
F |
serviceType naming convention |
17.6.0 |
|
2022-03 |
CT#95-e |
CP-220035 |
0425 |
|
B |
5MBS Subscription Data Storage |
17.6.0 |
|
2022-03 |
CT#95-e |
CP-220047 |
0400 |
2 |
F |
UDM retrieving SNPN info |
17.6.0 |
|
2022-03 |
CT#95-e |
CP-220047 |
0426 |
1 |
B |
EAP-TTLS support in SNPN (TS 29.505) |
17.6.0 |
|
2022-03 |
CT#95-e |
CP-220049 |
0416 |
1 |
B |
User Consent subscription |
17.6.0 |
|
2022-03 |
CT#95-e |
CP-220066 |
0428 |
|
F |
29.505 Rel-17 External doc update |
17.6.0 |
|
2022-06 |
CT#96-e |
CP-221025 |
0431 |
|
F |
resetId assignment to OperatorSpecificDataContainer in UDR consumer (PCF) |
17.7.0 |
|
2022-06 |
CT#96-e |
CP-221027 |
0430 |
|
F |
Support for arrays in Operator Specific Data |
17.7.0 |
|
2022-06 |
CT#96-e |
CP-221029 |
0435 |
1 |
F |
RoamingInfo Correction |
17.7.0 |
|
2022-06 |
CT#96-e |
CP-221029 |
0434 |
1 |
F |
Subscribable Resources and Notifiations to Store and Collection resources |
17.7.0 |
|
2022-06 |
CT#96-e |
CP-221029 |
0433 |
1 |
F |
EE-Subscription retrieval optimization |
17.7.0 |
|
2022-06 |
CT#96-e |
CP-221051 |
0436 |
|
F |
29.505 Rel-17 External doc update |
17.7.0 |
|
2022-09 |
CT#97-e |
CP-222026 |
0437 |
F |
CR implementation error |
17.8.0 |
|
|
2022-09 |
CT#97-e |
CP-222026 |
0438 |
F |
Allow empty array in 200 OK |
17.8.0 |
|
|
2022-09 |
CT#97-e |
CP-222026 |
0441 |
F |
ValidityTime in AuthorizationData |
17.8.0 |
|
|
2022-09 |
CT#97-e |
CP-222057 |
0445 |
F |
PEI Information |
17.8.0 |
|
|
2022-09 |
CT#97-e |
CP-222057 |
0446 |
1 |
F |
Roaming Information Correction |
17.8.0 |
|
2022-09 |
CT#97-e |
CP-222058 |
0447 |
F |
29.505 Rel-17 External doc update |
17.8.0 |
|
|
2022-09 |
CT#97-e |
CP-222059 |
0443 |
A |
Corrections on the Cardinality of map(5GVnGroupConfiguration) |
17.8.0 |
|
|
2022-12 |
CT#98-e |
CP-223027 |
0449 |
F |
URI parameter alignment with yaml definitions |
18.0.0 |
|
|
2022-12 |
CT#98-e |
CP-223027 |
0453 |
F |
Correction on Internal Group Id creation |
18.0.0 |
|
|
2022-12 |
CT#98-e |
CP-223029 |
0450 |
1 |
F |
Cardinality of SmfRegList alignment with yaml |
18.0.0 |
|
2022-12 |
CT#98-e |
CP-223029 |
0451 |
1 |
B |
Immediate Report |
18.0.0 |
|
2022-12 |
CT#98-e |
CP-223033 |
0454 |
F |
29.505 Rel-18 External doc update |
18.0.0 |
|