NUDM SDM

This service is used by Consumer NFs (AMF, SMF, and SMSF) to retrieve the UEs individual subscription data relevant to the consumer NF from the UDM.

OpenAPI

OpenAPI Version: 3.0.0

info

Version: '1.0.0'

Title: 'Nudm_SDM'

Description: 'Nudm Subscriber Data Management Service'

externalDocs

Description: 3GPP TS 29.503 Unified Data Management Services, version 15.2.1

URL: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.503/'

security

- oAuth2ClientCredentials:

- nudm-sdm

- {}

servers

URL: '{apiRoot}/nudm-sdm/v1'

Variables:

API Root:

Default: https://example.com

Description: apiRoot as defined in subclause subclause 4.4 of 3GPP TS 29.501.

paths

supi

get:

Summary: retrieve multiple data sets

Operation ID: Get

Tags:

- Retrieval of multiple data sets

Parameters:

- name: supi

In: path

Description: Identifier of the UE

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'

- name: dataset-names

In: query

style: form

explode: false

Description: List of dataset names

Required/Optional: true

Schema:

Reference: '#/components/schemas/DatasetNames'

- name: plmn-id

In: query

Description: serving PLMN ID

Content:

Application/JSON:

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'

- name: supported-features

In: query

Description: Supported Features

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

- name: If-None-Match

In: header

Description: Validator for conditional requests, as described in RFC 7232, 3.2

Schema:

Type: string

- name: If-Modified-Since

In: header

Description: Validator for conditional requests, as described in RFC 7232, 3.3

Schema:

Type: string

Responses:

'200' Expected response to a valid request

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/SubscriptionDataSets'

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': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default:

Description: Unexpected error

supi nssai

get:

Summary: retrieve a UE's subscribed NSSAI

Operation ID: Get

Tags:

- Slice Selection Subscription Data Retrieval

Parameters:

- name: supi

In: path

Description: Identifier of the UE

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'

- name: supported-features

In: query

Description: Supported Features

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

- name: plmn-id

In: query

Description: serving PLMN ID

Content:

Application/JSON:

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'

- 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' Expected response to a valid request

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/Nssai'

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': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default:

Description: Unexpected error

supi am data

get:

Summary: retrieve a UE's Access and Mobility Subscription Data

Operation ID: Get

Tags:

- Access and Mobility Subscription Data Retrieval

Parameters:

- name: supi

In: path

Description: Identifier of the UE

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'

- name: supported-features

In: query

Description: Supported Features

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

- name: plmn-id

In: query

Description: serving PLMN ID

Content:

Application/JSON:

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'

- 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' Expected response to a valid request

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/AccessAndMobilitySubscriptionData'

Headers:

Cache-Control:

Description: Cache-Control containing max-age, as described in RFC 7234, 5.2

Schema:

Type: string

ETag:

Description: Entity Tag, containing a strong validator, as described in RFC 7232, 2.3

Schema:

Type: string

Last-Modified:

Description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2

Schema:

Type: string

'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default:

Description: Unexpected error

supi smf select data

get:

Summary: retrieve a UE's SMF Selection Subscription Data

Operation ID: Get

Tags:

- SMF Selection Subscription Data Retrieval

Parameters:

- name: supi

In: path

Description: Identifier of the UE

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'

- name: supported-features

In: query

Description: Supported Features

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

- name: plmn-id

In: query

Description: serving PLMN ID

Content:

Application/JSON:

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'

- 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' Expected response to a valid request

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/SmfSelectionSubscriptionData'

Headers:

Cache-Control:

Description: Cache-Control containing max-age, as described in RFC 7234, 5.2

Schema:

Type: string

ETag:

Description: Entity Tag, containing a strong validator, as described in RFC 7232, 2.3

Schema:

Type: string

Last-Modified:

Description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2

Schema:

Type: string

'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default:

Description: Unexpected error

supi ue context in smf data

get:

Summary: retrieve a UE's UE Context In SMF Data

Operation ID: Get

Tags:

- UE Context In SMF Data Retrieval

Parameters:

- name: supi

In: path

Description: Identifier of the UE

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'

- name: supported-features

In: query

