3 title: NCMP to CPS Proxy API
4 description: NCMP to CPS Proxy API
9 /v1/ch/{cm-handle}/data/ds/{ncmp-datastore-name}:
13 summary: Get resource data for cm handle
14 description: Get resource data for given cm handle
15 operationId: getResourceDataForCmHandle
17 - name: ncmp-datastore-name
19 description: The type of the requested data
23 example: ncmp-datastore:operational
26 description: "The identifier for a network function, network element, subnetwork\
27 \ or any other cm object by managed Network CM Proxy"
32 - name: resourceIdentifier
34 description: The format of resource identifier depend on the associated DMI
35 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
36 it can really be anything.
44 resourceIdentifier: \shops\bookstore
47 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
50 resourceIdentifier: "parent=shops,child=bookstore"
53 description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
54 \ in parenthesis'()'. The format of options parameter depend on the associated\
55 \ DMI Plugin implementation."
66 options: (fields=book)
69 options: "(depth=2,fields=book/authors)"
72 description: topic parameter in query.
81 - name: include-descendants
83 description: Determines if descendants are included in response
97 $ref: '#/components/examples/dataSampleResponse'
99 description: Bad Request
103 $ref: '#/components/schemas/ErrorMessage'
105 status: 400 BAD_REQUEST
106 message: Bad request error message
107 details: Bad request error details
109 description: Unauthorized
113 $ref: '#/components/schemas/ErrorMessage'
116 message: Unauthorized error message
117 details: Unauthorized error details
119 description: Forbidden
123 $ref: '#/components/schemas/ErrorMessage'
126 message: Forbidden error message
127 details: Forbidden error details
129 description: Internal Server Error
133 $ref: '#/components/schemas/ErrorMessage'
136 message: Internal Server Error
137 details: Internal Server Error occurred
139 description: Bad Gateway
143 $ref: '#/components/schemas/DmiErrorMessage'
145 message: Bad Gateway Error Message NCMP
149 /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-running:
153 summary: Update resource data from pass-through running for a cm handle
154 description: Update resource data from pass-through running for the given cm
156 operationId: updateResourceDataRunningForCmHandle
160 description: "The identifier for a network function, network element, subnetwork\
161 \ or any other cm object by managed Network CM Proxy"
165 example: my-cm-handle
166 - name: resourceIdentifier
168 description: The format of resource identifier depend on the associated DMI
169 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
170 it can really be anything.
178 resourceIdentifier: \shops\bookstore
181 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
184 resourceIdentifier: "parent=shops,child=bookstore"
187 description: "Content parameter for request, if content parameter is null,\
188 \ default value is application/json."
192 example: application/yang-data+json
193 default: application/json
201 $ref: '#/components/examples/dataSampleRequest'
202 application/yang-data+json:
207 $ref: '#/components/examples/dataSampleRequest'
217 description: Bad Request
221 $ref: '#/components/schemas/ErrorMessage'
223 status: 400 BAD_REQUEST
224 message: Bad request error message
225 details: Bad request error details
227 description: Unauthorized
231 $ref: '#/components/schemas/ErrorMessage'
234 message: Unauthorized error message
235 details: Unauthorized error details
237 description: Forbidden
241 $ref: '#/components/schemas/ErrorMessage'
244 message: Forbidden error message
245 details: Forbidden error details
247 description: Internal Server Error
251 $ref: '#/components/schemas/ErrorMessage'
254 message: Internal Server Error
255 details: Internal Server Error occurred
257 description: Bad Gateway
261 $ref: '#/components/schemas/DmiErrorMessage'
263 message: Bad Gateway Error Message NCMP
270 summary: create resource data from pass-through running for cm handle
271 description: create resource data from pass-through running for given cm handle
272 operationId: createResourceDataRunningForCmHandle
276 description: "The identifier for a network function, network element, subnetwork\
277 \ or any other cm object by managed Network CM Proxy"
281 example: my-cm-handle
282 - name: resourceIdentifier
284 description: The format of resource identifier depend on the associated DMI
285 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
286 it can really be anything.
294 resourceIdentifier: \shops\bookstore
297 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
300 resourceIdentifier: "parent=shops,child=bookstore"
303 description: "Content parameter for request, if content parameter is null,\
304 \ default value is application/json."
308 example: application/yang-data+json
309 default: application/json
317 $ref: '#/components/examples/dataSampleRequest'
318 application/yang-data+json:
323 $ref: '#/components/examples/dataSampleRequest'
330 description: Bad Request
334 $ref: '#/components/schemas/ErrorMessage'
336 status: 400 BAD_REQUEST
337 message: Bad request error message
338 details: Bad request error details
340 description: Unauthorized
344 $ref: '#/components/schemas/ErrorMessage'
347 message: Unauthorized error message
348 details: Unauthorized error details
350 description: Forbidden
354 $ref: '#/components/schemas/ErrorMessage'
357 message: Forbidden error message
358 details: Forbidden error details
360 description: Internal Server Error
364 $ref: '#/components/schemas/ErrorMessage'
367 message: Internal Server Error
368 details: Internal Server Error occurred
370 description: Bad Gateway
374 $ref: '#/components/schemas/DmiErrorMessage'
376 message: Bad Gateway Error Message NCMP
383 summary: Delete resource data
384 description: Delete resource data from pass-through running for a given cm handle
385 operationId: deleteResourceDataRunningForCmHandle
389 description: "The identifier for a network function, network element, subnetwork\
390 \ or any other cm object by managed Network CM Proxy"
394 example: my-cm-handle
395 - name: resourceIdentifier
397 description: The format of resource identifier depend on the associated DMI
398 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
399 it can really be anything.
407 resourceIdentifier: \shops\bookstore
410 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
413 resourceIdentifier: "parent=shops,child=bookstore"
416 description: "Content parameter for request, if content parameter is null,\
417 \ default value is application/json."
421 example: application/yang-data+json
422 default: application/json
425 description: No Content
428 description: Bad Request
432 $ref: '#/components/schemas/ErrorMessage'
434 status: 400 BAD_REQUEST
435 message: Bad request error message
436 details: Bad request error details
438 description: Unauthorized
442 $ref: '#/components/schemas/ErrorMessage'
445 message: Unauthorized error message
446 details: Unauthorized error details
448 description: Forbidden
452 $ref: '#/components/schemas/ErrorMessage'
455 message: Forbidden error message
456 details: Forbidden error details
458 description: The specified resource was not found
462 $ref: '#/components/schemas/ErrorMessage'
465 message: Not found error message
466 details: Not found error details
468 description: Internal Server Error
472 $ref: '#/components/schemas/ErrorMessage'
475 message: Internal Server Error
476 details: Internal Server Error occurred
478 description: Bad Gateway
482 $ref: '#/components/schemas/DmiErrorMessage'
484 message: Bad Gateway Error Message NCMP
491 summary: Patch resource data from pass-through running
492 description: Patch resource data from pass-through running for the given cm
494 operationId: patchResourceDataRunningForCmHandle
498 description: "The identifier for a network function, network element, subnetwork\
499 \ or any other cm object by managed Network CM Proxy"
503 example: my-cm-handle
504 - name: resourceIdentifier
506 description: The format of resource identifier depend on the associated DMI
507 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
508 it can really be anything.
516 resourceIdentifier: \shops\bookstore
519 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
522 resourceIdentifier: "parent=shops,child=bookstore"
525 description: "Content parameter for request, if content parameter is null,\
526 \ default value is application/json."
530 example: application/yang-data+json
531 default: application/json
539 $ref: '#/components/examples/dataSamplePatchRequest'
549 description: Bad Request
553 $ref: '#/components/schemas/ErrorMessage'
555 status: 400 BAD_REQUEST
556 message: Bad request error message
557 details: Bad request error details
559 description: Unauthorized
563 $ref: '#/components/schemas/ErrorMessage'
566 message: Unauthorized error message
567 details: Unauthorized error details
569 description: Forbidden
573 $ref: '#/components/schemas/ErrorMessage'
576 message: Forbidden error message
577 details: Forbidden error details
579 description: Internal Server Error
583 $ref: '#/components/schemas/ErrorMessage'
586 message: Internal Server Error
587 details: Internal Server Error occurred
589 description: Bad Gateway
593 $ref: '#/components/schemas/DmiErrorMessage'
595 message: Bad Gateway Error Message NCMP
599 /v1/ch/{cm-handle}/modules:
603 summary: Fetch all module references (name and revision) for a given cm handle
604 description: fetch all module references (name and revision) for a given cm
606 operationId: getModuleReferencesByCmHandle
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
624 $ref: '#/components/schemas/RestModuleReference'
626 description: Bad Request
630 $ref: '#/components/schemas/ErrorMessage'
632 status: 400 BAD_REQUEST
633 message: Bad request error message
634 details: Bad request error details
636 description: Unauthorized
640 $ref: '#/components/schemas/ErrorMessage'
643 message: Unauthorized error message
644 details: Unauthorized error details
646 description: Forbidden
650 $ref: '#/components/schemas/ErrorMessage'
653 message: Forbidden error message
654 details: Forbidden error details
656 description: Internal Server Error
660 $ref: '#/components/schemas/ErrorMessage'
663 message: Internal Server Error
664 details: Internal Server Error occurred
665 /v1/ch/{cm-handle}/modules/definitions:
669 summary: "Fetch all module definitions (name, revision, yang resource) for a\
671 description: "Fetch all module definitions (name, revision, yang resource) for\
673 operationId: getModuleDefinitionsByCmHandleId
677 description: "The identifier for a network function, network element, subnetwork\
678 \ or any other cm object by managed Network CM Proxy"
682 example: my-cm-handle
691 $ref: '#/components/schemas/RestModuleDefinition'
693 description: Unauthorized
697 $ref: '#/components/schemas/ErrorMessage'
700 message: Unauthorized error message
701 details: Unauthorized error details
703 description: Forbidden
707 $ref: '#/components/schemas/ErrorMessage'
710 message: Forbidden error message
711 details: Forbidden error details
713 description: Internal Server Error
717 $ref: '#/components/schemas/ErrorMessage'
720 message: Internal Server Error
721 details: Internal Server Error occurred
726 summary: Execute cm handle search using the available conditions
727 description: Execute cm handle query search and return a list of cm handle details.
728 Any number of conditions can be applied. To be included in the result a cm-handle
729 must fulfill ALL the conditions. An empty collection will be returned in the
730 case that the cm handle does not match a condition. For more on cm handle
731 query search please refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/ncmp-cmhandle-querying.html">cm
732 handle query search Read the Docs</a>.<br/>By supplying a CPS Path it is possible
733 to query on any data related to the cm handle. For more on CPS Path please
734 refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html">CPS
735 Path Read the Docs</a>. The cm handle ancestor is automatically returned for
737 operationId: searchCmHandles
742 $ref: '#/components/schemas/CmHandleQueryParameters'
744 Cm handle properties query:
745 $ref: '#/components/examples/pubPropCmHandleQueryParameters'
746 Cm handle modules query:
747 $ref: '#/components/examples/modulesCmHandleQueryParameters'
748 All cm handle query parameters:
749 $ref: '#/components/examples/allCmHandleQueryParameters'
750 Cm handle with CPS path state query:
751 $ref: '#/components/examples/cpsPathCmHandleStateQueryParameters'
752 Cm handle with data sync flag query:
753 $ref: '#/components/examples/cpsPathCmHandleDataSyncQueryParameters'
763 $ref: '#/components/schemas/RestOutputCmHandle'
765 description: Bad Request
769 $ref: '#/components/schemas/ErrorMessage'
771 status: 400 BAD_REQUEST
772 message: Bad request error message
773 details: Bad request error details
775 description: Unauthorized
779 $ref: '#/components/schemas/ErrorMessage'
782 message: Unauthorized error message
783 details: Unauthorized error details
785 description: Forbidden
789 $ref: '#/components/schemas/ErrorMessage'
792 message: Forbidden error message
793 details: Forbidden error details
795 description: Internal Server Error
799 $ref: '#/components/schemas/ErrorMessage'
802 message: Internal Server Error
803 details: Internal Server Error occurred
808 summary: Retrieve CM handle details
809 description: Retrieve CM handle details and properties by cm handle id
810 operationId: retrieveCmHandleDetailsById
814 description: "The identifier for a network function, network element, subnetwork\
815 \ or any other cm object by managed Network CM Proxy"
819 example: my-cm-handle
826 $ref: '#/components/schemas/RestOutputCmHandle'
828 description: Bad Request
832 $ref: '#/components/schemas/ErrorMessage'
834 status: 400 BAD_REQUEST
835 message: Bad request error message
836 details: Bad request error details
838 description: Unauthorized
842 $ref: '#/components/schemas/ErrorMessage'
845 message: Unauthorized error message
846 details: Unauthorized error details
848 description: The specified resource was not found
852 $ref: '#/components/schemas/ErrorMessage'
855 message: Not found error message
856 details: Not found error details
858 description: Internal Server Error
862 $ref: '#/components/schemas/ErrorMessage'
865 message: Internal Server Error
866 details: Internal Server Error occurred
867 /v1/ch/{cm-handle}/properties:
871 summary: Get CM handle properties
872 description: Get CM handle properties by cm handle id
873 operationId: getCmHandlePublicPropertiesByCmHandleId
877 description: "The identifier for a network function, network element, subnetwork\
878 \ or any other cm object by managed Network CM Proxy"
882 example: my-cm-handle
889 $ref: '#/components/schemas/RestOutputCmHandlePublicProperties'
891 description: Bad Request
895 $ref: '#/components/schemas/ErrorMessage'
897 status: 400 BAD_REQUEST
898 message: Bad request error message
899 details: Bad request error details
901 description: Unauthorized
905 $ref: '#/components/schemas/ErrorMessage'
908 message: Unauthorized error message
909 details: Unauthorized error details
911 description: The specified resource was not found
915 $ref: '#/components/schemas/ErrorMessage'
918 message: Not found error message
919 details: Not found error details
921 description: Internal Server Error
925 $ref: '#/components/schemas/ErrorMessage'
928 message: Internal Server Error
929 details: Internal Server Error occurred
934 summary: Execute cm handle query upon a given set of query parameters
935 description: Execute cm handle query search and return a list of cm handle ids.
936 Any number of conditions can be applied. To be included in the result a cm-handle
937 must fulfill ALL the conditions. An empty collection will be returned in the
938 case that the cm handle does not match a condition. For more on cm handle
939 query search please refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/ncmp-cmhandle-querying.html">cm
940 handle query search Read the Docs</a>.<br/>By supplying a CPS Path it is possible
941 to query on any data related to the cm handle. For more on CPS Path please
942 refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html">CPS
943 Path Read the Docs</a>. The cm handle ancestor is automatically returned for
945 operationId: searchCmHandleIds
950 $ref: '#/components/schemas/CmHandleQueryParameters'
952 Cm handle properties query:
953 $ref: '#/components/examples/pubPropCmHandleQueryParameters'
954 Cm handle modules query:
955 $ref: '#/components/examples/modulesCmHandleQueryParameters'
956 All cm handle query parameters:
957 $ref: '#/components/examples/allCmHandleQueryParameters'
958 Cm handle with CPS path state query:
959 $ref: '#/components/examples/cpsPathCmHandleStateQueryParameters'
960 Cm handle with data sync flag query:
961 $ref: '#/components/examples/cpsPathCmHandleDataSyncQueryParameters'
973 description: Bad Request
977 $ref: '#/components/schemas/ErrorMessage'
979 status: 400 BAD_REQUEST
980 message: Bad request error message
981 details: Bad request error details
983 description: Unauthorized
987 $ref: '#/components/schemas/ErrorMessage'
990 message: Unauthorized error message
991 details: Unauthorized error details
993 description: Forbidden
997 $ref: '#/components/schemas/ErrorMessage'
1000 message: Forbidden error message
1001 details: Forbidden error details
1003 description: The specified resource was not found
1007 $ref: '#/components/schemas/ErrorMessage'
1010 message: Not found error message
1011 details: Not found error details
1013 description: Internal Server Error
1017 $ref: '#/components/schemas/ErrorMessage'
1020 message: Internal Server Error
1021 details: Internal Server Error occurred
1022 /v1/ch/{cm-handle}/state:
1026 summary: Get CM handle state
1027 description: Get CM handle state by cm handle id
1028 operationId: getCmHandleStateByCmHandleId
1032 description: "The identifier for a network function, network element, subnetwork\
1033 \ or any other cm object by managed Network CM Proxy"
1037 example: my-cm-handle
1044 $ref: '#/components/schemas/RestOutputCmHandleCompositeState'
1046 description: Bad Request
1050 $ref: '#/components/schemas/ErrorMessage'
1052 status: 400 BAD_REQUEST
1053 message: Bad request error message
1054 details: Bad request error details
1056 description: Unauthorized
1060 $ref: '#/components/schemas/ErrorMessage'
1063 message: Unauthorized error message
1064 details: Unauthorized error details
1066 description: The specified resource was not found
1070 $ref: '#/components/schemas/ErrorMessage'
1073 message: Not found error message
1074 details: Not found error details
1076 description: Internal Server Error
1080 $ref: '#/components/schemas/ErrorMessage'
1083 message: Internal Server Error
1084 details: Internal Server Error occurred
1085 /v1/ch/{cm-handle}/data-sync:
1089 summary: Set the Data Sync Enabled Flag
1090 description: Set the data sync enabled flag to true or false for a specified
1091 Cm-Handle. This will in turn set the data sync state to UNSYNCHRONIZED and
1092 NONE_REQUESTED respectfully.
1093 operationId: setDataSyncEnabledFlagForCmHandle
1097 description: "The identifier for a network function, network element, subnetwork\
1098 \ or any other cm object by managed Network CM Proxy"
1102 example: my-cm-handle
1103 - name: dataSyncEnabled
1105 description: Is used to enable or disable the data synchronization flag
1118 description: Bad Request
1122 $ref: '#/components/schemas/ErrorMessage'
1124 status: 400 BAD_REQUEST
1125 message: Bad request error message
1126 details: Bad request error details
1128 description: Unauthorized
1132 $ref: '#/components/schemas/ErrorMessage'
1135 message: Unauthorized error message
1136 details: Unauthorized error details
1138 description: Forbidden
1142 $ref: '#/components/schemas/ErrorMessage'
1145 message: Forbidden error message
1146 details: Forbidden error details
1148 description: Internal Server Error
1152 $ref: '#/components/schemas/ErrorMessage'
1155 message: Internal Server Error
1156 details: Internal Server Error occurred
1158 description: Bad Gateway
1162 $ref: '#/components/schemas/DmiErrorMessage'
1164 message: Bad Gateway Error Message NCMP
1181 title: DMI Error Message
1186 example: Bad Gateway Error Message NCMP
1188 $ref: '#/components/schemas/DmiErrorMessage_dmiresponse'
1189 RestModuleReference:
1190 title: Module reference details
1195 example: my-module-name
1198 example: my-module-revision
1199 RestModuleDefinition:
1200 title: Module definitions
1205 example: my-module-name
1208 example: 2020-09-15T00:00:00.000+00:00
1211 example: "module stores {\n yang-version 1.1;\n namespace \"org:onap:ccsdk:sample\"\
1212 ;\n prefix book-store;\n revision \"2020-09-15\" {\n description\n\
1213 \ \"Sample Model\";\n }\n}\n"
1214 CmHandleQueryParameters:
1215 title: Cm Handle query parameters for executing cm handle search
1218 cmHandleQueryParameters:
1221 $ref: '#/components/schemas/ConditionProperties'
1224 description: "not necessary, it is just for backward compatibility"
1227 $ref: '#/components/schemas/OldConditionProperties'
1228 ConditionProperties:
1232 conditionParameters:
1236 additionalProperties:
1238 OldConditionProperties:
1242 conditionParameters:
1245 $ref: '#/components/schemas/ModuleNameAsJsonObject'
1247 ModuleNameAsJsonObject:
1253 title: CM handle Details
1258 example: my-cm-handle1
1259 publicCmHandleProperties:
1260 $ref: '#/components/schemas/CmHandlePublicProperties'
1262 $ref: '#/components/schemas/CmHandleCompositeState'
1263 CmHandlePublicProperties:
1267 additionalProperties:
1270 CmHandleCompositeState:
1277 $ref: '#/components/schemas/lock-reason'
1280 example: 2022-12-31T20:30:40.000+0000
1285 $ref: '#/components/schemas/dataStores'
1291 example: LOCKED_MISBEHAVING
1294 example: locked due to failure in module sync
1299 $ref: '#/components/schemas/sync-state'
1301 $ref: '#/components/schemas/sync-state'
1307 example: NONE_REQUESTED
1310 example: 2022-12-31T20:30:40.000+0000
1311 RestOutputCmHandlePublicProperties:
1314 publicCmHandleProperties:
1315 $ref: '#/components/schemas/CmHandlePublicProperties'
1316 RestOutputCmHandleCompositeState:
1320 $ref: '#/components/schemas/CmHandleCompositeState'
1321 DmiErrorMessage_dmiresponse:
1329 example: Bad Request
1332 summary: Sample response
1333 description: Sample response for selecting 'sample 1'.
1349 summary: Sample request
1350 description: Sample request body
1353 bookstore-name: Chapters
1366 dataSamplePatchRequest:
1367 summary: Sample patch request
1368 description: Sample patch request body
1370 ietf-restconf:yang-patch:
1378 bookstore-name: Chapters
1396 bookstore-name: Novels
1409 pubPropCmHandleQueryParameters:
1411 cmHandleQueryParameters:
1412 - conditionName: hasAllProperties
1413 conditionParameters:
1417 modulesCmHandleQueryParameters:
1419 cmHandleQueryParameters:
1420 - conditionName: hasAllModules
1421 conditionParameters:
1422 - moduleName: my-module-1
1423 - moduleName: my-module-2
1424 - moduleName: my-module-3
1425 allCmHandleQueryParameters:
1427 cmHandleQueryParameters:
1428 - conditionName: hasAllModules
1429 conditionParameters:
1430 - moduleName: my-module-1
1431 - moduleName: my-module-2
1432 - moduleName: my-module-3
1433 - conditionName: hasAllProperties
1434 conditionParameters:
1438 - conditionName: cmHandleWithCpsPath
1439 conditionParameters:
1440 - cpsPath: "//state[@cm-handle-state='ADVISED']"
1441 cpsPathCmHandleStateQueryParameters:
1443 cmHandleQueryParameters:
1444 - conditionName: cmHandleWithCpsPath
1445 conditionParameters:
1446 - cpsPath: "//state[@cm-handle-state='LOCKED']"
1447 cpsPathCmHandleDataSyncQueryParameters:
1449 cmHandleQueryParameters:
1450 - conditionName: cmHandleWithCpsPath
1451 conditionParameters:
1452 - cpsPath: "//state[@data-sync-enabled='true']"