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
34 - name: dataspace-name
36 description: dataspace-name
50 description: Bad Request
54 $ref: '#/components/schemas/ErrorMessage'
58 details: The provided request is not valid
60 description: Unauthorized
64 $ref: '#/components/schemas/ErrorMessage'
67 message: Unauthorized request
68 details: This request is unauthorized
70 description: Forbidden
74 $ref: '#/components/schemas/ErrorMessage'
77 message: Request Forbidden
78 details: This request is forbidden
84 $ref: '#/components/schemas/ErrorMessage'
87 message: Conflicting request
88 details: The request cannot be processed as the resource is in use.
90 description: Internal Server Error
94 $ref: '#/components/schemas/ErrorMessage'
97 message: Internal Server Error
98 details: Internal Server Error occurred
103 summary: Create a dataspace
104 description: Create a new dataspace
105 operationId: createDataspaceV2
107 - name: dataspace-name
109 description: dataspace-name
113 example: my-dataspace
118 description: Bad Request
122 $ref: '#/components/schemas/ErrorMessage'
126 details: The provided request is not valid
128 description: Unauthorized
132 $ref: '#/components/schemas/ErrorMessage'
135 message: Unauthorized request
136 details: This request is unauthorized
138 description: Forbidden
142 $ref: '#/components/schemas/ErrorMessage'
145 message: Request Forbidden
146 details: This request is forbidden
148 description: Conflict
152 $ref: '#/components/schemas/ErrorMessage'
155 message: Conflicting request
156 details: The request cannot be processed as the resource is in use.
158 description: Internal Server Error
162 $ref: '#/components/schemas/ErrorMessage'
165 message: Internal Server Error
166 details: Internal Server Error occurred
167 /{apiVersion}/dataspaces:
171 summary: Delete a dataspace
172 description: Delete a dataspace
173 operationId: deleteDataspace
175 - $ref: '#/components/parameters/apiVersionInPath'
176 - name: dataspace-name
178 description: dataspace-name
182 example: my-dataspace
185 description: No Content
188 description: Bad Request
192 $ref: '#/components/schemas/ErrorMessage'
196 details: The provided request is not valid
198 description: Unauthorized
202 $ref: '#/components/schemas/ErrorMessage'
205 message: Unauthorized request
206 details: This request is unauthorized
208 description: Forbidden
212 $ref: '#/components/schemas/ErrorMessage'
215 message: Request Forbidden
216 details: This request is forbidden
218 description: Conflict
222 $ref: '#/components/schemas/ErrorMessage'
225 message: Conflicting request
226 details: The request cannot be processed as the resource is in use.
228 description: Internal Server Error
232 $ref: '#/components/schemas/ErrorMessage'
235 message: Internal Server Error
236 details: Internal Server Error occurred
237 /{apiVersion}/admin/dataspaces:
241 summary: Get dataspaces
242 description: "Read all dataspaces"
243 operationId: getAllDataspaces
245 - $ref: '#/components/parameters/apiVersionInPath'
254 $ref: '#/components/schemas/DataspaceDetails'
256 description: Bad Request
260 $ref: '#/components/schemas/ErrorMessage'
264 details: The provided request is not valid
266 description: Unauthorized
270 $ref: '#/components/schemas/ErrorMessage'
273 message: Unauthorized request
274 details: This request is unauthorized
276 description: Forbidden
280 $ref: '#/components/schemas/ErrorMessage'
283 message: Request Forbidden
284 details: This request is forbidden
286 description: Internal Server Error
290 $ref: '#/components/schemas/ErrorMessage'
293 message: Internal Server Error
294 details: Internal Server Error occurred
295 /{apiVersion}/admin/dataspaces/{dataspace-name}:
299 summary: Get a dataspace
300 description: Read an dataspace given a dataspace name
301 operationId: getDataspace
303 - $ref: '#/components/parameters/apiVersionInPath'
304 - name: dataspace-name
306 description: dataspace-name
310 example: my-dataspace
317 $ref: '#/components/schemas/DataspaceDetails'
319 description: Bad Request
323 $ref: '#/components/schemas/ErrorMessage'
327 details: The provided request is not valid
329 description: Unauthorized
333 $ref: '#/components/schemas/ErrorMessage'
336 message: Unauthorized request
337 details: This request is unauthorized
339 description: Forbidden
343 $ref: '#/components/schemas/ErrorMessage'
346 message: Request Forbidden
347 details: This request is forbidden
349 description: Internal Server Error
353 $ref: '#/components/schemas/ErrorMessage'
356 message: Internal Server Error
357 details: Internal Server Error occurred
358 /{apiVersion}/dataspaces/{dataspace-name}/anchors:
363 description: "Read all anchors, given a dataspace"
364 operationId: getAnchors
366 - $ref: '#/components/parameters/apiVersionInPath'
367 - name: dataspace-name
369 description: dataspace-name
373 example: my-dataspace
382 $ref: '#/components/schemas/AnchorDetails'
384 description: Bad Request
388 $ref: '#/components/schemas/ErrorMessage'
392 details: The provided request is not valid
394 description: Unauthorized
398 $ref: '#/components/schemas/ErrorMessage'
401 message: Unauthorized request
402 details: This request is unauthorized
404 description: Forbidden
408 $ref: '#/components/schemas/ErrorMessage'
411 message: Request Forbidden
412 details: This request is forbidden
414 description: Internal Server Error
418 $ref: '#/components/schemas/ErrorMessage'
421 message: Internal Server Error
422 details: Internal Server Error occurred
423 /v1/dataspaces/{dataspace-name}/anchors:
427 summary: Create an anchor
429 description: Create a new anchor in the given dataspace
430 operationId: createAnchor
432 - name: dataspace-name
434 description: dataspace-name
438 example: my-dataspace
439 - name: schema-set-name
441 description: schema-set-name
445 example: my-schema-set
448 description: anchor-name
462 description: Bad Request
466 $ref: '#/components/schemas/ErrorMessage'
470 details: The provided request is not valid
472 description: Unauthorized
476 $ref: '#/components/schemas/ErrorMessage'
479 message: Unauthorized request
480 details: This request is unauthorized
482 description: Forbidden
486 $ref: '#/components/schemas/ErrorMessage'
489 message: Request Forbidden
490 details: This request is forbidden
492 description: Conflict
496 $ref: '#/components/schemas/ErrorMessage'
499 message: Conflicting request
500 details: The request cannot be processed as the resource is in use.
502 description: Internal Server Error
506 $ref: '#/components/schemas/ErrorMessage'
509 message: Internal Server Error
510 details: Internal Server Error occurred
511 /v2/dataspaces/{dataspace-name}/anchors:
515 summary: Create an anchor
516 description: Create a new anchor in the given dataspace
517 operationId: createAnchorV2
519 - name: dataspace-name
521 description: dataspace-name
525 example: my-dataspace
526 - name: schema-set-name
528 description: schema-set-name
532 example: my-schema-set
535 description: anchor-name
544 description: Bad Request
548 $ref: '#/components/schemas/ErrorMessage'
552 details: The provided request is not valid
554 description: Unauthorized
558 $ref: '#/components/schemas/ErrorMessage'
561 message: Unauthorized request
562 details: This request is unauthorized
564 description: Forbidden
568 $ref: '#/components/schemas/ErrorMessage'
571 message: Request Forbidden
572 details: This request is forbidden
574 description: Conflict
578 $ref: '#/components/schemas/ErrorMessage'
581 message: Conflicting request
582 details: The request cannot be processed as the resource is in use.
584 description: Internal Server Error
588 $ref: '#/components/schemas/ErrorMessage'
591 message: Internal Server Error
592 details: Internal Server Error occurred
593 /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}:
597 summary: Get an anchor
598 description: Read an anchor given an anchor name and a dataspace
599 operationId: getAnchor
601 - $ref: '#/components/parameters/apiVersionInPath'
602 - name: dataspace-name
604 description: dataspace-name
608 example: my-dataspace
611 description: anchor-name
622 $ref: '#/components/schemas/AnchorDetails'
624 description: Bad Request
628 $ref: '#/components/schemas/ErrorMessage'
632 details: The provided request is not valid
634 description: Unauthorized
638 $ref: '#/components/schemas/ErrorMessage'
641 message: Unauthorized request
642 details: This request is unauthorized
644 description: Forbidden
648 $ref: '#/components/schemas/ErrorMessage'
651 message: Request Forbidden
652 details: This request is forbidden
654 description: Internal Server Error
658 $ref: '#/components/schemas/ErrorMessage'
661 message: Internal Server Error
662 details: Internal Server Error occurred
666 summary: Delete an anchor
667 description: Delete an anchor given an anchor name and a dataspace
668 operationId: deleteAnchor
670 - $ref: '#/components/parameters/apiVersionInPath'
671 - name: dataspace-name
673 description: dataspace-name
677 example: my-dataspace
680 description: anchor-name
687 description: No Content
690 description: Bad Request
694 $ref: '#/components/schemas/ErrorMessage'
698 details: The provided request is not valid
700 description: Unauthorized
704 $ref: '#/components/schemas/ErrorMessage'
707 message: Unauthorized request
708 details: This request is unauthorized
710 description: Forbidden
714 $ref: '#/components/schemas/ErrorMessage'
717 message: Request Forbidden
718 details: This request is forbidden
720 description: Internal Server Error
724 $ref: '#/components/schemas/ErrorMessage'
727 message: Internal Server Error
728 details: Internal Server Error occurred
729 /v1/dataspaces/{dataspace-name}/schema-sets:
733 summary: Create a schema set
734 description: Create a new schema set in the given dataspace
735 operationId: createSchemaSet
737 - name: dataspace-name
739 description: dataspace-name
743 example: my-dataspace
744 - name: schema-set-name
746 description: schema-set-name
750 example: my-schema-set
755 $ref: '#/components/schemas/MultipartFile'
766 description: Bad Request
770 $ref: '#/components/schemas/ErrorMessage'
774 details: The provided request is not valid
776 description: Unauthorized
780 $ref: '#/components/schemas/ErrorMessage'
783 message: Unauthorized request
784 details: This request is unauthorized
786 description: Forbidden
790 $ref: '#/components/schemas/ErrorMessage'
793 message: Request Forbidden
794 details: This request is forbidden
796 description: Conflict
800 $ref: '#/components/schemas/ErrorMessage'
803 message: Conflicting request
804 details: The request cannot be processed as the resource is in use.
806 description: Internal Server Error
810 $ref: '#/components/schemas/ErrorMessage'
813 message: Internal Server Error
814 details: Internal Server Error occurred
815 /v2/dataspaces/{dataspace-name}/schema-sets:
819 summary: Create a schema set
820 description: Create a new schema set in the given dataspace
821 operationId: createSchemaSetV2
823 - name: dataspace-name
825 description: dataspace-name
829 example: my-dataspace
830 - name: schema-set-name
832 description: schema-set-name
836 example: my-schema-set
841 $ref: '#/components/schemas/MultipartFile'
847 description: Bad Request
851 $ref: '#/components/schemas/ErrorMessage'
855 details: The provided request is not valid
857 description: Unauthorized
861 $ref: '#/components/schemas/ErrorMessage'
864 message: Unauthorized request
865 details: This request is unauthorized
867 description: Forbidden
871 $ref: '#/components/schemas/ErrorMessage'
874 message: Request Forbidden
875 details: This request is forbidden
877 description: Conflict
881 $ref: '#/components/schemas/ErrorMessage'
884 message: Conflicting request
885 details: The request cannot be processed as the resource is in use.
887 description: Internal Server Error
891 $ref: '#/components/schemas/ErrorMessage'
894 message: Internal Server Error
895 details: Internal Server Error occurred
896 /{apiVersion}/dataspaces/{dataspace-name}/schema-sets:
900 summary: Get schema sets for a given dataspace
901 description: "Read schema sets for a given dataspace"
902 operationId: getSchemaSets
904 - $ref: '#/components/parameters/apiVersionInPath'
905 - name: dataspace-name
907 description: dataspace-name
911 example: my-dataspace
920 $ref: '#/components/schemas/SchemaSetDetails'
922 description: Bad Request
926 $ref: '#/components/schemas/ErrorMessage'
930 details: The provided request is not valid
932 description: Unauthorized
936 $ref: '#/components/schemas/ErrorMessage'
939 message: Unauthorized request
940 details: This request is unauthorized
942 description: Forbidden
946 $ref: '#/components/schemas/ErrorMessage'
949 message: Request Forbidden
950 details: This request is forbidden
952 description: Internal Server Error
956 $ref: '#/components/schemas/ErrorMessage'
959 message: Internal Server Error
960 details: Internal Server Error occurred
961 /{apiVersion}/dataspaces/{dataspace-name}/schema-sets/{schema-set-name}:
965 summary: Get a schema set
966 description: Read a schema set given a schema set name and a dataspace
967 operationId: getSchemaSet
969 - $ref: '#/components/parameters/apiVersionInPath'
970 - name: dataspace-name
972 description: dataspace-name
976 example: my-dataspace
977 - name: schema-set-name
979 description: schema-set-name
983 example: my-schema-set
990 $ref: '#/components/schemas/SchemaSetDetails'
992 description: Bad Request
996 $ref: '#/components/schemas/ErrorMessage'
1000 details: The provided request is not valid
1002 description: Unauthorized
1006 $ref: '#/components/schemas/ErrorMessage'
1009 message: Unauthorized request
1010 details: This request is unauthorized
1012 description: Forbidden
1016 $ref: '#/components/schemas/ErrorMessage'
1019 message: Request Forbidden
1020 details: This request is forbidden
1022 description: Internal Server Error
1026 $ref: '#/components/schemas/ErrorMessage'
1029 message: Internal Server Error
1030 details: Internal Server Error occurred
1034 summary: Delete a schema set
1035 description: Delete a schema set given a schema set name and a dataspace
1036 operationId: deleteSchemaSet
1038 - $ref: '#/components/parameters/apiVersionInPath'
1039 - name: dataspace-name
1041 description: dataspace-name
1045 example: my-dataspace
1046 - name: schema-set-name
1048 description: schema-set-name
1052 example: my-schema-set
1055 description: No Content
1058 description: Bad Request
1062 $ref: '#/components/schemas/ErrorMessage'
1065 message: Bad Request
1066 details: The provided request is not valid
1068 description: Unauthorized
1072 $ref: '#/components/schemas/ErrorMessage'
1075 message: Unauthorized request
1076 details: This request is unauthorized
1078 description: Forbidden
1082 $ref: '#/components/schemas/ErrorMessage'
1085 message: Request Forbidden
1086 details: This request is forbidden
1088 description: Conflict
1092 $ref: '#/components/schemas/ErrorMessage'
1095 message: Conflicting request
1096 details: The request cannot be processed as the resource is in use.
1098 description: Internal Server Error
1102 $ref: '#/components/schemas/ErrorMessage'
1105 message: Internal Server Error
1106 details: Internal Server Error occurred
1107 /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
1112 description: Get a node with an option to retrieve all the children for a given
1113 anchor and dataspace
1114 operationId: getNodeByDataspaceAndAnchor
1116 - $ref: '#/components/parameters/apiVersionInPath'
1117 - name: dataspace-name
1119 description: dataspace-name
1123 example: my-dataspace
1126 description: anchor-name
1133 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1140 value: /shops/bookstore
1141 list attributes xpath:
1142 value: "/shops/bookstore/categories[@code=1]"
1143 - name: include-descendants
1145 description: include-descendants
1160 $ref: '#/components/examples/dataSample'
1162 description: Bad Request
1166 $ref: '#/components/schemas/ErrorMessage'
1169 message: Bad Request
1170 details: The provided request is not valid
1172 description: Unauthorized
1176 $ref: '#/components/schemas/ErrorMessage'
1179 message: Unauthorized request
1180 details: This request is unauthorized
1182 description: Forbidden
1186 $ref: '#/components/schemas/ErrorMessage'
1189 message: Request Forbidden
1190 details: This request is forbidden
1192 description: Internal Server Error
1196 $ref: '#/components/schemas/ErrorMessage'
1199 message: Internal Server Error
1200 details: Internal Server Error occurred
1201 x-codegen-request-body-name: xpath
1202 /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes:
1206 summary: Replace a node with descendants
1207 description: "Replace a node with descendants for a given dataspace, anchor\
1208 \ and a parent node xpath"
1209 operationId: replaceNode
1211 - $ref: '#/components/parameters/apiVersionInPath'
1212 - name: dataspace-name
1214 description: dataspace-name
1218 example: my-dataspace
1221 description: anchor-name
1228 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1235 value: /shops/bookstore
1236 list attributes xpath:
1237 value: "/shops/bookstore/categories[@code=1]"
1238 - name: observed-timestamp
1240 description: observed-timestamp
1244 example: 2021-03-21T00:10:34.030-0100
1252 $ref: '#/components/examples/dataSample'
1265 description: Bad Request
1269 $ref: '#/components/schemas/ErrorMessage'
1272 message: Bad Request
1273 details: The provided request is not valid
1275 description: Unauthorized
1279 $ref: '#/components/schemas/ErrorMessage'
1282 message: Unauthorized request
1283 details: This request is unauthorized
1285 description: Forbidden
1289 $ref: '#/components/schemas/ErrorMessage'
1292 message: Request Forbidden
1293 details: This request is forbidden
1295 description: Internal Server Error
1299 $ref: '#/components/schemas/ErrorMessage'
1302 message: Internal Server Error
1303 details: Internal Server Error occurred
1307 summary: Create a node
1308 description: Create a node for a given anchor and dataspace
1309 operationId: createNode
1311 - $ref: '#/components/parameters/apiVersionInPath'
1312 - name: dataspace-name
1314 description: dataspace-name
1318 example: my-dataspace
1321 description: anchor-name
1328 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1335 value: /shops/bookstore
1336 list attributes xpath:
1337 value: "/shops/bookstore/categories[@code=1]"
1338 - name: observed-timestamp
1340 description: observed-timestamp
1344 example: 2021-03-21T00:10:34.030-0100
1352 $ref: '#/components/examples/dataSample'
1356 description: Created
1361 example: my-resource
1363 description: Bad Request
1367 $ref: '#/components/schemas/ErrorMessage'
1370 message: Bad Request
1371 details: The provided request is not valid
1373 description: Unauthorized
1377 $ref: '#/components/schemas/ErrorMessage'
1380 message: Unauthorized request
1381 details: This request is unauthorized
1383 description: Forbidden
1387 $ref: '#/components/schemas/ErrorMessage'
1390 message: Request Forbidden
1391 details: This request is forbidden
1393 description: Conflict
1397 $ref: '#/components/schemas/ErrorMessage'
1400 message: Conflicting request
1401 details: The request cannot be processed as the resource is in use.
1403 description: Internal Server Error
1407 $ref: '#/components/schemas/ErrorMessage'
1410 message: Internal Server Error
1411 details: Internal Server Error occurred
1415 summary: Delete a data node
1416 description: Delete a datanode for a given dataspace and anchor given a node
1418 operationId: deleteDataNode
1420 - $ref: '#/components/parameters/apiVersionInPath'
1421 - name: dataspace-name
1423 description: dataspace-name
1427 example: my-dataspace
1430 description: anchor-name
1437 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1444 value: /shops/bookstore
1445 list attributes xpath:
1446 value: "/shops/bookstore/categories[@code=1]"
1447 - name: observed-timestamp
1449 description: observed-timestamp
1453 example: 2021-03-21T00:10:34.030-0100
1456 description: No Content
1459 description: Bad Request
1463 $ref: '#/components/schemas/ErrorMessage'
1466 message: Bad Request
1467 details: The provided request is not valid
1469 description: Unauthorized
1473 $ref: '#/components/schemas/ErrorMessage'
1476 message: Unauthorized request
1477 details: This request is unauthorized
1479 description: Forbidden
1483 $ref: '#/components/schemas/ErrorMessage'
1486 message: Request Forbidden
1487 details: This request is forbidden
1489 description: Internal Server Error
1493 $ref: '#/components/schemas/ErrorMessage'
1496 message: Internal Server Error
1497 details: Internal Server Error occurred
1501 summary: Update node leaves
1502 description: Update a data node leaves for a given dataspace and anchor and
1504 operationId: updateNodeLeaves
1506 - $ref: '#/components/parameters/apiVersionInPath'
1507 - name: dataspace-name
1509 description: dataspace-name
1513 example: my-dataspace
1516 description: anchor-name
1523 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1530 value: /shops/bookstore
1531 list attributes xpath:
1532 value: "/shops/bookstore/categories[@code=1]"
1533 - name: observed-timestamp
1535 description: observed-timestamp
1539 example: 2021-03-21T00:10:34.030-0100
1547 $ref: '#/components/examples/dataSample'
1560 description: Bad Request
1564 $ref: '#/components/schemas/ErrorMessage'
1567 message: Bad Request
1568 details: The provided request is not valid
1570 description: Unauthorized
1574 $ref: '#/components/schemas/ErrorMessage'
1577 message: Unauthorized request
1578 details: This request is unauthorized
1580 description: Forbidden
1584 $ref: '#/components/schemas/ErrorMessage'
1587 message: Request Forbidden
1588 details: This request is forbidden
1590 description: Internal Server Error
1594 $ref: '#/components/schemas/ErrorMessage'
1597 message: Internal Server Error
1598 details: Internal Server Error occurred
1599 /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes:
1603 summary: Replace list content
1604 description: "Replace list content under a given parent, anchor and dataspace"
1605 operationId: replaceListContent
1607 - $ref: '#/components/parameters/apiVersionInPath'
1608 - name: dataspace-name
1610 description: dataspace-name
1614 example: my-dataspace
1617 description: anchor-name
1624 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1630 value: /shops/bookstore
1631 list attributes xpath:
1632 value: "/shops/bookstore/categories[@code=1]"
1633 - name: observed-timestamp
1635 description: observed-timestamp
1639 example: 2021-03-21T00:10:34.030-0100
1647 $ref: '#/components/examples/dataSample'
1660 description: Bad Request
1664 $ref: '#/components/schemas/ErrorMessage'
1667 message: Bad Request
1668 details: The provided request is not valid
1670 description: Unauthorized
1674 $ref: '#/components/schemas/ErrorMessage'
1677 message: Unauthorized request
1678 details: This request is unauthorized
1680 description: Forbidden
1684 $ref: '#/components/schemas/ErrorMessage'
1687 message: Request Forbidden
1688 details: This request is forbidden
1690 description: Internal Server Error
1694 $ref: '#/components/schemas/ErrorMessage'
1697 message: Internal Server Error
1698 details: Internal Server Error occurred
1702 summary: Add list element(s)
1703 description: Add list element(s) to a list for a given anchor and dataspace
1704 operationId: addListElements
1706 - $ref: '#/components/parameters/apiVersionInPath'
1707 - name: dataspace-name
1709 description: dataspace-name
1713 example: my-dataspace
1716 description: anchor-name
1723 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1729 value: /shops/bookstore
1730 list attributes xpath:
1731 value: "/shops/bookstore/categories[@code=1]"
1732 - name: observed-timestamp
1734 description: observed-timestamp
1738 example: 2021-03-21T00:10:34.030-0100
1746 $ref: '#/components/examples/dataSample'
1750 description: Created
1755 example: my-resource
1757 description: Bad Request
1761 $ref: '#/components/schemas/ErrorMessage'
1764 message: Bad Request
1765 details: The provided request is not valid
1767 description: Unauthorized
1771 $ref: '#/components/schemas/ErrorMessage'
1774 message: Unauthorized request
1775 details: This request is unauthorized
1777 description: Forbidden
1781 $ref: '#/components/schemas/ErrorMessage'
1784 message: Request Forbidden
1785 details: This request is forbidden
1787 description: Internal Server Error
1791 $ref: '#/components/schemas/ErrorMessage'
1794 message: Internal Server Error
1795 details: Internal Server Error occurred
1799 summary: Delete one or all list element(s)
1800 description: Delete one or all list element(s) for a given anchor and dataspace
1801 operationId: deleteListOrListElement
1803 - $ref: '#/components/parameters/apiVersionInPath'
1804 - name: dataspace-name
1806 description: dataspace-name
1810 example: my-dataspace
1813 description: anchor-name
1820 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1826 value: /shops/bookstore
1827 list attributes xpath:
1828 value: "/shops/bookstore/categories[@code=1]"
1829 - name: observed-timestamp
1831 description: observed-timestamp
1835 example: 2021-03-21T00:10:34.030-0100
1838 description: No Content
1841 description: Bad Request
1845 $ref: '#/components/schemas/ErrorMessage'
1848 message: Bad Request
1849 details: The provided request is not valid
1851 description: Unauthorized
1855 $ref: '#/components/schemas/ErrorMessage'
1858 message: Unauthorized request
1859 details: This request is unauthorized
1861 description: Forbidden
1865 $ref: '#/components/schemas/ErrorMessage'
1868 message: Request Forbidden
1869 details: This request is forbidden
1871 description: Internal Server Error
1875 $ref: '#/components/schemas/ErrorMessage'
1878 message: Internal Server Error
1879 details: Internal Server Error occurred
1881 /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
1885 summary: Query data nodes
1886 description: Query data nodes for the given dataspace and anchor using CPS path
1887 operationId: getNodesByDataspaceAndAnchorAndCpsPath
1889 - $ref: '#/components/parameters/apiVersionInPath'
1890 - name: dataspace-name
1892 description: dataspace-name
1896 example: my-dataspace
1899 description: anchor-name
1906 description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1914 list attributes cps path:
1915 value: "//categories[@code=1]"
1916 - name: include-descendants
1918 description: include-descendants
1933 $ref: '#/components/examples/dataSample'
1935 description: Bad Request
1939 $ref: '#/components/schemas/ErrorMessage'
1942 message: Bad Request
1943 details: The provided request is not valid
1945 description: Unauthorized
1949 $ref: '#/components/schemas/ErrorMessage'
1952 message: Unauthorized request
1953 details: This request is unauthorized
1955 description: Forbidden
1959 $ref: '#/components/schemas/ErrorMessage'
1962 message: Request Forbidden
1963 details: This request is forbidden
1965 description: Internal Server Error
1969 $ref: '#/components/schemas/ErrorMessage'
1972 message: Internal Server Error
1973 details: Internal Server Error occurred
1974 x-codegen-request-body-name: xpath
1980 description: apiVersion
2002 title: Anchor details by anchor Name
2010 example: my-dataspace
2013 example: my-schema-set
2015 title: Dataspace details by dataspace Name
2020 example: my-dataspace
2028 description: multipartFile
2031 title: Schema set details by dataspace and schemasetName
2038 example: my-dataspace
2042 $ref: '#/components/schemas/ModuleReferences'
2045 example: my-schema-set
2047 title: Module reference object
2052 example: my-module-reference-name
2055 example: my-module-reference-namespace
2058 example: my-module-reference-revision
2063 bookstore-name: Chapters