Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand



Req/usecase

REST

Method

 URI

Request/Response Example
1Get all cmhandles that support a given
module
POST{ncmpRoot}/ncmp/v1/ch/searches

Scenario : Get the all cmhandles that support a given module
URI :  {ncmpRoot}/ncmp/v1/ch/searches

Request Body

{
  "modules": {
    "module-name": "some-module"
  }
}

Header :
Accept: application/json
Response:
{
cmHandles : [ "ew534fe", "23ft4", "434fsdf", ... ]
}
2Request (trigger) Data SyncPOST

{ncmpRoot}/ncmp/v1/ch/<cmHandle>/syncData

Scenario : Client requests to sync a node

URI : {ncmpRoot}/ncmp/v1/ch/node123/syncData

Response   : HTTP-Status code (only, no body)

3Get model info for CMHandleGET

{ncmpRoot}/ncmp/v1/ch/{cmHandle}/modules

Scenario : Get the model data for CMHandle

URI :{ncmpRoot}/ncmp/v1/ch/2334dedf/modules

Header :
      Accept: application/yang-data+json

Response:

{
  
"ietf-yang-library:modules-set" : [ # from RFC 8525
{
"name" : "5479120c17a619545ea6aff7aa19838b036ebbd7",
[
        {
    
"module"
 
:
 
[
{
      "
name
moduleName"
: "
_3gpp-nr-nrm-nrsectorcarrier",
"revision" : "2020-12-09",
"namespace" : "urn:3gpp:sa5:_3gpp-nr-nrmnrnetwork-nrsectorcarrier",
"location" : "http://emsadapter.com/modules/_3gppnr-nrm-nrsectorcarrier",
"submodule" : [
{
"name" : "xxxx-module",
"revision" : "2020-12-17",
nc-notifications",
            "
namespace
revision"
: "
urn:3gpp:sa5:xxx-module
2008-07-14",


        
"submodule" : [
},
        {
  
{
          
...
"moduleName": "ietf-tls-server",
       
}
     "revision": "2016-11-02",
  
]
      }

,
      
]
  {
  
},
    
{
      "
name
moduleName"
: "ietf-
yang
ssh-
library
server",


            "revision"
: "2016-
06
11-
21
02",


    
"namespace" : "urn:ietf:params:xml:ns:yang:ietfyang-library"
    }


    ]

}



NCMP / DMI Overview

Expand

draw.io Diagram
bordertrue
diagramNameNCMP Northbound REST API
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth971
revision8

...