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:

  [
        {
            "moduleName": "nc-notifications",
            "revision": "2008-07-14",
        },
        {
            "moduleName": "ietf-tls-server",
            "revision": "2016-11-02",
        },
        {
            "moduleName": "ietf-ssh-server",
            "revision": "2016-11-02",
        }
    ]


...