B.3.6 CMONNotifications_1 interface

28.3063GPPControl and monitoring of Power, Energy and Environmental (PEE) parameters Integration Reference Point (IRP)Release 17Solution Set (SS) definitionsTS

B.3.6.0 Introduction

The semantics of this interface is described in 3GPP TS 28.305 [2] – clause 6.2.6.

B.3.6.1 notifyMeasurementData notification

B.3.6.1.1 Description

The semantics of this notification is described in 3GPP TS 28.305 [2] – clause 6.2.6.1.

B.3.6.1.2 Resource structure and attributes

All resource URIs of the API shall use the base URI specification defined in clause B.3.10. The string "cmonnotifications_1" shall be used to represent {apiName}. The {apiVersion} shall be set to "v1" for the present document. All resource URIs in the clauses below are defined relatively to the above base URI.

NOTE: This version of the specification does not define how the Client URL is provisioned to the Server.

B.3.6.1.3 Flow of the notifyMeasurementData notification

This clause describes a sequence flow for notifying measurement data.

Figure B.3.6.1.3.1: Flow of the notifyMeasurementData notification

NOTE: in figure B.3.6.1.3.1, the Client is the NM-RMS and the Server can be the XCU/DGU or VS-RMS or DM/EM.

This operation consists of the following steps:

1. The Server generates a notification which includes measurement data, and sends it in the body of a POST request to the Client URI;

2. The Client acknowledges the successful delivery of the notification by returning a “204 No Content” response.

B.3.6.1.4 Resource: notification endpoint
B.3.6.1.4.1 Description

This resource represents a notification endpoint. The Server can use this resource to send notifications to the Client, which has provided the URI of this resource.

B.3.6.1.4.2 Resource definition

The resource URI has been provided by the Client.

B.3.6.1.4.3 Resource method: POST

The Server can use this method to send a notification to the Client.

Table B.3.6.1.4.3-1: Details of the POST request on this resource

Data type

Cardinality

Description

NotificationHeader

1

The header of the notification.

MeasDataCollection

1

The collection of measurement data.

Table B.3.6.1.4.3-2: Details of the POST response on this resource

Data type

Cardinality

Response codes

Description

None

204

The notification was delivered successfully.

B.3.6.1.5 Data Model
B.3.6.1.5.1 Introduction

This clause defines the request and response data structures of the notifyMeasurementData notification. If a request or response contains attributes not defined in the present document, a receiving functional block that does not understand these attributes shall not treat their presence as an error, and may choose to ignore them.

B.3.6.1.5.2 Data Type: NotificationHeader

Table B.3.6.1.5.2-1: Definition of the NotificationHeader data type

Attribute name

Data type

Cardinality

Description

notificationId

Identifier

1

Identifier of the notification instance.

notificationType

String

1

The type of notification (=”MeasDataNotification”).

senderInfo

Structure

(inlined)

1

Information about the sender of the notification.

>senderName

String

1

The name of the sender.

>senderType

String

1

The type of the sender.

>vendorName

String

1

The name of the vendor of the sender.

B.3.6.1.5.3 Data Type: MeasDataCollection

Table B.3.6.1.5.3-1: Definition of the MeasDataCollection data type

Attribute name

Data type

Cardinality

Description

MeasHeader

Structure

(inlined)

1

The measurement header.

>measFormatVersion

String

1

The format version of the measurement data collection

>collectionBeginTime

DateTime

1

The start of the measurement collection interval (granularity period) for the collected measurement data.

>jobId

Identifier

1

The identifier of the cmonpmjob thanks to which these measurement data are collected.

MeasData

Structure

(inlined)

1..N

The measurement data.

>mEId

Identifier

Identifier of the monitored entity instance

>measInfo

Structure

(inlined)

1..N

The sequence of measurements, values and related information.

>>measName

String

1

The name of the measurement

>>measValue

Any

1

The value of the measurement

MeasFooter

Structure

(inlined)

1

The measurement footer.

>collectionEndTime

DateTime

1

The end of the measurement collection interval (granularity period) for the collected measurement data.