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'
369 summary: DMI notifies NCMP of new CM Handles
370 description: "Register a DMI Plugin with any new, updated or removed CM Handles."
371 operationId: updateDmiPluginRegistration
376 $ref: '#/components/schemas/RestDmiPluginRegistration'
383 description: Bad Request
387 $ref: '#/components/schemas/ErrorMessage'
389 description: Unauthorized
393 $ref: '#/components/schemas/ErrorMessage'
395 description: Forbidden
399 $ref: '#/components/schemas/ErrorMessage'
400 /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-operational/{resourceIdentifier}:
404 summary: Get resource data from pass-through operational for cm handle
405 description: Get resource data from pass-through operational for given cm handle
406 operationId: getResourceDataOperationalForCmHandle
410 description: "The identifier for a network function, network element, subnetwork\
411 \ or any other cm object by managed Network CM Proxy"
415 - name: resourceIdentifier
417 description: Resource identifier to get/set the resource data
423 description: "Accept parameter for response, if accept parameter is null,\
424 \ that means client can accept any format."
430 - application/yang-data+json
433 description: Fields parameter to filter resource
439 description: Depth parameter for response
452 description: Bad Request
456 $ref: '#/components/schemas/ErrorMessage'
458 description: Unauthorized
462 $ref: '#/components/schemas/ErrorMessage'
464 description: Forbidden
468 $ref: '#/components/schemas/ErrorMessage'
470 description: The specified resource was not found
474 $ref: '#/components/schemas/ErrorMessage'
475 /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-running/{resourceIdentifier}:
479 summary: Get resource data from pass-through running for cm handle
480 description: Get resource data from pass-through running for given cm handle
481 operationId: getResourceDataRunningForCmHandle
485 description: "The identifier for a network function, network element, subnetwork\
486 \ or any other cm object by managed Network CM Proxy"
490 - name: resourceIdentifier
492 description: Resource identifier to get/set the resource data
498 description: "Accept parameter for response, if accept parameter is null,\
499 \ that means client can accept any format."
505 - application/yang-data+json
508 description: Fields parameter to filter resource
514 description: Depth parameter for response
527 description: Bad Request
531 $ref: '#/components/schemas/ErrorMessage'
533 description: Unauthorized
537 $ref: '#/components/schemas/ErrorMessage'
539 description: Forbidden
543 $ref: '#/components/schemas/ErrorMessage'
545 description: The specified resource was not found
549 $ref: '#/components/schemas/ErrorMessage'
553 summary: create resource data from pass-through running for cm handle
554 description: create resource data from pass-through running for given cm handle
555 operationId: createResourceDataRunningForCmHandle
559 description: "The identifier for a network function, network element, subnetwork\
560 \ or any other cm object by managed Network CM Proxy"
564 - name: resourceIdentifier
566 description: Resource identifier to get/set the resource data
572 description: "Content parameter for request, if content parameter is null,\
573 \ default value is application/json."
577 default: application/json
583 application/yang-data+json:
592 description: Bad Request
596 $ref: '#/components/schemas/ErrorMessage'
598 description: Unauthorized
602 $ref: '#/components/schemas/ErrorMessage'
604 description: Forbidden
608 $ref: '#/components/schemas/ErrorMessage'
610 description: The specified resource was not found
614 $ref: '#/components/schemas/ErrorMessage'
627 RestDmiPluginRegistration:
632 example: onap-dmi-plugin
636 $ref: '#/components/schemas/RestCmHandle'
640 $ref: '#/components/schemas/RestCmHandle'
654 $ref: '#/components/schemas/RestCmHandleAdditionalProperties'
655 RestCmHandleAdditionalProperties:
657 additionalProperties: