| # | Use Case | Rest Method | Service | URI | Example |
|---|
| 1 | DMI notifies NCMP of new , deleted or changed cmhandles DMI Plugin NCMP. Including initial registration | POST json attributes: - "dmi-plugin" resolvable servicename
- "createdcmhandles" used for initial cm handle registrations or subsequent
cmhandle creations - "updatedcmhandles"
Used for updates to cmhandles. Same structure as for create handles
- "removedcmhandles" array of cmhandles that have been deleted
from the network (no additional properties
| NCMP | {ncmp-root}/ncmp/v1/ch/ | Scenario : DMI notifies NCMP of new cmhandles
Method : POST
URI : {ncmp-root}/ncmp/v1/ch/
Header :
Content-Type: application/json
Body : {
"dmi-plugin" : "onap.dmi.plugin",
"createdcmhandles" : [ { "cmhandle" : "rf4er5454",
"additionalProperties" :
{ "subsystemId" : "system-001" }
}, {..} ],
"updatedcmhandles" : [ .. ],
"removedcmhandles" : [ "node-1", "node-2" , ... ]
} |
| 2 | Get all the registered cmhandles for a
given plugin | GET | NCMP | {ncmp-root}/ncmp/v1/dmi-plugins/{plugin-id}/ch | Scenario : Get all cmhandles from NCMP for a given dmi-plugin. May be used
for conciliation
Method : GET
URI : {ncmp-root}/ncmp/v1/dmi-plugins/{dmi-plugin}/ch
Header :
Content-Type: application/json
Success Response :
HTTP/1.1 200 Ok
Date: Thu, 26 Jan 2021 20:56:30 GMT
Server: example-server
{ "cmhandles" : [ {
"cmhandle" : "node-1",
"additionalProperties" : [ "subSystem" : "system-001" ]
} ]
} |
| 3 | Get model (schema set) for cmhandle | GET | DMI-Plugin | {ncmp-root}/ncmp/v1/dmi-plugins/{plugin-id}/ch/<cm-handle>/schema-sets/{schema-set-name} | Scenario : NCMP requests a list of modules for a cmhandle
Method : PUT
URI : {dmi-root}/dmi/v1/ch/cm-handle-001/schema-sets/cps-ran-schema-model
Header :
Content-Type: application/json
Response:
{
"name": "cps-ran-schema-model",
"cmHandle": "cm-handle-001",
"moduleReferences": [
{
"name": "cps-ran-schema-model",
"namespace": "org:onap:ccsdk:features:sdnr:northbound:cps-ran-schema-model",
"revision": "2021-01-28"
},
{
"name": "ietf-inet-types",
"namespace": "urn:ietf:params:xml:ns:yang:ietf-inet-types",
"revision": "2013-07-15"
},
{
"name": "ietf-yang-types",
"namespace": "urn:ietf:params:xml:ns:yang:ietf-yang-types",
"revision": "2013-07-15"
}
]
} |
| 4 | Get yang module for a list of modules | POST | DMI-Plugin | {dmi-root}/dmi/v1/model/ch/<cmhandle> | Body : { [ "org:onap:cps:test:store:2020-12-09??", "org:onap:cps:test:bookstorestore" ] }
response
Response : a list yang module sources
{
"org:onap:cps:test:store" : [
{
"module" : [ {
"name" : "books",
"module" : [
{
"name" : "books",
"revision" : "2020-12-09",
"namespace" : "org:onap:cps:test:bookstore",
"module-content" : "paper back",
"submodule" : [
{
"name" : "Fiction",
"revision" : "2020-12-17",
"namespace" : "org:onap:cps:test:fiction",
]
....
} |
