A.7 File data reporting management service

28.5323GPPGeneric management servicesManagement and orchestrationRelease 17TS

A.7.1 Introduction

Clause A.7.2 contains the OpenAPI definition of the File Data Reporting MnS.

Clause A.7.3 provides indications regarding the content of the File Data Reporting MnS notifications when the consumer of these notifications supports the ONAP VES API. This content is sent as payload of VES events (see Annex B).

A.7.2 OpenAPI document "TS 28532_FileDataReportingMnS.yaml"

openapi: 3.0.1

info:

title: File Data Reporting MnS

version: 17.0.0

description: >-

OAS 3.0.1 definition of the File Data Reporting MnS

© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

All rights reserved.

externalDocs:

description: 3GPP TS 28.532; Generic management services

url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/

servers:

– url: ‘{MnSRoot}/fileDataReportingMnS/{MnSVersion}’

variables:

MnSRoot:

description: See clause 4.4.3 of TS 32.158

default: http://example.com/3GPPManagement

MnSVersion:

description: Version number of the OpenAPI definition

default: XXX

paths:

/files:

get:

summary: Read information about available files

description: >-

Information about available files is read with HTTP GET. The files for

which information shall be returned are identified with the path

component (base resource) and the query component (fileDataType, beginTime,

endTime) of the URI.

parameters:

– name: fileDataType

in: query

description: >-

This parameter selects files based on the file data type.

required: true

schema:

$ref: ‘#/components/schemas/FileDataType’

– name: beginTime

in: query

description: >-

This parameter selects files based on the earliest time they

became available

required: false

schema:

$ref: ‘TS28623_ComDefs.yaml#/components/schemas/DateTime’

– name: endTime

in: query

description: >-

This parameter selects files based on the latest time they

became available

required: false

schema:

$ref: ‘TS28623_ComDefs.yaml#/components/schemas/DateTime’

responses:

‘200’:

description: >-

‘Success case ("200 OK").

The resources identified in the request for retrieval are returned

in the response message body.’

content:

application/json:

schema:

type: array

items:

$ref: ‘#/components/schemas/FileInfo’

default:

description: Error case.

content:

application/json:

schema:

$ref: ‘TS28623_ComDefs.yaml#/components/schemas/ErrorResponse’

/subscriptions:

post:

summary: Create a subscription

description: >-

To create a subscription the representation of the subscription is

POSTed on the /subscriptions collection resource.

requestBody:

required: true

content:

application/json:

schema:

$ref: ‘TS28532_FaultMnS.yaml#/components/schemas/Subscription’

responses:

‘201’:

description: >-

Success case ("201 Created").

The representation of the newly created subscription resource shall

be returned.

content:

application/json:

schema:

$ref: ‘TS28532_FaultMnS.yaml#/components/schemas/Subscription’

headers:

Location:

description: URI of the newly created subscription resource

required: true

schema:

type: string

default:

description: Error case.

content:

application/json:

schema:

$ref: ‘TS28623_ComDefs.yaml#/components/schemas/ErrorResponse’

callbacks:

notifyFileReady:

