B.3.3 CMONOperations_1 interface
28.3063GPPControl and monitoring of Power, Energy and Environmental (PEE) parameters Integration Reference Point (IRP)Release 17Solution Set (SS) definitionsTS
B.3.3.1 Description
The semantics of this interface is described in 3GPP TS 28.305 [2] – clause 6.2.3.1.
B.3.3.2 Resource structure and methods
All resource URIs of the API shall use the base URI specification defined in clause XXX. The string "cmonoperations_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 relative to the above base URI.
Figure B.3.3.2.1 shows the overall resource URI structure defined for the CMONOperations_1 interface.
Figure B.3.3.2.1: Resource URI structure of the CMONOperations_1 interface
B.3.3.3 Sequence diagrams (informative)
B.3.3.3.1 Flow of the readMEDescription operation
This clause describes a sequence flow for reading all attribute values of an individual monitored entity.
Figure B.3.3.3.1.1: Flow of the readMEDescription operation
NOTE: In figure B.3.3.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 the NM-RMS, and includes the monitored entity Id and a data structure of type "attNameValueList" in the payload body.
B.3.3.3.2 Flow of the writeMEDescription operation
This clause describes a sequence flow for modifying a list of attribute values of an individual monitored entity.
Figure B.3.3.3.2.1: Flow of the writeMEDescription operation
NOTE: In figure B.3.3.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. Client sends a PATCH request to an individual monitored entity resource, addressed by the appropriate monitored entity identifier in its resource URI, which includes in the payload body a data structure of type "attNameValueList", containing the list of attribute name and value pairs corresponding to attributes to be modified.
2. Server returns a "200 OK" response to the NM-RMS, and includes the monitored entity Id and a data structure of type "attNameValueList" in the payload body, containing the list of attribute name and value pairs corresponding to attributes whose values have been modified.
B.3.3.4 Resources
B.3.3.4.1 Introduction
This clause defines all the resources and methods provided by the CMONOperations_1 interface.
B.3.3.4.2 Resource: Individual monitored entity
B.3.3.4.2.1 Description
This resource represents an individual monitored entity.
B.3.3.4.2.2 Resource definition
B.3.3.4.2.3 Resource methods
B.3.3.4.2.3.1 GET
The client can use this method to get the value of all attributes of an individual monitored entity.
Table B.3.3.4.2.3.1-1: Details of the GET request on this resource
|
Data type |
Cardinality |
Description |
|
meId |
1 |
The Id of the monitored entity. |
Table B.3.3.4.2.3.1-2: Details of the GET response on this resource
|
Data type |
Cardinality |
Response codes |
Description |
|
meId |
1 |
200 OK |
The request was accepted and completed. The response body shall contain the monitored entity Id and attribute name and value pairs for the monitored entity. |
|
AttNameValueList |
1 |
B.3.3.4.2.3.2 PATCH
The client can use this method to write the value of a list of attributes of an individual monitored entity.
Table B.3.3.4.2.3.2-1: Details of the PATCH request on this resource
|
Data type |
Cardinality |
Description |
|
meId |
1 |
The Id of the monitored entity. |
|
AttNameValueList |
1 |
The list of names and values of attributes to be modified. |
Table B.3.3.4.2.3.1-2: Details of the PATCH response on this resource
|
Data type |
Cardinality |
Response codes |
Description |
|
meId |
1 |
200 OK |
The request was accepted and completed. The response body shall contain the monitored entity Id and attribute modifications for themonitored entity. |
|
AttNameValueList |
1 |
B.3.3.5 Data Model
B.3.3.5.1 Introduction
This clause defines the request and response data structures of the CMONOperations_1 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.3.5.2 Resource and notification data types
B.3.3.5.2.1 Introduction
This clause defines the data structures to be used in the resource representations and notifications for the CMONOperations_1 interface.
B.3.3.5.2.2 Type: AttributeNameList
Table B.3.3.5.2.2-1: Definition of the AttributeNameList data type
|
Attribute name |
Data type |
Cardinality |
Description |
|
attributeName |
String |
0..N |
Name of the attribute whose value is queried. |
B.3.3.5.2.3 Type: AttNameValueList
Table B.3.3.5.2.3-1: Definition of the AttNameValueList data type
|
Attribute name |
Data type |
Cardinality |
Description |
|
attributeNameValue |
Structure (inlined) |
0..N |
Pair of name+value of an attribute. |
|
> attributeName |
String |
1 |
Name of the attribute. |
|
> attributeValue |
Any |
1 |
Value of the attribute. |