3 title: NCMP to CPS Proxy API
4 description: NCMP to CPS Proxy API
9 /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-operational:
13 summary: Get resource data from pass-through operational for cm handle
14 description: Get resource data from pass-through operational for given cm handle
15 operationId: getResourceDataOperationalForCmHandle
19 description: "The identifier for a network function, network element, subnetwork\
20 \ or any other cm object by managed Network CM Proxy"
25 - name: resourceIdentifier
27 description: The format of resource identifier depend on the associated DMI
28 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
29 it can really be anything.
37 resourceIdentifier: \shops\bookstore
40 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
43 resourceIdentifier: "parent=shops,child=bookstore"
46 description: "Accept parameter for response, if accept parameter is null,\
47 \ that means client can accept any format."
53 - application/yang-data+json
56 description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
57 \ in parenthesis'()'. The format of options parameter depend on the associated\
58 \ DMI Plugin implementation."
69 options: (fields=book)
72 options: "(depth=2,fields=book/authors)"
82 $ref: '#/components/examples/dataSampleResponse'
84 description: Bad Request
88 $ref: '#/components/schemas/ErrorMessage'
90 status: 400 BAD_REQUEST
91 message: Bad request error message
92 details: Bad request error details
94 description: Unauthorized
98 $ref: '#/components/schemas/ErrorMessage'
101 message: Unauthorized error message
102 details: Unauthorized error details
104 description: Forbidden
108 $ref: '#/components/schemas/ErrorMessage'
111 message: Forbidden error message
112 details: Forbidden error details
114 description: Internal Server Error
118 $ref: '#/components/schemas/ErrorMessage'
121 message: Internal Server Error
122 details: Internal Server Error occurred
123 /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-running:
127 summary: Get resource data from pass-through running for cm handle
128 description: Get resource data from pass-through running for given cm handle
129 operationId: getResourceDataRunningForCmHandle
133 description: "The identifier for a network function, network element, subnetwork\
134 \ or any other cm object by managed Network CM Proxy"
138 example: my-cm-handle
139 - name: resourceIdentifier
141 description: The format of resource identifier depend on the associated DMI
142 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
143 it can really be anything.
151 resourceIdentifier: \shops\bookstore
154 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
157 resourceIdentifier: "parent=shops,child=bookstore"
160 description: "Accept parameter for response, if accept parameter is null,\
161 \ that means client can accept any format."
167 - application/yang-data+json
170 description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
171 \ in parenthesis'()'. The format of options parameter depend on the associated\
172 \ DMI Plugin implementation."
183 options: (fields=book)
186 options: "(depth=2,fields=book/authors)"
196 $ref: '#/components/examples/dataSampleResponse'
198 description: Bad Request
202 $ref: '#/components/schemas/ErrorMessage'
204 status: 400 BAD_REQUEST
205 message: Bad request error message
206 details: Bad request error details
208 description: Unauthorized
212 $ref: '#/components/schemas/ErrorMessage'
215 message: Unauthorized error message
216 details: Unauthorized error details
218 description: Forbidden
222 $ref: '#/components/schemas/ErrorMessage'
225 message: Forbidden error message
226 details: Forbidden error details
228 description: Internal Server Error
232 $ref: '#/components/schemas/ErrorMessage'
235 message: Internal Server Error
236 details: Internal Server Error occurred
240 summary: Update resource data from pass-through running for a cm handle
241 description: Update resource data from pass-through running for the given cm
243 operationId: updateResourceDataRunningForCmHandle
247 description: "The identifier for a network function, network element, subnetwork\
248 \ or any other cm object by managed Network CM Proxy"
252 example: my-cm-handle
253 - name: resourceIdentifier
255 description: The format of resource identifier depend on the associated DMI
256 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
257 it can really be anything.
265 resourceIdentifier: \shops\bookstore
268 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
271 resourceIdentifier: "parent=shops,child=bookstore"
274 description: "Content parameter for request, if content parameter is null,\
275 \ default value is application/json."
279 example: application/yang-data+json
280 default: application/json
288 $ref: '#/components/examples/dataSampleRequest'
289 application/yang-data+json:
294 $ref: '#/components/examples/dataSampleRequest'
304 description: Bad Request
308 $ref: '#/components/schemas/ErrorMessage'
310 status: 400 BAD_REQUEST
311 message: Bad request error message
312 details: Bad request error details
314 description: Unauthorized
318 $ref: '#/components/schemas/ErrorMessage'
321 message: Unauthorized error message
322 details: Unauthorized error details
324 description: Forbidden
328 $ref: '#/components/schemas/ErrorMessage'
331 message: Forbidden error message
332 details: Forbidden error details
334 description: Internal Server Error
338 $ref: '#/components/schemas/ErrorMessage'
341 message: Internal Server Error
342 details: Internal Server Error occurred
346 summary: create resource data from pass-through running for cm handle
347 description: create resource data from pass-through running for given cm handle
348 operationId: createResourceDataRunningForCmHandle
352 description: "The identifier for a network function, network element, subnetwork\
353 \ or any other cm object by managed Network CM Proxy"
357 example: my-cm-handle
358 - name: resourceIdentifier
360 description: The format of resource identifier depend on the associated DMI
361 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
362 it can really be anything.
370 resourceIdentifier: \shops\bookstore
373 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
376 resourceIdentifier: "parent=shops,child=bookstore"
379 description: "Content parameter for request, if content parameter is null,\
380 \ default value is application/json."
384 example: application/yang-data+json
385 default: application/json
393 $ref: '#/components/examples/dataSampleRequest'
394 application/yang-data+json:
399 $ref: '#/components/examples/dataSampleRequest'
406 description: Bad Request
410 $ref: '#/components/schemas/ErrorMessage'
412 status: 400 BAD_REQUEST
413 message: Bad request error message
414 details: Bad request error details
416 description: Unauthorized
420 $ref: '#/components/schemas/ErrorMessage'
423 message: Unauthorized error message
424 details: Unauthorized error details
426 description: Forbidden
430 $ref: '#/components/schemas/ErrorMessage'
433 message: Forbidden error message
434 details: Forbidden error details
436 description: Internal Server Error
440 $ref: '#/components/schemas/ErrorMessage'
443 message: Internal Server Error
444 details: Internal Server Error occurred
448 summary: Delete resource data
449 description: Delete resource data from pass-through running for a given cm handle
450 operationId: deleteResourceDataRunningForCmHandle
454 description: "The identifier for a network function, network element, subnetwork\
455 \ or any other cm object by managed Network CM Proxy"
459 example: my-cm-handle
460 - name: resourceIdentifier
462 description: The format of resource identifier depend on the associated DMI
463 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
464 it can really be anything.
472 resourceIdentifier: \shops\bookstore
475 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
478 resourceIdentifier: "parent=shops,child=bookstore"
481 description: "Content parameter for request, if content parameter is null,\
482 \ default value is application/json."
486 example: application/yang-data+json
487 default: application/json
490 description: No Content
493 description: Bad Request
497 $ref: '#/components/schemas/ErrorMessage'
499 status: 400 BAD_REQUEST
500 message: Bad request error message
501 details: Bad request error details
503 description: Unauthorized
507 $ref: '#/components/schemas/ErrorMessage'
510 message: Unauthorized error message
511 details: Unauthorized error details
513 description: Forbidden
517 $ref: '#/components/schemas/ErrorMessage'
520 message: Forbidden error message
521 details: Forbidden error details
523 description: The specified resource was not found
527 $ref: '#/components/schemas/ErrorMessage'
530 message: Not found error message
531 details: Not found error details
533 description: Internal Server Error
537 $ref: '#/components/schemas/ErrorMessage'
540 message: Internal Server Error
541 details: Internal Server Error occurred
545 summary: Patch resource data from pass-through running
546 description: Patch resource data from pass-through running for the given cm
548 operationId: patchResourceDataRunningForCmHandle
552 description: "The identifier for a network function, network element, subnetwork\
553 \ or any other cm object by managed Network CM Proxy"
557 example: my-cm-handle
558 - name: resourceIdentifier
560 description: The format of resource identifier depend on the associated DMI
561 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
562 it can really be anything.
570 resourceIdentifier: \shops\bookstore
573 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
576 resourceIdentifier: "parent=shops,child=bookstore"
579 description: "Content parameter for request, if content parameter is null,\
580 \ default value is application/json."
584 example: application/yang-data+json
585 default: application/json
593 $ref: '#/components/examples/dataSamplePatchRequest'
603 description: Bad Request
607 $ref: '#/components/schemas/ErrorMessage'
609 status: 400 BAD_REQUEST
610 message: Bad request error message
611 details: Bad request error details
613 description: Unauthorized
617 $ref: '#/components/schemas/ErrorMessage'
620 message: Unauthorized error message
621 details: Unauthorized error details
623 description: Forbidden
627 $ref: '#/components/schemas/ErrorMessage'
630 message: Forbidden error message
631 details: Forbidden error details
633 description: Internal Server Error
637 $ref: '#/components/schemas/ErrorMessage'
640 message: Internal Server Error
641 details: Internal Server Error occurred
642 /v1/ch/{cm-handle}/modules:
646 summary: Fetch all module references (name and revision) for a given cm handle
647 description: fetch all module references (name and revision) for a given cm
649 operationId: getModuleReferencesByCmHandle
653 description: "The identifier for a network function, network element, subnetwork\
654 \ or any other cm object by managed Network CM Proxy"
658 example: my-cm-handle
667 $ref: '#/components/schemas/ModuleReference'
669 description: Bad Request
673 $ref: '#/components/schemas/ErrorMessage'
675 status: 400 BAD_REQUEST
676 message: Bad request error message
677 details: Bad request error details
679 description: Unauthorized
683 $ref: '#/components/schemas/ErrorMessage'
686 message: Unauthorized error message
687 details: Unauthorized error details
689 description: Forbidden
693 $ref: '#/components/schemas/ErrorMessage'
696 message: Forbidden error message
697 details: Forbidden error details
699 description: Internal Server Error
703 $ref: '#/components/schemas/ErrorMessage'
706 message: Internal Server Error
707 details: Internal Server Error occurred
712 summary: Execute cm handle search using the available conditions
713 description: Execute cm handle searches using 'hasAllModules' condition to get
714 all cm handles for the given module names
715 operationId: executeCmHandleSearch
720 $ref: '#/components/schemas/Conditions'
728 $ref: '#/components/schemas/CmHandles'
730 description: Bad Request
734 $ref: '#/components/schemas/ErrorMessage'
736 status: 400 BAD_REQUEST
737 message: Bad request error message
738 details: Bad request error details
740 description: Unauthorized
744 $ref: '#/components/schemas/ErrorMessage'
747 message: Unauthorized error message
748 details: Unauthorized error details
750 description: Forbidden
754 $ref: '#/components/schemas/ErrorMessage'
757 message: Forbidden error message
758 details: Forbidden error details
760 description: Internal Server Error
764 $ref: '#/components/schemas/ErrorMessage'
767 message: Internal Server Error
768 details: Internal Server Error occurred
773 summary: Retrieve CM handle details
774 description: Retrieve CM handle details and properties by cm handle id
775 operationId: retrieveCmHandleDetailsById
779 description: "The identifier for a network function, network element, subnetwork\
780 \ or any other cm object by managed Network CM Proxy"
784 example: my-cm-handle
791 $ref: '#/components/schemas/RestOutputCmHandle'
793 description: Bad Request
797 $ref: '#/components/schemas/ErrorMessage'
799 status: 400 BAD_REQUEST
800 message: Bad request error message
801 details: Bad request error details
803 description: Unauthorized
807 $ref: '#/components/schemas/ErrorMessage'
810 message: Unauthorized error message
811 details: Unauthorized error details
813 description: Forbidden
817 $ref: '#/components/schemas/ErrorMessage'
820 message: Forbidden error message
821 details: Forbidden error details
823 description: The specified resource was not found
827 $ref: '#/components/schemas/ErrorMessage'
830 message: Not found error message
831 details: Not found error details
833 description: Internal Server Error
837 $ref: '#/components/schemas/ErrorMessage'
840 message: Internal Server Error
841 details: Internal Server Error occurred
855 title: Module reference details
860 example: my-module-name
863 example: my-module-revision
868 $ref: '#/components/schemas/ConditionsData'
872 $ref: '#/components/schemas/ConditionProperties'
877 example: hasAllModules
879 $ref: '#/components/schemas/ModuleNamesAsJsonArray'
880 ModuleNamesAsJsonArray:
883 $ref: '#/components/schemas/ModuleNameAsJsonObject'
884 ModuleNameAsJsonObject:
893 $ref: '#/components/schemas/CmHandleProperties'
897 $ref: '#/components/schemas/CmHandleProperty'
902 example: my-cm-handle-id
904 title: CM handle Details
909 example: my-cm-handle1
910 publicCmHandleProperties:
911 $ref: '#/components/schemas/CmHandlePublicProperties'
912 CmHandlePublicProperties:
916 additionalProperties:
921 summary: Sample response
922 description: Sample response for selecting 'sample 1'.
938 summary: Sample request
939 description: Sample request body
942 bookstore-name: Chapters
955 dataSamplePatchRequest:
956 summary: Sample patch request
957 description: Sample patch request body
959 ietf-restconf:yang-patch:
967 bookstore-name: Chapters
985 bookstore-name: Novels