‘{request.body#/consumerReference}’:

post:

requestBody:

required: true

content:

application/json:

schema:

$ref: ‘#/components/schemas/NotifyFileReady’

responses:

‘204’:

description: >-

Success case ("204 No Content").

The notification is successfully delivered. The response message

body is absent.

default:

description: Error case.

content:

application/json:

schema:

$ref: ‘TS28623_ComDefs.yaml#/components/schemas/ErrorResponse’

notifyFilePreparationError:

‘{request.body#/consumerReference}’:

post:

requestBody:

required: true

content:

application/json:

schema:

$ref: ‘#/components/schemas/NotifyFilePreparationError’

responses:

‘204’:

description: >-

Success case ("204 No Content").

The notification is successfully delivered. The response message

body is absent.

default:

description: Error case.

content:

application/json:

schema:

$ref: ‘TS28623_ComDefs.yaml#/components/schemas/ErrorResponse’

/subscriptions/{subscriptionId}:

delete:

summary: Delete a subscription

description: >-

The subscription is deleted by deleting the corresponding subscription

resource. The resource to be deleted is identified with the path

component of the URI.

parameters:

– name: subscriptionId

in: path

description: Identifies the subscription to be deleted.

required: true

schema:

type: string

responses:

‘204’:

description: >-

Success case ("204 No Content").

The subscription resource has been deleted. The response message body

is absent.

default:

description: Error case.

content:

application/json:

schema:

$ref: ‘TS28623_ComDefs.yaml#/components/schemas/ErrorResponse’

components:

schemas:

FileDataType:

type: string

enum:

– Performance

– Trace

– Analytics

– Proprietary

FileNotificationTypes:

type: string

enum:

– notifyFileReady

– notifyFilePreparationError

FileInfo:

type: object

properties:

fileLocation:

$ref: ‘TS28623_ComDefs.yaml#/components/schemas/Uri’

fileCompression:

type: string

fileSize:

type: integer

fileDataType:

$ref: ‘#/components/schemas/FileDataType’

fileFormat:

type: string

fileReadyTime:

$ref: ‘TS28623_ComDefs.yaml#/components/schemas/DateTime’

fileExpirationTime:

$ref: ‘TS28623_ComDefs.yaml#/components/schemas/DateTime’

jobId:

type: string

NotifyFileReady:

allOf:

– $ref: ‘TS28623_ComDefs.yaml#/components/schemas/NotificationHeader’

– type: object

properties:

fileInfoList:

type: array

items:

$ref: ‘#/components/schemas/FileInfo’

additionalText:

type: string

NotifyFilePreparationError:

allOf:

– $ref: ‘TS28623_ComDefs.yaml#/components/schemas/NotificationHeader’

– type: object

properties:

fileInfoList:

type: array

items:

$ref: ‘#/components/schemas/FileInfo’

reason:

type: string

additionalText:

type: string

A.7.3 Integration with ONAP VES

Detailed guidelines for integration of file data reporting MnS notifications with ONAP VES are provided in Annex B.

Annex B (Informative):
Guidelines for the integration of 3GPP MnS notifications with ONAP VES

In case the consumer of the 3GPP MnS notifications specified in the present document is an ONAP VES collector, the following guidelines are for the developer of the corresponding notification producer:

– The produced notification conforms to ONAP-defined VES specification;

– The VES Common Event Header fields are populated by the producer is as follows:

– The domain "stndDefined" is used,

– The "stndDefinedNamespace" field value is the concatenation of "3GPP-" and the name of the 3GPP MnS which the 3GPP IS notification is part of. Based on the MnS names defined in the present version of this document, VES name space values corresponding to 3GPP MnS could be:

– "3GPP-Provisioning",

– "3GPP-FaultSupervision",

– "3GPP-PerformanceAssurance",

– "3GPP-Heartbeat",

– "3GPP-DataStreamingReporting",

– "3GPP-DataFileReporting".

– How the other fields of the Common Event Header are populated is not in the scope of the present document;

– The payload part of the VES event specification conforms to the OpenAPI definitions of clause A.1.1 (for provisioning MnS notifications), A.2.1 (for the fault supervision MnS notifications), A4.2 (for the performance assurance MnS notifications), A.5.1 (for the heartbeat notifications) and A.7.2 (for the file data reporting MnS notifications) of the present document. The OpenAPI definitions of Annex A in the present document may also be found on 3GPP FORGE (see [46]).

Figure X-1. 3GPP MnS notifications consumed by ONAP VES Collector(s).

Annex C (informative):
Change history

Change history

Date

Meeting

TDoc

CR

Rev

Cat

Subject/Comment

New version

2018-09

SA#81

Upgrade to change control version

15.0.0

2018-09

SA#81

EditHelp editorial fix

15.0.1

2018-12

SA#82

SP-181042

0002

1

F

Correction of references

15.1.0

2018-12

SA#82

SP-181042

0003

1

F

Align with 3GPP draft rules of the usage of must

15.1.0

2018-12

SA#82

SP-181042

0004

1

F

Correction of the numbering and title of figures and tables

15.1.0

2018-12

SA#82

SP-181042

0005

1

F

Remove unnecessary Editor’s Note and figure

15.1.0

2018-12

SA#82

SP-181045

0006

1

F

Update Resource URI of alarmCount

15.1.0

2018-12

SA#82

SP-181045

0009

1

F

Change the name of IRPAgent and IRPManager

15.1.0

2018-12

SA#82

SP-181045

0010

1

F

Remove unnecessary import table and state diagram

15.1.0

2018-12

SA#82

SP-181045

0012

F

Correct the subscription resource related errors

15.1.0

2018-12

SA#82

SP-181043

0018

F

Add notifyNewSecurityAlarm to notification type

15.1.0

2018-12

SA#82

SP-181045

0020

1

F

Change alarmIRP to FaultSupervision MnS producer

15.1.0

2018-12

SA#82

SP-181042

0021

1

F

Add stage 2 definition for provisioning management service related notifications

15.1.0

2018-12

SA#82

SP-181042

0022

1

F

Correct stage 3 description of the Provisioning Management Service

15.1.0

2018-12

SA#82

SP-181045

0025

F

Correct erroneous reference to notification header

15.1.0

2019-03

SA#83

SP-190120

0029

1

F

Correction of references

15.2.0

2019-06

SA#84

SP-190372

0031

2

B

Add RESTful HTTP-based solution set of fault supervision for integration with ONAP VES

16.0.0

2019-06

SA#84

SP-190371

0038

1

B

Add performance threshold crossing notification

16.0.0

2019-09

SA#85

SP-190742

0038A

Global reorganization, correcting operation names, notification parameter and wrong references

16.1.0

2019-12

SA#86

SP-191178

0055

1

B

RESTful CM notifications for integration with ONAP VES

16.2.0

2019-12

SA#86

SP-191219

0059

1

A

Corrections to provisioning MnS notification definitions (Stage 2)

16.2.0

2019-12

SA#86

SP-191219

0061

2

A

Correct fault supervision management service

16.2.0

2019-12

SA#86

SP-191159

0069

2

C

Make scoping and filtering optional in the ProvMnS

16.2.0

2019-12

SA#86

SP-191159

0071

2

F

Correct and update the RESTful HTTP-based solution set of provisioning

16.2.0

2019-12

SA#86

SP-191178

0073

2

B

Introduce Heartbeat

16.2.0

2019-12

SA#86

SP-191173

0075

1

A

Correct event time defn

16.2.0

2019-12

SA#86

SP-191166

0076

1

B

Add notifyEvent

16.2.0

2019-12

SA#86

SP-191159

0081

1

F

Correct schema to reflect location in the specifications

16.2.0

2019-12

SA#86

SP-191159

0082

F

Correct XML Schema for consistency and clarity

16.2.0

2020-03

SA#87E

SP-200174

0089

A

Add missing definition for matching-criteria-attributes

16.3.0

2020-03

SA#87E

SP-200166

0092

1

F

Clarify capability of ack alarms and filter constraint

16.3.0

2020-03

SA#87E

SP-200176

0094

1

F

Correction of MnS Stage 3 solution sets for integration with ONAP VES

16.3.0

2020-03

SA#87E

SP-200166

0096

F

Rapporteur clean up

16.3.0

2020-03

SA#87E

SP-200169

0098

1

B

YANG_Netconf Operations

16.3.0

2020-03

SA#87E

SP-200166

0101

1

F

Clarify and add numerous issues in the REST SS of the ProvMnS

16.3.0

2020-03

SA#87E

SP-200166

0103

2

F

Correct OpenAPI definition of the ProvMnS

16.3.0

2020-03

SA#87E

SP-200174

0104

A

Correct ackState attribute name

16.3.0

2020-03

SA#87E

SP-200169

0105

F

Correct Heartbeat

16.3.0

2020-06

SA#88-e

SP-200484

0100

2

B

Add summary CM notification to the ProvMnS

16.4.0

2020-06

SA#88-e

SP-200484

0102

1

F

Remove subscribe and unsubscribe operation from ProvMnS

16.4.0

2020-06

SA#88-e

SP-200484

0107

1

F

Void meaningless clauses 12.1.2.2.1.2 and 12.2.2.2.1.2

16.4.0

2020-06

SA#88-e

SP-200484

0111

F

Add missing callbacks for notifications to ProvMnS

16.4.0

2020-06

SA#88-e

SP-200484

0113

F

Remove attribute referenceObjectInstance which is not supported by solution set

16.4.0

2020-06

SA#88-e

SP-200485

0114

2

F

Update URI for generic fault supervision management service

16.4.0

2020-06

SA#88-e

SP-200485

0115

2

F

Update URI for performance data file reporting management service

16.4.0

2020-06

SA#88-e

SP-200484

0116

F

Remove data object from response types in the ProvMnS

16.4.0

2020-06

SA#88-e

SP-200483

0117

3

B

Add streaming trace data reporting service stage 2 definition

16.4.0

2020-06

SA#88-e

SP-200483

0118

2

B

Add streaming data reporting service stage 3 mapping of operations

16.4.0

2020-06

SA#88-e

SP-200483

0119

2

B

16.4.0

2020-06

SA#88-e

SP-200483

0120

2

B

16.4.0

2020-06

SA#88-e

SP-200483

0121

2

B

Add streaming data reporting service stage 3 OpenAPI definition

16.4.0

2020-06

SA#88-e

SP-200499

0123

A

Move XML file format from stage2 to stage3

16.4.0

2020-06

SA#88-e

SP-200485

0126

1

C

Update Fault Supervision MnS (stage 2)

16.4.0

2020-06

SA#88-e

SP-200485

0127

1

C

Update Fault Supervision MnS (REST SS)

16.4.0

2020-06

SA#88-e

SP-200485

0128

1

C

Update Fault Supervision MnS (OpenAPI definitions)

16.4.0

2020-06

SA#88-e

SP-200500

0133

F

Correction of ONAP references

16.4.0

2020-06

SA#88-e

SP-200611

0134

1

F

Convert JSON schema to YAML file for performance threshold monitoring service

16.4.0

2020-09

SA#89e

SP-200738

0135

F

Change stage2 definition for performance data file report MnS to generic file data report MnS

16.5.0

2020-09

SA#89e

SP-200738

0136

F

Change RESTFUL definition for performance data file report MnS to generic file data report MnS

16.5.0

2020-09

SA#89e

SP-200724

0137

F

Change openAPI definition for performance data file report MnS to generic file data report MnS

16.5.0

2020-09

SA#89e

SP-200737

0138

1

F

Clarification on Annex A.1, A.2 and A.5

16.5.0

2020-09

SA#89e

SP-200723

0139

F

Update URI for streamingDataReportingMnS to aligh with URI structure defined in 32.158

16.5.0

2020-09

SA#89e

SP-200736

0141

1

A

Correct the description for generic provisioning MnS

16.5.0

2020-09

SA#89e

SP-200724

0143

F

Correct various smaller errors (e.g. validation errors) in faultMnS.yaml (OpenAPI definitions)

16.5.0

2020-09

SA#89e

SP-200724

0144

F

Correct definition of ThresholdLevelInd (REST SS)

16.5.0

2020-09

SA#89e

SP-200737

0147

F

Remove unintended normative statement from informative clause

16.5.0

2020-09

SA#89e

Correction of clause numbering

16.5.1

2020-11

Cleanup of custom XML, watermarks, hidden text, etc.. no technical changes

16.5.2

2020-12

SA#90e

SP-201050

0148

1

F

Correction on generic file data report MnS

16.6.0

2020-12

SA#90e

SP-201088

0149

2

F

Update generic streaming MnS

16.6.0

2020-12

SA#90e

SP-201050

0150

1

F

Correct CR implementation errors (Fault MnS)

16.6.0

2020-12

SA#90e

SP-201050

0152

1

F

Correct ThresholdLevelInd (REST SS, OpenAPI definition)

16.6.0

2020-12

SA#90e

SP-201054

0153

F

Correct notifyThresholdCrossing (stage 2)

16.6.0

2020-12

SA#90e

SP-201050

0154

1

F

Correct notifyThresholdCrossing (REST SS, OpenAPI definition)

16.6.0

2020-12

SA#90e

SP-201050

0155

1

F

Correct notifyHeartbeat (stage 2, REST SS, OpenAPI definition)

16.6.0

2020-12

SA#90e

SP-201050

0156

F

Correct small errors in faultMnS.yaml (OpenAPI definition)

16.6.0

2020-12

SA#90e

SP-201050

0157

1

F

Correct notifyChangedAlarmGeneral (stage 2)

16.6.0

2020-12

SA#90e

SP-201050

0158

F

Correct notifyChangedAlarmGeneral (REST SS, OpenAPI definitions)

16.6.0

2020-12

SA#90e

SP-201055

0160

1

F

Fix inconsistencies in guidelines for integration with ONAP VES

16.6.0

2020-12

SA#90e

SP-201088

0161

F

Correct small errors in the Fault MnS (REST SS)

16.6.0

2020-12

SA#90e

SP-201088

0162

F

Align ProvMnS data type names to UpperCamel (REST SS, OpenAPI definition)

16.6.0

2021-03

SA#91e

SP-210150

0163

2

F

16.7.0

2021-03

SA#91e

SP-210150

0164

2

F

Correct definitions for the File MnS (REST SS)

16.7.0

2021-03

SA#91e

SP-210150

0165

2

F

Correct definitions for the File MnS (OpenAPI definitions)

16.7.0

2021-03

SA#91e

SP-210150

0166

1

F

Correct support qualifiers of the notifyThresholdCrossing parameters (stage 2)

16.7.0

2021-03

SA#91e

SP-210146

0167

F

Fix compilation errors

16.7.0

2021-03

SA#91e

SP-210146

0168

1

F

Correct the misalignment information for stage2 Fault Supervision MnS

16.7.0

2021-03

SA#91e

SP-210146

0170

1

F

Correct some minor errors in the Fault MnS definition (REST SS)

16.7.0

2021-03

SA#91e

SP-210146

0171

F

Correct some minor errors in the Prov MnS definition (REST SS)

16.7.0

2021-04

SA#91e

Editorial cleanup with the help of the Rapporteur

16.7.1

2021-06

SA#92e

SP-210406

0173

1

F

16.8.0

2021-06

SA#92e

SP-210406

0174

1

F

Correct definitions for file management (stage 2, REST SS, OpenAPI definition)

16.8.0

2021-06

SA#92e

SP-210416

0175

F

Align different (abbreviated) names for support qualifier to S

16.8.0

2021-06

SA#92e

SP-210406

0176

1

F

Update clause 11.2.2 Managed information for fault supervision management service

16.8.0

2021-06

SA#92e

Editorial fix: format of tables

16.8.1

2021-09

SA#93e

SP-210885

0178

1

F

Remove last occurrences of “-Type” in data type names

16.9.0

2021-09

SA#93e

SP-210885

0179

1

F

Correct definition of the timeTick parameter in the File MnS

16.9.0

2021-09

SA#93e

SP-210885

0180

1

F

Alignment the description for streaming data reporting MnS producer

16.9.0

2021-09

SA#93e

SP-210885

0185

F

Add missing reference for TS 32.404 and RFC 6901

16.9.0

2021-12

SA#94e

SP-211454

0187

1

F

Align the description for generic provisioning MnS

16.10.0

2021-12

SA#94e

SP-211454

0188

F

Fix the incorrect reference of Generic fault supervision management service to TS 32.158

16.10.0

2021-12

SA#94e

SP-211454

0189

F

Fix the incorrect reference of File data reporting service to TS 32.158

16.10.0

2021-12

SA#94e

SP-211454

0190

1

F

Fix the URI description for streaming data report MnS

16.10.0

2021-12

SA#94e

SP-211454

0193

1

F

Correct spelling of notifyAlarmListRebuilt

16.10.0

2022-03

SA#95e

SP-220183

0196

1

B

Add jobId to FileInfo

17.0.0

2022-06

SA#96

SP-220497

0200

A

Correct REST SS of deleteMOI

17.1.0

2022-06

SA#96

SP-220497

0201

F

Align allowed file transfer protocols in stage 2 with stage 1 requirements

17.1.0

2022-06

SA#96

SP-200502

0202

B

Update proMnS yaml file to include the resources-intentNrm

17.1.0

2022-06

SA#96

SP-220497

0205

A

OpenAPI file name and dependence change- part1

17.1.0

2022-06

SA#96

SP-220497

0206

A

OpenAPI file name and dependence change- part2

17.1.0

2022-06

SA#96

SP-220497

0208

1

A

Correct definition of Resource

17.1.0

2022-06

SA#96

SP-220564

0209

1

F

Correct notifyMOIChanges (stage 2)

17.1.0

2022-06

SA#96

SP-220564

0210

1

F

Correct notifyMOIChanges (REST SS)

17.1.0

2022-06

SA#96

SP-220564

0211

1

F

Correct notifyMOIChanges (OpenAPI definitions)

17.1.0

2022-06

SA#96

SP-220564

0213

1

B

Data change notifications YANG-in-Rest format

17.1.0

2022-06

SA#96

SP-220497

0216

A

Fix FileDataType definition in OpenAPI

17.1.0

2022-06

SA#96

CR implementation corrections

17.1.1

2022-09

SA#97e

SP-220849

0219

F

Updating Hysteresis from M to O in notifyThresholdCrossing

17.2.0

2022-09

SA#97e

SP-220858

0221

A

Update provMnS yaml to include resources-coslaNrm

17.2.0

2022-09

SA#97e

SP-220851

0222

F

Update provMnS yaml to include MDA NRM related resources

17.2.0

2022-09

SA#97e

SP-220859

0223

F

Correct notifyMOIChanges handling for YANG leaf-lists

17.2.0

2022-09

SA#97e

Annex A.1.1 aligned with FORGE content

17.2.1

2022-12

SA#98e

SP-221169

0227

1

A

Correct OpenAPI definition of HTTP DELETE

17.3.0

2022-12

SA#98e

SP-221169

0229

1

A

Correct type of observedValue attribute

17.3.0

2022-12

SA#98e

SP-221169

0231

1

A

Correct definition of the HTTP GET response

17.3.0

2022-12

SA#98e

SP-221169

0233

2

A

Add missing definition of the JSON Patch document

17.3.0

2022-12

SA#98e

SP-221169

0235

A

Remove duplicated message flows (REST SS of ProvMnS)

17.3.0

2022-12

SA#98e

SP-221169

0237

2

A

Add introduction clause to the Prov MnS definition

17.3.0

2022-12

SA#98e

SP-221167

0238

1

F

Add missing insert attribute to the data type MoiChange

17.3.0

2022-12

SA#98e

SP-221167

0239

F

Clarify allowed values for href parameter in notifyMOIChanges (NETCONF/YANG)

17.3.0