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
59 - description: Authorization parameter for request.
68 description: No Content
73 status: 400 BAD_REQUEST
74 message: Bad request error message
75 details: Bad request error details
77 $ref: '#/components/schemas/ErrorMessage'
78 description: Bad Request
84 message: Forbidden error message
85 details: Forbidden error details
87 $ref: '#/components/schemas/ErrorMessage'
88 description: Forbidden
94 message: Not found error message
95 details: Not found error details
97 $ref: '#/components/schemas/ErrorMessage'
98 description: The specified resource was not found
104 message: Internal Server Error
105 details: Internal Server Error occurred
107 $ref: '#/components/schemas/ErrorMessage'
108 description: Internal Server Error
113 message: Bad Gateway Error Message NCMP
118 $ref: '#/components/schemas/DmiErrorMessage'
119 description: Bad Gateway
120 summary: Delete resource data
124 description: Get resource data for given cm handle
125 operationId: getResourceDataForCmHandle
127 - description: The type of the requested data
132 example: ncmp-datastore:running
134 - description: "The identifier for a network function, network element, subnetwork\
135 \ or any other cm object by managed Network CM Proxy"
140 example: my-cm-handle
142 - allowReserved: true
143 description: The format of resource identifier depend on the associated DMI
144 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
145 it can really be anything.
149 resourceIdentifier: \shops\bookstore
152 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
155 resourceIdentifier: "parent=shops,child=bookstore"
157 name: resourceIdentifier
161 - allowReserved: true
162 description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
163 \ in parenthesis'()'. The format of options parameter depend on the associated\
164 \ DMI Plugin implementation."
171 options: (fields=book)
174 options: "(depth=2,fields=book/authors)"
180 - allowReserved: true
181 description: topic parameter in query.
191 - description: Determines if descendants are included in response
193 name: include-descendants
198 - description: Authorization parameter for request.
210 $ref: '#/components/examples/dataSampleResponse'
219 status: 400 BAD_REQUEST
220 message: Bad request error message
221 details: Bad request error details
223 $ref: '#/components/schemas/ErrorMessage'
224 description: Bad Request
230 message: Forbidden error message
231 details: Forbidden error details
233 $ref: '#/components/schemas/ErrorMessage'
234 description: Forbidden
240 message: Internal Server Error
241 details: Internal Server Error occurred
243 $ref: '#/components/schemas/ErrorMessage'
244 description: Internal Server Error
249 message: Bad Gateway Error Message NCMP
254 $ref: '#/components/schemas/DmiErrorMessage'
255 description: Bad Gateway
256 summary: Get resource data for cm handle
260 description: Patch resource data from pass-through running for the given cm
262 operationId: patchResourceDataRunningForCmHandle
264 - description: The type of the requested data
269 example: ncmp-datastore:running
271 - description: "The identifier for a network function, network element, subnetwork\
272 \ or any other cm object by managed Network CM Proxy"
277 example: my-cm-handle
279 - allowReserved: true
280 description: The format of resource identifier depend on the associated DMI
281 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
282 it can really be anything.
286 resourceIdentifier: \shops\bookstore
289 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
292 resourceIdentifier: "parent=shops,child=bookstore"
294 name: resourceIdentifier
298 - description: "Content parameter for request, if content parameter is null,\
299 \ default value is application/json."
304 default: application/json
305 example: application/yang-data+json
307 - description: Authorization parameter for request.
318 $ref: '#/components/examples/dataSamplePatchRequest'
334 status: 400 BAD_REQUEST
335 message: Bad request error message
336 details: Bad request error details
338 $ref: '#/components/schemas/ErrorMessage'
339 description: Bad Request
345 message: Forbidden error message
346 details: Forbidden error details
348 $ref: '#/components/schemas/ErrorMessage'
349 description: Forbidden
355 message: Internal Server Error
356 details: Internal Server Error occurred
358 $ref: '#/components/schemas/ErrorMessage'
359 description: Internal Server Error
364 message: Bad Gateway Error Message NCMP
369 $ref: '#/components/schemas/DmiErrorMessage'
370 description: Bad Gateway
371 summary: Patch resource data from pass-through running
375 description: create resource data from pass-through running for given cm handle
376 operationId: createResourceDataRunningForCmHandle
378 - description: The type of the requested data
383 example: ncmp-datastore:running
385 - description: "The identifier for a network function, network element, subnetwork\
386 \ or any other cm object by managed Network CM Proxy"
391 example: my-cm-handle
393 - allowReserved: true
394 description: The format of resource identifier depend on the associated DMI
395 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
396 it can really be anything.
400 resourceIdentifier: \shops\bookstore
403 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
406 resourceIdentifier: "parent=shops,child=bookstore"
408 name: resourceIdentifier
412 - description: "Content parameter for request, if content parameter is null,\
413 \ default value is application/json."
418 default: application/json
419 example: application/yang-data+json
421 - description: Authorization parameter for request.
432 $ref: '#/components/examples/dataSampleRequest'
436 application/yang-data+json:
439 $ref: '#/components/examples/dataSampleRequest'
452 status: 400 BAD_REQUEST
453 message: Bad request error message
454 details: Bad request error details
456 $ref: '#/components/schemas/ErrorMessage'
457 description: Bad Request
463 message: Forbidden error message
464 details: Forbidden error details
466 $ref: '#/components/schemas/ErrorMessage'
467 description: Forbidden
473 message: Internal Server Error
474 details: Internal Server Error occurred
476 $ref: '#/components/schemas/ErrorMessage'
477 description: Internal Server Error
482 message: Bad Gateway Error Message NCMP
487 $ref: '#/components/schemas/DmiErrorMessage'
488 description: Bad Gateway
489 summary: create resource data from pass-through running for cm handle
493 description: Update resource data from pass-through running for the given cm
495 operationId: updateResourceDataRunningForCmHandle
497 - description: The type of the requested data
502 example: ncmp-datastore:running
504 - description: "The identifier for a network function, network element, subnetwork\
505 \ or any other cm object by managed Network CM Proxy"
510 example: my-cm-handle
512 - allowReserved: true
513 description: The format of resource identifier depend on the associated DMI
514 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
515 it can really be anything.
519 resourceIdentifier: \shops\bookstore
522 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
525 resourceIdentifier: "parent=shops,child=bookstore"
527 name: resourceIdentifier
531 - description: "Content parameter for request, if content parameter is null,\
532 \ default value is application/json."
537 default: application/json
538 example: application/yang-data+json
540 - description: Authorization parameter for request.
551 $ref: '#/components/examples/dataSampleRequest'
555 application/yang-data+json:
558 $ref: '#/components/examples/dataSampleRequest'
574 status: 400 BAD_REQUEST
575 message: Bad request error message
576 details: Bad request error details
578 $ref: '#/components/schemas/ErrorMessage'
579 description: Bad Request
585 message: Forbidden error message
586 details: Forbidden error details
588 $ref: '#/components/schemas/ErrorMessage'
589 description: Forbidden
595 message: Internal Server Error
596 details: Internal Server Error occurred
598 $ref: '#/components/schemas/ErrorMessage'
599 description: Internal Server Error
604 message: Bad Gateway Error Message NCMP
609 $ref: '#/components/schemas/DmiErrorMessage'
610 description: Bad Gateway
611 summary: Update resource data from pass-through running for a cm handle
616 description: This request will be handled asynchronously using messaging to
617 the supplied topic. The rest response will be an acknowledge with a requestId
618 to identify the relevant messages.
619 operationId: executeDataOperationForCmHandles
621 - allowReserved: true
622 description: mandatory topic parameter in query.
632 - description: Authorization parameter for request.
642 $ref: '#/components/schemas/DataOperationRequest'
655 status: 400 BAD_REQUEST
656 message: Bad request error message
657 details: Bad request error details
659 $ref: '#/components/schemas/ErrorMessage'
660 description: Bad Request
666 message: Forbidden error message
667 details: Forbidden error details
669 $ref: '#/components/schemas/ErrorMessage'
670 description: Forbidden
676 message: Internal Server Error
677 details: Internal Server Error occurred
679 $ref: '#/components/schemas/ErrorMessage'
680 description: Internal Server Error
685 message: Bad Gateway Error Message NCMP
690 $ref: '#/components/schemas/DmiErrorMessage'
691 description: Bad Gateway
692 summary: Execute a data operation for group of cm handle ids
695 /v1/ch/{cm-handle}/data/ds/{datastore-name}/query:
697 description: Query resource data for a given cm handle
698 operationId: queryResourceDataForCmHandle
700 - description: The type of the requested data
705 example: ncmp-datastore:running
707 - description: "The identifier for a network function, network element, subnetwork\
708 \ or any other cm object by managed Network CM Proxy"
713 example: my-cm-handle
715 - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
719 list attributes cps path:
720 value: "//categories[@code=1]"
727 - allowReserved: true
728 description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
729 \ in parenthesis'()'. The format of options parameter depend on the associated\
730 \ DMI Plugin implementation."
737 options: (fields=book)
740 options: "(depth=2,fields=book/authors)"
746 - allowReserved: true
747 description: topic parameter in query.
757 - description: Determines if descendants are included in response
759 name: include-descendants
770 $ref: '#/components/examples/dataSampleResponse'
779 status: 400 BAD_REQUEST
780 message: Bad request error message
781 details: Bad request error details
783 $ref: '#/components/schemas/ErrorMessage'
784 description: Bad Request
790 message: Forbidden error message
791 details: Forbidden error details
793 $ref: '#/components/schemas/ErrorMessage'
794 description: Forbidden
800 message: Internal Server Error
801 details: Internal Server Error occurred
803 $ref: '#/components/schemas/ErrorMessage'
804 description: Internal Server Error
809 message: Bad Gateway Error Message NCMP
814 $ref: '#/components/schemas/DmiErrorMessage'
815 description: Bad Gateway
816 summary: Query resource data for a given cm handle
819 /v1/ch/{cm-handle}/modules:
821 description: fetch all module references (name and revision) for a given cm
823 operationId: getModuleReferencesByCmHandle
825 - description: "The identifier for a network function, network element, subnetwork\
826 \ or any other cm object by managed Network CM Proxy"
831 example: my-cm-handle
839 $ref: '#/components/schemas/RestModuleReference'
846 status: 400 BAD_REQUEST
847 message: Bad request error message
848 details: Bad request error details
850 $ref: '#/components/schemas/ErrorMessage'
851 description: Bad Request
857 message: Forbidden error message
858 details: Forbidden error details
860 $ref: '#/components/schemas/ErrorMessage'
861 description: Forbidden
867 message: Internal Server Error
868 details: Internal Server Error occurred
870 $ref: '#/components/schemas/ErrorMessage'
871 description: Internal Server Error
872 summary: Fetch all module references (name and revision) for a given cm handle
875 /v1/ch/{cm-handle}/modules/definitions:
877 description: "Get module definitions (module name, revision, yang resource)\
878 \ with options to filter on module name and revision"
879 operationId: getModuleDefinitions
881 - description: "The identifier for a network function, network element, subnetwork\
882 \ or any other cm object by managed Network CM Proxy"
887 example: my-cm-handle
889 - description: Filter for a module name.This is an optional parameter
896 - description: Filter for a module revision.This is an optional parameter and
897 ignored when no module name is supplied
910 $ref: '#/components/schemas/RestModuleDefinition'
918 message: Forbidden error message
919 details: Forbidden error details
921 $ref: '#/components/schemas/ErrorMessage'
922 description: Forbidden
928 message: Internal Server Error
929 details: Internal Server Error occurred
931 $ref: '#/components/schemas/ErrorMessage'
932 description: Internal Server Error
933 summary: Get module definitions
938 description: Execute cm handle query search and return a list of cm handle details.
939 Any number of conditions can be applied. To be included in the result a cm-handle
940 must fulfill ALL the conditions. An empty collection will be returned in the
941 case that the cm handle does not match a condition. For more on cm handle
942 query search please refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/ncmp-cmhandle-querying.html">cm
943 handle query search Read the Docs</a>.<br/>By supplying a CPS Path it is possible
944 to query on any data related to the cm handle. For more on CPS Path please
945 refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html">CPS
946 Path Read the Docs</a>. The cm handle ancestor is automatically returned for
948 operationId: searchCmHandles
953 Cm handle properties query:
954 $ref: '#/components/examples/pubPropCmHandleQueryParameters'
956 Cm handle modules query:
957 $ref: '#/components/examples/modulesCmHandleQueryParameters'
959 All cm handle query parameters:
960 $ref: '#/components/examples/allCmHandleQueryParameters'
962 Cm handle with CPS path state query:
963 $ref: '#/components/examples/cpsPathCmHandleStateQueryParameters'
965 Cm handle with data sync flag query:
966 $ref: '#/components/examples/cpsPathCmHandleDataSyncQueryParameters'
969 $ref: '#/components/schemas/CmHandleQueryParameters'
977 $ref: '#/components/schemas/RestOutputCmHandle'
984 status: 400 BAD_REQUEST
985 message: Bad request error message
986 details: Bad request error details
988 $ref: '#/components/schemas/ErrorMessage'
989 description: Bad Request
995 message: Forbidden error message
996 details: Forbidden error details
998 $ref: '#/components/schemas/ErrorMessage'
999 description: Forbidden
1005 message: Internal Server Error
1006 details: Internal Server Error occurred
1008 $ref: '#/components/schemas/ErrorMessage'
1009 description: Internal Server Error
1010 summary: Execute cm handle search using the available conditions
1015 description: Retrieve CM handle details and properties by cm handle id
1016 operationId: retrieveCmHandleDetailsById
1018 - description: "The identifier for a network function, network element, subnetwork\
1019 \ or any other cm object by managed Network CM Proxy"
1024 example: my-cm-handle
1031 $ref: '#/components/schemas/RestOutputCmHandle'
1037 status: 400 BAD_REQUEST
1038 message: Bad request error message
1039 details: Bad request error details
1041 $ref: '#/components/schemas/ErrorMessage'
1042 description: Bad Request
1048 message: Not found error message
1049 details: Not found error details
1051 $ref: '#/components/schemas/ErrorMessage'
1052 description: The specified resource was not found
1058 message: Internal Server Error
1059 details: Internal Server Error occurred
1061 $ref: '#/components/schemas/ErrorMessage'
1062 description: Internal Server Error
1063 summary: Retrieve CM handle details
1066 /v1/ch/{cm-handle}/properties:
1068 description: Get CM handle properties by cm handle id
1069 operationId: getCmHandlePublicPropertiesByCmHandleId
1071 - description: "The identifier for a network function, network element, subnetwork\
1072 \ or any other cm object by managed Network CM Proxy"
1077 example: my-cm-handle
1084 $ref: '#/components/schemas/RestOutputCmHandlePublicProperties'
1090 status: 400 BAD_REQUEST
1091 message: Bad request error message
1092 details: Bad request error details
1094 $ref: '#/components/schemas/ErrorMessage'
1095 description: Bad Request
1101 message: Not found error message
1102 details: Not found error details
1104 $ref: '#/components/schemas/ErrorMessage'
1105 description: The specified resource was not found
1111 message: Internal Server Error
1112 details: Internal Server Error occurred
1114 $ref: '#/components/schemas/ErrorMessage'
1115 description: Internal Server Error
1116 summary: Get CM handle properties
1121 description: Execute cm handle query search and return a list of cm handle ids.
1122 Any number of conditions can be applied. To be included in the result a cm-handle
1123 must fulfill ALL the conditions. An empty collection will be returned in the
1124 case that the cm handle does not match a condition. For more on cm handle
1125 query search please refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/ncmp-cmhandle-querying.html">cm
1126 handle query search Read the Docs</a>.<br/>By supplying a CPS Path it is possible
1127 to query on any data related to the cm handle. For more on CPS Path please
1128 refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html">CPS
1129 Path Read the Docs</a>. The cm handle ancestor is automatically returned for
1131 operationId: searchCmHandleIds
1136 Cm handle properties query:
1137 $ref: '#/components/examples/pubPropCmHandleQueryParameters'
1139 Cm handle modules query:
1140 $ref: '#/components/examples/modulesCmHandleQueryParameters'
1142 All cm handle query parameters:
1143 $ref: '#/components/examples/allCmHandleQueryParameters'
1145 Cm handle with CPS path state query:
1146 $ref: '#/components/examples/cpsPathCmHandleStateQueryParameters'
1148 Cm handle with data sync flag query:
1149 $ref: '#/components/examples/cpsPathCmHandleDataSyncQueryParameters'
1152 $ref: '#/components/schemas/CmHandleQueryParameters'
1167 status: 400 BAD_REQUEST
1168 message: Bad request error message
1169 details: Bad request error details
1171 $ref: '#/components/schemas/ErrorMessage'
1172 description: Bad Request
1178 message: Forbidden error message
1179 details: Forbidden error details
1181 $ref: '#/components/schemas/ErrorMessage'
1182 description: Forbidden
1188 message: Not found error message
1189 details: Not found error details
1191 $ref: '#/components/schemas/ErrorMessage'
1192 description: The specified resource was not found
1198 message: Internal Server Error
1199 details: Internal Server Error occurred
1201 $ref: '#/components/schemas/ErrorMessage'
1202 description: Internal Server Error
1203 summary: Execute cm handle query upon a given set of query parameters
1206 /v1/ch/{cm-handle}/state:
1208 description: Get CM handle state by cm handle id
1209 operationId: getCmHandleStateByCmHandleId
1211 - description: "The identifier for a network function, network element, subnetwork\
1212 \ or any other cm object by managed Network CM Proxy"
1217 example: my-cm-handle
1224 $ref: '#/components/schemas/RestOutputCmHandleCompositeState'
1230 status: 400 BAD_REQUEST
1231 message: Bad request error message
1232 details: Bad request error details
1234 $ref: '#/components/schemas/ErrorMessage'
1235 description: Bad Request
1241 message: Not found error message
1242 details: Not found error details
1244 $ref: '#/components/schemas/ErrorMessage'
1245 description: The specified resource was not found
1251 message: Internal Server Error
1252 details: Internal Server Error occurred
1254 $ref: '#/components/schemas/ErrorMessage'
1255 description: Internal Server Error
1256 summary: Get CM handle state
1259 /v1/ch/{cm-handle}/data-sync:
1261 description: Set the data sync enabled flag to true or false for a specified
1262 Cm-Handle. This will in turn set the data sync state to UNSYNCHRONIZED and
1263 NONE_REQUESTED respectfully.
1264 operationId: setDataSyncEnabledFlagForCmHandle
1266 - description: "The identifier for a network function, network element, subnetwork\
1267 \ or any other cm object by managed Network CM Proxy"
1272 example: my-cm-handle
1274 - description: Is used to enable or disable the data synchronization flag
1276 name: dataSyncEnabled
1292 status: 400 BAD_REQUEST
1293 message: Bad request error message
1294 details: Bad request error details
1296 $ref: '#/components/schemas/ErrorMessage'
1297 description: Bad Request
1303 message: Forbidden error message
1304 details: Forbidden error details
1306 $ref: '#/components/schemas/ErrorMessage'
1307 description: Forbidden
1313 message: Internal Server Error
1314 details: Internal Server Error occurred
1316 $ref: '#/components/schemas/ErrorMessage'
1317 description: Internal Server Error
1322 message: Bad Gateway Error Message NCMP
1327 $ref: '#/components/schemas/DmiErrorMessage'
1328 description: Bad Gateway
1329 summary: Set the Data Sync Enabled Flag
1335 description: Sample response for selecting 'sample 1'.
1336 summary: Sample response
1352 description: Sample request body
1353 summary: Sample request
1356 bookstore-name: Chapters
1369 dataSamplePatchRequest:
1370 description: Sample patch request body
1371 summary: Sample patch request
1373 ietf-restconf:yang-patch:
1381 bookstore-name: Chapters
1399 bookstore-name: Novels
1412 pubPropCmHandleQueryParameters:
1414 cmHandleQueryParameters:
1415 - conditionName: hasAllProperties
1416 conditionParameters:
1420 modulesCmHandleQueryParameters:
1422 cmHandleQueryParameters:
1423 - conditionName: hasAllModules
1424 conditionParameters:
1425 - moduleName: my-module-1
1426 - moduleName: my-module-2
1427 - moduleName: my-module-3
1428 allCmHandleQueryParameters:
1430 cmHandleQueryParameters:
1431 - conditionName: hasAllModules
1432 conditionParameters:
1433 - moduleName: my-module-1
1434 - moduleName: my-module-2
1435 - moduleName: my-module-3
1436 - conditionName: hasAllProperties
1437 conditionParameters:
1441 - conditionName: cmHandleWithCpsPath
1442 conditionParameters:
1443 - cpsPath: "//state[@cm-handle-state='ADVISED']"
1444 cpsPathCmHandleStateQueryParameters:
1446 cmHandleQueryParameters:
1447 - conditionName: cmHandleWithCpsPath
1448 conditionParameters:
1449 - cpsPath: "//state[@cm-handle-state='LOCKED']"
1450 cpsPathCmHandleDataSyncQueryParameters:
1452 cmHandleQueryParameters:
1453 - conditionName: cmHandleWithCpsPath
1454 conditionParameters:
1455 - cpsPath: "//state[@data-sync-enabled='true']"
1458 description: The type of the requested data
1460 name: datastore-name
1463 example: ncmp-datastore:running
1466 description: "The identifier for a network function, network element, subnetwork\
1467 \ or any other cm object by managed Network CM Proxy"
1472 example: my-cm-handle
1474 resourceIdentifierInQuery:
1476 description: The format of resource identifier depend on the associated DMI
1477 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but it
1478 can really be anything.
1482 resourceIdentifier: \shops\bookstore
1485 resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]"
1488 resourceIdentifier: "parent=shops,child=bookstore"
1490 name: resourceIdentifier
1494 optionsParamInQuery:
1496 description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
1497 \ in parenthesis'()'. The format of options parameter depend on the associated\
1498 \ DMI Plugin implementation."
1505 options: (fields=book)
1508 options: "(depth=2,fields=book/authors)"
1516 description: topic parameter in query.
1520 topic: my-topic-name
1526 includeDescendantsOptionInQuery:
1527 description: Determines if descendants are included in response
1529 name: include-descendants
1534 authorizationParamInHeader:
1535 description: Authorization parameter for request.
1541 contentParamInHeader:
1542 description: "Content parameter for request, if content parameter is null, default\
1543 \ value is application/json."
1548 default: application/json
1549 example: application/yang-data+json
1551 requiredTopicParamInQuery:
1553 description: mandatory topic parameter in query.
1557 topic: my-topic-name
1564 description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1568 list attributes cps path:
1569 value: "//categories[@code=1]"
1577 description: Filter for a module name.This is an optional parameter
1585 description: Filter for a module revision.This is an optional parameter and
1586 ignored when no module name is supplied
1594 description: Is used to enable or disable the data synchronization flag
1596 name: dataSyncEnabled
1606 status: 400 BAD_REQUEST
1607 message: Bad request error message
1608 details: Bad request error details
1610 $ref: '#/components/schemas/ErrorMessage'
1611 description: Bad Request
1617 message: Forbidden error message
1618 details: Forbidden error details
1620 $ref: '#/components/schemas/ErrorMessage'
1621 description: Forbidden
1622 InternalServerError:
1627 message: Internal Server Error
1628 details: Internal Server Error occurred
1630 $ref: '#/components/schemas/ErrorMessage'
1631 description: Internal Server Error
1636 message: Bad Gateway Error Message NCMP
1641 $ref: '#/components/schemas/DmiErrorMessage'
1642 description: Bad Gateway
1651 description: Created
1654 description: No Content
1660 message: Not found error message
1661 details: Not found error details
1663 $ref: '#/components/schemas/ErrorMessage'
1664 description: The specified resource was not found
1679 example: Bad Gateway Error Message NCMP
1682 $ref: '#/components/schemas/DmiErrorMessage_dmi_response'
1683 title: DMI Error Message
1685 DataOperationRequest:
1688 - resourceIdentifier: parent/child
1690 - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
1692 - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
1694 datastore: ncmp-datastore:passthrough-operational
1695 options: (fields=schemas/schema)
1698 - resourceIdentifier: parent/child
1700 - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
1702 - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
1704 datastore: ncmp-datastore:passthrough-operational
1705 options: (fields=schemas/schema)
1710 description: contains group of data operation requests
1712 $ref: '#/components/schemas/DataOperationDefinition'
1714 title: execute data operation for given array of operations
1716 DataOperationDefinition:
1718 resourceIdentifier: parent/child
1720 - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
1722 - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
1724 datastore: ncmp-datastore:passthrough-operational
1725 options: (fields=schemas/schema)
1736 example: ncmp-datastore:passthrough-operational
1739 example: (fields=schemas/schema)
1742 example: parent/child
1746 example: "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
1754 RestModuleReference:
1756 moduleName: my-module-name
1757 revision: my-module-revision
1760 example: my-module-name
1763 example: my-module-revision
1765 title: Module reference details
1767 RestModuleDefinition:
1769 moduleName: my-module-name
1773 namespace 'org:onap:ccsdk:sample';
1775 revision '2020-09-15' {
1780 revision: 2020-09-15
1783 example: my-module-name
1792 namespace 'org:onap:ccsdk:sample';
1794 revision '2020-09-15' {
1800 title: Module definitions
1802 CmHandleQueryParameters:
1804 cmHandleQueryParameters:
1805 - conditionParameters:
1806 - key: conditionParameters
1807 - key: conditionParameters
1808 conditionName: conditionName
1809 - conditionParameters:
1810 - key: conditionParameters
1811 - key: conditionParameters
1812 conditionName: conditionName
1815 conditionParameters:
1816 - moduleName: my-module
1817 - moduleName: my-module
1819 conditionParameters:
1820 - moduleName: my-module
1821 - moduleName: my-module
1823 cmHandleQueryParameters:
1825 $ref: '#/components/schemas/ConditionProperties'
1829 description: "not necessary, it is just for backward compatibility"
1831 $ref: '#/components/schemas/OldConditionProperties'
1833 title: Cm Handle query parameters for executing cm handle search
1835 ConditionProperties:
1837 conditionParameters:
1838 - key: conditionParameters
1839 - key: conditionParameters
1840 conditionName: conditionName
1844 conditionParameters:
1846 additionalProperties:
1850 OldConditionProperties:
1854 conditionParameters:
1855 - moduleName: my-module
1856 - moduleName: my-module
1860 conditionParameters:
1862 $ref: '#/components/schemas/ModuleNameAsJsonObject'
1864 ModuleNameAsJsonObject:
1866 moduleName: my-module
1873 cmHandle: my-cm-handle1
1874 publicCmHandleProperties:
1878 dataSyncEnabled: false
1881 lastSyncTime: 2022-12-31T20:30:40.000+0000
1882 syncState: NONE_REQUESTED
1884 lastSyncTime: 2022-12-31T20:30:40.000+0000
1885 syncState: NONE_REQUESTED
1886 cmHandleState: ADVISED
1888 reason: LOCKED_MISBEHAVING
1889 details: locked due to failure in module sync
1890 lastUpdateTime: 2022-12-31T20:30:40.000+0000
1891 trustLevel: COMPLETE
1894 example: my-cm-handle1
1896 publicCmHandleProperties:
1898 additionalProperties:
1904 $ref: '#/components/schemas/CmHandleCompositeState'
1906 description: Current trust level of the relevant CM handle ID.
1909 title: CM handle Details
1911 CmHandlePublicProperties:
1913 additionalProperties:
1918 CmHandleCompositeState:
1920 dataSyncEnabled: false
1923 lastSyncTime: 2022-12-31T20:30:40.000+0000
1924 syncState: NONE_REQUESTED
1926 lastSyncTime: 2022-12-31T20:30:40.000+0000
1927 syncState: NONE_REQUESTED
1928 cmHandleState: ADVISED
1930 reason: LOCKED_MISBEHAVING
1931 details: locked due to failure in module sync
1932 lastUpdateTime: 2022-12-31T20:30:40.000+0000
1938 $ref: '#/components/schemas/lock-reason'
1940 example: 2022-12-31T20:30:40.000+0000
1946 $ref: '#/components/schemas/dataStores'
1950 reason: LOCKED_MISBEHAVING
1951 details: locked due to failure in module sync
1954 example: LOCKED_MISBEHAVING
1957 example: locked due to failure in module sync
1963 lastSyncTime: 2022-12-31T20:30:40.000+0000
1964 syncState: NONE_REQUESTED
1966 lastSyncTime: 2022-12-31T20:30:40.000+0000
1967 syncState: NONE_REQUESTED
1970 $ref: '#/components/schemas/sync-state'
1972 $ref: '#/components/schemas/sync-state'
1976 lastSyncTime: 2022-12-31T20:30:40.000+0000
1977 syncState: NONE_REQUESTED
1980 example: NONE_REQUESTED
1983 example: 2022-12-31T20:30:40.000+0000
1987 description: Current trust level of the relevant CM handle ID.
1990 RestOutputCmHandlePublicProperties:
1992 publicCmHandleProperties:
1996 publicCmHandleProperties:
1998 additionalProperties:
2004 RestOutputCmHandleCompositeState:
2007 dataSyncEnabled: false
2010 lastSyncTime: 2022-12-31T20:30:40.000+0000
2011 syncState: NONE_REQUESTED
2013 lastSyncTime: 2022-12-31T20:30:40.000+0000
2014 syncState: NONE_REQUESTED
2015 cmHandleState: ADVISED
2017 reason: LOCKED_MISBEHAVING
2018 details: locked due to failure in module sync
2019 lastUpdateTime: 2022-12-31T20:30:40.000+0000
2022 $ref: '#/components/schemas/CmHandleCompositeState'
2024 DmiErrorMessage_dmi_response:
2030 example: Bad Request