Description: Supported Features

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

Responses:

'200' Expected response to a valid request

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/UeContextInSmfData'

'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default:

Description: Unexpected error

supi ue context in smsf data

get:

Summary: retrieve a UE's UE Context In SMSF Data

Operation ID: Get

Tags:

- UE Context In SMSF Data Retrieval

Parameters:

- name: supi

In: path

Description: Identifier of the UE

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'

- name: supported-features

In: query

Description: Supported Features

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

Responses:

'200' Expected response to a valid request

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/UeContextInSmsfData'

'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default:

Description: Unexpected error

supi trace data

get:

Summary: retrieve a UE's Trace Configuration Data

Operation ID: Get

Tags:

- Trace Configuration Data Retrieval

Parameters:

- name: supi

In: path

Description: Identifier of the UE

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'

- name: supported-features

In: query

Description: Supported Features

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

- name: plmn-id

In: query

Description: serving PLMN ID

Content:

Application/JSON:

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'

- 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' Expected response to a valid request

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/TraceDataResponse'

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': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default:

Description: Unexpected error

supi sm data

get:

Summary: retrieve a UE's Session Management Subscription Data

Operation ID: Get

Tags:

- Session Management Subscription Data Retrieval

Parameters:

- name: supi

In: path

Description: Identifier of the UE

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'

- name: supported-features

In: query

Description: Supported Features

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

- name: single-nssai

In: query

Content:

Application/JSON:

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Snssai'

- name: dnn

In: query

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Dnn'

- name: plmn-id

In: query

Content:

Application/JSON:

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'

- 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' Expected response to a valid request

Content:

Application/JSON:

Schema:

Type: array

items:

Reference: '#/components/schemas/SessionManagementSubscriptionData'

minItems: 1

Headers:

Cache-Control:

Description: Cache-Control containing max-age, as described in RFC 7234, 5.2

Schema:

Type: string

ETag:

Description: Entity Tag, containing a strong validator, as described in RFC 7232, 2.3

Schema:

Type: string

Last-Modified:

Description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2

Schema:

Type: string

'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default:

Description: Unexpected error

supi sms data

get:

Summary: retrieve a UE's SMS Subscription Data

Operation ID: Get

Tags:

- SMS Subscription Data Retrieval

Parameters:

- name: supi

In: path

Description: Identifier of the UE

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'

- name: supported-features

In: query

Description: Supported Features

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

- name: plmn-id

In: query

Content:

Application/JSON:

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'

- 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' Expected response to a valid request

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/SmsSubscriptionData'

Headers:

Cache-Control:

Description: Cache-Control containing max-age, as described in RFC 7234, 5.2

Schema:

Type: string

ETag:

Description: Entity Tag, containing a strong validator, as described in RFC 7232, 2.3

Schema:

Type: string

Last-Modified:

Description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2

Schema:

Type: string

'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default:

Description: Unexpected error

supi sms mng data

get:

Summary: retrieve a UE's SMS Management Subscription Data

Operation ID: Get

Tags:

- SMS Management Subscription Data Retrieval

Parameters:

- name: supi

In: path

Description: Identifier of the UE

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'

- name: supported-features

In: query

Description: Supported Features

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

- name: plmn-id

In: query

Content:

Application/JSON:

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'

- 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' Expected response to a valid request

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/SmsManagementSubscriptionData'

Headers:

Cache-Control:

Description: Cache-Control containing max-age, as described in RFC 7234, 5.2

Schema:

Type: string

ETag:

Description: Entity Tag, containing a strong validator, as described in RFC 7232, 2.3

Schema:

Type: string

Last-Modified:

Description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2

Schema:

Type: string

'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default:

Description: Unexpected error

supi sdm subscriptions

Method: Post

Summary: subscribe to notifications

Operation ID: Subscribe

Tags:

- Subscription Creation

Parameters:

- name: supi

In: path

Description: SUPI of the user

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'

Request Body:

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/SdmSubscription'

Required/Optional: true

Responses:

'201' Expected response to a valid request

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/SdmSubscription'

Headers:

Location:

Description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-sdm/v1/{supi}/sdm-subscriptions/{subscriptionId}'

