A.3 Ndccf_ContextManagement API
29.5743GPP5G SystemData Collection Coordination ServicesRelease 18Stage 3TS
openapi: 3.0.0
info:
version: 1.1.0-alpha.1
title: Ndccf_ContextManagement
description: |
DCCF Context Management Service.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.574 V18.0.0; 5G System; Data Collection Coordination Services; Stage 3.
url: ‘https://www.3gpp.org/ftp/Specs/archive/29_series/29.574/’
#
servers:
– url: ‘{apiRoot}/ndccf-contextmanagement/v1’
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501.
#
security:
– oAuth2ClientCredentials:
– ndccf-contextmanagement
– {}
#
paths:
/data-collection-profiles:
post:
summary: Creates a new Individual DCCF Data Collection Profile resource.
operationId: CreateDCCFDataCollectionProfile
tags:
– DCCF Data Collection Profiles (Collection)
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/NdccfDataCollectionProfile’
required: true
responses:
‘201’:
description: A new Individual DCCF Data Collection Profile resource created.
headers:
Location:
description: >
Contains the URI of the newly created resource, according to the structure
{apiRoot}/ndccf-contextmanagement/<apiVersion>/data-collection-profiles/{profileId}’
required: true
schema:
type: string
content:
application/json:
schema:
$ref: ‘#/components/schemas/NdccfDataCollectionProfile’
‘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’
/data-collection-profiles/{profileId}:
delete:
summary: Deletes an existing Individual DCCF Data Subscription resource.
operationId: DeleteDCCFDataCollectionProfile
tags:
– Individual DCCF Data Collection Profile (Document)
parameters:
– name: profileId
in: path
description: >
String identifying a data collection profile at the Ndccf_ContextManagement Service.
required: true
schema:
type: string
responses:
‘204’:
description: >
No Content. The Individual DCCF Data Collection Profile resource matching the profileId
was 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’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
put:
summary: Updates an existing Individual DCCF Data Collection Profile resource.
operationId: UpdateDCCFDataCollectionProfile
tags:
– Individual DCCF Data Collection Profile (Document)
requestBody:
required: true
content:
application/json:
schema:
$ref: ‘#/components/schemas/NdccfDataCollectionProfile’
parameters:
– name: profileId
in: path
description: >
String identifying a data collection profile at the Ndccf_ContextManagement Service.
required: true
schema:
type: string
responses:
‘200’:
description: >
The Individual DCCF Data Collection Profile resource was modified successfully and a
representation of that resource is returned.
content:
application/json:
schema:
$ref: ‘#/components/schemas/NdccfDataCollectionProfile’
‘204’:
description: >
The Individual DCCF Data Collection Profile resource was modified successfully.
‘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:
ndccf-contextmanagement: Access to the ndccf-contextmanagement API
#
schemas:
NdccfDataCollectionProfile:
description: Represents an Individual DCCF Data Collection Profile.
type: object
allOf:
– oneOf:
– required: [anaSub]
– required: [dataSub]
– oneOf:
– required: [nwdafId]
– required: [adrfId]
– required: [nwdafSetId]
– required: [adrfSetId]
properties:
anaSub:
$ref: ‘TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscription’
dataSub:
$ref: ‘TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataNotification’
nwdafId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/NfInstanceId’
nwdafSetId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/NfSetId’
adrfId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/NfInstanceId’
adrfSetId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/NfSetId’
#
Annex B (informative):
Change history
|
Change history |
|||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2021-05 |
CT3#116e |
Skeleton of TS on 5G System; Data Collection Coordination Services; Stage 3. |
0.0.0 |
||||
|
2021-05 |
CT3#116e |
Inclusion of documents agreed in CT3#116e: C3-213235, C3-213236, C3-213237, C3-213238 and C3-213239. |
0.1.0 |
||||
|
2021-08 |
CT3#117e |
Inclusion of document agreed in CT3#117e: C3-214167. |
0.2.0 |
||||
|
2021-10 |
CT3#118e |
Inclusion of document agreed in CT3#118e: C3-215182, C3-215480, C3-215184, C3-215185, C3-215186, C3-215187, C3-215188. |
0.3.0 |
||||
|
2021-11 |
CT3#119e |
Inclusion of document agreed in CT3#119e: C3-216452, C3-216453, C3-216454, C3-216057, C3-216058, C3-216601 |
0.4.0 |
||||
|
2022-01 |
CT3#119bis-e |
Inclusion of document agreed in CT3#119bis-e: C3-220506, C3-220507, C3-220508, C3-220497, C3-220509, C3-220498, C3-220050, C3-220368, C3-220301. |
0.5.0 |
||||
|
2022-02 |
CT3#120-e |
Inclusion of document agreed in CT3#120e: C3-221619, C3-221281, C3-221287, C3-221682, C3-221301. |
0.6.0 |
||||
|
2022-03 |
CT#95e |
CP-220159 |
Presentation to TSG CT for approval |
1.0.0 |
|||
|
2022-03 |
CT#95e |
CP-220159 |
Approved by TSG CT |
17.0.0 |
|||
|
2022-06 |
CT#96 |
CP-221132 |
0001 |
1 |
F |
Adding 3XX response handling support for DCCF services |
17.1.0 |
|
2022-06 |
CT#96 |
CP-221132 |
0003 |
1 |
F |
Corrections in the Ndccf_DataManagement API |
17.1.0 |
|
2022-06 |
CT#96 |
CP-221132 |
0004 |
1 |
F |
Removing ENs about possible further data sources and attributes |
17.1.0 |
|
2022-06 |
CT#96 |
CP-221132 |
0005 |
1 |
B |
Update Ndccf_DataManagement_Fetch service operation |
17.1.0 |
|
2022-06 |
CT#96 |
CP-221131 |
0009 |
1 |
F |
Ndccf_DataManagement API corrections |
17.1.0 |
|
2022-06 |
CT#96 |
CP-221130 |
0010 |
– |
F |
Ndccf_DataManagement API: responses on DELETE method |
17.1.0 |
|
2022-06 |
CT#96 |
CP-221130 |
0011 |
– |
F |
Ndccf_DataManagement API: responses on DELETE method |
17.1.0 |
|
2022-06 |
CT#96 |
CP-221130 |
0012 |
– |
B |
Remove the unused sections from TS skeleton |
17.1.0 |
|
2022-06 |
CT#96 |
CP-221131 |
0013 |
1 |
F |
Miscellaneous corrections and updates |
17.1.0 |
|
2022-06 |
CT#96 |
C3-223520 |
0020 |
1 |
F |
Update the apiVersion in the specification |
17.1.0 |
|
2022-06 |
CT#96 |
CP-221133 |
0015 |
– |
F |
Removing UDM from the list of service consumers for DCCF subscriptions |
17.1.0 |
|
2022-06 |
CT#96 |
CP-221136 |
0002 |
3 |
B |
Cleanup of the Ndccf_DataManagement data model |
17.1.0 |
|
2022-06 |
CT#96 |
CP-221133 |
0016 |
– |
F |
Removal of repetitive description in HTTP error response |
17.1.0 |
|
2022-06 |
CT#96 |
CP-221136 |
0006 |
3 |
B |
Support carrying Time Window in Ndccf_DataManagement_Subscribe service operation |
17.1.0 |
|
2022-06 |
CT#96 |
CP-221134 |
0018 |
– |
B |
Remove the ENs about when the DCCF sends the response to the consumer |
17.1.0 |
|
2022-06 |
CT#96 |
CP-221134 |
0019 |
1 |
B |
Update the Notification Correlation ID for Ndccf_DataManagement_Subscribe |
17.1.0 |
|
2022-06 |
CT#96 |
CP-221134 |
0007 |
1 |
F |
add ADRF as a consumer of Ndccf_DataManagement service |
17.1.0 |
|
2022-06 |
CT#96 |
CP-221135 |
0021 |
1 |
F |
remove CEF and OAM from the list of consumers of Ndccf_DataManagement Service |
17.1.0 |
|
2022-06 |
CT#96 |
CP-221135 |
0022 |
1 |
F |
update of Abbreviations |
17.1.0 |
|
2022-06 |
CT#96 |
CP-221152 |
0023 |
– |
F |
Update of info and externalDocs fields |
17.1.0 |
|
2022-09 |
CT#97e |
CP-222101 |
0032 |
– |
F |
Corrections to Fetch service operation |
17.2.0 |
|
2022-09 |
CT#97e |
CP-222102 |
0034 |
1 |
F |
Add Headers supported by 3xx Response Code for Analytics and Data Notification |
17.2.0 |
|
2022-09 |
CT#97e |
CP-222102 |
0035 |
1 |
F |
Add the missing data types for 3xx response codes |
17.2.0 |
|
2022-09 |
CT#97e |
CP-222102 |
0036 |
1 |
F |
Missing description field for enumeration data types |
17.2.0 |
|
2022-09 |
CT#97e |
CP-222103 |
0031 |
1 |
F |
Corrections to fetch correlation identifiers |
17.2.0 |
|
2022-09 |
CT#97e |
CP-222103 |
0033 |
1 |
F |
Corrections in the error handling of DCCF subscription |
17.2.0 |
|
2022-09 |
CT#97e |
CP-222104 |
0026 |
1 |
F |
Corrections related to callback functions in DCCF |
17.2.0 |
|
2022-09 |
CT#97e |
CP-222104 |
0027 |
1 |
F |
Add ADRF information in DCCF subscriptions |
17.2.0 |
|
2022-09 |
CT#97e |
CP-222104 |
0029 |
1 |
F |
Updates of formatting and processing instructions |
17.2.0 |
|
2022-09 |
CT#97e |
CP-222104 |
0030 |
1 |
F |
Adding NRF and NSACF as data sources |
17.2.0 |
|
2022-09 |
CT#97e |
CP-222104 |
0017 |
2 |
F |
Update inputs of Ndccf_DataManagement_Notify service |
17.2.0 |
|
2022-09 |
CT#97e |
CP-222104 |
0038 |
1 |
F |
Support user consent indication and data collection purpose |
17.2.0 |
|
2022-09 |
CT#97e |
CP-222104 |
0024 |
2 |
F |
eventId attribute editors note removal |
17.2.0 |
|
2022-09 |
CT#97e |
CP-222121 |
0039 |
– |
F |
Update of info and externalDocs fields |
17.2.0 |
|
2022-12 |
CT#98e |
CP-223173 |
0040 |
1 |
F |
17.3.0 |
|
|
2022-12 |
CT#98e |
CP-223172 |
0041 |
– |
F |
17.3.0 |
|
|
2022-12 |
CT#98e |
CP-223172 |
0042 |
– |
F |
17.3.0 |
|
|
2022-12 |
CT#98e |
CP-223172 |
0046 |
– |
F |
Incorrect data type name |
17.3.0 |
|
2022-12 |
CT#98e |
CP-223173 |
0047 |
1 |
F |
Correction to the value of consTrigNotif attribute |
17.3.0 |
|
2022-12 |
CT#98e |
CP-223174 |
0048 |
2 |
F |
Corrections in Ndccf_DataManagement service |
17.3.0 |
|
2022-12 |
CT#98e |
CP-223172 |
0049 |
– |
F |
Corrections to data type in DELETE header |
17.3.0 |
|
2022-12 |
CT#98e |
CP-223173 |
0050 |
1 |
F |
Time stamp for requested data or analytics in Ndccf_DataManagement Service |
17.3.0 |
|
2022-12 |
CT#98e |
CP-223188 |
0053 |
– |
F |
Update of info and externalDocs fields |
17.3.0 |
|
2022-12 |
CT#98e |
CP-223191 |
0043 |
– |
F |
18.0.0 |
|
|
2022-12 |
CT#98e |
CP-223176 |
0052 |
– |
F |
18.0.0 |
|
|
2022-12 |
CT#98e |
CP-223190 |
0054 |
– |
F |
Update of info and externalDocs fields |
18.0.0 |