B.3.5 CMONOperations_3 interface

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

Tools: ARFCN - Frequency Conversion for 5G NR/LTE/UMTS/GSM

B.3.5.0 Introduction

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

B.3.5.1 createCMONPMJob operation

B.3.5.1.1 Description

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

B.3.5.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 "cmonoperations_3" 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 relative to the above base URI.

Figure B.3.5.1.2.1 shows the overall resource URI structure defined for the createCMONPMJob operation.

Figure B.3.5.1.2.1: Resource URI structure of the createCMONPMJob operation

B.3.5.1.3 Flow of the createCMONPMJob operation

This clause describes a sequence flow for creating an individual cmonpmjob instance.

Figure B.3.5.1.3.1: Flow of the createCMONPMJob operation

NOTE: in figure B.3.4.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 Client sends a POST request to the cmonpmjobs resource, including in the payload body a data structure of type “Createcmonpmjobparamaters”;

2. The Server creates a new Cmonpmjob instance, and the associated Cmonpmjob instance identifier;

3. The Server returns a “201 Created” response to the Client, containing a representation of the Cmonpmjob instance resource just created by the Server, and provides the URI of the newly created resource in the “Location” HTTP header.

B.3.5.1.4 Resource: cmonpmjobs

B.3.5.1.4.1 Description

This resource represents cmonpmjobs. The client can use this resource to request the creation of a new instance of cmonpmjob.

B.3.5.1.4.2 Resource definition

The resource URI is: {apiRoot}/cmonoperations_3/v1/cmonpmjobs

B.3.5.1.4.3 Resource method: POST

The client can use this method to create an individual cmonpmjob instance.

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

Data type	Cardinality	Description
MeIdList	1	The list of mEIds of PEEMonitoredEntity instances on which measurements are to be collected.
MeasurementNameList	1	The list of names of measurements to be collected.
GranularityPeriod	1	The granularity period.

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

Data type	Cardinality	Response codes	Description
CmonPmJobId	1	201 Created (cmonpmjobid)	The request was accepted. The new instance of cmonpmjob is created by Server and its Id is sent to Client.

B.3.5.1.5 Data Model

B.3.5.1.5.1 Introduction

This clause defines the request and response data structures of the createCMONPMJob operation. 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.5.1.5.2 Data Type: MeIdList

Table B.3.5.1.5.2-1: Definition of the MeIdList data type

Attribute name	Data type	Cardinality	Description
mEId	Identifier	1..N	Identifier of monitored entity instance.

B.3.5.1.5.3 Data Type: MeasurementNameList

Table B.3.5.1.5.3-1: Definition of the MeasurementNameList data type

Attribute name	Data type	Cardinality	Description
measurementName	String	1..N	Name of the the measurement. It shall correspond to an attribute name of PEEMeasurementData.

B.3.5.1.5.4 Data Type: GranularityPeriod

Table B.3.5.1.5.4-1: Definition of the GranularityPeriod data type

Attribute name	Data type	Cardinality	Description
granularityPeriod	Integer	1	It specifies the period between two successive measurements. Expressed in munutes.

B.3.5.1.5.5 Data Type: ServerJobId

Table B.3.5.1.5.6-1: Definition of the CmonPmJobId data type

Attribute name	Data type	Cardinality	Description
cmonmjobid	Identifier	1	Identifier of cmonpmjob instance, assigned by Server.

B.3.5.2 stopCMONPMJob operation

B.3.5.2.1 Description

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

B.3.5.2.2 Resource structure and attributes

Figure B.3.5.2.2.1 shows the overall resource URI structure defined for the stopCMONPMJob operation.

Figure B.3.5.2.2.1: Resource URI structure of the stopCMONPMJob operation

B.3.5.2.3 Flow of the stopCMONPMJob operation

This clause describes a sequence flow for stopping an individual cmonpmjob.

Figure B.3.5.2.3.1: Flow of the stopCMONPMJob operation

NOTE: in figure B.3.5.2.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 Client sends a DELETE request to the individual cmonpmjob instance resource;

2. The Server deletes the cmonpmjob instance resource, and the associated cmonpmjob instance identifier;

3. The Server returns a “204 No Content” response to the Client, with an empty payload body.

B.3.5.2.4 Resource: individual cmonpmjob instance

B.3.5.2.4.1 Description

This resource represents an individual cmonpmjob instance.

B.3.5.2.4.2 Resource definition

The resource URI is: {apiRoot}/cmonoperations_3/v1/cmonpmjobs/{cmonpmjobId}

B.3.5.2.4.3 Resource method: DELETE

The client can use this method to delete an individual cmonpmjob instance.

Table B.3.5.2.4.3-1: Details of the DELETE request on this resource

Data type	Cardinality	Description
CmonPmJobId	1	The Id of the cmonpmjob instance.

Table B.3.5.2.4.3-2: Details of the DELETE response on this resource

Data type	Cardinality	Response codes	Description
N/A		204	The request was accepted. The cmonpmjob instance is deleted by Server.

B.3.5.2.5 Data Model

B.3.5.2.5.1 Introduction

This clause defines the request and response data structures of the stopCMONPMJob operation. 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.5.2.5.2 Data Type: CmonPmJobId

Table B.3.5.2.5.2-1: Definition of the CmonPmJobId data type

Attribute name	Data type	Cardinality	Description
cmonpmjobid	Identifier	1	Identifier of a cmonpmjob instance.