Required/Optional: true

Schema:

Type: string

'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'501': Reference 'TS29571_CommonData.yaml#/components/responses/501'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default:

Description: Unexpected error

Callbacks:

datachangeNotification:

'{request.body#/callbackReference}':

Method: Post

Request Body:

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/ModificationNotification'

Responses:

'204' Successful Notification response

'307' Temporary Redirect

Content:

application/problem+json:

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'

'308' Permanent Redirect

Content:

application/problem+json:

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'

'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default:

Description: Unexpected error

supi sdm subscriptions subscriptionId

delete:

Summary: unsubscribe from notifications

Operation ID: Unsubscribe

Tags:

- Subscription Deletion

Parameters:

- name: supi

In: path

Description: SUPI of the user

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'

- name: subscriptionId

In: path

Description: Id of the SDM Subscription

Required/Optional: true

Schema:

Type: string

Responses:

'204' Successful response

'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default:

Description: Unexpected error

gpsi id translation result

get:

Summary: retrieve a UE's SUPI

Operation ID: Get

Tags:

- GPSI to SUPI Translation

Parameters:

- name: gpsi

In: path

Description: Identifier of the UE

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'

- name: supported-features

In: query

Description: Supported Features

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

- name: If-None-Match

In: header

Description: Validator for conditional requests, as described in RFC 7232, 3.2

Schema:

Type: string

- name: If-Modified-Since

In: header

Description: Validator for conditional requests, as described in RFC 7232, 3.3

Schema:

Type: string

Responses:

'200' Expected response to a valid request

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/IdTranslationResult'

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': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default:

Description: Unexpected error

supi am data sor ack

put:

Summary: Nudm_Sdm Info service operation

Operation ID: Info

Tags:

- Providing acknowledgement of Steering of Roaming

Parameters:

- name: supi

In: path

Description: Identifier of the UE

Required/Optional: true

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'

Request Body:

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/AcknowledgeInfo'

Responses:

'204' Successful acknowledgement

'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default:

Description: Unexpected error

/shared-data

get:

Summary: retrieve shared data

Operation ID: GetSharedData

Tags:

- Retrieval of shared data

Parameters:

- name: shared-data-ids

In: query

Description: List of shared data ids

Required/Optional: true

style: form

explode: false

Schema:

Reference: '#/components/schemas/SharedDataIds'

- name: supportedFeatures

In: query

Description: Supported Features

Schema:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

- name: If-None-Match

In: header

Description: Validator for conditional requests, as described in RFC 7232, 3.2

Schema:

Type: string

- name: If-Modified-Since

In: header

Description: Validator for conditional requests, as described in RFC 7232, 3.3

Schema:

Type: string

Responses:

'200' Expected response to a valid request

Content:

Application/JSON:

Schema:

Type: array

items:

Reference: '#/components/schemas/SharedData'

minItems: 1

Headers:

Cache-Control:

Description: Cache-Control containing max-age, as described in RFC 7234, 5.2

Schema:

Type: string

ETag:

Description: Entity Tag, containing a strong validator, as described in RFC 7232, 2.3

Schema:

Type: string

Last-Modified:

Description: Timestamp for last modification of the resource, as described in RFC 7232, 2.2

Schema:

Type: string

'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default:

Description: Unexpected error

/shared-data-subscriptions

Method: Post

Summary: subscribe to notifications for shared data

Operation ID: Subscribe to shared data

Tags:

- Subscription Creation for shared data

Request Body:

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/SdmSubscription'

Required/Optional: true

Responses:

'201' Expected response to a valid request

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/SdmSubscription'

Headers:

Location:

Description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-sdm/v1/shared-data-subscriptions/{subscriptionId}'

Required/Optional: true

Schema:

Type: string

'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'

default:

Description: Unexpected error

Callbacks:

datachangeNotification:

'{request.body#/callbackReference}':

Method: Post

Request Body:

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/ModificationNotification'

Responses:

'204' Successful Notification response

'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default:

Description: Unexpected error

/shared-data-subscriptions/{subscriptionId}

delete:

Summary: unsubscribe from notifications for shared data

Operation ID: Unsubscribe for shared data

