Nudm_EE

Nudm Event Exposure Service.

OpenAPI

OpenAPI Version: 3.0.0

info

Version: '1.0.0'

Title: 'Nudm_EE'

Description: 'Nudm Event Exposure 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-ee

- {}

servers

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

Variables:

API Root:

Default: https://example.com

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

paths

ueIdentity and ee subscriptions

Method: Post

Summary: Subscribe

Operation ID: CreateEeSubscription

Tags:

- Create EE Subscription

Parameters:

- name: ueIdentity

In: path

Description: Represents the scope of the UE for which the subscription is applied. Contains the GPSI of the user or the external group ID or any UE.

Required/Optional: true

Schema:

Type: string

pattern: '^(msisdn-[0-9]{5,15}|.+|extid-[^@]+@[^@]+|extgroupid-[^@]+@[^@]+|anyUE)$'

Request Body:

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/EeSubscription'

Required/Optional: true

Responses:

'201' Expected response to a valid request

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/CreatedEeSubscription'

Headers:

Location:

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

Required/Optional: true

Schema:

Type: string

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

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

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

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

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

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

default:

Description: Unexpected error

Callbacks:

eventOccurrenceNotification:

'{request.body#/callbackReference}':

Method: Post

Request Body:

Required/Optional: true

Content:

Application/JSON:

Schema:

Type: array

items:

Reference: '#/components/schemas/MonitoringReport'

minItems: 1

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

ueIdentity, ee subscriptions and subscriptionId

delete:

Summary: Unsubscribe

Operation ID: DeleteEeSubscription

Tags:

- Delete EE Subscription

Parameters:

- name: ueIdentity

In: path

Description: Represents the scope of the UE for which the subscription is applied. Contains the GPSI of the user or the external group ID or any UE.

Required/Optional: true

Schema:

Type: string

pattern: '^(msisdn-[0-9]{5,15}|.+|extid-[^@]+@[^@]+|extgroupid-[^@]+@[^@]+|anyUE)$'

- name: subscriptionId

In: path

Description: Id of the EE Subscription

Required/Optional: true

Schema:

Type: string

Responses:

'204' Successful 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

components

securitySchemes

oAuth2ClientCredentials

Type: oauth2

Flows:

clientCredentials:

tokenUrl: '{nrfApiRoot}/oauth2/token'

scopes:

nudm-ee: Access to the nudm-ee API

schemas

# COMPLEX TYPES:

CreatedEeSubscription

Type: object

Required:

- eeSubscription

Properties:

eeSubscription:

Reference: '#/components/schemas/EeSubscription'

numberOfUes:

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

eventReports:

Type: array

Items:

Reference: '#/components/schemas/MonitoringReport'

minItems: 1

EeSubscription

Type: object

Required:

- callbackReference

- monitoringConfigurations

Properties:

callbackReference:

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

monitoringConfigurations:

Description: A map (list of key-value pairs where ReferenceId serves as key) of MonitoringConfigurations

Type: object

additionalProperties:

Reference: '#/components/schemas/MonitoringConfiguration'

minProperties: 1

reportingOptions:

Reference: '#/components/schemas/ReportingOptions'

supportedFeatures:

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

MonitoringConfiguration

Type: object

Required:

- eventType

Properties:

eventType:

Reference: '#/components/schemas/EventType'

immediateFlag:

Type: boolean

locationReportingConfiguration:

Reference: '#/components/schemas/LocationReportingConfiguration'

LocationReportingConfiguration

Type: object

Required:

- currentLocation

Properties:

currentLocation:

Type: boolean

oneTime:

Type: boolean

accuracy:

Reference: '#/components/schemas/LocationAccuracy'

ReportingOptions

Type: object

Properties:

maxNumOfReports:

Reference: '#/components/schemas/MaxNumOfReports'

expiry:

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

MonitoringReport

Type: object

Required:

- referencId

- eventType

- timeStamp

Properties:

referenceId:

Reference: '#/components/schemas/ReferenceId'

eventType:

Reference: '#/components/schemas/EventType'

report:

Reference: '#/components/schemas/Report'

gpsi:

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

timeStamp:

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

Report

oneOf:

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

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

ChangeOfSupiPeiAssociationReport

Type: object

Required:

- newPei

Properties:

newPei:

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

RoamingStatusReport

Type: object

Required:

- roaming

- newServingPlmn

Properties:

roaming:

Type:

boolean

newServingPlmn:

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

# SIMPLE TYPES:

ReferenceId

Type: integer

MaxNumOfReports

Type: integer

# ENUMS:

EventType

anyOf:

- type: string

enum:

- LOSS_OF_CONNECTIVITY

- UE_REACHABILITY_FOR_DATA

- UE_REACHABILITY_FOR_SMS

- LOCATION_REPORTING

- CHANGE_OF_SUPI_PEI_ASSOCIATION

- ROAMING_STATUS

- COMMUNICATION_FAILURE

- AVAILABILITY_AFTER_DNN_FAILURE

- type: string

LocationAccuracy

anyOf:

- type: string

enum:

- CELL_LEVEL

- TA_LEVEL

- type: string