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: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
47 \ in parenthesis'()'. The format of options parameter depend on the associated\
48 \ DMI Plugin implementation."
59 options: (fields=book)
62 options: "(depth=2,fields=book/authors)"
65 description: topic parameter in query.
83 $ref: '#/components/examples/dataSampleResponse'
85 description: Bad Request
89 $ref: '#/components/schemas/ErrorMessage'
91 status: 400 BAD_REQUEST
92 message: Bad request error message
93 details: Bad request error details
95 description: Unauthorized
99 $ref: '#/components/schemas/ErrorMessage'
102 message: Unauthorized error message
103 details: Unauthorized error details
105 description: Forbidden
109 $ref: '#/components/schemas/ErrorMessage'
112 message: Forbidden error message
113 details: Forbidden error details
115 description: Internal Server Error
119 $ref: '#/components/schemas/ErrorMessage'
122 message: Internal Server Error
123 details: Internal Server Error occurred
125 description: Bad Gateway
129 $ref: '#/components/schemas/DmiErrorMessage'
131 message: "Bad Gateway Error Message NCMP"
136 /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-running:
140 summary: Get resource data from pass-through running for cm handle
141 description: Get resource data from pass-through running for given cm handle
142 operationId: getResourceDataRunningForCmHandle
146 description: "The identifier for a network function, network element, subnetwork\
147 \ or any other cm object by managed Network CM Proxy"
151 example: my-cm-handle
152 - name: resourceIdentifier
154 description: The format of resource identifier depend on the associated DMI
155 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
156 it can really be anything.
164 resourceIdentifier: \shops\bookstore
167 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
170 resourceIdentifier: "parent=shops,child=bookstore"
173 description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
174 \ in parenthesis'()'. The format of options parameter depend on the associated\
175 \ DMI Plugin implementation."
186 options: (fields=book)
189 options: "(depth=2,fields=book/authors)"
192 description: topic parameter in query.
210 $ref: '#/components/examples/dataSampleResponse'
212 description: Bad Request
216 $ref: '#/components/schemas/ErrorMessage'
218 status: 400 BAD_REQUEST
219 message: Bad request error message
220 details: Bad request error details
222 description: Unauthorized
226 $ref: '#/components/schemas/ErrorMessage'
229 message: Unauthorized error message
230 details: Unauthorized error details
232 description: Forbidden
236 $ref: '#/components/schemas/ErrorMessage'
239 message: Forbidden error message
240 details: Forbidden error details
242 description: Internal Server Error
246 $ref: '#/components/schemas/ErrorMessage'
249 message: Internal Server Error
250 details: Internal Server Error occurred
252 description: Bad Gateway
256 $ref: '#/components/schemas/DmiErrorMessage'
258 message: "Bad Gateway Error Message NCMP"
265 summary: Update resource data from pass-through running for a cm handle
266 description: Update resource data from pass-through running for the given cm
268 operationId: updateResourceDataRunningForCmHandle
272 description: "The identifier for a network function, network element, subnetwork\
273 \ or any other cm object by managed Network CM Proxy"
277 example: my-cm-handle
278 - name: resourceIdentifier
280 description: The format of resource identifier depend on the associated DMI
281 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
282 it can really be anything.
290 resourceIdentifier: \shops\bookstore
293 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
296 resourceIdentifier: "parent=shops,child=bookstore"
299 description: "Content parameter for request, if content parameter is null,\
300 \ default value is application/json."
304 example: application/yang-data+json
305 default: application/json
313 $ref: '#/components/examples/dataSampleRequest'
314 application/yang-data+json:
319 $ref: '#/components/examples/dataSampleRequest'
329 description: Bad Request
333 $ref: '#/components/schemas/ErrorMessage'
335 status: 400 BAD_REQUEST
336 message: Bad request error message
337 details: Bad request error details
339 description: Unauthorized
343 $ref: '#/components/schemas/ErrorMessage'
346 message: Unauthorized error message
347 details: Unauthorized error details
349 description: Forbidden
353 $ref: '#/components/schemas/ErrorMessage'
356 message: Forbidden error message
357 details: Forbidden error details
359 description: Internal Server Error
363 $ref: '#/components/schemas/ErrorMessage'
366 message: Internal Server Error
367 details: Internal Server Error occurred
369 description: Bad Gateway
373 $ref: '#/components/schemas/DmiErrorMessage'
375 message: "Bad Gateway Error Message NCMP"
382 summary: create resource data from pass-through running for cm handle
383 description: create resource data from pass-through running for given cm handle
384 operationId: createResourceDataRunningForCmHandle
388 description: "The identifier for a network function, network element, subnetwork\
389 \ or any other cm object by managed Network CM Proxy"
393 example: my-cm-handle
394 - name: resourceIdentifier
396 description: The format of resource identifier depend on the associated DMI
397 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
398 it can really be anything.
406 resourceIdentifier: \shops\bookstore
409 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
412 resourceIdentifier: "parent=shops,child=bookstore"
415 description: "Content parameter for request, if content parameter is null,\
416 \ default value is application/json."
420 example: application/yang-data+json
421 default: application/json
429 $ref: '#/components/examples/dataSampleRequest'
430 application/yang-data+json:
435 $ref: '#/components/examples/dataSampleRequest'
442 description: Bad Request
446 $ref: '#/components/schemas/ErrorMessage'
448 status: 400 BAD_REQUEST
449 message: Bad request error message
450 details: Bad request error details
452 description: Unauthorized
456 $ref: '#/components/schemas/ErrorMessage'
459 message: Unauthorized error message
460 details: Unauthorized error details
462 description: Forbidden
466 $ref: '#/components/schemas/ErrorMessage'
469 message: Forbidden error message
470 details: Forbidden error details
472 description: Internal Server Error
476 $ref: '#/components/schemas/ErrorMessage'
479 message: Internal Server Error
480 details: Internal Server Error occurred
482 description: Bad Gateway
486 $ref: '#/components/schemas/DmiErrorMessage'
488 message: "Bad Gateway Error Message NCMP"
495 summary: Delete resource data
496 description: Delete resource data from pass-through running for a given cm handle
497 operationId: deleteResourceDataRunningForCmHandle
501 description: "The identifier for a network function, network element, subnetwork\
502 \ or any other cm object by managed Network CM Proxy"
506 example: my-cm-handle
507 - name: resourceIdentifier
509 description: The format of resource identifier depend on the associated DMI
510 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
511 it can really be anything.
519 resourceIdentifier: \shops\bookstore
522 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
525 resourceIdentifier: "parent=shops,child=bookstore"
528 description: "Content parameter for request, if content parameter is null,\
529 \ default value is application/json."
533 example: application/yang-data+json
534 default: application/json
537 description: No Content
540 description: Bad Request
544 $ref: '#/components/schemas/ErrorMessage'
546 status: 400 BAD_REQUEST
547 message: Bad request error message
548 details: Bad request error details
550 description: Unauthorized
554 $ref: '#/components/schemas/ErrorMessage'
557 message: Unauthorized error message
558 details: Unauthorized error details
560 description: Forbidden
564 $ref: '#/components/schemas/ErrorMessage'
567 message: Forbidden error message
568 details: Forbidden error details
570 description: The specified resource was not found
574 $ref: '#/components/schemas/ErrorMessage'
577 message: Not found error message
578 details: Not found error details
580 description: Internal Server Error
584 $ref: '#/components/schemas/ErrorMessage'
587 message: Internal Server Error
588 details: Internal Server Error occurred
590 description: Bad Gateway
594 $ref: '#/components/schemas/DmiErrorMessage'
596 message: "Bad Gateway Error Message NCMP"
603 summary: Patch resource data from pass-through running
604 description: Patch resource data from pass-through running for the given cm
606 operationId: patchResourceDataRunningForCmHandle
610 description: "The identifier for a network function, network element, subnetwork\
611 \ or any other cm object by managed Network CM Proxy"
615 example: my-cm-handle
616 - name: resourceIdentifier
618 description: The format of resource identifier depend on the associated DMI
619 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
620 it can really be anything.
628 resourceIdentifier: \shops\bookstore
631 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
634 resourceIdentifier: "parent=shops,child=bookstore"
637 description: "Content parameter for request, if content parameter is null,\
638 \ default value is application/json."
642 example: application/yang-data+json
643 default: application/json
651 $ref: '#/components/examples/dataSamplePatchRequest'
661 description: Bad Request
665 $ref: '#/components/schemas/ErrorMessage'
667 status: 400 BAD_REQUEST
668 message: Bad request error message
669 details: Bad request error details
671 description: Unauthorized
675 $ref: '#/components/schemas/ErrorMessage'
678 message: Unauthorized error message
679 details: Unauthorized error details
681 description: Forbidden
685 $ref: '#/components/schemas/ErrorMessage'
688 message: Forbidden error message
689 details: Forbidden error details
691 description: Internal Server Error
695 $ref: '#/components/schemas/ErrorMessage'
698 message: Internal Server Error
699 details: Internal Server Error occurred
701 description: Bad Gateway
705 $ref: '#/components/schemas/DmiErrorMessage'
707 message: "Bad Gateway Error Message NCMP"
711 /v1/ch/{cm-handle}/modules:
715 summary: Fetch all module references (name and revision) for a given cm handle
716 description: fetch all module references (name and revision) for a given cm
718 operationId: getModuleReferencesByCmHandle
722 description: "The identifier for a network function, network element, subnetwork\
723 \ or any other cm object by managed Network CM Proxy"
727 example: my-cm-handle
736 $ref: '#/components/schemas/RestModuleReference'
738 description: Bad Request
742 $ref: '#/components/schemas/ErrorMessage'
744 status: 400 BAD_REQUEST
745 message: Bad request error message
746 details: Bad request error details
748 description: Unauthorized
752 $ref: '#/components/schemas/ErrorMessage'
755 message: Unauthorized error message
756 details: Unauthorized error details
758 description: Forbidden
762 $ref: '#/components/schemas/ErrorMessage'
765 message: Forbidden error message
766 details: Forbidden error details
768 description: Internal Server Error
772 $ref: '#/components/schemas/ErrorMessage'
775 message: Internal Server Error
776 details: Internal Server Error occurred
781 summary: Execute cm handle search using the available conditions
782 description: Execute cm handle searches using 'hasAllModules' condition to get
783 all cm handles for the given module names
784 operationId: executeCmHandleSearch
789 $ref: '#/components/schemas/Conditions'
797 $ref: '#/components/schemas/CmHandles'
799 description: Bad Request
803 $ref: '#/components/schemas/ErrorMessage'
805 status: 400 BAD_REQUEST
806 message: Bad request error message
807 details: Bad request error details
809 description: Unauthorized
813 $ref: '#/components/schemas/ErrorMessage'
816 message: Unauthorized error message
817 details: Unauthorized error details
819 description: Forbidden
823 $ref: '#/components/schemas/ErrorMessage'
826 message: Forbidden error message
827 details: Forbidden error details
829 description: Internal Server Error
833 $ref: '#/components/schemas/ErrorMessage'
836 message: Internal Server Error
837 details: Internal Server Error occurred
842 summary: Retrieve CM handle details
843 description: Retrieve CM handle details and properties by cm handle id
844 operationId: retrieveCmHandleDetailsById
848 description: "The identifier for a network function, network element, subnetwork\
849 \ or any other cm object by managed Network CM Proxy"
853 example: my-cm-handle
860 $ref: '#/components/schemas/RestOutputCmHandle'
862 description: Bad Request
866 $ref: '#/components/schemas/ErrorMessage'
868 status: 400 BAD_REQUEST
869 message: Bad request error message
870 details: Bad request error details
872 description: Unauthorized
876 $ref: '#/components/schemas/ErrorMessage'
879 message: Unauthorized error message
880 details: Unauthorized error details
882 description: Forbidden
886 $ref: '#/components/schemas/ErrorMessage'
889 message: Forbidden error message
890 details: Forbidden error details
892 description: The specified resource was not found
896 $ref: '#/components/schemas/ErrorMessage'
899 message: Not found error message
900 details: Not found error details
902 description: Internal Server Error
906 $ref: '#/components/schemas/ErrorMessage'
909 message: Internal Server Error
910 details: Internal Server Error occurred
923 # DMI Server Exception Schema
925 title: DMI Error Message
930 example: "Bad Gateway Error Message NCMP"
941 title: Module reference details
946 example: my-module-name
949 example: my-module-revision
954 $ref: '#/components/schemas/ConditionsData'
958 $ref: '#/components/schemas/ConditionProperties'
963 example: hasAllModules
965 $ref: '#/components/schemas/ModuleNamesAsJsonArray'
966 ModuleNamesAsJsonArray:
969 $ref: '#/components/schemas/ModuleNameAsJsonObject'
970 ModuleNameAsJsonObject:
979 $ref: '#/components/schemas/CmHandleProperties'
983 $ref: '#/components/schemas/CmHandleProperty'
988 example: my-cm-handle-id
990 title: CM handle Details
995 example: my-cm-handle1
996 publicCmHandleProperties:
997 $ref: '#/components/schemas/CmHandlePublicProperties'
998 CmHandlePublicProperties:
1002 additionalProperties:
1007 summary: Sample response
1008 description: Sample response for selecting 'sample 1'.
1024 summary: Sample request
1025 description: Sample request body
1028 bookstore-name: Chapters
1041 dataSamplePatchRequest:
1042 summary: Sample patch request
1043 description: Sample patch request body
1045 ietf-restconf:yang-patch:
1053 bookstore-name: Chapters
1071 bookstore-name: Novels