Tags:

- Subscription Deletion for shared data

Parameters:

- name: subscriptionId

In: path

Description: Id of the Shared data Subscription

Required/Optional: true

Schema:

Type: string

Responses:

'204' Successful response

'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default:

Description: Unexpected error

components

securitySchemes

oAuth2ClientCredentials

Type: oauth2

Flows:

clientCredentials:

tokenUrl: '{nrfApiRoot}/oauth2/token'

scopes:

nudm-sdm: Access to the nudm-sdm API

schemas

# COMPLEX TYPES:

DatasetNames

Type: array

Items:

Reference: '#/components/schemas/DataSetName'

minItems: 2

uniqueItems: true

SubscriptionDataSets

Type: object

Properties:

amData:

Reference: '#/components/schemas/AccessAndMobilitySubscriptionData'

smfSelData:

Reference: '#/components/schemas/SmfSelectionSubscriptionData'

uecSmfData:

Reference: '#/components/schemas/UeContextInSmfData'

uecSmsfData:

Reference: '#/components/schemas/UeContextInSmsfData'

smsSubsData:

Reference: '#/components/schemas/SmsSubscriptionData'

smData:

Type: array

Items:

Reference: '#/components/schemas/SessionManagementSubscriptionData'

minItems: 1

traceData:

Reference: 'TS29571_CommonData.yaml#/components/schemas/TraceData'

smsMngData:

Reference: '#/components/schemas/SmsManagementSubscriptionData'

UeContextInSmsfData

Type: object

Properties:

smsfInfo3GppAccess:

Reference: '#/components/schemas/SmsfInfo'

smsfInfoNon3GppAccess:

Reference: '#/components/schemas/SmsfInfo'

SmsfInfo

Type: object

Required:

- smsfInstanceId

- plmnId

Properties:

smsfInstanceId:

Reference: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'

plmnId:

Reference: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'

AccessAndMobilitySubscriptionData

Type: object

Properties:

supportedFeatures:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

gpsis:

Type: array

Items:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'

internalGroupIds:

Type: array

Items:

Reference: 'TS29571_CommonData.yaml#/components/schemas/GroupId'

minItems: 1

subscribedUeAmbr:

Reference: 'TS29571_CommonData.yaml#/components/schemas/AmbrRm'

nssai:

Reference: '#/components/schemas/Nssai'

ratRestrictions:

Type: array

Items:

Reference: 'TS29571_CommonData.yaml#/components/schemas/RatType'

forbiddenAreas:

Type: array

Items:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Area'

serviceAreaRestriction:

Reference: 'TS29571_CommonData.yaml#/components/schemas/ServiceAreaRestriction'

coreNetworkTypeRestrictions:

Type: array

Items:

Reference: 'TS29571_CommonData.yaml#/components/schemas/CoreNetworkType'

rfspIndex:

Reference: 'TS29571_CommonData.yaml#/components/schemas/RfspIndexRm'

subsRegTimer:

Reference: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm'

ueUsageType:

Reference: '#/components/schemas/UeUsageType'

mpsPriority:

Reference: '#/components/schemas/MpsPriorityIndicator'

mcsPriority:

Reference: '#/components/schemas/McsPriorityIndicator'

activeTime:

Reference: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm'

dlPacketCount:

Reference: '#/components/schemas/DlPacketCount'

sorInfo:

Reference: '#/components/schemas/SorInfo'

micoAllowed:

Reference: '#/components/schemas/MicoAllowed'

sharedAmDataIds:

Type: array

Items:

Reference: '#/components/schemas/SharedDataId'

minItems: 1

odbPacketServices:

Reference: 'TS29571_CommonData.yaml#/components/schemas/OdbPacketServices'

SmfSelectionSubscriptionData

Type: object

Properties:

supportedFeatures:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

subscribedSnssaiInfos:

Type: object

additionalProperties:

Reference: '#/components/schemas/SnssaiInfo'

sharedSnssaiInfosId:

Reference: '#/components/schemas/SharedDataId'

SnssaiInfo

Type: object

Required:

- dnnInfos

Properties:

dnnInfos:

Type: array

Items:

Reference: '#/components/schemas/DnnInfo'

minItems: 1

DnnInfo

Type: object

Required:

- dnn

Properties:

dnn:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Dnn'

defaultDnnIndicator:

Reference: '#/components/schemas/DnnIndicator'

lboRoamingAllowed:

Reference: '#/components/schemas/LboRoamingAllowed'

iwkEpsInd:

Reference: '#/components/schemas/IwkEpsInd'

ladnIndicator:

Reference: '#/components/schemas/LadnIndicator'

Nssai

Type: object

Required:

- defaultSingleNssais

Properties:

supportedFeatures:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

defaultSingleNssais:

Type: array

Items:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Snssai'

minItems: 1

singleNssais:

Type: array

Items:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Snssai'

minItems: 1

nullable: true

UeContextInSmfData

Type: object

Properties:

pduSessions:

Description: A map (list of key-value pairs where PduSessionId serves as key) of PduSessions

Type: object

additionalProperties:

Reference: '#/components/schemas/PduSession'

pgwInfo:

Type: array

Items:

Reference: '#/components/schemas/PgwInfo'

minItems: 1

PduSession

Type: object

Required:

- dnn

- smfInstanceId

- plmnId

Properties:

dnn:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Dnn'

smfInstanceId:

Reference: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'

plmnId:

Reference: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'

PgwInfo

Type: object

Required:

- dnn

- pgwFqdn

Properties:

dnn:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Dnn'

pgwFqdn:

Type: string

plmnId:

Reference: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'

SessionManagementSubscriptionData

Type: object

Required:

- singleNssai

Properties:

singleNssai:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Snssai'

dnnConfigurations:

Description: A map (list of key-value pairs where Dnn serves as key) of DnnConfigurations

Type: object

additionalProperties:

Reference: '#/components/schemas/DnnConfiguration'

internalGroupIds:

Type: array

Items:

Reference: 'TS29571_CommonData.yaml#/components/schemas/GroupId'

minItems: 1

sharedDnnConfigurationsIds:

Reference: '#/components/schemas/SharedDataId'

DnnConfiguration

Type: object

Required:

- pduSessionTypes

- sscModes

Properties:

pduSessionTypes:

Reference: '#/components/schemas/PduSessionTypes'

sscModes:

Reference: '#/components/schemas/SscModes'

iwkEpsInd:

Reference: '#/components/schemas/IwkEpsInd'

ladnIndicator:

Reference: '#/components/schemas/LadnIndicator'

5gQosProfile:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SubscribedDefaultQos'

sessionAmbr:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Ambr'

3gppChargingCharacteristics:

Reference: '#/components/schemas/3GppChargingCharacteristics'

staticIpAddress:

Type: array

Items:

Reference: '#/components/schemas/IpAddress'

minItems: 1

maxItems: 2

upSecurity:

Reference: 'TS29571_CommonData.yaml#/components/schemas/UpSecurity'

IpAddress

Type: object

oneOf:

- required:

- ipv4Address

- required:

- ipv6Address

- required:

- ipv6Prefix

Properties:

ipv4Addr:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'

ipv6Addr:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'

ipv6Prefix:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'

PduSessionTypes

Type: object

Required:

- defaultSessionType

Properties:

defaultSessionType:

Reference: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType'

allowedSessionTypes:

Type: array

Items:

Reference: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType'

minItems: 1

SscModes

Type: object

Required:

- defaultSscMode

Properties:

defaultSscMode:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SscMode'

allowedSscModes:

Type: array

Items:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SscMode'

minItems: 1

maxItems: 2

SmsSubscriptionData

Type: object

Properties:

smsSubscribed:

Reference: '#/components/schemas/SmsSubscribed'

sharedSmsSubsDataId:

Reference: '#/components/schemas/SharedDataIds'

SmsManagementSubscriptionData

Type: object

Properties:

supportedFeatures:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

mtSmsSubscribed:

Type: boolean

mtSmsBarringAll:

Type: boolean

mtSmsBarringRoaming:

Type: boolean

moSmsSubscribed:

Type: boolean

moSmsBarringAll:

Type: boolean

moSmsBarringRoaming:

