3 description: NCMP to CPS Proxy API
4 title: NCMP to CPS Proxy API
11 /v1/ch/{cm-handle}/data/ds/{datastore-name}:
13 description: Delete resource data from pass-through running for a given cm handle
14 operationId: deleteResourceDataRunningForCmHandle
16 - description: The type of the requested data
21 example: ncmp-datastore:running
23 - description: "The identifier for a network function, network element, subnetwork\
24 \ or any other cm object by managed Network CM Proxy"
32 description: The format of resource identifier depend on the associated DMI
33 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
34 it can really be anything.
38 resourceIdentifier: \shops\bookstore
41 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
44 resourceIdentifier: "parent=shops,child=bookstore"
46 name: resourceIdentifier
50 - description: "Content parameter for request, if content parameter is null,\
51 \ default value is application/json."
56 default: application/json
57 example: application/yang-data+json
62 description: No Content
67 status: 400 BAD_REQUEST
68 message: Bad request error message
69 details: Bad request error details
71 $ref: '#/components/schemas/ErrorMessage'
72 description: Bad Request
78 message: Unauthorized error message
79 details: Unauthorized error details
81 $ref: '#/components/schemas/ErrorMessage'
82 description: Unauthorized
88 message: Forbidden error message
89 details: Forbidden error details
91 $ref: '#/components/schemas/ErrorMessage'
92 description: Forbidden
98 message: Not found error message
99 details: Not found error details
101 $ref: '#/components/schemas/ErrorMessage'
102 description: The specified resource was not found
108 message: Internal Server Error
109 details: Internal Server Error occurred
111 $ref: '#/components/schemas/ErrorMessage'
112 description: Internal Server Error
117 message: Bad Gateway Error Message NCMP
122 $ref: '#/components/schemas/DmiErrorMessage'
123 description: Bad Gateway
124 summary: Delete resource data
128 description: Get resource data for given cm handle
129 operationId: getResourceDataForCmHandle
131 - description: The type of the requested data
136 example: ncmp-datastore:running
138 - description: "The identifier for a network function, network element, subnetwork\
139 \ or any other cm object by managed Network CM Proxy"
144 example: my-cm-handle
146 - allowReserved: true
147 description: The format of resource identifier depend on the associated DMI
148 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
149 it can really be anything.
153 resourceIdentifier: \shops\bookstore
156 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
159 resourceIdentifier: "parent=shops,child=bookstore"
161 name: resourceIdentifier
165 - allowReserved: true
166 description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
167 \ in parenthesis'()'. The format of options parameter depend on the associated\
168 \ DMI Plugin implementation."
175 options: (fields=book)
178 options: "(depth=2,fields=book/authors)"
184 - allowReserved: true
185 description: topic parameter in query.
195 - description: Determines if descendants are included in response
197 name: include-descendants
208 $ref: '#/components/examples/dataSampleResponse'
217 status: 400 BAD_REQUEST
218 message: Bad request error message
219 details: Bad request error details
221 $ref: '#/components/schemas/ErrorMessage'
222 description: Bad Request
228 message: Unauthorized error message
229 details: Unauthorized error details
231 $ref: '#/components/schemas/ErrorMessage'
232 description: Unauthorized
238 message: Forbidden error message
239 details: Forbidden error details
241 $ref: '#/components/schemas/ErrorMessage'
242 description: Forbidden
248 message: Internal Server Error
249 details: Internal Server Error occurred
251 $ref: '#/components/schemas/ErrorMessage'
252 description: Internal Server Error
257 message: Bad Gateway Error Message NCMP
262 $ref: '#/components/schemas/DmiErrorMessage'
263 description: Bad Gateway
264 summary: Get resource data for cm handle
268 description: Patch resource data from pass-through running for the given cm
270 operationId: patchResourceDataRunningForCmHandle
272 - description: The type of the requested data
277 example: ncmp-datastore:running
279 - description: "The identifier for a network function, network element, subnetwork\
280 \ or any other cm object by managed Network CM Proxy"
285 example: my-cm-handle
287 - allowReserved: true
288 description: The format of resource identifier depend on the associated DMI
289 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
290 it can really be anything.
294 resourceIdentifier: \shops\bookstore
297 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
300 resourceIdentifier: "parent=shops,child=bookstore"
302 name: resourceIdentifier
306 - description: "Content parameter for request, if content parameter is null,\
307 \ default value is application/json."
312 default: application/json
313 example: application/yang-data+json
320 $ref: '#/components/examples/dataSamplePatchRequest'
336 status: 400 BAD_REQUEST
337 message: Bad request error message
338 details: Bad request error details
340 $ref: '#/components/schemas/ErrorMessage'
341 description: Bad Request
347 message: Unauthorized error message
348 details: Unauthorized error details
350 $ref: '#/components/schemas/ErrorMessage'
351 description: Unauthorized
357 message: Forbidden error message
358 details: Forbidden error details
360 $ref: '#/components/schemas/ErrorMessage'
361 description: Forbidden
367 message: Internal Server Error
368 details: Internal Server Error occurred
370 $ref: '#/components/schemas/ErrorMessage'
371 description: Internal Server Error
376 message: Bad Gateway Error Message NCMP
381 $ref: '#/components/schemas/DmiErrorMessage'
382 description: Bad Gateway
383 summary: Patch resource data from pass-through running
387 description: create resource data from pass-through running for given cm handle
388 operationId: createResourceDataRunningForCmHandle
390 - description: The type of the requested data
395 example: ncmp-datastore:running
397 - description: "The identifier for a network function, network element, subnetwork\
398 \ or any other cm object by managed Network CM Proxy"
403 example: my-cm-handle
405 - allowReserved: true
406 description: The format of resource identifier depend on the associated DMI
407 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
408 it can really be anything.
412 resourceIdentifier: \shops\bookstore
415 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
418 resourceIdentifier: "parent=shops,child=bookstore"
420 name: resourceIdentifier
424 - description: "Content parameter for request, if content parameter is null,\
425 \ default value is application/json."
430 default: application/json
431 example: application/yang-data+json
438 $ref: '#/components/examples/dataSampleRequest'
442 application/yang-data+json:
445 $ref: '#/components/examples/dataSampleRequest'
458 status: 400 BAD_REQUEST
459 message: Bad request error message
460 details: Bad request error details
462 $ref: '#/components/schemas/ErrorMessage'
463 description: Bad Request
469 message: Unauthorized error message
470 details: Unauthorized error details
472 $ref: '#/components/schemas/ErrorMessage'
473 description: Unauthorized
479 message: Forbidden error message
480 details: Forbidden error details
482 $ref: '#/components/schemas/ErrorMessage'
483 description: Forbidden
489 message: Internal Server Error
490 details: Internal Server Error occurred
492 $ref: '#/components/schemas/ErrorMessage'
493 description: Internal Server Error
498 message: Bad Gateway Error Message NCMP
503 $ref: '#/components/schemas/DmiErrorMessage'
504 description: Bad Gateway
505 summary: create resource data from pass-through running for cm handle
509 description: Update resource data from pass-through running for the given cm
511 operationId: updateResourceDataRunningForCmHandle
513 - description: The type of the requested data
518 example: ncmp-datastore:running
520 - description: "The identifier for a network function, network element, subnetwork\
521 \ or any other cm object by managed Network CM Proxy"
526 example: my-cm-handle
528 - allowReserved: true
529 description: The format of resource identifier depend on the associated DMI
530 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
531 it can really be anything.
535 resourceIdentifier: \shops\bookstore
538 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
541 resourceIdentifier: "parent=shops,child=bookstore"
543 name: resourceIdentifier
547 - description: "Content parameter for request, if content parameter is null,\
548 \ default value is application/json."
553 default: application/json
554 example: application/yang-data+json
561 $ref: '#/components/examples/dataSampleRequest'
565 application/yang-data+json:
568 $ref: '#/components/examples/dataSampleRequest'
584 status: 400 BAD_REQUEST
585 message: Bad request error message
586 details: Bad request error details
588 $ref: '#/components/schemas/ErrorMessage'
589 description: Bad Request
595 message: Unauthorized error message
596 details: Unauthorized error details
598 $ref: '#/components/schemas/ErrorMessage'
599 description: Unauthorized
605 message: Forbidden error message
606 details: Forbidden error details
608 $ref: '#/components/schemas/ErrorMessage'
609 description: Forbidden
615 message: Internal Server Error
616 details: Internal Server Error occurred
618 $ref: '#/components/schemas/ErrorMessage'
619 description: Internal Server Error
624 message: Bad Gateway Error Message NCMP
629 $ref: '#/components/schemas/DmiErrorMessage'
630 description: Bad Gateway
631 summary: Update resource data from pass-through running for a cm handle
636 description: This request will be handled asynchronously using messaging to
637 the supplied topic. The rest response will be an acknowledge with a requestId
638 to identify the relevant messages.
639 operationId: executeDataOperationForCmHandles
641 - allowReserved: true
642 description: mandatory topic parameter in query.
656 $ref: '#/components/schemas/DataOperationRequest'
669 status: 400 BAD_REQUEST
670 message: Bad request error message
671 details: Bad request error details
673 $ref: '#/components/schemas/ErrorMessage'
674 description: Bad Request
680 message: Unauthorized error message
681 details: Unauthorized error details
683 $ref: '#/components/schemas/ErrorMessage'
684 description: Unauthorized
690 message: Forbidden error message
691 details: Forbidden error details
693 $ref: '#/components/schemas/ErrorMessage'
694 description: Forbidden
700 message: Internal Server Error
701 details: Internal Server Error occurred
703 $ref: '#/components/schemas/ErrorMessage'
704 description: Internal Server Error
709 message: Bad Gateway Error Message NCMP
714 $ref: '#/components/schemas/DmiErrorMessage'
715 description: Bad Gateway
716 summary: Execute a data operation for group of cm handle ids
719 /v1/ch/{cm-handle}/data/ds/{datastore-name}/query:
721 description: Query resource data for a given cm handle
722 operationId: queryResourceDataForCmHandle
724 - description: The type of the requested data
729 example: ncmp-datastore:running
731 - description: "The identifier for a network function, network element, subnetwork\
732 \ or any other cm object by managed Network CM Proxy"
737 example: my-cm-handle
739 - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
743 list attributes cps path:
744 value: "//categories[@code=1]"
751 - allowReserved: true
752 description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
753 \ in parenthesis'()'. The format of options parameter depend on the associated\
754 \ DMI Plugin implementation."
761 options: (fields=book)
764 options: "(depth=2,fields=book/authors)"
770 - allowReserved: true
771 description: topic parameter in query.
781 - description: Determines if descendants are included in response
783 name: include-descendants
794 $ref: '#/components/examples/dataSampleResponse'
803 status: 400 BAD_REQUEST
804 message: Bad request error message
805 details: Bad request error details
807 $ref: '#/components/schemas/ErrorMessage'
808 description: Bad Request
814 message: Unauthorized error message
815 details: Unauthorized error details
817 $ref: '#/components/schemas/ErrorMessage'
818 description: Unauthorized
824 message: Forbidden error message
825 details: Forbidden error details
827 $ref: '#/components/schemas/ErrorMessage'
828 description: Forbidden
834 message: Internal Server Error
835 details: Internal Server Error occurred
837 $ref: '#/components/schemas/ErrorMessage'
838 description: Internal Server Error
843 message: Bad Gateway Error Message NCMP
848 $ref: '#/components/schemas/DmiErrorMessage'
849 description: Bad Gateway
850 summary: Query resource data for a given cm handle
853 /v1/ch/{cm-handle}/modules:
855 description: fetch all module references (name and revision) for a given cm
857 operationId: getModuleReferencesByCmHandle
859 - description: "The identifier for a network function, network element, subnetwork\
860 \ or any other cm object by managed Network CM Proxy"
865 example: my-cm-handle
873 $ref: '#/components/schemas/RestModuleReference'
880 status: 400 BAD_REQUEST
881 message: Bad request error message
882 details: Bad request error details
884 $ref: '#/components/schemas/ErrorMessage'
885 description: Bad Request
891 message: Unauthorized error message
892 details: Unauthorized error details
894 $ref: '#/components/schemas/ErrorMessage'
895 description: Unauthorized
901 message: Forbidden error message
902 details: Forbidden error details
904 $ref: '#/components/schemas/ErrorMessage'
905 description: Forbidden
911 message: Internal Server Error
912 details: Internal Server Error occurred
914 $ref: '#/components/schemas/ErrorMessage'
915 description: Internal Server Error
916 summary: Fetch all module references (name and revision) for a given cm handle
919 /v1/ch/{cm-handle}/modules/definitions:
921 description: "Get module definitions (module name, revision, yang resource)\
922 \ with options to filter on module name and revision"
923 operationId: getModuleDefinitions
925 - description: "The identifier for a network function, network element, subnetwork\
926 \ or any other cm object by managed Network CM Proxy"
931 example: my-cm-handle
933 - description: Filter for a module name.This is an optional parameter
940 - description: Filter for a module revision.This is an optional parameter and
941 ignored when no module name is supplied
954 $ref: '#/components/schemas/RestModuleDefinition'
962 message: Unauthorized error message
963 details: Unauthorized error details
965 $ref: '#/components/schemas/ErrorMessage'
966 description: Unauthorized
972 message: Forbidden error message
973 details: Forbidden error details
975 $ref: '#/components/schemas/ErrorMessage'
976 description: Forbidden
982 message: Internal Server Error
983 details: Internal Server Error occurred
985 $ref: '#/components/schemas/ErrorMessage'
986 description: Internal Server Error
987 summary: Get module definitions
992 description: Execute cm handle query search and return a list of cm handle details.
993 Any number of conditions can be applied. To be included in the result a cm-handle
994 must fulfill ALL the conditions. An empty collection will be returned in the
995 case that the cm handle does not match a condition. For more on cm handle
996 query search please refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/ncmp-cmhandle-querying.html">cm
997 handle query search Read the Docs</a>.<br/>By supplying a CPS Path it is possible
998 to query on any data related to the cm handle. For more on CPS Path please
999 refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html">CPS
1000 Path Read the Docs</a>. The cm handle ancestor is automatically returned for
1002 operationId: searchCmHandles
1007 Cm handle properties query:
1008 $ref: '#/components/examples/pubPropCmHandleQueryParameters'
1010 Cm handle modules query:
1011 $ref: '#/components/examples/modulesCmHandleQueryParameters'
1013 All cm handle query parameters:
1014 $ref: '#/components/examples/allCmHandleQueryParameters'
1016 Cm handle with CPS path state query:
1017 $ref: '#/components/examples/cpsPathCmHandleStateQueryParameters'
1019 Cm handle with data sync flag query:
1020 $ref: '#/components/examples/cpsPathCmHandleDataSyncQueryParameters'
1023 $ref: '#/components/schemas/CmHandleQueryParameters'
1031 $ref: '#/components/schemas/RestOutputCmHandle'
1038 status: 400 BAD_REQUEST
1039 message: Bad request error message
1040 details: Bad request error details
1042 $ref: '#/components/schemas/ErrorMessage'
1043 description: Bad Request
1049 message: Unauthorized error message
1050 details: Unauthorized error details
1052 $ref: '#/components/schemas/ErrorMessage'
1053 description: Unauthorized
1059 message: Forbidden error message
1060 details: Forbidden error details
1062 $ref: '#/components/schemas/ErrorMessage'
1063 description: Forbidden
1069 message: Internal Server Error
1070 details: Internal Server Error occurred
1072 $ref: '#/components/schemas/ErrorMessage'
1073 description: Internal Server Error
1074 summary: Execute cm handle search using the available conditions
1079 description: Retrieve CM handle details and properties by cm handle id
1080 operationId: retrieveCmHandleDetailsById
1082 - description: "The identifier for a network function, network element, subnetwork\
1083 \ or any other cm object by managed Network CM Proxy"
1088 example: my-cm-handle
1095 $ref: '#/components/schemas/RestOutputCmHandle'
1101 status: 400 BAD_REQUEST
1102 message: Bad request error message
1103 details: Bad request error details
1105 $ref: '#/components/schemas/ErrorMessage'
1106 description: Bad Request
1112 message: Unauthorized error message
1113 details: Unauthorized error details
1115 $ref: '#/components/schemas/ErrorMessage'
1116 description: Unauthorized
1122 message: Not found error message
1123 details: Not found error details
1125 $ref: '#/components/schemas/ErrorMessage'
1126 description: The specified resource was not found
1132 message: Internal Server Error
1133 details: Internal Server Error occurred
1135 $ref: '#/components/schemas/ErrorMessage'
1136 description: Internal Server Error
1137 summary: Retrieve CM handle details
1140 /v1/ch/{cm-handle}/properties:
1142 description: Get CM handle properties by cm handle id
1143 operationId: getCmHandlePublicPropertiesByCmHandleId
1145 - description: "The identifier for a network function, network element, subnetwork\
1146 \ or any other cm object by managed Network CM Proxy"
1151 example: my-cm-handle
1158 $ref: '#/components/schemas/RestOutputCmHandlePublicProperties'
1164 status: 400 BAD_REQUEST
1165 message: Bad request error message
1166 details: Bad request error details
1168 $ref: '#/components/schemas/ErrorMessage'
1169 description: Bad Request
1175 message: Unauthorized error message
1176 details: Unauthorized error details
1178 $ref: '#/components/schemas/ErrorMessage'
1179 description: Unauthorized
1185 message: Not found error message
1186 details: Not found error details
1188 $ref: '#/components/schemas/ErrorMessage'
1189 description: The specified resource was not found
1195 message: Internal Server Error
1196 details: Internal Server Error occurred
1198 $ref: '#/components/schemas/ErrorMessage'
1199 description: Internal Server Error
1200 summary: Get CM handle properties
1205 description: Execute cm handle query search and return a list of cm handle ids.
1206 Any number of conditions can be applied. To be included in the result a cm-handle
1207 must fulfill ALL the conditions. An empty collection will be returned in the
1208 case that the cm handle does not match a condition. For more on cm handle
1209 query search please refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/ncmp-cmhandle-querying.html">cm
1210 handle query search Read the Docs</a>.<br/>By supplying a CPS Path it is possible
1211 to query on any data related to the cm handle. For more on CPS Path please
1212 refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html">CPS
1213 Path Read the Docs</a>. The cm handle ancestor is automatically returned for
1215 operationId: searchCmHandleIds
1220 Cm handle properties query:
1221 $ref: '#/components/examples/pubPropCmHandleQueryParameters'
1223 Cm handle modules query:
1224 $ref: '#/components/examples/modulesCmHandleQueryParameters'
1226 All cm handle query parameters:
1227 $ref: '#/components/examples/allCmHandleQueryParameters'
1229 Cm handle with CPS path state query:
1230 $ref: '#/components/examples/cpsPathCmHandleStateQueryParameters'
1232 Cm handle with data sync flag query:
1233 $ref: '#/components/examples/cpsPathCmHandleDataSyncQueryParameters'
1236 $ref: '#/components/schemas/CmHandleQueryParameters'
1251 status: 400 BAD_REQUEST
1252 message: Bad request error message
1253 details: Bad request error details
1255 $ref: '#/components/schemas/ErrorMessage'
1256 description: Bad Request
1262 message: Unauthorized error message
1263 details: Unauthorized error details
1265 $ref: '#/components/schemas/ErrorMessage'
1266 description: Unauthorized
1272 message: Forbidden error message
1273 details: Forbidden error details
1275 $ref: '#/components/schemas/ErrorMessage'
1276 description: Forbidden
1282 message: Not found error message
1283 details: Not found error details
1285 $ref: '#/components/schemas/ErrorMessage'
1286 description: The specified resource was not found
1292 message: Internal Server Error
1293 details: Internal Server Error occurred
1295 $ref: '#/components/schemas/ErrorMessage'
1296 description: Internal Server Error
1297 summary: Execute cm handle query upon a given set of query parameters
1300 /v1/ch/{cm-handle}/state:
1302 description: Get CM handle state by cm handle id
1303 operationId: getCmHandleStateByCmHandleId
1305 - description: "The identifier for a network function, network element, subnetwork\
1306 \ or any other cm object by managed Network CM Proxy"
1311 example: my-cm-handle
1318 $ref: '#/components/schemas/RestOutputCmHandleCompositeState'
1324 status: 400 BAD_REQUEST
1325 message: Bad request error message
1326 details: Bad request error details
1328 $ref: '#/components/schemas/ErrorMessage'
1329 description: Bad Request
1335 message: Unauthorized error message
1336 details: Unauthorized error details
1338 $ref: '#/components/schemas/ErrorMessage'
1339 description: Unauthorized
1345 message: Not found error message
1346 details: Not found error details
1348 $ref: '#/components/schemas/ErrorMessage'
1349 description: The specified resource was not found
1355 message: Internal Server Error
1356 details: Internal Server Error occurred
1358 $ref: '#/components/schemas/ErrorMessage'
1359 description: Internal Server Error
1360 summary: Get CM handle state
1363 /v1/ch/{cm-handle}/data-sync:
1365 description: Set the data sync enabled flag to true or false for a specified
1366 Cm-Handle. This will in turn set the data sync state to UNSYNCHRONIZED and
1367 NONE_REQUESTED respectfully.
1368 operationId: setDataSyncEnabledFlagForCmHandle
1370 - description: "The identifier for a network function, network element, subnetwork\
1371 \ or any other cm object by managed Network CM Proxy"
1376 example: my-cm-handle
1378 - description: Is used to enable or disable the data synchronization flag
1380 name: dataSyncEnabled
1396 status: 400 BAD_REQUEST
1397 message: Bad request error message
1398 details: Bad request error details
1400 $ref: '#/components/schemas/ErrorMessage'
1401 description: Bad Request
1407 message: Unauthorized error message
1408 details: Unauthorized error details
1410 $ref: '#/components/schemas/ErrorMessage'
1411 description: Unauthorized
1417 message: Forbidden error message
1418 details: Forbidden error details
1420 $ref: '#/components/schemas/ErrorMessage'
1421 description: Forbidden
1427 message: Internal Server Error
1428 details: Internal Server Error occurred
1430 $ref: '#/components/schemas/ErrorMessage'
1431 description: Internal Server Error
1436 message: Bad Gateway Error Message NCMP
1441 $ref: '#/components/schemas/DmiErrorMessage'
1442 description: Bad Gateway
1443 summary: Set the Data Sync Enabled Flag
1449 description: Sample response for selecting 'sample 1'.
1450 summary: Sample response
1466 description: Sample request body
1467 summary: Sample request
1470 bookstore-name: Chapters
1483 dataSamplePatchRequest:
1484 description: Sample patch request body
1485 summary: Sample patch request
1487 ietf-restconf:yang-patch:
1495 bookstore-name: Chapters
1513 bookstore-name: Novels
1526 pubPropCmHandleQueryParameters:
1528 cmHandleQueryParameters:
1529 - conditionName: hasAllProperties
1530 conditionParameters:
1534 modulesCmHandleQueryParameters:
1536 cmHandleQueryParameters:
1537 - conditionName: hasAllModules
1538 conditionParameters:
1539 - moduleName: my-module-1
1540 - moduleName: my-module-2
1541 - moduleName: my-module-3
1542 allCmHandleQueryParameters:
1544 cmHandleQueryParameters:
1545 - conditionName: hasAllModules
1546 conditionParameters:
1547 - moduleName: my-module-1
1548 - moduleName: my-module-2
1549 - moduleName: my-module-3
1550 - conditionName: hasAllProperties
1551 conditionParameters:
1555 - conditionName: cmHandleWithCpsPath
1556 conditionParameters:
1557 - cpsPath: "//state[@cm-handle-state='ADVISED']"
1558 cpsPathCmHandleStateQueryParameters:
1560 cmHandleQueryParameters:
1561 - conditionName: cmHandleWithCpsPath
1562 conditionParameters:
1563 - cpsPath: "//state[@cm-handle-state='LOCKED']"
1564 cpsPathCmHandleDataSyncQueryParameters:
1566 cmHandleQueryParameters:
1567 - conditionName: cmHandleWithCpsPath
1568 conditionParameters:
1569 - cpsPath: "//state[@data-sync-enabled='true']"
1572 description: The type of the requested data
1574 name: datastore-name
1577 example: ncmp-datastore:running
1580 description: "The identifier for a network function, network element, subnetwork\
1581 \ or any other cm object by managed Network CM Proxy"
1586 example: my-cm-handle
1588 resourceIdentifierInQuery:
1590 description: The format of resource identifier depend on the associated DMI
1591 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but it
1592 can really be anything.
1596 resourceIdentifier: \shops\bookstore
1599 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
1602 resourceIdentifier: "parent=shops,child=bookstore"
1604 name: resourceIdentifier
1608 optionsParamInQuery:
1610 description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
1611 \ in parenthesis'()'. The format of options parameter depend on the associated\
1612 \ DMI Plugin implementation."
1619 options: (fields=book)
1622 options: "(depth=2,fields=book/authors)"
1630 description: topic parameter in query.
1634 topic: my-topic-name
1640 includeDescendantsOptionInQuery:
1641 description: Determines if descendants are included in response
1643 name: include-descendants
1648 contentParamInHeader:
1649 description: "Content parameter for request, if content parameter is null, default\
1650 \ value is application/json."
1655 default: application/json
1656 example: application/yang-data+json
1658 requiredTopicParamInQuery:
1660 description: mandatory topic parameter in query.
1664 topic: my-topic-name
1671 description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1675 list attributes cps path:
1676 value: "//categories[@code=1]"
1684 description: Filter for a module name.This is an optional parameter
1692 description: Filter for a module revision.This is an optional parameter and
1693 ignored when no module name is supplied
1701 description: Is used to enable or disable the data synchronization flag
1703 name: dataSyncEnabled
1713 status: 400 BAD_REQUEST
1714 message: Bad request error message
1715 details: Bad request error details
1717 $ref: '#/components/schemas/ErrorMessage'
1718 description: Bad Request
1724 message: Unauthorized error message
1725 details: Unauthorized error details
1727 $ref: '#/components/schemas/ErrorMessage'
1728 description: Unauthorized
1734 message: Forbidden error message
1735 details: Forbidden error details
1737 $ref: '#/components/schemas/ErrorMessage'
1738 description: Forbidden
1739 InternalServerError:
1744 message: Internal Server Error
1745 details: Internal Server Error occurred
1747 $ref: '#/components/schemas/ErrorMessage'
1748 description: Internal Server Error
1753 message: Bad Gateway Error Message NCMP
1758 $ref: '#/components/schemas/DmiErrorMessage'
1759 description: Bad Gateway
1768 description: Created
1771 description: No Content
1777 message: Not found error message
1778 details: Not found error details
1780 $ref: '#/components/schemas/ErrorMessage'
1781 description: The specified resource was not found
1796 example: Bad Gateway Error Message NCMP
1799 $ref: '#/components/schemas/DmiErrorMessage_dmi_response'
1800 title: DMI Error Message
1802 DataOperationRequest:
1805 - resourceIdentifier: parent/child
1807 - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
1809 - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
1811 datastore: ncmp-datastore:passthrough-operational
1812 options: (fields=schemas/schema)
1815 - resourceIdentifier: parent/child
1817 - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
1819 - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
1821 datastore: ncmp-datastore:passthrough-operational
1822 options: (fields=schemas/schema)
1827 description: contains group of data operation requests
1829 $ref: '#/components/schemas/DataOperationDefinition'
1831 title: execute data operation for given array of operations
1833 DataOperationDefinition:
1835 resourceIdentifier: parent/child
1837 - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
1839 - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
1841 datastore: ncmp-datastore:passthrough-operational
1842 options: (fields=schemas/schema)
1853 example: ncmp-datastore:passthrough-operational
1856 example: (fields=schemas/schema)
1859 example: parent/child
1863 example: "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
1871 RestModuleReference:
1873 moduleName: my-module-name
1874 revision: my-module-revision
1877 example: my-module-name
1880 example: my-module-revision
1882 title: Module reference details
1884 RestModuleDefinition:
1886 moduleName: my-module-name
1890 namespace 'org:onap:ccsdk:sample';
1892 revision '2020-09-15' {
1897 revision: 2020-09-15
1900 example: my-module-name
1909 namespace 'org:onap:ccsdk:sample';
1911 revision '2020-09-15' {
1917 title: Module definitions
1919 CmHandleQueryParameters:
1921 cmHandleQueryParameters:
1922 - conditionParameters:
1923 - key: conditionParameters
1924 - key: conditionParameters
1925 conditionName: conditionName
1926 - conditionParameters:
1927 - key: conditionParameters
1928 - key: conditionParameters
1929 conditionName: conditionName
1932 conditionParameters:
1933 - moduleName: my-module
1934 - moduleName: my-module
1936 conditionParameters:
1937 - moduleName: my-module
1938 - moduleName: my-module
1940 cmHandleQueryParameters:
1942 $ref: '#/components/schemas/ConditionProperties'
1946 description: "not necessary, it is just for backward compatibility"
1948 $ref: '#/components/schemas/OldConditionProperties'
1950 title: Cm Handle query parameters for executing cm handle search
1952 ConditionProperties:
1954 conditionParameters:
1955 - key: conditionParameters
1956 - key: conditionParameters
1957 conditionName: conditionName
1961 conditionParameters:
1963 additionalProperties:
1967 OldConditionProperties:
1971 conditionParameters:
1972 - moduleName: my-module
1973 - moduleName: my-module
1977 conditionParameters:
1979 $ref: '#/components/schemas/ModuleNameAsJsonObject'
1981 ModuleNameAsJsonObject:
1983 moduleName: my-module
1990 cmHandle: my-cm-handle1
1991 publicCmHandleProperties:
1995 dataSyncEnabled: false
1998 lastSyncTime: 2022-12-31T20:30:40.000+0000
1999 syncState: NONE_REQUESTED
2001 lastSyncTime: 2022-12-31T20:30:40.000+0000
2002 syncState: NONE_REQUESTED
2003 cmHandleState: ADVISED
2005 reason: LOCKED_MISBEHAVING
2006 details: locked due to failure in module sync
2007 lastUpdateTime: 2022-12-31T20:30:40.000+0000
2008 trustLevel: COMPLETE
2011 example: my-cm-handle1
2013 publicCmHandleProperties:
2015 additionalProperties:
2021 $ref: '#/components/schemas/CmHandleCompositeState'
2023 description: Current trust level of the relevant CM handle ID.
2026 title: CM handle Details
2028 CmHandlePublicProperties:
2030 additionalProperties:
2035 CmHandleCompositeState:
2037 dataSyncEnabled: false
2040 lastSyncTime: 2022-12-31T20:30:40.000+0000
2041 syncState: NONE_REQUESTED
2043 lastSyncTime: 2022-12-31T20:30:40.000+0000
2044 syncState: NONE_REQUESTED
2045 cmHandleState: ADVISED
2047 reason: LOCKED_MISBEHAVING
2048 details: locked due to failure in module sync
2049 lastUpdateTime: 2022-12-31T20:30:40.000+0000
2055 $ref: '#/components/schemas/lock-reason'
2057 example: 2022-12-31T20:30:40.000+0000
2063 $ref: '#/components/schemas/dataStores'
2067 reason: LOCKED_MISBEHAVING
2068 details: locked due to failure in module sync
2071 example: LOCKED_MISBEHAVING
2074 example: locked due to failure in module sync
2080 lastSyncTime: 2022-12-31T20:30:40.000+0000
2081 syncState: NONE_REQUESTED
2083 lastSyncTime: 2022-12-31T20:30:40.000+0000
2084 syncState: NONE_REQUESTED
2087 $ref: '#/components/schemas/sync-state'
2089 $ref: '#/components/schemas/sync-state'
2093 lastSyncTime: 2022-12-31T20:30:40.000+0000
2094 syncState: NONE_REQUESTED
2097 example: NONE_REQUESTED
2100 example: 2022-12-31T20:30:40.000+0000
2104 description: Current trust level of the relevant CM handle ID.
2107 RestOutputCmHandlePublicProperties:
2109 publicCmHandleProperties:
2113 publicCmHandleProperties:
2115 additionalProperties:
2121 RestOutputCmHandleCompositeState:
2124 dataSyncEnabled: false
2127 lastSyncTime: 2022-12-31T20:30:40.000+0000
2128 syncState: NONE_REQUESTED
2130 lastSyncTime: 2022-12-31T20:30:40.000+0000
2131 syncState: NONE_REQUESTED
2132 cmHandleState: ADVISED
2134 reason: LOCKED_MISBEHAVING
2135 details: locked due to failure in module sync
2136 lastUpdateTime: 2022-12-31T20:30:40.000+0000
2139 $ref: '#/components/schemas/CmHandleCompositeState'
2141 DmiErrorMessage_dmi_response:
2147 example: Bad Request