...
<OP> ncmp / <v{v-number}> / cm-handle /<cmhandle> /<data|operations|{ncmp-action}> /ds/{datastore} / <resource-path> ? <query>
| URI | Mandatory or Optional | |
|---|---|---|
| <OP> | method | Mandatory |
| ncmp / | entry | Mandatory |
| <v{v-number}> | version | Mandatory |
| cm-handle /<cm-handle> | cm-handle | Optional |
| <data|operations|{ncmp-action}> | request category | Mandatory |
| ds/{datastore} | datastore | Optional |
| <resource-path> | resource | Optional |
| <query> | query | Optional |
where:
<OP> : the HTTP method
...
The new ncmp datastores required for ONAP Release I include :
| ncmp-datastores:running (RW) | Read/Write to the CPS "intended" store (with validation). Then do subsequent write on DMI interface with ds ietf-datastores:running. |
| ncmp-datastores:operational (RO) | Read from the CPS "operational" store. |
| ncmp-datastores:passthrough-running (RW) | Read/Write to/from the live devices ietf-datastores:running (no local ncmp validation) |
Future datastores to be supported by NCMP include :
| ncmp-datastores:passthrough-intented (RO) | Read from the live devices ietf-datastores:intended ncmp-datastores:passthrough-operational (RO) : Read from the live devices ietf-datastores:operational |
| ncmp-datastores:passthrough-candidate (RW) | Read from the live devices ietf-datastores:candidate |
If datastore (ds/{datastore}) is omitted from URI AND the model/moduleSet is not available in NCMP, the datastore is defaulted to ncmp-datastores: passthrough-running
...
Yang data resource actions and RPC operations are run directly on the 'device' meaning ncmp-datastores:passthrough-running is used for these request
| Req/usecase | REST Method | URI / Payload | Header Parameters | Request/Response Example | Status | |
|---|---|---|---|---|---|---|
| 1 | NCMP-CM-001-1 Get model (module set) for CMHandle | GET | {ncmp-root}/ncmp/v1/model/<handleId> {ncmp-root}/ncmp/v1/model/cm-handle/<cm-handle> | Accept: application/ yang- data+json | Scenario : Get the model data for CMHandle with id "335ff" Response : | Under Review |
| 2 | NCMP-CM-001-4 Create a data resource for a cmhandle | POST | {ncmp-root}/ncmp/v1/cm-handle/<cmhandle>/ds
| Accept: application/ yang- data+json | Scenario : Create nrsectorcarrier-vdu-add:NRSectorCarrier=4 under_3gpp-common-managed-element:ManagedElement=Kista-001/_3gpp-nr-nrm-gnbdufunction:GNBDUFunction=1 | Under Review |
| 3 | ||||||
| 4 | ||||||
| 5 |