ExposureData

OpenAPI

OpenAPI Version: 3.0.0

info

Version: '-'

Title: 'Unified Data Repository Service API file for structured data for exposure'

Description: 'The API version is defined in 3GPP TS 29.504'

externalDocs

Description: 3GPP TS 29.519 V15.2.0; 5G System; Usage of the Unified Data Repository Service for Policy Data, Application Data and Structured Data for Exposure.

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

paths

/exposure-data/{ueId}/access-and-mobility-data

put:

Summary: Creates and updates the access and mobility exposure data for a UE

Operation ID: CreateAccessAndMobilityData

Tags:

- AccessAndMobilityData

Parameters:

- name: ueId

In: path

Description: UE id

Required/Optional: true

Schema:

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

Request Body:

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/AccessAndMobilityData'

Responses:

'201' Upon success, a response body is returned containing a representation of the access and mobility data

Headers:

Location:

Description: 'Contains the URI of the newly created resource'

Required/Optional: true

Schema:

Type: string

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

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

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

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

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

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

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

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

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

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

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

get:

Summary: Retrieves the access and mobility exposure data for a UE

Operation ID: QueryAccessAndMobilityData

Tags:

- AccessAndMobilityData

Parameters:

- name: ueId

In: path

Description: UE id

Required/Optional: true

Schema:

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

- name: supp-feat

In: query

Description: Supported Features

Schema:

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

Responses:

'200' The response body contains the access and mobility data

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/AccessAndMobilityData'

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

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

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

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

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

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

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

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

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

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

delete:

Summary: Deletes the access and mobility exposure data for a UE

Operation ID: DeleteAccessAndMobilityData

Tags:

- AccessAndMobilityData

Parameters:

- name: ueId

In: path

Description: UE id

Required/Optional: true

Schema:

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

Responses:

'204' Upon success, an empty response body shall be returned

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

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

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

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

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

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

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

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

/exposure-data/{ueId}/session-management-data/{pduSessionId}

put:

Summary: Creates and updates the session management data for a UE and for an individual PDU session

Operation ID: CreateSessionManagementData

Tags:

- PduSessionManagementData

Parameters:

- name: ueId

In: path

Description: UE id

Required/Optional: true

Schema:

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

- name: pduSessionId

In: path

Description: PDU session id

Required/Optional: true

Schema:

Type: integer

Request Body:

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/PduSessionManagementData'

Responses:

'201' Upon success, a response body is returned containing a representation of the session management data

Headers:

Location:

Description: 'Contains the URI of the newly created resource'

Required/Optional: true

Schema:

Type: string

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

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

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

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

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

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

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

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

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

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

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

get:

Summary: Retrieves the session management data for a UE and for an individual PDU session

Operation ID: QuerySessionManagementData

Tags:

- PduSessionManagementData

Parameters:

- name: ueId

In: path

Description: UE id

Required/Optional: true

Schema:

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

- name: pduSessionId

In: path

Description: PDU session id

Required/Optional: true

Schema:

Type: integer

- name: ipv4-addr

In: query

Description: IPv4 Address of the UE

Schema:

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

- name: ipv6-prefix

In: query

Description: IPv6 Address Prefix of the UE

Schema:

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

- name: dnn

In: query

Description: DNN of the UE

Schema:

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

- name: fields

In: query

Description: attributes to be retrieved

Required/Optional: false

Schema:

Type: array

items:

Type: string

- name: supp-feat

In: query

Description: Supported Features

Schema:

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

Responses:

'200' The response body contains the session management data

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/PduSessionManagementData'

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

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

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

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

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

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

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

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

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

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

delete:

Summary: Deletes the session management data for a UE and for an individual PDU session

Operation ID: DeleteSessionManagementData

Tags:

- PduSessionManagementData

Parameters:

- name: ueId

In: path

Description: UE id

Required/Optional: true

Schema:

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

- name: pduSessionId

In: path

Description: PDU session id

