3 title: ONAP Open API v3 Configuration Persistence Service
4 description: Configuration Persistence Service is a Model Driven Generic Database
7 url: https://onap.readthedocs.io
8 email: onap-discuss@lists.onap.org
11 url: http://www.apache.org/licenses/LICENSE-2.0
13 x-planned-retirement-date: "202212"
21 description: cps Admin
29 summary: Create a dataspace
30 description: Create a new dataspace
31 operationId: createDataspace
33 - name: dataspace-name
35 description: dataspace-name
49 description: Unauthorized
53 $ref: '#/components/schemas/ErrorMessage'
56 message: Unauthorized request
57 details: This request is unauthorized
59 description: Forbidden
63 $ref: '#/components/schemas/ErrorMessage'
66 message: Request Forbidden
67 details: This request is forbidden
73 $ref: '#/components/schemas/ErrorMessage'
76 message: Conflicting request
77 details: The request cannot be processed as the resource is in use.
79 description: Internal Server Error
83 $ref: '#/components/schemas/ErrorMessage'
86 message: Internal Server Error
87 details: Internal Server Error occurred
91 summary: Delete a dataspace
92 description: Delete a dataspace
93 operationId: deleteDataspace
95 - name: dataspace-name
97 description: dataspace-name
101 example: my-dataspace
104 description: No Content
107 description: Bad Request
111 $ref: '#/components/schemas/ErrorMessage'
115 details: The provided request is not valid
117 description: Unauthorized
121 $ref: '#/components/schemas/ErrorMessage'
124 message: Unauthorized request
125 details: This request is unauthorized
127 description: Forbidden
131 $ref: '#/components/schemas/ErrorMessage'
134 message: Request Forbidden
135 details: This request is forbidden
137 description: Conflict
141 $ref: '#/components/schemas/ErrorMessage'
144 message: Conflicting request
145 details: The request cannot be processed as the resource is in use.
147 description: Internal Server Error
151 $ref: '#/components/schemas/ErrorMessage'
154 message: Internal Server Error
155 details: Internal Server Error occurred
156 /v1/dataspaces/{dataspace-name}/anchors:
161 description: "Read all anchors, given a dataspace"
162 operationId: getAnchors
164 - name: dataspace-name
166 description: dataspace-name
170 example: my-dataspace
179 $ref: '#/components/schemas/AnchorDetails'
181 description: Bad Request
185 $ref: '#/components/schemas/ErrorMessage'
189 details: The provided request is not valid
191 description: Unauthorized
195 $ref: '#/components/schemas/ErrorMessage'
198 message: Unauthorized request
199 details: This request is unauthorized
201 description: Forbidden
205 $ref: '#/components/schemas/ErrorMessage'
208 message: Request Forbidden
209 details: This request is forbidden
211 description: Internal Server Error
215 $ref: '#/components/schemas/ErrorMessage'
218 message: Internal Server Error
219 details: Internal Server Error occurred
223 summary: Create an anchor
224 description: Create a new anchor in the given dataspace
225 operationId: createAnchor
227 - name: dataspace-name
229 description: dataspace-name
233 example: my-dataspace
234 - name: schema-set-name
236 description: schema-set-name
240 example: my-schema-set
243 description: anchor-name
257 description: Bad Request
261 $ref: '#/components/schemas/ErrorMessage'
265 details: The provided request is not valid
267 description: Unauthorized
271 $ref: '#/components/schemas/ErrorMessage'
274 message: Unauthorized request
275 details: This request is unauthorized
277 description: Forbidden
281 $ref: '#/components/schemas/ErrorMessage'
284 message: Request Forbidden
285 details: This request is forbidden
287 description: Conflict
291 $ref: '#/components/schemas/ErrorMessage'
294 message: Conflicting request
295 details: The request cannot be processed as the resource is in use.
297 description: Internal Server Error
301 $ref: '#/components/schemas/ErrorMessage'
304 message: Internal Server Error
305 details: Internal Server Error occurred
306 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}:
310 summary: Get an anchor
311 description: Read an anchor given an anchor name and a dataspace
312 operationId: getAnchor
314 - name: dataspace-name
316 description: dataspace-name
320 example: my-dataspace
323 description: anchor-name
334 $ref: '#/components/schemas/AnchorDetails'
336 description: Bad Request
340 $ref: '#/components/schemas/ErrorMessage'
344 details: The provided request is not valid
346 description: Unauthorized
350 $ref: '#/components/schemas/ErrorMessage'
353 message: Unauthorized request
354 details: This request is unauthorized
356 description: Forbidden
360 $ref: '#/components/schemas/ErrorMessage'
363 message: Request Forbidden
364 details: This request is forbidden
366 description: Internal Server Error
370 $ref: '#/components/schemas/ErrorMessage'
373 message: Internal Server Error
374 details: Internal Server Error occurred
378 summary: Delete an anchor
379 description: Delete an anchor given an anchor name and a dataspace
380 operationId: deleteAnchor
382 - name: dataspace-name
384 description: dataspace-name
388 example: my-dataspace
391 description: anchor-name
398 description: No Content
401 description: Bad Request
405 $ref: '#/components/schemas/ErrorMessage'
409 details: The provided request is not valid
411 description: Unauthorized
415 $ref: '#/components/schemas/ErrorMessage'
418 message: Unauthorized request
419 details: This request is unauthorized
421 description: Forbidden
425 $ref: '#/components/schemas/ErrorMessage'
428 message: Request Forbidden
429 details: This request is forbidden
431 description: Internal Server Error
435 $ref: '#/components/schemas/ErrorMessage'
438 message: Internal Server Error
439 details: Internal Server Error occurred
440 /v1/dataspaces/{dataspace-name}/schema-sets:
444 summary: Create a schema set
445 description: Create a new schema set in the given dataspace
446 operationId: createSchemaSet
448 - name: dataspace-name
450 description: dataspace-name
454 example: my-dataspace
455 - name: schema-set-name
457 description: schema-set-name
461 example: my-schema-set
466 $ref: '#/components/schemas/MultipartFile'
477 description: Bad Request
481 $ref: '#/components/schemas/ErrorMessage'
485 details: The provided request is not valid
487 description: Unauthorized
491 $ref: '#/components/schemas/ErrorMessage'
494 message: Unauthorized request
495 details: This request is unauthorized
497 description: Forbidden
501 $ref: '#/components/schemas/ErrorMessage'
504 message: Request Forbidden
505 details: This request is forbidden
507 description: Conflict
511 $ref: '#/components/schemas/ErrorMessage'
514 message: Conflicting request
515 details: The request cannot be processed as the resource is in use.
517 description: Internal Server Error
521 $ref: '#/components/schemas/ErrorMessage'
524 message: Internal Server Error
525 details: Internal Server Error occurred
526 /v1/dataspaces/{dataspace-name}/schema-sets/{schema-set-name}:
530 summary: Get a schema set
531 description: Read a schema set given a schema set name and a dataspace
532 operationId: getSchemaSet
534 - name: dataspace-name
536 description: dataspace-name
540 example: my-dataspace
541 - name: schema-set-name
543 description: schema-set-name
547 example: my-schema-set
554 $ref: '#/components/schemas/SchemaSetDetails'
556 description: Bad Request
560 $ref: '#/components/schemas/ErrorMessage'
564 details: The provided request is not valid
566 description: Unauthorized
570 $ref: '#/components/schemas/ErrorMessage'
573 message: Unauthorized request
574 details: This request is unauthorized
576 description: Forbidden
580 $ref: '#/components/schemas/ErrorMessage'
583 message: Request Forbidden
584 details: This request is forbidden
586 description: Internal Server Error
590 $ref: '#/components/schemas/ErrorMessage'
593 message: Internal Server Error
594 details: Internal Server Error occurred
598 summary: Delete a schema set
599 description: Delete a schema set given a schema set name and a dataspace
600 operationId: deleteSchemaSet
602 - name: dataspace-name
604 description: dataspace-name
608 example: my-dataspace
609 - name: schema-set-name
611 description: schema-set-name
615 example: my-schema-set
618 description: No Content
621 description: Bad Request
625 $ref: '#/components/schemas/ErrorMessage'
629 details: The provided request is not valid
631 description: Unauthorized
635 $ref: '#/components/schemas/ErrorMessage'
638 message: Unauthorized request
639 details: This request is unauthorized
641 description: Forbidden
645 $ref: '#/components/schemas/ErrorMessage'
648 message: Request Forbidden
649 details: This request is forbidden
651 description: Conflict
655 $ref: '#/components/schemas/ErrorMessage'
658 message: Conflicting request
659 details: The request cannot be processed as the resource is in use.
661 description: Internal Server Error
665 $ref: '#/components/schemas/ErrorMessage'
668 message: Internal Server Error
669 details: Internal Server Error occurred
670 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
675 description: Get a node with an option to retrieve all the children for a given
677 operationId: getNodeByDataspaceAndAnchor
679 - name: dataspace-name
681 description: dataspace-name
685 example: my-dataspace
688 description: anchor-name
695 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
702 value: /shops/bookstore
703 list attributes xpath:
704 value: "/shops/bookstore/categories[@code=1]"
705 - name: include-descendants
707 description: include-descendants
722 $ref: '#/components/examples/dataSample'
724 description: Bad Request
728 $ref: '#/components/schemas/ErrorMessage'
732 details: The provided request is not valid
734 description: Unauthorized
738 $ref: '#/components/schemas/ErrorMessage'
741 message: Unauthorized request
742 details: This request is unauthorized
744 description: Forbidden
748 $ref: '#/components/schemas/ErrorMessage'
751 message: Request Forbidden
752 details: This request is forbidden
754 description: Internal Server Error
758 $ref: '#/components/schemas/ErrorMessage'
761 message: Internal Server Error
762 details: Internal Server Error occurred
763 x-codegen-request-body-name: xpath
764 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes:
768 summary: Replace a node with descendants
769 description: "Replace a node with descendants for a given dataspace, anchor\
770 \ and a parent node xpath"
771 operationId: replaceNode
773 - name: dataspace-name
775 description: dataspace-name
779 example: my-dataspace
782 description: anchor-name
789 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
796 value: /shops/bookstore
797 list attributes xpath:
798 value: "/shops/bookstore/categories[@code=1]"
799 - name: observed-timestamp
801 description: observed-timestamp
805 example: 2021-03-21T00:10:34.030-0100
813 $ref: '#/components/examples/dataSample'
826 description: Bad Request
830 $ref: '#/components/schemas/ErrorMessage'
834 details: The provided request is not valid
836 description: Unauthorized
840 $ref: '#/components/schemas/ErrorMessage'
843 message: Unauthorized request
844 details: This request is unauthorized
846 description: Forbidden
850 $ref: '#/components/schemas/ErrorMessage'
853 message: Request Forbidden
854 details: This request is forbidden
856 description: Internal Server Error
860 $ref: '#/components/schemas/ErrorMessage'
863 message: Internal Server Error
864 details: Internal Server Error occurred
868 summary: Create a node
869 description: Create a node for a given anchor and dataspace
870 operationId: createNode
872 - name: dataspace-name
874 description: dataspace-name
878 example: my-dataspace
881 description: anchor-name
888 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
895 value: /shops/bookstore
896 list attributes xpath:
897 value: "/shops/bookstore/categories[@code=1]"
898 - name: observed-timestamp
900 description: observed-timestamp
904 example: 2021-03-21T00:10:34.030-0100
912 $ref: '#/components/examples/dataSample'
923 description: Bad Request
927 $ref: '#/components/schemas/ErrorMessage'
931 details: The provided request is not valid
933 description: Unauthorized
937 $ref: '#/components/schemas/ErrorMessage'
940 message: Unauthorized request
941 details: This request is unauthorized
943 description: Forbidden
947 $ref: '#/components/schemas/ErrorMessage'
950 message: Request Forbidden
951 details: This request is forbidden
953 description: Conflict
957 $ref: '#/components/schemas/ErrorMessage'
960 message: Conflicting request
961 details: The request cannot be processed as the resource is in use.
963 description: Internal Server Error
967 $ref: '#/components/schemas/ErrorMessage'
970 message: Internal Server Error
971 details: Internal Server Error occurred
975 summary: Delete a data node
976 description: Delete a datanode for a given dataspace and anchor given a node
978 operationId: deleteDataNode
980 - name: dataspace-name
982 description: dataspace-name
986 example: my-dataspace
989 description: anchor-name
996 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1003 value: /shops/bookstore
1004 list attributes xpath:
1005 value: "/shops/bookstore/categories[@code=1]"
1006 - name: observed-timestamp
1008 description: observed-timestamp
1012 example: 2021-03-21T00:10:34.030-0100
1015 description: No Content
1018 description: Bad Request
1022 $ref: '#/components/schemas/ErrorMessage'
1025 message: Bad Request
1026 details: The provided request is not valid
1028 description: Unauthorized
1032 $ref: '#/components/schemas/ErrorMessage'
1035 message: Unauthorized request
1036 details: This request is unauthorized
1038 description: Forbidden
1042 $ref: '#/components/schemas/ErrorMessage'
1045 message: Request Forbidden
1046 details: This request is forbidden
1048 description: Internal Server Error
1052 $ref: '#/components/schemas/ErrorMessage'
1055 message: Internal Server Error
1056 details: Internal Server Error occurred
1060 summary: Update node leaves
1061 description: Update a data node leaves for a given dataspace and anchor and
1063 operationId: updateNodeLeaves
1065 - name: dataspace-name
1067 description: dataspace-name
1071 example: my-dataspace
1074 description: anchor-name
1081 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1088 value: /shops/bookstore
1089 list attributes xpath:
1090 value: "/shops/bookstore/categories[@code=1]"
1091 - name: observed-timestamp
1093 description: observed-timestamp
1097 example: 2021-03-21T00:10:34.030-0100
1105 $ref: '#/components/examples/dataSample'
1118 description: Bad Request
1122 $ref: '#/components/schemas/ErrorMessage'
1125 message: Bad Request
1126 details: The provided request is not valid
1128 description: Unauthorized
1132 $ref: '#/components/schemas/ErrorMessage'
1135 message: Unauthorized request
1136 details: This request is unauthorized
1138 description: Forbidden
1142 $ref: '#/components/schemas/ErrorMessage'
1145 message: Request Forbidden
1146 details: This request is forbidden
1148 description: Internal Server Error
1152 $ref: '#/components/schemas/ErrorMessage'
1155 message: Internal Server Error
1156 details: Internal Server Error occurred
1157 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes:
1161 summary: Replace list content
1162 description: "Replace list content under a given parent, anchor and dataspace"
1163 operationId: replaceListContent
1165 - name: dataspace-name
1167 description: dataspace-name
1171 example: my-dataspace
1174 description: anchor-name
1181 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1187 value: /shops/bookstore
1188 list attributes xpath:
1189 value: "/shops/bookstore/categories[@code=1]"
1190 - name: observed-timestamp
1192 description: observed-timestamp
1196 example: 2021-03-21T00:10:34.030-0100
1204 $ref: '#/components/examples/dataSample'
1217 description: Bad Request
1221 $ref: '#/components/schemas/ErrorMessage'
1224 message: Bad Request
1225 details: The provided request is not valid
1227 description: Unauthorized
1231 $ref: '#/components/schemas/ErrorMessage'
1234 message: Unauthorized request
1235 details: This request is unauthorized
1237 description: Forbidden
1241 $ref: '#/components/schemas/ErrorMessage'
1244 message: Request Forbidden
1245 details: This request is forbidden
1247 description: Internal Server Error
1251 $ref: '#/components/schemas/ErrorMessage'
1254 message: Internal Server Error
1255 details: Internal Server Error occurred
1259 summary: Add list element(s)
1260 description: Add list element(s) to a list for a given anchor and dataspace
1261 operationId: addListElements
1263 - name: dataspace-name
1265 description: dataspace-name
1269 example: my-dataspace
1272 description: anchor-name
1279 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1285 value: /shops/bookstore
1286 list attributes xpath:
1287 value: "/shops/bookstore/categories[@code=1]"
1288 - name: observed-timestamp
1290 description: observed-timestamp
1294 example: 2021-03-21T00:10:34.030-0100
1302 $ref: '#/components/examples/dataSample'
1306 description: Created
1311 example: my-resource
1313 description: Bad Request
1317 $ref: '#/components/schemas/ErrorMessage'
1320 message: Bad Request
1321 details: The provided request is not valid
1323 description: Unauthorized
1327 $ref: '#/components/schemas/ErrorMessage'
1330 message: Unauthorized request
1331 details: This request is unauthorized
1333 description: Forbidden
1337 $ref: '#/components/schemas/ErrorMessage'
1340 message: Request Forbidden
1341 details: This request is forbidden
1343 description: Internal Server Error
1347 $ref: '#/components/schemas/ErrorMessage'
1350 message: Internal Server Error
1351 details: Internal Server Error occurred
1355 summary: Delete one or all list element(s)
1356 description: Delete one or all list element(s) for a given anchor and dataspace
1357 operationId: deleteListOrListElement
1359 - name: dataspace-name
1361 description: dataspace-name
1365 example: my-dataspace
1368 description: anchor-name
1375 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1381 value: /shops/bookstore
1382 list attributes xpath:
1383 value: "/shops/bookstore/categories[@code=1]"
1384 - name: observed-timestamp
1386 description: observed-timestamp
1390 example: 2021-03-21T00:10:34.030-0100
1393 description: No Content
1396 description: Bad Request
1400 $ref: '#/components/schemas/ErrorMessage'
1403 message: Bad Request
1404 details: The provided request is not valid
1406 description: Unauthorized
1410 $ref: '#/components/schemas/ErrorMessage'
1413 message: Unauthorized request
1414 details: This request is unauthorized
1416 description: Forbidden
1420 $ref: '#/components/schemas/ErrorMessage'
1423 message: Request Forbidden
1424 details: This request is forbidden
1426 description: Internal Server Error
1430 $ref: '#/components/schemas/ErrorMessage'
1433 message: Internal Server Error
1434 details: Internal Server Error occurred
1436 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
1440 summary: Query data nodes
1441 description: Query data nodes for the given dataspace and anchor using CPS path
1442 operationId: getNodesByDataspaceAndAnchorAndCpsPath
1444 - name: dataspace-name
1446 description: dataspace-name
1450 example: my-dataspace
1453 description: anchor-name
1460 description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1468 list attributes cps path:
1469 value: "//categories[@code=1]"
1470 - name: include-descendants
1472 description: include-descendants
1487 $ref: '#/components/examples/dataSample'
1489 description: Bad Request
1493 $ref: '#/components/schemas/ErrorMessage'
1496 message: Bad Request
1497 details: The provided request is not valid
1499 description: Unauthorized
1503 $ref: '#/components/schemas/ErrorMessage'
1506 message: Unauthorized request
1507 details: This request is unauthorized
1509 description: Forbidden
1513 $ref: '#/components/schemas/ErrorMessage'
1516 message: Request Forbidden
1517 details: This request is forbidden
1519 description: Internal Server Error
1523 $ref: '#/components/schemas/ErrorMessage'
1526 message: Internal Server Error
1527 details: Internal Server Error occurred
1528 x-codegen-request-body-name: xpath
1542 title: Anchor details by anchor Name
1550 example: my-dataspace
1553 example: my-schema-set
1561 description: multipartFile
1564 title: Schema set details by dataspace and schemasetName
1571 example: my-dataspace
1575 $ref: '#/components/schemas/ModuleReferences'
1578 example: my-schema-set
1580 title: Module reference object
1585 example: my-module-reference-name
1588 example: my-module-reference-namespace
1591 example: my-module-reference-revision
1596 bookstore-name: Chapters