Type: boolean

sharedSmsMngDataIds:

Type: array

Items:

Reference: '#/components/schemas/SharedDataId'

minItems: 1

SdmSubscription

Type: object

Required:

- nfInstanceId

- callbackUri

- monitoredResourceUri

Properties:

nfInstanceId:

Reference: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'

implicitUnsubscribe:

Type: boolean

expires:

Reference: 'TS29571_CommonData.yaml#/components/schemas/DateTime'

callbackReference:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'

amfServiceName:

Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName'

monitoredResourceUris:

Type: array

Items:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'

minItems: 1

singleNssai:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Snssai'

dnn:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Dnn'

ModificationNotification

Type: object

Required:

- notifyItems

Properties:

notifyItems:

Type: array

Items:

Reference: 'TS29571_CommonData.yaml#/components/schemas/NotifyItem'

minItems: 1

IdTranslationResult

Type: object

Required:

- supi

Properties:

supportedFeatures:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

supi:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'

gpsi:

Reference: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'

AcknowledgeInfo

Type: object

Properties:

sorMacIue:

Reference: 'TS29509_Nausf_SoRProtection.yaml#/components/schemas/SorMac'

securedPacket:

Reference: '#/components/schemas/SecuredPacket'

SorInfo

Type: object

Properties:

steeringContainer:

Reference: '#/components/schemas/SteeringContainer'

ackInd:

Reference: 'TS29509_Nausf_SoRProtection.yaml#/components/schemas/AckInd'

sorMacIausf:

Reference: 'TS29509_Nausf_SoRProtection.yaml#/components/schemas/SorMac'

countersor:

Reference: 'TS29509_Nausf_SoRProtection.yaml#/components/schemas/CounterSor'

Required:

- ackInd

- sorMacIausf

- countersor

SharedDataIds

Type: array

Items:

Reference: '#/components/schemas/SharedDataId'

SharedData

Type: object

Required:

- sharedDataId

Properties:

sharedDataId:

Reference: '#/components/schemas/SharedDataId'

sharedAmData:

Reference: '#/components/schemas/AccessAndMobilitySubscriptionData'

sharedSmsSubsData:

Reference: '#/components/schemas/SmsSubscriptionData'

sharedSmsMngSubsData:

Reference: '#/components/schemas/SmsManagementSubscriptionData'

sharedDnnConfigurations:

Type: object

additionalProperties:

Reference: '#/components/schemas/DnnConfiguration'

sharedTraceData:

Reference: 'TS29571_CommonData.yaml#/components/schemas/TraceData'

sharedSnssaiInfos:

Type: object

additionalProperties:

Reference: '#/components/schemas/SnssaiInfo'

sharedAuthenticationSubscription:

Reference: 'TS29505_Subscription_Data.yaml#/components/schemas/SharedAuthenticationSubscription'

TraceDataResponse

Type: object

Properties:

traceData:

Reference: 'TS29571_CommonData.yaml#/components/schemas/TraceData'

sharedTraceDataId:

Reference: '#/components/schemas/SharedDataId'

SteeringContainer

oneOf:

- type: array

Items:

Reference: 'TS29509_Nausf_SoRProtection.yaml#/components/schemas/SteeringInfo'

minItems: 1

- $ref: '#/components/schemas/SecuredPacket'

# SIMPLE TYPES:

UeUsageType

Type: integer

MpsPriorityIndicator

Type: boolean

McsPriorityIndicator

Type: boolean

DnnIndicator

Type: boolean

LboRoamingAllowed

Type: boolean

LadnIndicator

Type: boolean

SmsSubscribed

Type: boolean

3GppChargingCharacteristics

Type: string

DlPacketCount

Type: integer

Minimum: -1

MicoAllowed

Type: boolean

SharedDataId

Type: string

Pattern: '^[0-9]{5,6}-.+$'

IwkEpsInd

Type: boolean

SecuredPacket

Type: string

format: base64

# ENUMS:

DataSetName

anyOf:

- type: string

enum:

- AM

- SMF_SEL

- UEC_SMF

- UEC_SMSF

- SMS_SUB

- SM

- TRACE

- SMS_MNG

- type: string