Required/Optional: true

Schema:

Type: integer

Responses:

'204' Upon success, an empty response body shall be returned

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

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

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

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

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

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

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

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

/exposure-data/subs-to-notify

Method: Post

Request Body:

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/ExposureDataSubscription'

Responses:

'201' Created

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/ExposureDataSubscription'

Headers:

Location:

Description: 'Contains the URI of the newly created resource'

Required/Optional: true

Schema:

Type: string

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

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

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

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

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

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

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

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

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

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

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

Callbacks:

exposureDataChangeNotification:

'{$request.body#/notificationUri}':

Method: Post

Request Body:

Required/Optional: true

Content:

Application/JSON:

Schema:

Type: array

items:

Reference: '#/components/schemas/ExposureDataChangeNotification'

minItems: 1

Responses:

'204' No Content, Notification was succesfull

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

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

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

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

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

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

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

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

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

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

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

/exposure-data/subs-to-notify/{subId}

put:

Summary: updates a subcription for notifications

Parameters:

- name: subId

In: path

Description: Subscription id

Required/Optional: true

Schema:

Type: string

Request Body:

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/ExposureDataSubscription'

Responses:

'200' Resource was succesfully modified.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/ExposureDataSubscription'

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

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

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

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

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

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

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

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

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

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

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

delete:

Summary: Deletes a subcription for notifications

Parameters:

- name: subId

In: path

Description: Subscription id

Required/Optional: true

Schema:

Type: string

Responses:

'204' Resource was succesfully deleted.

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

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

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

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

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

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

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

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

components

schemas

AccessAndMobilityData

Type: object

Properties:

location:

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

locationTs:

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

timeZone:

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

timeZoneTs:

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

accessType:

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

regStates:

Type: array

Items:

Reference: 'TS29518_Namf_EventExposure.yaml#/components/schemas/RmInfo'

regStatesTs:

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

connStates:

Type: array

Items:

Reference: 'TS29518_Namf_EventExposure.yaml#/components/schemas/CmInfo'

connStatesTs:

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

reachabilityStatus:

Reference: 'TS29518_Namf_EventExposure.yaml#/components/schemas/UeReachability'

reachabilityStatusTs:

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

smsOverNasStatus:

Reference: 'TS29518_Namf_Communication.yaml#/components/schemas/SmsSupport'

smsOverNasStatusTs:

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

roamingStatus:

Type: boolean

Description: True The serving PLMN of the UE is different from the HPLMN of the UE; False The serving PLMN of the UE is the HPLMN of the UE.

roamingStatusTs:

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

currentPlmn:

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

currentPlmnTs:

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

ratType:

Type: array

Items:

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

ratTypesTs:

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

PduSessionManagementData

Type: object

Properties:

pduSessionStatus:

Reference: '#/components/schemas/PduSessionStatus'

pduSessionStatusTs:

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

dnai:

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

dnaiTs:

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

n6TrafficRoutingInfo:

Type: array

Items:

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

n6TrafficRoutingInfoTs:

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

ipv4Addr:

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

ipv6Prefix:

Type: array

Items:

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

minItems: 1

Description: UE IPv6 prefix.

ipAddrTs:

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

dnn:

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

ExposureDataSubscription

Type: object

Properties:

notificationUri:

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

monitoredResourceUris:

Type: array

Items:

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

minItems: 1

supportedFeatures:

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

Required:

- notificationUri

- monitoredResourceUris

ExposureDataChangeNotification

Type: object

Properties:

ueId:

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

accessAndMobilityData:

Reference: '#/components/schemas/AccessAndMobilityData'

pduSessionManagementData:

Type: array

Items:

Reference: '#/components/schemas/PduSessionManagementData'

minItems: 1

PduSessionStatus

anyOf:

- type: string

This string provides forward-compatibility with future

extensions to the enumeration but is not used to encode

content defined in the present version of this API.

Possible values are

- "ACTIVE"

- "RELEASED"