A.3 Nmfaf_3caDataManagement API
29.5763GPP5G SystemMessaging Framework Adaptor ServicesRelease 18Stage 3TS
openapi: 3.0.0
info:
version: 1.1.0-alpha.1
title: Nmfaf_3caDataManagement
description: |
MFAF 3GPP Consumer Adaptor (3CA) Data Management Service.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.576 V18.0.0; 5G System; Messaging Framework Adaptor Services; Stage 3.
url: ‘https://www.3gpp.org/ftp/Specs/archive/29_series/29.576/’
servers:
– url: ‘{apiRoot}/nmfaf-3cadatamanagement/v1’
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501.
security:
– oAuth2ClientCredentials:
– nmfaf-3cadatamanagement
– {}
paths:
/mfaf-data-analytics:
post:
# This is a pseudo operation, clients shall NOT invoke this method!
summary: subscribe to notifications
operationId: CreateIndividualSubcription
tags:
– MFAF Data or Analytics Resources (Collection)
requestBody:
required: true
content:
application/json:
schema: {}
responses:
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
callbacks:
Notification:
‘{notificationURI}’:
# The URI in {notificationURI} is provided via Nmfaf-3daDataManagement API during the configuration for mapping data or analytics.
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: ‘#/components/schemas/NmfafDataRetrievalNotification’
responses:
‘204’:
description: The receipt of the Notification is acknowledged.
‘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’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
callbacks:
Fetch:
‘{request.body#/fetchInstruction/fetchUri}’:
post:
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
type: string
minItems: 1
description: Indicate the fetch correlation identifier.
responses:
‘200’:
description: Expected response to a valid request.
content:
application/json:
schema:
$ref: ‘#/components/schemas/NmfafDataAnaNotification’
‘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’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘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:
nmfaf-3cadatamanagement: Access to the nmfaf-3cadatamanagement API
schemas:
NmfafDataRetrievalNotification:
description: >
Represents the data or analytics or notification of availability of data or analytics
to notification endpoints.
type: object
required:
– correId
oneOf:
– required: [dataAnaNotif]
– required: [fetchInstruction]
properties:
correId:
type: string
description: >
Represents the Analytics Consumer Notification Correlation ID
or Data Consumer Notification Correlation ID. It shall be set to the same
value as the "correId" attribute of MessageConfiguration data type.
dataAnaNotif:
$ref: ‘#/components/schemas/NmfafDataAnaNotification’
fetchInstruction:
$ref: ‘#/components/schemas/FetchInstruction’
FetchInstruction:
description: >
The fetch instructions indicate whether the data or analytics are to be fetched by the
consumer.
type: object
required:
– fetchUri
– fetchCorrIds
properties:
fetchUri:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uri’
fetchCorrIds:
type: array
items:
type: string
minItems: 1
description: The fetch correlation identifier(s) of the MFAF Data or Analytics.
expiry:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’
NmfafDataAnaNotification:
description: MFAF data or analytics.
type: object
oneOf:
– required: [anaNotifications]
– required: [dataNotif]
properties:
anaNotifications:
type: array
items:
$ref: ‘TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscriptionNotification’
minItems: 1
description: List of analytics subscription notifications.
dataNotif:
$ref: ‘TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataNotification’
Annex B (informative):
Change history
|
Change history |
||||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
|
2021-06 |
CT3#116e |
TS skeleton of Messaging Framework Adaptor Services specification |
0.0.0 |
|||||
|
2021-06 |
CT3#116e |
C3-213502 |
Inclusion of documents agreed in CT3#116e C3-213377. |
0.1.0 |
||||
|
2021-08 |
CT3#117e |
C3-214580 |
Inclusion of documents agreed in CT3#117e C3-214479, |
0.2.0 |
||||
|
2021-11 |
CT3#119e |
C3-216522 |
Inclusion of documents agreed in CT3#119e C3-216422, |
0.3.0 |
||||
|
2022-01 |
CT3#119bis-e |
C3-220455 |
Inclusion of documents agreed in CT3#119bis-e C3-220294, |
0.4.0 |
||||
|
2022-02 |
CT3#120e |
C3-221516 |
Inclusion of documents agreed in CT3#120e C3-221289, |
0.5.0 |
||||
|
2022-03 |
CT#95e |
CP-220161 |
Presentation to TSG CT for approval |
1.0.0 |
||||
|
2022-03 |
CT#95e |
CP-220161 |
Approved by TSG CT |
17.0.0 |
||||
|
2022-06 |
CT#96 |
CP-221132 |
0001 |
1 |
F |
Adding 3XX and error response handling support for MFAF services |
17.1.0 |
|
|
2022-06 |
CT#96 |
CP-221132 |
0002 |
1 |
F |
Corrections in the MFAF 3caDataManagement API |
17.1.0 |
|
|
2022-06 |
CT#96 |
CP-221129 |
0003 |
F |
Correct the Cardinality and Presence of some attributes |
17.1.0 |
||
|
2022-06 |
CT#96 |
CP-221132 |
0004 |
1 |
B |
Support carrying ADRF ID in Nmfaf_3daDataManagement_Configure service operation |
17.1.0 |
|
|
2022-06 |
CT#96 |
CP-221129 |
0005 |
F |
Nmfaf_3daDataManagement API corrections |
17.1.0 |
||
|
2022-06 |
CT#96 |
CP-221131 |
0006 |
1 |
F |
Nmfaf_3caDataManagement API corrections |
17.1.0 |
|
|
2022-06 |
CT#96 |
CP-221130 |
0007 |
F |
Handling of the redirection responses |
17.1.0 |
||
|
2022-06 |
CT#96 |
CP-221134 |
0009 |
2 |
F |
Correction on DataNotification type |
17.1.0 |
|
|
2022-06 |
CT#96 |
CP-221133 |
0011 |
F |
Removing UDM from the list of MFAF service consumers |
17.1.0 |
||
|
2022-06 |
CT#96 |
CP-221135 |
0012 |
1 |
F |
Update inputs of Nmfaf_3caDataManagement_Notify service |
17.1.0 |
|
|
2022-06 |
CT#96 |
CP-221134 |
0014 |
F |
Correction to MFAF notification information |
17.1.0 |
||
|
2022-06 |
CT#96 |
CP-221134 |
0015 |
F |
add CEF and OAM as consumers of Ndccf_DataManagement Service |
17.1.0 |
||
|
2022-06 |
CT#96 |
CP-221134 |
0016 |
F |
update of Abbreviations |
17.1.0 |
||
|
2022-06 |
CT#96 |
CP-221155 |
0018 |
1 |
F |
Update the apiVersion placeholder |
17.1.0 |
|
|
2022-06 |
CT#96 |
CP-221152 |
0019 |
F |
Update of info and externalDocs fields |
17.1.0 |
||
|
2022-09 |
CT#97e |
CP-222104 |
0021 |
2 |
F |
Add expiry attribute to the fetch instructions |
17.2.0 |
|
|
2022-09 |
CT#97e |
CP-222104 |
0022 |
1 |
F |
Corrections related to callback functions in MFAF |
17.2.0 |
|
|
2022-09 |
CT#97e |
CP-222104 |
0023 |
1 |
F |
Add NWDAF hosting DCCF as consumer of the Nmfaf_3daDataManagement service |
17.2.0 |
|
|
2022-09 |
CT#97e |
CP-222101 |
0024 |
F |
Clean up References |
17.2.0 |
||
|
2022-09 |
CT#97e |
CP-222101 |
0025 |
F |
Corrections related to NmfafDataRetrievalNotification data type |
17.2.0 |
||
|
2022-09 |
CT#97e |
CP-222101 |
0026 |
F |
Corrections to Fetch Notification |
17.2.0 |
||
|
2022-09 |
CT#97e |
CP-222102 |
0028 |
1 |
F |
Miscellaneous corrections |
17.2.0 |
|
|
2022-09 |
CT#97e |
CP-222101 |
0029 |
F |
Corrections to NF service consumer |
17.2.0 |
||
|
2022-09 |
CT#97e |
CP-222121 |
0030 |
F |
Update of info and externalDocs fields |
17.2.0 |
||
|
2022-12 |
CT#98e |
CP-223172 |
0034 |
F |
Correcting procedure description for dataNotif attribute |
17.3.0 |
||
|
2022-12 |
CT#98e |
CP-223172 |
0036 |
F |
Corrections to data type in POST header |
17.3.0 |
||
|
2022-12 |
CT#98e |
CP-223237 |
0037 |
1 |
F |
The time stamp of data and analytics notification |
17.3.0 |
|
|
2022-12 |
CT#98e |
CP-223188 |
0041 |
F |
Update of info and externalDocs fields |
17.3.0 |
||
|
2022-12 |
CT#98e |
CP-223191 |
0031 |
F |
Adding the mandatory error code 502 Bad Gateway |
18.0.0 |
||
|
2022-12 |
CT#98e |
CP-223176 |
0035 |
1 |
F |
Correction of data type of procInstruct |
18.0.0 |
|
|
2022-12 |
CT#98e |
CP-223190 |
0040 |
F |
Update of info and externalDocs fields |
18.0.0 |
||