B.3.4 CMONOperations_2 interface

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

B.3.4.1 Description

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

B.3.4.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 "cmonoperations_2" 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.

Figure B.3.4.3.2.1 shows the overall resource URI structure defined for the CMONOperations_2 interface.

Figure B.3.4.3.2.1: Resource URI structure of the CMONOperations_2 interface

B.3.4.3 Sequence diagrams (informative)

B.3.4.3.1 Flow of the readMEConfiguration operation

This clause describes a sequence flow for reading threshold values of an individual monitored entity instance.

Figure B.3.4.3.1.1: Flow of the readMEConfiguration operation

NOTE: in figure B.3.4.3.1.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. Client sends a GET request to an individual monitored entity resource, addressed by the appropriate monitored entity identifier in its resource URI.

2. Server returns a "200 OK" response to Client, and includes the monitored entity Id and a data structure of type "thresholdNameValueList" in the payload body.

B.3.4.3.2 Flow of the writeMEConfiguration operation

This clause describes a sequence flow for writing threshold values of an individual monitored entity instance.

Figure B.3.4.3.2.1: Flow of the writeMEConfiguration operation

NOTE: in figure B.3.4.3.2.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 Client sends a PUT request to the individual monitored entity instance resource;

2. The Server modifies values of the thresholds of the monitored entity instance resource;

3. The Server returns a “200 OK” response to the Client, with a payload body containing the monitored entity Id and the actual values of the thresholds in a data structure of type “thresholdNameValueList”.

B.3.4.4 Resources

B.3.4.4.1 Introduction

This clause defines all the resources and methods provided by the CMONOperations_2 interface.

B.3.4.4.2 Resource: Individual monitored entity

B.3.4.4.2.1 Description

This resource represents an individual monitored entity.

B.3.4.4.2.2 Resource definition

B.3.4.4.2.3 Resource methods

B.3.4.4.2.3.1 GET

The client can use this method to get the value of all threshold values of an individual monitored entity.

Table B.3.4.4.2.3.1-1: Details of the GET request on this resource

Data type	Cardinality	Description
meId	1	The monitored entity Id.

Table B.3.4.4.2.3.1-2: Details of the GET response on this resource

Data type	Cardinality	Response codes	Description
meId ThresholdNameValueList	1	200 OK	The request was accepted and completed. The response body shall contain the monitored entity Id and threshold name and value pairs of the monitored entity.

B.3.4.4.2.3.2 PUT

The client can use this method to write the value of a list of thresholds of an individual monitored entity.

Table B.3.3.4.2.3.2-1: Details of the PUT request on this resource

Data type	Cardinality	Description
meId	1	The monitored entity Id
ThresholdNameValueList	1	The list of names and values of thresholds to be modified.

Table B.3.4.4.2.3.1-2: Details of the PUT response on this resource

Data type	Cardinality	Response codes	Description
meId ThresholdNameValueList	1	200 OK	The request was accepted and completed. The response body shall contain the monitored entity Id and threshold modifications for the monitored entity.

B.3.4.5 Data Model

B.3.4.5.1 Introduction

This clause defines the request and response data structures of the CMONOperations_2 interface. 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.4.5.2 Resource and notification data types

B.3.4.5.2.1 Introduction

This clause defines the data structures to be used in the resource representations and notifications for the CMONOperations_2 interface.

B.3.4.5.2.2 Type: ThresholdNameValueList

Table B.3.4.5.2.2-1: Definition of the ThresholdNameValueList data type

Attribute name	Data type	Cardinality	Description
thresholdNameValue	Structure (inlined)	0..N	Pair of name+value of a threshold.
> thresholdName	String	1	Name of the threshold.
> thresholdValue	Any	1	Value of the threshold.