3 title: NCMP to CPS Proxy API
4 description: NCMP to CPS Proxy API
9 /v1/cm-handles/{cm-handle}/node:
13 summary: Get a node given a cm Handle and xpath
14 description: Get a node with an option to retrieve all the children for a given
16 operationId: getNodeByCmHandleAndXpath
20 description: "The identifier for a network function, network element, subnetwork\
21 \ or any other cm object by managed Network CM Proxy"
32 - name: include-descendants
34 description: include-descendants
47 description: Bad Request
51 $ref: '#/components/schemas/ErrorMessage'
53 description: Unauthorized
57 $ref: '#/components/schemas/ErrorMessage'
59 description: Forbidden
63 $ref: '#/components/schemas/ErrorMessage'
65 description: The specified resource was not found
69 $ref: '#/components/schemas/ErrorMessage'
71 /v1/cm-handles/{cm-handle}/list-node:
75 summary: Add list-node child element(s)
76 description: Add one or more list-node child elements under existing node for
78 operationId: addListNodeElements
82 description: "The identifier for a network function, network element, subnetwork\
83 \ or any other cm object by managed Network CM Proxy"
104 description: Bad Request
108 $ref: '#/components/schemas/ErrorMessage'
110 description: Unauthorized
114 $ref: '#/components/schemas/ErrorMessage'
116 description: Forbidden
120 $ref: '#/components/schemas/ErrorMessage'
122 description: The specified resource was not found
126 $ref: '#/components/schemas/ErrorMessage'
128 /v1/cm-handles/{cm-handle}/nodes/query:
132 summary: Query data nodes
133 description: Query nodes for the given cps path and cm Handle
134 operationId: queryNodesByCmHandleAndCpsPath
138 description: "The identifier for a network function, network element, subnetwork\
139 \ or any other cm object by managed Network CM Proxy"
145 description: cps-path
150 - name: include-descendants
152 description: include-descendants
165 description: Bad Request
169 $ref: '#/components/schemas/ErrorMessage'
171 description: Unauthorized
175 $ref: '#/components/schemas/ErrorMessage'
177 description: Forbidden
181 $ref: '#/components/schemas/ErrorMessage'
183 description: The specified resource was not found
187 $ref: '#/components/schemas/ErrorMessage'
189 /v1/cm-handles/{cm-handle}/nodes:
193 summary: Replace a node with descendants
194 description: Replace a node with descendants for the given cps path and cm Handle
195 operationId: replaceNode
199 description: "The identifier for a network function, network element, subnetwork\
200 \ or any other cm object by managed Network CM Proxy"
225 description: Bad Request
229 $ref: '#/components/schemas/ErrorMessage'
231 description: Unauthorized
235 $ref: '#/components/schemas/ErrorMessage'
237 description: Forbidden
241 $ref: '#/components/schemas/ErrorMessage'
243 description: The specified resource was not found
247 $ref: '#/components/schemas/ErrorMessage'
252 summary: Create a node with descendants
253 description: Create a node with descendants for the given CM Handle; top level
254 or under existing node (requires xpath)
255 operationId: createNode
259 description: "The identifier for a network function, network element, subnetwork\
260 \ or any other cm object by managed Network CM Proxy"
282 description: Bad Request
286 $ref: '#/components/schemas/ErrorMessage'
288 description: Unauthorized
292 $ref: '#/components/schemas/ErrorMessage'
294 description: Forbidden
298 $ref: '#/components/schemas/ErrorMessage'
300 description: The specified resource was not found
304 $ref: '#/components/schemas/ErrorMessage'
309 summary: Update node leaves
310 description: Update node leaves for the given cps path and cm Handle
311 operationId: updateNodeLeaves
315 description: "The identifier for a network function, network element, subnetwork\
316 \ or any other cm object by managed Network CM Proxy"
341 description: Bad Request
345 $ref: '#/components/schemas/ErrorMessage'
347 description: Unauthorized
351 $ref: '#/components/schemas/ErrorMessage'
353 description: Forbidden
357 $ref: '#/components/schemas/ErrorMessage'
359 description: The specified resource was not found
363 $ref: '#/components/schemas/ErrorMessage'
365 /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-operational:
369 summary: Get resource data from pass-through operational for cm handle
370 description: Get resource data from pass-through operational for given cm handle
371 operationId: getResourceDataOperationalForCmHandle
375 description: "The identifier for a network function, network element, subnetwork\
376 \ or any other cm object by managed Network CM Proxy"
380 - name: resourceIdentifier
382 description: The format of resource identifier depend on the associated DMI
383 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
384 it can really be anything.
392 resourceIdentifier: \parent\child
395 resourceIdentifier: "\\parent\\listElement[key=value]"
398 resourceIdentifier: "\\parent\\listElement[key=value]\\grandChild"
401 resourceIdentifier: "parent=1,child=abc"
404 description: "Accept parameter for response, if accept parameter is null,\
405 \ that means client can accept any format."
411 - application/yang-data+json
414 description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
415 \ in parenthesis'()'."
423 options: "(key1=value1,key2=value2)"
426 options: "(key1=value1,key2=value1/value2)"
429 options: "(key1=10,key2=value2,key3=[val31;val32])"
438 description: Bad Request
442 $ref: '#/components/schemas/ErrorMessage'
444 description: Unauthorized
448 $ref: '#/components/schemas/ErrorMessage'
450 description: Forbidden
454 $ref: '#/components/schemas/ErrorMessage'
456 description: The specified resource was not found
460 $ref: '#/components/schemas/ErrorMessage'
461 /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-running:
465 summary: Get resource data from pass-through running for cm handle
466 description: Get resource data from pass-through running for given cm handle
467 operationId: getResourceDataRunningForCmHandle
471 description: "The identifier for a network function, network element, subnetwork\
472 \ or any other cm object by managed Network CM Proxy"
476 - name: resourceIdentifier
478 description: The format of resource identifier depend on the associated DMI
479 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
480 it can really be anything.
488 resourceIdentifier: \parent\child
491 resourceIdentifier: "\\parent\\listElement[key=value]"
494 resourceIdentifier: "\\parent\\listElement[key=value]\\grandChild"
497 resourceIdentifier: "parent=1,child=abc"
500 description: "Accept parameter for response, if accept parameter is null,\
501 \ that means client can accept any format."
507 - application/yang-data+json
510 description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
511 \ in parenthesis'()'."
519 options: "(key1=value1,key2=value2)"
522 options: "(key1=value1,key2=value1/value2)"
525 options: "(key1=10,key2=value2,key3=[val31;val32])"
534 description: Bad Request
538 $ref: '#/components/schemas/ErrorMessage'
540 description: Unauthorized
544 $ref: '#/components/schemas/ErrorMessage'
546 description: Forbidden
550 $ref: '#/components/schemas/ErrorMessage'
552 description: The specified resource was not found
556 $ref: '#/components/schemas/ErrorMessage'
560 summary: create resource data from pass-through running for cm handle
561 description: create resource data from pass-through running for given cm handle
562 operationId: createResourceDataRunningForCmHandle
566 description: "The identifier for a network function, network element, subnetwork\
567 \ or any other cm object by managed Network CM Proxy"
571 - name: resourceIdentifier
573 description: The format of resource identifier depend on the associated DMI
574 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
575 it can really be anything.
583 resourceIdentifier: \parent\child
586 resourceIdentifier: "\\parent\\listElement[key=value]"
589 resourceIdentifier: "\\parent\\listElement[key=value]\\grandChild"
592 resourceIdentifier: "parent=1,child=abc"
595 description: "Content parameter for request, if content parameter is null,\
596 \ default value is application/json."
600 default: application/json
606 application/yang-data+json:
615 description: Bad Request
619 $ref: '#/components/schemas/ErrorMessage'
621 description: Unauthorized
625 $ref: '#/components/schemas/ErrorMessage'
627 description: Forbidden
631 $ref: '#/components/schemas/ErrorMessage'
633 description: The specified resource was not found
637 $ref: '#/components/schemas/ErrorMessage'
638 /v1/ch/{cm-handle}/modules:
642 summary: Fetch all module references (name and revision) for a given cm handle
643 description: fetch all module references (name and revision) for a given cm
645 operationId: getModuleReferencesByCmHandle
649 description: "The identifier for a network function, network element, subnetwork\
650 \ or any other cm object by managed Network CM Proxy"
662 description: Bad Request
666 $ref: '#/components/schemas/ErrorMessage'
668 description: Unauthorized
672 $ref: '#/components/schemas/ErrorMessage'
674 description: Forbidden
678 $ref: '#/components/schemas/ErrorMessage'
680 description: The specified resource was not found
684 $ref: '#/components/schemas/ErrorMessage'