A.3 Nnef_EASDeployment API
29.5913GPP5G SystemNetwork Exposure Function Southbound ServicesRelease 17Stage 3TS
openapi: 3.0.0
info:
title: Nnef_EASDeployment
version: 1.0.0
description: |
NEF EAS Deployment service.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.591 V17.6.0; 5G System; Network Exposure Function Southbound Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.591/
servers:
– url: ‘{apiRoot}/nnef-eas-deployment/v1’
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
security:
– {}
– oAuth2ClientCredentials:
– nnef-eas-deployment
paths:
/subscriptions:
post:
summary: subscribe to notifications
operationId: CreateIndividualSubcription
tags:
– Subscriptions (Collection)
requestBody:
required: true
content:
application/json:
schema:
$ref: ‘#/components/schemas/EasDeploySubData’
responses:
‘201’:
description: Success
content:
application/json:
schema:
$ref: ‘#/components/schemas/EasDeploySubData’
headers:
Location:
description: >
Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nnef-eas-deployment/<apiVersion>/subscriptions/{subscriptionId}.
required: true
schema:
type: string
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘411’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/411’
‘413’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/413’
‘415’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/415’
‘429’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
callbacks:
notifUri:
‘{$request.body#/notifUri}’:
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: ‘#/components/schemas/EasDeployInfoNotif’
responses:
‘204’:
description: No Content, Notification was succesfull
‘307’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/307’
‘308’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/308’
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘411’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/411’
‘413’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/413’
‘415’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/415’
‘429’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscriptions/{subscriptionId}:
get:
summary: retrieve subscription
operationId: GetIndividualSubcription
tags:
– IndividualSubscription (Document)
parameters:
– name: subscriptionId
in: path
description: Event Subscription ID
required: true
schema:
type: string
responses:
‘200’:
description: OK. Resource representation is returned
content:
application/json:
schema:
$ref: ‘#/components/schemas/EasDeploySubData’
‘307’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/307’
‘308’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/308’
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘406’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/406’
‘429’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
summary: unsubscribe from notifications
operationId: DeleteIndividualSubcription
tags:
– IndividualSubscription (Document)
parameters:
– name: subscriptionId
in: path
description: Event Subscription ID
required: true
schema:
type: string
responses:
‘204’:
description: No Content. Resource was succesfully deleted
‘307’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/307’
‘308’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/308’
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘429’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: ‘{nrfApiRoot}/oauth2/token’
scopes:
nnef-eas-deployment: Access to the Nnef_EASDeployment API
schemas:
EasDeploySubData:
description: Represents an Individual EAS Deployment Event Subscription resource.
type: object
properties:
appId:
type: string
dnnSnssaiInfos:
type: array
items:
$ref: ‘TS29522_AMInfluence.yaml#/components/schemas/DnnSnssaiInformation’
minItems: 1
description: Each of the element identifies a (DNN, S-NSSAI) combination.
eventId:
$ref: ‘#/components/schemas/EasEvent’
eventsNotifs:
type: array
items:
$ref: ‘#/components/schemas/EasDeployInfoData’
minItems: 1
description: >
Represents the EAS Deployment Information changes event(s) to be reported.
Shall only be present if the "immRep" attribute is included and sets to true,
and the current status of EAS Deployment Information is available.
immRep:
type: boolean
description: >
Indication of immediate reporting. Set to true: requires the immediate reporting of the
current status of EAS Deployment Information, if available. Set to false (default): EAS
Deployment Information event report occurs when the event is met.
interGroupId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/GroupId’
notifId:
type: string
notifUri:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uri’
required:
– eventId
– notifId
– notifUri
EasDeployInfoNotif:
description: >
Represents notifications on EAS Deployment Information changes event(s) that occurred for an
Individual EAS Deployment Event Subscription resource.
type: object
properties:
easDepNotifs:
type: array
items:
$ref: ‘#/components/schemas/EasDepNotification’
minItems: 1
notifId:
type: string
required:
– easDepNotifs
– notifId
EasDepNotification:
description: Represents the EAS Deployment Notifcation.
type: object
properties:
easDepInfo:
$ref: ‘#/components/schemas/EasDeployInfoData’
eventId:
$ref: ‘#/components/schemas/EasEvent’
required:
– easDepInfo
– eventId
EasDeployInfoData:
description: Represents the EAS Deployment Information to be reported.
type: object
properties:
appId:
type: string
dnaiInfos:
type: object
additionalProperties:
$ref: ‘TS29522_EASDeployment.yaml#/components/schemas/DnaiInformation’
minProperties: 1
description: >
list of DNS server identifier (consisting of IP address and port) and/or IP address(s)
of the EAS in the local DN for each DNAI. The key of map is the DNAI.
dnn:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Dnn’
fqdnPatternList:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/FqdnPatternMatchingRule’
minItems: 1
internalGroupId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/GroupId’
snssai:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Snssai’
required:
– fqdnPatternList
# Simple data types and Enumerations
EasEvent:
anyOf:
– type: string
enum:
– EAS_INFO_CHG
– type: string
description: >
Possible values are
– EAS_INFO_CHG: Indicates that the EAS Deployment Information is changed.
Annex B (informative):
Change history
|
Change history |
|||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2019-10 |
CT3#106 |
TS Skeleton |
0.0.0 |
||||
|
2019-10 |
CT3#106 |
C3-194392 |
Removed some subclauses and editorial changes |
0.1.0 |
|||
|
2019-10 |
CT3#106 |
Inclusion of C3-194271, C3-194396, C3-194397 and C3-194399. |
0.2.0 |
||||
|
2019-11 |
CT3#107 |
Inclusion of C3-195234, C3-195235, C3-195236 and C3-195274. |
0.3.0 |
||||
|
2020-02 |
CT3#108e |
Inclusion of C3-201284, C3-201288, C3-201367, C3-201368, C3-201370, C3-201407, C3-201409, C3-201413 and C3-201516. |
0.4.0 |
||||
|
2020-03 |
CT#87e |
CP-200187 |
TS sent to plenary for approval |
1.0.0 |
|||
|
2020-03 |
CT#87e |
CP-200187 |
TS approved by plenary |
16.0.0 |
|||
|
2020-06 |
CT#88e |
CP-201234 |
0001 |
1 |
F |
Correction on resource usage |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201234 |
0002 |
F |
Data type used during event subscription |
16.1.0 |
|
|
2020-06 |
CT#88e |
CP-201234 |
0007 |
1 |
F |
Correction to service operation description |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201244 |
0008 |
1 |
F |
Storage of YAML files in ETSI Forge |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201210 |
0009 |
1 |
F |
Removal of Ninef_EventExposure service |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201256 |
0011 |
1 |
F |
URI of the Nnef_EventExposure service |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201234 |
0012 |
F |
Event Reporting Information data usage |
16.1.0 |
|
|
2020-06 |
CT#88e |
CP-201234 |
0013 |
F |
Support of immediate reporting |
16.1.0 |
|
|
2020-06 |
CT#88e |
CP-201234 |
0014 |
F |
Supported features definition |
16.1.0 |
|
|
2020-06 |
CT#88e |
CP-201234 |
0015 |
F |
Correction on the ueCommInfos |
16.1.0 |
|
|
2020-06 |
CT#88e |
CP-201234 |
0016 |
F |
Applicabilities for UE communication |
16.1.0 |
|
|
2020-06 |
CT#88e |
CP-201234 |
0017 |
1 |
F |
Supported headers, Resource Data type and yaml mapping |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201255 |
0018 |
F |
Update of OpenAPI version and TS version in externalDocs field |
16.1.0 |
|
|
2020-09 |
CT#89e |
CP-202066 |
0019 |
1 |
F |
Defalt value for eventsRepInfo attribute |
16.2.0 |
|
2020-09 |
CT#89e |
CP-202066 |
0022 |
F |
Missed response code |
16.2.0 |
|
|
2020-09 |
CT#89e |
CP-202066 |
0023 |
F |
Applicabilities of appIds and locArea |
16.2.0 |
|
|
2020-09 |
CT#89e |
CP-202084 |
0024 |
F |
Update of OpenAPI version and TS version in externalDocs field |
16.2.0 |
|
|
2020-12 |
CT#90e |
CP-203139 |
0025 |
1 |
F |
Essential Corrections and alignments |
16.3.0 |
|
2020-12 |
CT#90e |
CP-203139 |
0026 |
F |
Storage of YAML files in 3GPP Forge |
16.3.0 |
|
|
2020-12 |
CT#90e |
CP-203139 |
0028 |
1 |
F |
Callback URI correction |
16.3.0 |
|
2020-12 |
CT#90e |
CP-203152 |
0030 |
F |
Update of OpenAPI version and TS version in externalDocs field |
16.3.0 |
|
|
2020-12 |
CT#90e |
CP-203130 |
0029 |
1 |
F |
Corrections to location area usage |
17.0.0 |
|
2021-03 |
CT#91e |
CP-210191 |
0032 |
F |
Support Stateless NFs |
17.1.0 |
|
|
2021-03 |
CT#91e |
CP-210218 |
0033 |
F |
OpenAPI reference |
17.1.0 |
|
|
2021-03 |
CT#91e |
CP-210230 |
0034 |
2 |
F |
Correction to location information usage |
17.1.0 |
|
2021-03 |
CT#91e |
CP-210221 |
0035 |
1 |
F |
Adding some missing description fields to data type definitions in OpenAPI |
17.1.0 |
|
2021-03 |
CT#91e |
CP-210230 |
0036 |
1 |
F |
Adding description fields to the data types in the Nnef_EventExposure specific and reused Data Types tables |
17.1.0 |
|
2021-03 |
CT#91e |
CP-210230 |
0037 |
1 |
F |
Specifying the Applicability field for some data types in the Nnef_EventExposure Data Types tables |
17.1.0 |
|
2021-03 |
CT#91e |
CP-210220 |
0038 |
F |
Optional header clarification |
17.1.0 |
|
|
2021-03 |
CT#91e |
CP-210206 |
0040 |
A |
Resource URI correction |
17.1.0 |
|
|
2021-03 |
CT#91e |
CP-210240 |
0042 |
F |
Update of OpenAPI version and TS version in externalDocs field |
17.1.0 |
|
|
2021-06 |
CT#92e |
CP-211221 |
0043 |
B |
Support of Mute reporting |
17.2.0 |
|
|
2021-06 |
CT#92e |
CP-211221 |
0044 |
B |
Partitioning criteria for applying sampling in specific UE partitions in NEF event exposure |
17.2.0 |
|
|
2021-06 |
CT#92e |
CP-211220 |
0046 |
1 |
A |
Presence condition of eventsRepInfo attribute |
17.2.0 |
|
2021-06 |
CT#92e |
CP-211200 |
0048 |
1 |
A |
Redirection responses |
17.2.0 |
|
2021-06 |
CT#92e |
CP-211173 |
0049 |
2 |
B |
Extensions to User Data Congestion Analytics |
17.2.0 |
|
2021-06 |
CT#92e |
CP-211265 |
0051 |
F |
Update of OpenAPI version and TS version in externalDocs field |
17.2.0 |
|
|
2021-09 |
CT#93e |
CP-212220 |
0052 |
F |
Resource URI correction on Nnef_EventExposure API |
17.3.0 |
|
|
2021-09 |
CT#93e |
CP-212245 |
0053 |
1 |
B |
Implementation for Performance Data event |
17.3.0 |
|
2021-09 |
CT#93e |
CP-212203 |
0054 |
B |
Support UE data volume dispersion collection |
17.3.0 |
|
|
2021-09 |
CT#93e |
CP-214553 |
0055 |
F |
Update of OpenAPI version and TS version in externalDocs field |
17.3.0 |
|
|
2021-12 |
CT#94e |
CP-213227 |
0057 |
1 |
F |
Updates to User Data Congestion |
17.4.0 |
|
2021-12 |
CT#94e |
CP-213227 |
0058 |
1 |
F |
Updates to UE data volume dispersion collection |
17.4.0 |
|
2021-12 |
CT#94e |
CP-213227 |
0059 |
2 |
F |
Update of notification procedure with description of USER_DATA_CONGESTION and DISPERSION events |
17.4.0 |
|
2021-12 |
CT#94e |
CP-213233 |
0060 |
B |
Clarification on Nnef_Authentication service |
17.4.0 |
|
|
2021-12 |
CT#94e |
CP-213223 |
0063 |
B |
Procedures to support Nnef_EASDeployment_Subscribe service opertion |
17.4.0 |
|
|
2021-12 |
CT#94e |
CP-213228 |
0061 |
B |
Collective Behaviour Analytics |
17.4.0 |
|
|
2021-12 |
CT#94e |
0062 |
F |
Update of OpenAPI version and TS version in externalDocs field |
17.4.0 |
||
|
2022-03 |
CT#95e |
CP-220185 |
0064 |
3 |
B |
Procedures to support Nnef_EASDeployment_Unsubscribe service opertion |
17.5.0 |
|
2022-03 |
CT#95e |
CP-220185 |
0065 |
4 |
B |
Procedures to support Nnef_EASDeployment_Notify service opertion |
17.5.0 |
|
2022-03 |
CT#95e |
CP-220186 |
0067 |
B |
Service Architecture for Nnef_EASDeployment service |
17.5.0 |
|
|
2022-03 |
CT#95e |
CP-220186 |
0068 |
1 |
B |
Update procedures to support Nnef_EASDeployment_Subscribe service opertion |
17.5.0 |
|
2022-03 |
CT#95e |
CP-220186 |
0069 |
1 |
B |
API definition to support Nnef_EASDeployment service |
17.5.0 |
|
2022-03 |
CT#95e |
CP-220361 |
0070 |
2 |
B |
OpenAPI to support Nnef_EASDeployment service |
17.5.0 |
|
2022-03 |
CT#95e |
CP-220190 |
0071 |
1 |
F |
Corrections to Data Model of NEF Event Exposure service |
17.5.0 |
|
2022-03 |
CT#95e |
CP-220201 |
0072 |
F |
Corrections to Nnef_EventExposure_Subscribe Service Operation |
17.5.0 |
|
|
2022-03 |
CT#95e |
CP-220185 |
0073 |
1 |
F |
Formatting of description fields |
17.5.0 |
|
2022-03 |
CT#95e |
CP-220194 |
0074 |
F |
Update of info and externalDocs field |
17.5.0 |
|
|
2022-06 |
CT#96 |
CP-221126 |
0078 |
1 |
F |
Updates to EasDeploySubData data type |
17.6.0 |
|
2022-06 |
CT#96 |
CP-221155 |
0081 |
1 |
F |
Remove the apiVersion placeholder from the resource URI variables table |
17.6.0 |
|
2022-06 |
CT#96 |
CP-221127 |
0080 |
2 |
F |
Defining FQDN information for EAS deployment |
17.6.0 |
|
2022-06 |
CT#96 |
CP-221133 |
0079 |
– |
F |
Muting notifications correction |
17.6.0 |
|
2022-06 |
CT#96 |
CP-221142 |
0082 |
1 |
B |
Support new NF service consumer in the Nnef_EventExposure API |
17.6.0 |
|
2022-06 |
CT#96 |
CP-221142 |
0083 |
1 |
B |
Support QoE metrics in NEF Event Exposure |
17.6.0 |
|
2022-06 |
CT#96 |
CP-221142 |
0084 |
1 |
B |
Support Consumption reports in NEF Event Exposure |
17.6.0 |
|
2022-06 |
CT#96 |
CP-221142 |
0085 |
1 |
B |
Support Network Assistance invocations in NEF Event Exposure |
17.6.0 |
|
2022-06 |
CT#96 |
CP-221142 |
0086 |
1 |
B |
Support Consumption reports in NEF Event Exposure |
17.6.0 |
|
2022-06 |
CT#96 |
CP-221142 |
0087 |
1 |
B |
Support Consumption reports in NEF Event Exposure |
17.6.0 |
|
2022-06 |
CT#96 |
CP-221152 |
0088 |
– |
F |
Update of info and externalDocs fields |
17.6.0 |
|
2022-09 |
CT#97e |
CP-222102 |
0094 |
1 |
F |
Missing description field for enumeration data types |
17.7.0 |
|
2022-09 |
CT#97e |
CP-222110 |
0089 |
1 |
B |
Updates to Media Streaming QoE metrics Event |
17.7.0 |
|
2022-09 |
CT#97e |
CP-222110 |
0090 |
1 |
F |
Updates to Media Streaming Consumption Event |
17.7.0 |
|
2022-09 |
CT#97e |
CP-222110 |
0091 |
1 |
F |
Updates to Media Streaming Network Assistance Invocation Event |
17.7.0 |
|
2022-09 |
CT#97e |
CP-222110 |
0092 |
1 |
F |
Updates to Media Streaming Dynamic Policy Event |
17.7.0 |
|
2022-09 |
CT#97e |
CP-222110 |
0093 |
1 |
F |
Updates to Media Streaming Access Event |
17.7.0 |
|
2022-09 |
CT#97e |
CP-222121 |
0095 |
– |
F |
Update of info and externalDocs fields |
17.7.0 |
|
2022-12 |
CT#98e |
CP-223179 |
0097 |
1 |
F |
Corrections to procedures of MS Event Exposure |
17.8.0 |
|
2022-12 |
CT#98e |
CP-223179 |
0100 |
– |
F |
Correct the data type of the attributeV |
17.8.0 |
|
2022-12 |
CT#98e |
CP-223179 |
0101 |
– |
F |
Correct the events and features in the data structures |
17.8.0 |