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
152 summary: Update resource data from pass-through running for a cm handle
153 description: Update resource data from pass-through running for the given cm
155 operationId: updateResourceDataRunningForCmHandle
157 - name: ncmp-datastore-name
159 description: The type of the requested data
163 example: ncmp-datastore:operational
166 description: "The identifier for a network function, network element, subnetwork\
167 \ or any other cm object by managed Network CM Proxy"
171 example: my-cm-handle
172 - name: resourceIdentifier
174 description: The format of resource identifier depend on the associated DMI
175 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
176 it can really be anything.
184 resourceIdentifier: \shops\bookstore
187 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
190 resourceIdentifier: "parent=shops,child=bookstore"
193 description: "Content parameter for request, if content parameter is null,\
194 \ default value is application/json."
198 example: application/yang-data+json
199 default: application/json
207 $ref: '#/components/examples/dataSampleRequest'
208 application/yang-data+json:
213 $ref: '#/components/examples/dataSampleRequest'
223 description: Bad Request
227 $ref: '#/components/schemas/ErrorMessage'
229 status: 400 BAD_REQUEST
230 message: Bad request error message
231 details: Bad request error details
233 description: Unauthorized
237 $ref: '#/components/schemas/ErrorMessage'
240 message: Unauthorized error message
241 details: Unauthorized error details
243 description: Forbidden
247 $ref: '#/components/schemas/ErrorMessage'
250 message: Forbidden error message
251 details: Forbidden error details
253 description: Internal Server Error
257 $ref: '#/components/schemas/ErrorMessage'
260 message: Internal Server Error
261 details: Internal Server Error occurred
263 description: Bad Gateway
267 $ref: '#/components/schemas/DmiErrorMessage'
269 message: Bad Gateway Error Message NCMP
276 summary: create resource data from pass-through running for cm handle
277 description: create resource data from pass-through running for given cm handle
278 operationId: createResourceDataRunningForCmHandle
280 - name: ncmp-datastore-name
282 description: The type of the requested data
286 example: ncmp-datastore:operational
289 description: "The identifier for a network function, network element, subnetwork\
290 \ or any other cm object by managed Network CM Proxy"
294 example: my-cm-handle
295 - name: resourceIdentifier
297 description: The format of resource identifier depend on the associated DMI
298 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
299 it can really be anything.
307 resourceIdentifier: \shops\bookstore
310 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
313 resourceIdentifier: "parent=shops,child=bookstore"
316 description: "Content parameter for request, if content parameter is null,\
317 \ default value is application/json."
321 example: application/yang-data+json
322 default: application/json
330 $ref: '#/components/examples/dataSampleRequest'
331 application/yang-data+json:
336 $ref: '#/components/examples/dataSampleRequest'
343 description: Bad Request
347 $ref: '#/components/schemas/ErrorMessage'
349 status: 400 BAD_REQUEST
350 message: Bad request error message
351 details: Bad request error details
353 description: Unauthorized
357 $ref: '#/components/schemas/ErrorMessage'
360 message: Unauthorized error message
361 details: Unauthorized error details
363 description: Forbidden
367 $ref: '#/components/schemas/ErrorMessage'
370 message: Forbidden error message
371 details: Forbidden error details
373 description: Internal Server Error
377 $ref: '#/components/schemas/ErrorMessage'
380 message: Internal Server Error
381 details: Internal Server Error occurred
383 description: Bad Gateway
387 $ref: '#/components/schemas/DmiErrorMessage'
389 message: Bad Gateway Error Message NCMP
396 summary: Delete resource data
397 description: Delete resource data from pass-through running for a given cm handle
398 operationId: deleteResourceDataRunningForCmHandle
400 - name: ncmp-datastore-name
402 description: The type of the requested data
406 example: ncmp-datastore:operational
409 description: "The identifier for a network function, network element, subnetwork\
410 \ or any other cm object by managed Network CM Proxy"
414 example: my-cm-handle
415 - name: resourceIdentifier
417 description: The format of resource identifier depend on the associated DMI
418 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
419 it can really be anything.
427 resourceIdentifier: \shops\bookstore
430 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
433 resourceIdentifier: "parent=shops,child=bookstore"
436 description: "Content parameter for request, if content parameter is null,\
437 \ default value is application/json."
441 example: application/yang-data+json
442 default: application/json
445 description: No Content
448 description: Bad Request
452 $ref: '#/components/schemas/ErrorMessage'
454 status: 400 BAD_REQUEST
455 message: Bad request error message
456 details: Bad request error details
458 description: Unauthorized
462 $ref: '#/components/schemas/ErrorMessage'
465 message: Unauthorized error message
466 details: Unauthorized error details
468 description: Forbidden
472 $ref: '#/components/schemas/ErrorMessage'
475 message: Forbidden error message
476 details: Forbidden error details
478 description: The specified resource was not found
482 $ref: '#/components/schemas/ErrorMessage'
485 message: Not found error message
486 details: Not found error details
488 description: Internal Server Error
492 $ref: '#/components/schemas/ErrorMessage'
495 message: Internal Server Error
496 details: Internal Server Error occurred
498 description: Bad Gateway
502 $ref: '#/components/schemas/DmiErrorMessage'
504 message: Bad Gateway Error Message NCMP
511 summary: Patch resource data from pass-through running
512 description: Patch resource data from pass-through running for the given cm
514 operationId: patchResourceDataRunningForCmHandle
516 - name: ncmp-datastore-name
518 description: The type of the requested data
522 example: ncmp-datastore:operational
525 description: "The identifier for a network function, network element, subnetwork\
526 \ or any other cm object by managed Network CM Proxy"
530 example: my-cm-handle
531 - name: resourceIdentifier
533 description: The format of resource identifier depend on the associated DMI
534 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
535 it can really be anything.
543 resourceIdentifier: \shops\bookstore
546 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
549 resourceIdentifier: "parent=shops,child=bookstore"
552 description: "Content parameter for request, if content parameter is null,\
553 \ default value is application/json."
557 example: application/yang-data+json
558 default: application/json
566 $ref: '#/components/examples/dataSamplePatchRequest'
576 description: Bad Request
580 $ref: '#/components/schemas/ErrorMessage'
582 status: 400 BAD_REQUEST
583 message: Bad request error message
584 details: Bad request error details
586 description: Unauthorized
590 $ref: '#/components/schemas/ErrorMessage'
593 message: Unauthorized error message
594 details: Unauthorized error details
596 description: Forbidden
600 $ref: '#/components/schemas/ErrorMessage'
603 message: Forbidden error message
604 details: Forbidden error details
606 description: Internal Server Error
610 $ref: '#/components/schemas/ErrorMessage'
613 message: Internal Server Error
614 details: Internal Server Error occurred
616 description: Bad Gateway
620 $ref: '#/components/schemas/DmiErrorMessage'
622 message: Bad Gateway Error Message NCMP
626 /v1/ch/{cm-handle}/modules:
630 summary: Fetch all module references (name and revision) for a given cm handle
631 description: fetch all module references (name and revision) for a given cm
633 operationId: getModuleReferencesByCmHandle
637 description: "The identifier for a network function, network element, subnetwork\
638 \ or any other cm object by managed Network CM Proxy"
642 example: my-cm-handle
651 $ref: '#/components/schemas/RestModuleReference'
653 description: Bad Request
657 $ref: '#/components/schemas/ErrorMessage'
659 status: 400 BAD_REQUEST
660 message: Bad request error message
661 details: Bad request error details
663 description: Unauthorized
667 $ref: '#/components/schemas/ErrorMessage'
670 message: Unauthorized error message
671 details: Unauthorized error details
673 description: Forbidden
677 $ref: '#/components/schemas/ErrorMessage'
680 message: Forbidden error message
681 details: Forbidden error details
683 description: Internal Server Error
687 $ref: '#/components/schemas/ErrorMessage'
690 message: Internal Server Error
691 details: Internal Server Error occurred
692 /v1/ch/{cm-handle}/modules/definitions:
696 summary: "Fetch all module definitions (name, revision, yang resource) for a\
698 description: "Fetch all module definitions (name, revision, yang resource) for\
700 operationId: getModuleDefinitionsByCmHandleId
704 description: "The identifier for a network function, network element, subnetwork\
705 \ or any other cm object by managed Network CM Proxy"
709 example: my-cm-handle
718 $ref: '#/components/schemas/RestModuleDefinition'
720 description: Unauthorized
724 $ref: '#/components/schemas/ErrorMessage'
727 message: Unauthorized error message
728 details: Unauthorized error details
730 description: Forbidden
734 $ref: '#/components/schemas/ErrorMessage'
737 message: Forbidden error message
738 details: Forbidden error details
740 description: Internal Server Error
744 $ref: '#/components/schemas/ErrorMessage'
747 message: Internal Server Error
748 details: Internal Server Error occurred
753 summary: Execute cm handle search using the available conditions
754 description: Execute cm handle query search and return a list of cm handle details.
755 Any number of conditions can be applied. To be included in the result a cm-handle
756 must fulfill ALL the conditions. An empty collection will be returned in the
757 case that the cm handle does not match a condition. For more on cm handle
758 query search please refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/ncmp-cmhandle-querying.html">cm
759 handle query search Read the Docs</a>.<br/>By supplying a CPS Path it is possible
760 to query on any data related to the cm handle. For more on CPS Path please
761 refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html">CPS
762 Path Read the Docs</a>. The cm handle ancestor is automatically returned for
764 operationId: searchCmHandles
769 $ref: '#/components/schemas/CmHandleQueryParameters'
771 Cm handle properties query:
772 $ref: '#/components/examples/pubPropCmHandleQueryParameters'
773 Cm handle modules query:
774 $ref: '#/components/examples/modulesCmHandleQueryParameters'
775 All cm handle query parameters:
776 $ref: '#/components/examples/allCmHandleQueryParameters'
777 Cm handle with CPS path state query:
778 $ref: '#/components/examples/cpsPathCmHandleStateQueryParameters'
779 Cm handle with data sync flag query:
780 $ref: '#/components/examples/cpsPathCmHandleDataSyncQueryParameters'
790 $ref: '#/components/schemas/RestOutputCmHandle'
792 description: Bad Request
796 $ref: '#/components/schemas/ErrorMessage'
798 status: 400 BAD_REQUEST
799 message: Bad request error message
800 details: Bad request error details
802 description: Unauthorized
806 $ref: '#/components/schemas/ErrorMessage'
809 message: Unauthorized error message
810 details: Unauthorized error details
812 description: Forbidden
816 $ref: '#/components/schemas/ErrorMessage'
819 message: Forbidden error message
820 details: Forbidden error details
822 description: Internal Server Error
826 $ref: '#/components/schemas/ErrorMessage'
829 message: Internal Server Error
830 details: Internal Server Error occurred
835 summary: Retrieve CM handle details
836 description: Retrieve CM handle details and properties by cm handle id
837 operationId: retrieveCmHandleDetailsById
841 description: "The identifier for a network function, network element, subnetwork\
842 \ or any other cm object by managed Network CM Proxy"
846 example: my-cm-handle
853 $ref: '#/components/schemas/RestOutputCmHandle'
855 description: Bad Request
859 $ref: '#/components/schemas/ErrorMessage'
861 status: 400 BAD_REQUEST
862 message: Bad request error message
863 details: Bad request error details
865 description: Unauthorized
869 $ref: '#/components/schemas/ErrorMessage'
872 message: Unauthorized error message
873 details: Unauthorized error details
875 description: The specified resource was not found
879 $ref: '#/components/schemas/ErrorMessage'
882 message: Not found error message
883 details: Not found error details
885 description: Internal Server Error
889 $ref: '#/components/schemas/ErrorMessage'
892 message: Internal Server Error
893 details: Internal Server Error occurred
894 /v1/ch/{cm-handle}/properties:
898 summary: Get CM handle properties
899 description: Get CM handle properties by cm handle id
900 operationId: getCmHandlePublicPropertiesByCmHandleId
904 description: "The identifier for a network function, network element, subnetwork\
905 \ or any other cm object by managed Network CM Proxy"
909 example: my-cm-handle
916 $ref: '#/components/schemas/RestOutputCmHandlePublicProperties'
918 description: Bad Request
922 $ref: '#/components/schemas/ErrorMessage'
924 status: 400 BAD_REQUEST
925 message: Bad request error message
926 details: Bad request error details
928 description: Unauthorized
932 $ref: '#/components/schemas/ErrorMessage'
935 message: Unauthorized error message
936 details: Unauthorized error details
938 description: The specified resource was not found
942 $ref: '#/components/schemas/ErrorMessage'
945 message: Not found error message
946 details: Not found error details
948 description: Internal Server Error
952 $ref: '#/components/schemas/ErrorMessage'
955 message: Internal Server Error
956 details: Internal Server Error occurred
961 summary: Execute cm handle query upon a given set of query parameters
962 description: Execute cm handle query search and return a list of cm handle ids.
963 Any number of conditions can be applied. To be included in the result a cm-handle
964 must fulfill ALL the conditions. An empty collection will be returned in the
965 case that the cm handle does not match a condition. For more on cm handle
966 query search please refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/ncmp-cmhandle-querying.html">cm
967 handle query search Read the Docs</a>.<br/>By supplying a CPS Path it is possible
968 to query on any data related to the cm handle. For more on CPS Path please
969 refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html">CPS
970 Path Read the Docs</a>. The cm handle ancestor is automatically returned for
972 operationId: searchCmHandleIds
977 $ref: '#/components/schemas/CmHandleQueryParameters'
979 Cm handle properties query:
980 $ref: '#/components/examples/pubPropCmHandleQueryParameters'
981 Cm handle modules query:
982 $ref: '#/components/examples/modulesCmHandleQueryParameters'
983 All cm handle query parameters:
984 $ref: '#/components/examples/allCmHandleQueryParameters'
985 Cm handle with CPS path state query:
986 $ref: '#/components/examples/cpsPathCmHandleStateQueryParameters'
987 Cm handle with data sync flag query:
988 $ref: '#/components/examples/cpsPathCmHandleDataSyncQueryParameters'
1000 description: Bad Request
1004 $ref: '#/components/schemas/ErrorMessage'
1006 status: 400 BAD_REQUEST
1007 message: Bad request error message
1008 details: Bad request error details
1010 description: Unauthorized
1014 $ref: '#/components/schemas/ErrorMessage'
1017 message: Unauthorized error message
1018 details: Unauthorized error details
1020 description: Forbidden
1024 $ref: '#/components/schemas/ErrorMessage'
1027 message: Forbidden error message
1028 details: Forbidden error details
1030 description: The specified resource was not found
1034 $ref: '#/components/schemas/ErrorMessage'
1037 message: Not found error message
1038 details: Not found error details
1040 description: Internal Server Error
1044 $ref: '#/components/schemas/ErrorMessage'
1047 message: Internal Server Error
1048 details: Internal Server Error occurred
1049 /v1/ch/{cm-handle}/state:
1053 summary: Get CM handle state
1054 description: Get CM handle state by cm handle id
1055 operationId: getCmHandleStateByCmHandleId
1059 description: "The identifier for a network function, network element, subnetwork\
1060 \ or any other cm object by managed Network CM Proxy"
1064 example: my-cm-handle
1071 $ref: '#/components/schemas/RestOutputCmHandleCompositeState'
1073 description: Bad Request
1077 $ref: '#/components/schemas/ErrorMessage'
1079 status: 400 BAD_REQUEST
1080 message: Bad request error message
1081 details: Bad request error details
1083 description: Unauthorized
1087 $ref: '#/components/schemas/ErrorMessage'
1090 message: Unauthorized error message
1091 details: Unauthorized error details
1093 description: The specified resource was not found
1097 $ref: '#/components/schemas/ErrorMessage'
1100 message: Not found error message
1101 details: Not found error details
1103 description: Internal Server Error
1107 $ref: '#/components/schemas/ErrorMessage'
1110 message: Internal Server Error
1111 details: Internal Server Error occurred
1112 /v1/ch/{cm-handle}/data-sync:
1116 summary: Set the Data Sync Enabled Flag
1117 description: Set the data sync enabled flag to true or false for a specified
1118 Cm-Handle. This will in turn set the data sync state to UNSYNCHRONIZED and
1119 NONE_REQUESTED respectfully.
1120 operationId: setDataSyncEnabledFlagForCmHandle
1124 description: "The identifier for a network function, network element, subnetwork\
1125 \ or any other cm object by managed Network CM Proxy"
1129 example: my-cm-handle
1130 - name: dataSyncEnabled
1132 description: Is used to enable or disable the data synchronization flag
1145 description: Bad Request
1149 $ref: '#/components/schemas/ErrorMessage'
1151 status: 400 BAD_REQUEST
1152 message: Bad request error message
1153 details: Bad request error details
1155 description: Unauthorized
1159 $ref: '#/components/schemas/ErrorMessage'
1162 message: Unauthorized error message
1163 details: Unauthorized error details
1165 description: Forbidden
1169 $ref: '#/components/schemas/ErrorMessage'
1172 message: Forbidden error message
1173 details: Forbidden error details
1175 description: Internal Server Error
1179 $ref: '#/components/schemas/ErrorMessage'
1182 message: Internal Server Error
1183 details: Internal Server Error occurred
1185 description: Bad Gateway
1189 $ref: '#/components/schemas/DmiErrorMessage'
1191 message: Bad Gateway Error Message NCMP
1208 title: DMI Error Message
1213 example: Bad Gateway Error Message NCMP
1215 $ref: '#/components/schemas/DmiErrorMessage_dmiresponse'
1216 RestModuleReference:
1217 title: Module reference details
1222 example: my-module-name
1225 example: my-module-revision
1226 RestModuleDefinition:
1227 title: Module definitions
1232 example: my-module-name
1235 example: 2020-09-15T00:00:00.000+00:00
1238 example: "module stores {\n yang-version 1.1;\n namespace \"org:onap:ccsdk:sample\"\
1239 ;\n prefix book-store;\n revision \"2020-09-15\" {\n description\n\
1240 \ \"Sample Model\";\n }\n}\n"
1241 CmHandleQueryParameters:
1242 title: Cm Handle query parameters for executing cm handle search
1245 cmHandleQueryParameters:
1248 $ref: '#/components/schemas/ConditionProperties'
1251 description: "not necessary, it is just for backward compatibility"
1254 $ref: '#/components/schemas/OldConditionProperties'
1255 ConditionProperties:
1259 conditionParameters:
1263 additionalProperties:
1265 OldConditionProperties:
1269 conditionParameters:
1272 $ref: '#/components/schemas/ModuleNameAsJsonObject'
1274 ModuleNameAsJsonObject:
1280 title: CM handle Details
1285 example: my-cm-handle1
1286 publicCmHandleProperties:
1287 $ref: '#/components/schemas/CmHandlePublicProperties'
1289 $ref: '#/components/schemas/CmHandleCompositeState'
1290 CmHandlePublicProperties:
1294 additionalProperties:
1297 CmHandleCompositeState:
1304 $ref: '#/components/schemas/lock-reason'
1307 example: 2022-12-31T20:30:40.000+0000
1312 $ref: '#/components/schemas/dataStores'
1318 example: LOCKED_MISBEHAVING
1321 example: locked due to failure in module sync
1326 $ref: '#/components/schemas/sync-state'
1328 $ref: '#/components/schemas/sync-state'
1334 example: NONE_REQUESTED
1337 example: 2022-12-31T20:30:40.000+0000
1338 RestOutputCmHandlePublicProperties:
1341 publicCmHandleProperties:
1342 $ref: '#/components/schemas/CmHandlePublicProperties'
1343 RestOutputCmHandleCompositeState:
1347 $ref: '#/components/schemas/CmHandleCompositeState'
1348 DmiErrorMessage_dmiresponse:
1356 example: Bad Request
1359 summary: Sample response
1360 description: Sample response for selecting 'sample 1'.
1376 summary: Sample request
1377 description: Sample request body
1380 bookstore-name: Chapters
1393 dataSamplePatchRequest:
1394 summary: Sample patch request
1395 description: Sample patch request body
1397 ietf-restconf:yang-patch:
1405 bookstore-name: Chapters
1423 bookstore-name: Novels
1436 pubPropCmHandleQueryParameters:
1438 cmHandleQueryParameters:
1439 - conditionName: hasAllProperties
1440 conditionParameters:
1444 modulesCmHandleQueryParameters:
1446 cmHandleQueryParameters:
1447 - conditionName: hasAllModules
1448 conditionParameters:
1449 - moduleName: my-module-1
1450 - moduleName: my-module-2
1451 - moduleName: my-module-3
1452 allCmHandleQueryParameters:
1454 cmHandleQueryParameters:
1455 - conditionName: hasAllModules
1456 conditionParameters:
1457 - moduleName: my-module-1
1458 - moduleName: my-module-2
1459 - moduleName: my-module-3
1460 - conditionName: hasAllProperties
1461 conditionParameters:
1465 - conditionName: cmHandleWithCpsPath
1466 conditionParameters:
1467 - cpsPath: "//state[@cm-handle-state='ADVISED']"
1468 cpsPathCmHandleStateQueryParameters:
1470 cmHandleQueryParameters:
1471 - conditionName: cmHandleWithCpsPath
1472 conditionParameters:
1473 - cpsPath: "//state[@cm-handle-state='LOCKED']"
1474 cpsPathCmHandleDataSyncQueryParameters:
1476 cmHandleQueryParameters:
1477 - conditionName: cmHandleWithCpsPath
1478 conditionParameters:
1479 - cpsPath: "//state[@data-sync-enabled='true']"