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: "Fetch all module definitions (name, revision, yang resource) for\
923 operationId: getModuleDefinitionsByCmHandleId
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
939 $ref: '#/components/schemas/RestModuleDefinition'
947 message: Unauthorized error message
948 details: Unauthorized error details
950 $ref: '#/components/schemas/ErrorMessage'
951 description: Unauthorized
957 message: Forbidden error message
958 details: Forbidden error details
960 $ref: '#/components/schemas/ErrorMessage'
961 description: Forbidden
967 message: Internal Server Error
968 details: Internal Server Error occurred
970 $ref: '#/components/schemas/ErrorMessage'
971 description: Internal Server Error
972 summary: "Fetch all module definitions (name, revision, yang resource) for a\
978 description: Execute cm handle query search and return a list of cm handle details.
979 Any number of conditions can be applied. To be included in the result a cm-handle
980 must fulfill ALL the conditions. An empty collection will be returned in the
981 case that the cm handle does not match a condition. For more on cm handle
982 query search please refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/ncmp-cmhandle-querying.html">cm
983 handle query search Read the Docs</a>.<br/>By supplying a CPS Path it is possible
984 to query on any data related to the cm handle. For more on CPS Path please
985 refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html">CPS
986 Path Read the Docs</a>. The cm handle ancestor is automatically returned for
988 operationId: searchCmHandles
993 Cm handle properties query:
994 $ref: '#/components/examples/pubPropCmHandleQueryParameters'
996 Cm handle modules query:
997 $ref: '#/components/examples/modulesCmHandleQueryParameters'
999 All cm handle query parameters:
1000 $ref: '#/components/examples/allCmHandleQueryParameters'
1002 Cm handle with CPS path state query:
1003 $ref: '#/components/examples/cpsPathCmHandleStateQueryParameters'
1005 Cm handle with data sync flag query:
1006 $ref: '#/components/examples/cpsPathCmHandleDataSyncQueryParameters'
1009 $ref: '#/components/schemas/CmHandleQueryParameters'
1017 $ref: '#/components/schemas/RestOutputCmHandle'
1024 status: 400 BAD_REQUEST
1025 message: Bad request error message
1026 details: Bad request error details
1028 $ref: '#/components/schemas/ErrorMessage'
1029 description: Bad Request
1035 message: Unauthorized error message
1036 details: Unauthorized error details
1038 $ref: '#/components/schemas/ErrorMessage'
1039 description: Unauthorized
1045 message: Forbidden error message
1046 details: Forbidden error details
1048 $ref: '#/components/schemas/ErrorMessage'
1049 description: Forbidden
1055 message: Internal Server Error
1056 details: Internal Server Error occurred
1058 $ref: '#/components/schemas/ErrorMessage'
1059 description: Internal Server Error
1060 summary: Execute cm handle search using the available conditions
1065 description: Retrieve CM handle details and properties by cm handle id
1066 operationId: retrieveCmHandleDetailsById
1068 - description: "The identifier for a network function, network element, subnetwork\
1069 \ or any other cm object by managed Network CM Proxy"
1074 example: my-cm-handle
1081 $ref: '#/components/schemas/RestOutputCmHandle'
1087 status: 400 BAD_REQUEST
1088 message: Bad request error message
1089 details: Bad request error details
1091 $ref: '#/components/schemas/ErrorMessage'
1092 description: Bad Request
1098 message: Unauthorized error message
1099 details: Unauthorized error details
1101 $ref: '#/components/schemas/ErrorMessage'
1102 description: Unauthorized
1108 message: Not found error message
1109 details: Not found error details
1111 $ref: '#/components/schemas/ErrorMessage'
1112 description: The specified resource was not found
1118 message: Internal Server Error
1119 details: Internal Server Error occurred
1121 $ref: '#/components/schemas/ErrorMessage'
1122 description: Internal Server Error
1123 summary: Retrieve CM handle details
1126 /v1/ch/{cm-handle}/properties:
1128 description: Get CM handle properties by cm handle id
1129 operationId: getCmHandlePublicPropertiesByCmHandleId
1131 - description: "The identifier for a network function, network element, subnetwork\
1132 \ or any other cm object by managed Network CM Proxy"
1137 example: my-cm-handle
1144 $ref: '#/components/schemas/RestOutputCmHandlePublicProperties'
1150 status: 400 BAD_REQUEST
1151 message: Bad request error message
1152 details: Bad request error details
1154 $ref: '#/components/schemas/ErrorMessage'
1155 description: Bad Request
1161 message: Unauthorized error message
1162 details: Unauthorized error details
1164 $ref: '#/components/schemas/ErrorMessage'
1165 description: Unauthorized
1171 message: Not found error message
1172 details: Not found error details
1174 $ref: '#/components/schemas/ErrorMessage'
1175 description: The specified resource was not found
1181 message: Internal Server Error
1182 details: Internal Server Error occurred
1184 $ref: '#/components/schemas/ErrorMessage'
1185 description: Internal Server Error
1186 summary: Get CM handle properties
1191 description: Execute cm handle query search and return a list of cm handle ids.
1192 Any number of conditions can be applied. To be included in the result a cm-handle
1193 must fulfill ALL the conditions. An empty collection will be returned in the
1194 case that the cm handle does not match a condition. For more on cm handle
1195 query search please refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/ncmp-cmhandle-querying.html">cm
1196 handle query search Read the Docs</a>.<br/>By supplying a CPS Path it is possible
1197 to query on any data related to the cm handle. For more on CPS Path please
1198 refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html">CPS
1199 Path Read the Docs</a>. The cm handle ancestor is automatically returned for
1201 operationId: searchCmHandleIds
1206 Cm handle properties query:
1207 $ref: '#/components/examples/pubPropCmHandleQueryParameters'
1209 Cm handle modules query:
1210 $ref: '#/components/examples/modulesCmHandleQueryParameters'
1212 All cm handle query parameters:
1213 $ref: '#/components/examples/allCmHandleQueryParameters'
1215 Cm handle with CPS path state query:
1216 $ref: '#/components/examples/cpsPathCmHandleStateQueryParameters'
1218 Cm handle with data sync flag query:
1219 $ref: '#/components/examples/cpsPathCmHandleDataSyncQueryParameters'
1222 $ref: '#/components/schemas/CmHandleQueryParameters'
1237 status: 400 BAD_REQUEST
1238 message: Bad request error message
1239 details: Bad request error details
1241 $ref: '#/components/schemas/ErrorMessage'
1242 description: Bad Request
1248 message: Unauthorized error message
1249 details: Unauthorized error details
1251 $ref: '#/components/schemas/ErrorMessage'
1252 description: Unauthorized
1258 message: Forbidden error message
1259 details: Forbidden error details
1261 $ref: '#/components/schemas/ErrorMessage'
1262 description: Forbidden
1268 message: Not found error message
1269 details: Not found error details
1271 $ref: '#/components/schemas/ErrorMessage'
1272 description: The specified resource was not found
1278 message: Internal Server Error
1279 details: Internal Server Error occurred
1281 $ref: '#/components/schemas/ErrorMessage'
1282 description: Internal Server Error
1283 summary: Execute cm handle query upon a given set of query parameters
1286 /v1/ch/{cm-handle}/state:
1288 description: Get CM handle state by cm handle id
1289 operationId: getCmHandleStateByCmHandleId
1291 - description: "The identifier for a network function, network element, subnetwork\
1292 \ or any other cm object by managed Network CM Proxy"
1297 example: my-cm-handle
1304 $ref: '#/components/schemas/RestOutputCmHandleCompositeState'
1310 status: 400 BAD_REQUEST
1311 message: Bad request error message
1312 details: Bad request error details
1314 $ref: '#/components/schemas/ErrorMessage'
1315 description: Bad Request
1321 message: Unauthorized error message
1322 details: Unauthorized error details
1324 $ref: '#/components/schemas/ErrorMessage'
1325 description: Unauthorized
1331 message: Not found error message
1332 details: Not found error details
1334 $ref: '#/components/schemas/ErrorMessage'
1335 description: The specified resource was not found
1341 message: Internal Server Error
1342 details: Internal Server Error occurred
1344 $ref: '#/components/schemas/ErrorMessage'
1345 description: Internal Server Error
1346 summary: Get CM handle state
1349 /v1/ch/{cm-handle}/data-sync:
1351 description: Set the data sync enabled flag to true or false for a specified
1352 Cm-Handle. This will in turn set the data sync state to UNSYNCHRONIZED and
1353 NONE_REQUESTED respectfully.
1354 operationId: setDataSyncEnabledFlagForCmHandle
1356 - description: "The identifier for a network function, network element, subnetwork\
1357 \ or any other cm object by managed Network CM Proxy"
1362 example: my-cm-handle
1364 - description: Is used to enable or disable the data synchronization flag
1366 name: dataSyncEnabled
1382 status: 400 BAD_REQUEST
1383 message: Bad request error message
1384 details: Bad request error details
1386 $ref: '#/components/schemas/ErrorMessage'
1387 description: Bad Request
1393 message: Unauthorized error message
1394 details: Unauthorized error details
1396 $ref: '#/components/schemas/ErrorMessage'
1397 description: Unauthorized
1403 message: Forbidden error message
1404 details: Forbidden error details
1406 $ref: '#/components/schemas/ErrorMessage'
1407 description: Forbidden
1413 message: Internal Server Error
1414 details: Internal Server Error occurred
1416 $ref: '#/components/schemas/ErrorMessage'
1417 description: Internal Server Error
1422 message: Bad Gateway Error Message NCMP
1427 $ref: '#/components/schemas/DmiErrorMessage'
1428 description: Bad Gateway
1429 summary: Set the Data Sync Enabled Flag
1435 description: Sample response for selecting 'sample 1'.
1436 summary: Sample response
1452 description: Sample request body
1453 summary: Sample request
1456 bookstore-name: Chapters
1469 dataSamplePatchRequest:
1470 description: Sample patch request body
1471 summary: Sample patch request
1473 ietf-restconf:yang-patch:
1481 bookstore-name: Chapters
1499 bookstore-name: Novels
1512 pubPropCmHandleQueryParameters:
1514 cmHandleQueryParameters:
1515 - conditionName: hasAllProperties
1516 conditionParameters:
1520 modulesCmHandleQueryParameters:
1522 cmHandleQueryParameters:
1523 - conditionName: hasAllModules
1524 conditionParameters:
1525 - moduleName: my-module-1
1526 - moduleName: my-module-2
1527 - moduleName: my-module-3
1528 allCmHandleQueryParameters:
1530 cmHandleQueryParameters:
1531 - conditionName: hasAllModules
1532 conditionParameters:
1533 - moduleName: my-module-1
1534 - moduleName: my-module-2
1535 - moduleName: my-module-3
1536 - conditionName: hasAllProperties
1537 conditionParameters:
1541 - conditionName: cmHandleWithCpsPath
1542 conditionParameters:
1543 - cpsPath: "//state[@cm-handle-state='ADVISED']"
1544 cpsPathCmHandleStateQueryParameters:
1546 cmHandleQueryParameters:
1547 - conditionName: cmHandleWithCpsPath
1548 conditionParameters:
1549 - cpsPath: "//state[@cm-handle-state='LOCKED']"
1550 cpsPathCmHandleDataSyncQueryParameters:
1552 cmHandleQueryParameters:
1553 - conditionName: cmHandleWithCpsPath
1554 conditionParameters:
1555 - cpsPath: "//state[@data-sync-enabled='true']"
1558 description: The type of the requested data
1560 name: datastore-name
1563 example: ncmp-datastore:running
1566 description: "The identifier for a network function, network element, subnetwork\
1567 \ or any other cm object by managed Network CM Proxy"
1572 example: my-cm-handle
1574 resourceIdentifierInQuery:
1576 description: The format of resource identifier depend on the associated DMI
1577 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but it
1578 can really be anything.
1582 resourceIdentifier: \shops\bookstore
1585 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
1588 resourceIdentifier: "parent=shops,child=bookstore"
1590 name: resourceIdentifier
1594 optionsParamInQuery:
1596 description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
1597 \ in parenthesis'()'. The format of options parameter depend on the associated\
1598 \ DMI Plugin implementation."
1605 options: (fields=book)
1608 options: "(depth=2,fields=book/authors)"
1616 description: topic parameter in query.
1620 topic: my-topic-name
1626 includeDescendantsOptionInQuery:
1627 description: Determines if descendants are included in response
1629 name: include-descendants
1634 contentParamInHeader:
1635 description: "Content parameter for request, if content parameter is null, default\
1636 \ value is application/json."
1641 default: application/json
1642 example: application/yang-data+json
1644 requiredTopicParamInQuery:
1646 description: mandatory topic parameter in query.
1650 topic: my-topic-name
1657 description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1661 list attributes cps path:
1662 value: "//categories[@code=1]"
1670 description: Is used to enable or disable the data synchronization flag
1672 name: dataSyncEnabled
1682 status: 400 BAD_REQUEST
1683 message: Bad request error message
1684 details: Bad request error details
1686 $ref: '#/components/schemas/ErrorMessage'
1687 description: Bad Request
1693 message: Unauthorized error message
1694 details: Unauthorized error details
1696 $ref: '#/components/schemas/ErrorMessage'
1697 description: Unauthorized
1703 message: Forbidden error message
1704 details: Forbidden error details
1706 $ref: '#/components/schemas/ErrorMessage'
1707 description: Forbidden
1708 InternalServerError:
1713 message: Internal Server Error
1714 details: Internal Server Error occurred
1716 $ref: '#/components/schemas/ErrorMessage'
1717 description: Internal Server Error
1722 message: Bad Gateway Error Message NCMP
1727 $ref: '#/components/schemas/DmiErrorMessage'
1728 description: Bad Gateway
1737 description: Created
1740 description: No Content
1746 message: Not found error message
1747 details: Not found error details
1749 $ref: '#/components/schemas/ErrorMessage'
1750 description: The specified resource was not found
1765 example: Bad Gateway Error Message NCMP
1768 $ref: '#/components/schemas/DmiErrorMessage_dmi_response'
1769 title: DMI Error Message
1771 DataOperationRequest:
1774 - resourceIdentifier: parent/child
1776 - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
1778 - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
1780 datastore: ncmp-datastore:passthrough-operational
1781 options: (fields=schemas/schema)
1784 - resourceIdentifier: parent/child
1786 - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
1788 - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
1790 datastore: ncmp-datastore:passthrough-operational
1791 options: (fields=schemas/schema)
1796 description: contains group of data operation requests
1798 $ref: '#/components/schemas/DataOperationDefinition'
1800 title: execute data operation for given array of operations
1802 DataOperationDefinition:
1804 resourceIdentifier: parent/child
1806 - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
1808 - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
1810 datastore: ncmp-datastore:passthrough-operational
1811 options: (fields=schemas/schema)
1822 example: ncmp-datastore:passthrough-operational
1825 example: (fields=schemas/schema)
1828 example: parent/child
1832 example: "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
1840 RestModuleReference:
1842 moduleName: my-module-name
1843 revision: my-module-revision
1846 example: my-module-name
1849 example: my-module-revision
1851 title: Module reference details
1853 RestModuleDefinition:
1855 moduleName: my-module-name
1859 namespace 'org:onap:ccsdk:sample';
1861 revision '2020-09-15' {
1866 revision: 2020-09-15
1869 example: my-module-name
1878 namespace 'org:onap:ccsdk:sample';
1880 revision '2020-09-15' {
1886 title: Module definitions
1888 CmHandleQueryParameters:
1890 cmHandleQueryParameters:
1891 - conditionParameters:
1892 - key: conditionParameters
1893 - key: conditionParameters
1894 conditionName: conditionName
1895 - conditionParameters:
1896 - key: conditionParameters
1897 - key: conditionParameters
1898 conditionName: conditionName
1901 conditionParameters:
1902 - moduleName: my-module
1903 - moduleName: my-module
1905 conditionParameters:
1906 - moduleName: my-module
1907 - moduleName: my-module
1909 cmHandleQueryParameters:
1911 $ref: '#/components/schemas/ConditionProperties'
1915 description: "not necessary, it is just for backward compatibility"
1917 $ref: '#/components/schemas/OldConditionProperties'
1919 title: Cm Handle query parameters for executing cm handle search
1921 ConditionProperties:
1923 conditionParameters:
1924 - key: conditionParameters
1925 - key: conditionParameters
1926 conditionName: conditionName
1930 conditionParameters:
1932 additionalProperties:
1936 OldConditionProperties:
1940 conditionParameters:
1941 - moduleName: my-module
1942 - moduleName: my-module
1946 conditionParameters:
1948 $ref: '#/components/schemas/ModuleNameAsJsonObject'
1950 ModuleNameAsJsonObject:
1952 moduleName: my-module
1959 cmHandle: my-cm-handle1
1960 publicCmHandleProperties:
1964 dataSyncEnabled: false
1967 lastSyncTime: 2022-12-31T20:30:40.000+0000
1968 syncState: NONE_REQUESTED
1970 lastSyncTime: 2022-12-31T20:30:40.000+0000
1971 syncState: NONE_REQUESTED
1972 cmHandleState: ADVISED
1974 reason: LOCKED_MISBEHAVING
1975 details: locked due to failure in module sync
1976 lastUpdateTime: 2022-12-31T20:30:40.000+0000
1977 trustLevel: COMPLETE
1980 example: my-cm-handle1
1982 publicCmHandleProperties:
1984 additionalProperties:
1990 $ref: '#/components/schemas/CmHandleCompositeState'
1992 description: Current trust level of the relevant CM handle ID.
1995 title: CM handle Details
1997 CmHandlePublicProperties:
1999 additionalProperties:
2004 CmHandleCompositeState:
2006 dataSyncEnabled: false
2009 lastSyncTime: 2022-12-31T20:30:40.000+0000
2010 syncState: NONE_REQUESTED
2012 lastSyncTime: 2022-12-31T20:30:40.000+0000
2013 syncState: NONE_REQUESTED
2014 cmHandleState: ADVISED
2016 reason: LOCKED_MISBEHAVING
2017 details: locked due to failure in module sync
2018 lastUpdateTime: 2022-12-31T20:30:40.000+0000
2024 $ref: '#/components/schemas/lock-reason'
2026 example: 2022-12-31T20:30:40.000+0000
2032 $ref: '#/components/schemas/dataStores'
2036 reason: LOCKED_MISBEHAVING
2037 details: locked due to failure in module sync
2040 example: LOCKED_MISBEHAVING
2043 example: locked due to failure in module sync
2049 lastSyncTime: 2022-12-31T20:30:40.000+0000
2050 syncState: NONE_REQUESTED
2052 lastSyncTime: 2022-12-31T20:30:40.000+0000
2053 syncState: NONE_REQUESTED
2056 $ref: '#/components/schemas/sync-state'
2058 $ref: '#/components/schemas/sync-state'
2062 lastSyncTime: 2022-12-31T20:30:40.000+0000
2063 syncState: NONE_REQUESTED
2066 example: NONE_REQUESTED
2069 example: 2022-12-31T20:30:40.000+0000
2073 description: Current trust level of the relevant CM handle ID.
2076 RestOutputCmHandlePublicProperties:
2078 publicCmHandleProperties:
2082 publicCmHandleProperties:
2084 additionalProperties:
2090 RestOutputCmHandleCompositeState:
2093 dataSyncEnabled: false
2096 lastSyncTime: 2022-12-31T20:30:40.000+0000
2097 syncState: NONE_REQUESTED
2099 lastSyncTime: 2022-12-31T20:30:40.000+0000
2100 syncState: NONE_REQUESTED
2101 cmHandleState: ADVISED
2103 reason: LOCKED_MISBEHAVING
2104 details: locked due to failure in module sync
2105 lastUpdateTime: 2022-12-31T20:30:40.000+0000
2108 $ref: '#/components/schemas/CmHandleCompositeState'
2110 DmiErrorMessage_dmi_response:
2116 example: Bad Request