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 /v1/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
1115 operationId: getNodeByDataspaceAndAnchor
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 /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
1207 description: Get a node with an option to retrieve all the children for a given
1208 anchor and dataspace
1209 operationId: getNodeByDataspaceAndAnchorV2
1211 - name: dataspace-name
1213 description: dataspace-name
1217 example: my-dataspace
1220 description: anchor-name
1227 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1234 value: /shops/bookstore
1235 list attributes xpath:
1236 value: "/shops/bookstore/categories[@code=1]"
1239 description: descendants
1245 pattern: '^all$|^none$|^[0-9]+$|^-1$'
1255 $ref: '#/components/examples/dataSample'
1257 description: Bad Request
1261 $ref: '#/components/schemas/ErrorMessage'
1264 message: Bad Request
1265 details: The provided request is not valid
1267 description: Unauthorized
1271 $ref: '#/components/schemas/ErrorMessage'
1274 message: Unauthorized request
1275 details: This request is unauthorized
1277 description: Forbidden
1281 $ref: '#/components/schemas/ErrorMessage'
1284 message: Request Forbidden
1285 details: This request is forbidden
1287 description: Internal Server Error
1291 $ref: '#/components/schemas/ErrorMessage'
1294 message: Internal Server Error
1295 details: Internal Server Error occurred
1296 x-codegen-request-body-name: xpath
1297 /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes:
1301 summary: Replace a node with descendants
1302 description: "Replace a node with descendants for a given dataspace, anchor\
1303 \ and a parent node xpath"
1304 operationId: replaceNode
1306 - $ref: '#/components/parameters/apiVersionInPath'
1307 - name: dataspace-name
1309 description: dataspace-name
1313 example: my-dataspace
1316 description: anchor-name
1323 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1330 value: /shops/bookstore
1331 list attributes xpath:
1332 value: "/shops/bookstore/categories[@code=1]"
1333 - name: observed-timestamp
1335 description: observed-timestamp
1339 example: 2021-03-21T00:10:34.030-0100
1347 $ref: '#/components/examples/dataSample'
1360 description: Bad Request
1364 $ref: '#/components/schemas/ErrorMessage'
1367 message: Bad Request
1368 details: The provided request is not valid
1370 description: Unauthorized
1374 $ref: '#/components/schemas/ErrorMessage'
1377 message: Unauthorized request
1378 details: This request is unauthorized
1380 description: Forbidden
1384 $ref: '#/components/schemas/ErrorMessage'
1387 message: Request Forbidden
1388 details: This request is forbidden
1390 description: Internal Server Error
1394 $ref: '#/components/schemas/ErrorMessage'
1397 message: Internal Server Error
1398 details: Internal Server Error occurred
1402 summary: Create a node
1403 description: Create a node for a given anchor and dataspace
1404 operationId: createNode
1406 - $ref: '#/components/parameters/apiVersionInPath'
1407 - name: dataspace-name
1409 description: dataspace-name
1413 example: my-dataspace
1416 description: anchor-name
1423 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1430 value: /shops/bookstore
1431 list attributes xpath:
1432 value: "/shops/bookstore/categories[@code=1]"
1433 - name: observed-timestamp
1435 description: observed-timestamp
1439 example: 2021-03-21T00:10:34.030-0100
1447 $ref: '#/components/examples/dataSample'
1451 description: Created
1456 example: my-resource
1458 description: Bad Request
1462 $ref: '#/components/schemas/ErrorMessage'
1465 message: Bad Request
1466 details: The provided request is not valid
1468 description: Unauthorized
1472 $ref: '#/components/schemas/ErrorMessage'
1475 message: Unauthorized request
1476 details: This request is unauthorized
1478 description: Forbidden
1482 $ref: '#/components/schemas/ErrorMessage'
1485 message: Request Forbidden
1486 details: This request is forbidden
1488 description: Conflict
1492 $ref: '#/components/schemas/ErrorMessage'
1495 message: Conflicting request
1496 details: The request cannot be processed as the resource is in use.
1498 description: Internal Server Error
1502 $ref: '#/components/schemas/ErrorMessage'
1505 message: Internal Server Error
1506 details: Internal Server Error occurred
1510 summary: Delete a data node
1511 description: Delete a datanode for a given dataspace and anchor given a node
1513 operationId: deleteDataNode
1515 - $ref: '#/components/parameters/apiVersionInPath'
1516 - name: dataspace-name
1518 description: dataspace-name
1522 example: my-dataspace
1525 description: anchor-name
1532 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1539 value: /shops/bookstore
1540 list attributes xpath:
1541 value: "/shops/bookstore/categories[@code=1]"
1542 - name: observed-timestamp
1544 description: observed-timestamp
1548 example: 2021-03-21T00:10:34.030-0100
1551 description: No Content
1554 description: Bad Request
1558 $ref: '#/components/schemas/ErrorMessage'
1561 message: Bad Request
1562 details: The provided request is not valid
1564 description: Unauthorized
1568 $ref: '#/components/schemas/ErrorMessage'
1571 message: Unauthorized request
1572 details: This request is unauthorized
1574 description: Forbidden
1578 $ref: '#/components/schemas/ErrorMessage'
1581 message: Request Forbidden
1582 details: This request is forbidden
1584 description: Internal Server Error
1588 $ref: '#/components/schemas/ErrorMessage'
1591 message: Internal Server Error
1592 details: Internal Server Error occurred
1596 summary: Update node leaves
1597 description: Update a data node leaves for a given dataspace and anchor and
1599 operationId: updateNodeLeaves
1601 - $ref: '#/components/parameters/apiVersionInPath'
1602 - name: dataspace-name
1604 description: dataspace-name
1608 example: my-dataspace
1611 description: anchor-name
1618 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1625 value: /shops/bookstore
1626 list attributes xpath:
1627 value: "/shops/bookstore/categories[@code=1]"
1628 - name: observed-timestamp
1630 description: observed-timestamp
1634 example: 2021-03-21T00:10:34.030-0100
1642 $ref: '#/components/examples/dataSample'
1655 description: Bad Request
1659 $ref: '#/components/schemas/ErrorMessage'
1662 message: Bad Request
1663 details: The provided request is not valid
1665 description: Unauthorized
1669 $ref: '#/components/schemas/ErrorMessage'
1672 message: Unauthorized request
1673 details: This request is unauthorized
1675 description: Forbidden
1679 $ref: '#/components/schemas/ErrorMessage'
1682 message: Request Forbidden
1683 details: This request is forbidden
1685 description: Internal Server Error
1689 $ref: '#/components/schemas/ErrorMessage'
1692 message: Internal Server Error
1693 details: Internal Server Error occurred
1694 /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes:
1698 summary: Replace list content
1699 description: "Replace list content under a given parent, anchor and dataspace"
1700 operationId: replaceListContent
1702 - $ref: '#/components/parameters/apiVersionInPath'
1703 - name: dataspace-name
1705 description: dataspace-name
1709 example: my-dataspace
1712 description: anchor-name
1719 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1725 value: /shops/bookstore
1726 list attributes xpath:
1727 value: "/shops/bookstore/categories[@code=1]"
1728 - name: observed-timestamp
1730 description: observed-timestamp
1734 example: 2021-03-21T00:10:34.030-0100
1742 $ref: '#/components/examples/dataSample'
1755 description: Bad Request
1759 $ref: '#/components/schemas/ErrorMessage'
1762 message: Bad Request
1763 details: The provided request is not valid
1765 description: Unauthorized
1769 $ref: '#/components/schemas/ErrorMessage'
1772 message: Unauthorized request
1773 details: This request is unauthorized
1775 description: Forbidden
1779 $ref: '#/components/schemas/ErrorMessage'
1782 message: Request Forbidden
1783 details: This request is forbidden
1785 description: Internal Server Error
1789 $ref: '#/components/schemas/ErrorMessage'
1792 message: Internal Server Error
1793 details: Internal Server Error occurred
1797 summary: Add list element(s)
1798 description: Add list element(s) to a list for a given anchor and dataspace
1799 operationId: addListElements
1801 - $ref: '#/components/parameters/apiVersionInPath'
1802 - name: dataspace-name
1804 description: dataspace-name
1808 example: my-dataspace
1811 description: anchor-name
1818 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1824 value: /shops/bookstore
1825 list attributes xpath:
1826 value: "/shops/bookstore/categories[@code=1]"
1827 - name: observed-timestamp
1829 description: observed-timestamp
1833 example: 2021-03-21T00:10:34.030-0100
1841 $ref: '#/components/examples/dataSample'
1845 description: Created
1850 example: my-resource
1852 description: Bad Request
1856 $ref: '#/components/schemas/ErrorMessage'
1859 message: Bad Request
1860 details: The provided request is not valid
1862 description: Unauthorized
1866 $ref: '#/components/schemas/ErrorMessage'
1869 message: Unauthorized request
1870 details: This request is unauthorized
1872 description: Forbidden
1876 $ref: '#/components/schemas/ErrorMessage'
1879 message: Request Forbidden
1880 details: This request is forbidden
1882 description: Internal Server Error
1886 $ref: '#/components/schemas/ErrorMessage'
1889 message: Internal Server Error
1890 details: Internal Server Error occurred
1894 summary: Delete one or all list element(s)
1895 description: Delete one or all list element(s) for a given anchor and dataspace
1896 operationId: deleteListOrListElement
1898 - $ref: '#/components/parameters/apiVersionInPath'
1899 - name: dataspace-name
1901 description: dataspace-name
1905 example: my-dataspace
1908 description: anchor-name
1915 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1921 value: /shops/bookstore
1922 list attributes xpath:
1923 value: "/shops/bookstore/categories[@code=1]"
1924 - name: observed-timestamp
1926 description: observed-timestamp
1930 example: 2021-03-21T00:10:34.030-0100
1933 description: No Content
1936 description: Bad Request
1940 $ref: '#/components/schemas/ErrorMessage'
1943 message: Bad Request
1944 details: The provided request is not valid
1946 description: Unauthorized
1950 $ref: '#/components/schemas/ErrorMessage'
1953 message: Unauthorized request
1954 details: This request is unauthorized
1956 description: Forbidden
1960 $ref: '#/components/schemas/ErrorMessage'
1963 message: Request Forbidden
1964 details: This request is forbidden
1966 description: Internal Server Error
1970 $ref: '#/components/schemas/ErrorMessage'
1973 message: Internal Server Error
1974 details: Internal Server Error occurred
1976 /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
1980 summary: Query data nodes
1981 description: Query data nodes for the given dataspace and anchor using CPS path
1982 operationId: getNodesByDataspaceAndAnchorAndCpsPath
1984 - $ref: '#/components/parameters/apiVersionInPath'
1985 - name: dataspace-name
1987 description: dataspace-name
1991 example: my-dataspace
1994 description: anchor-name
2001 description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
2009 list attributes cps path:
2010 value: "//categories[@code=1]"
2011 - name: include-descendants
2013 description: include-descendants
2028 $ref: '#/components/examples/dataSample'
2030 description: Bad Request
2034 $ref: '#/components/schemas/ErrorMessage'
2037 message: Bad Request
2038 details: The provided request is not valid
2040 description: Unauthorized
2044 $ref: '#/components/schemas/ErrorMessage'
2047 message: Unauthorized request
2048 details: This request is unauthorized
2050 description: Forbidden
2054 $ref: '#/components/schemas/ErrorMessage'
2057 message: Request Forbidden
2058 details: This request is forbidden
2060 description: Internal Server Error
2064 $ref: '#/components/schemas/ErrorMessage'
2067 message: Internal Server Error
2068 details: Internal Server Error occurred
2069 x-codegen-request-body-name: xpath
2070 /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
2074 summary: Query data nodes
2075 description: Query data nodes for the given dataspace and anchor using CPS path
2076 operationId: getNodesByDataspaceAndAnchorAndCpsPathV2
2078 - name: dataspace-name
2080 description: dataspace-name
2084 example: my-dataspace
2087 description: anchor-name
2094 description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
2102 list attributes cps path:
2103 value: "//categories[@code=1]"
2106 description: descendants
2110 pattern: '^all$|^none$|^[0-9]+$|^-1$'
2123 $ref: '#/components/examples/dataSample'
2125 description: Bad Request
2129 $ref: '#/components/schemas/ErrorMessage'
2132 message: Bad Request
2133 details: The provided request is not valid
2135 description: Unauthorized
2139 $ref: '#/components/schemas/ErrorMessage'
2142 message: Unauthorized request
2143 details: This request is unauthorized
2145 description: Forbidden
2149 $ref: '#/components/schemas/ErrorMessage'
2152 message: Request Forbidden
2153 details: This request is forbidden
2155 description: Internal Server Error
2159 $ref: '#/components/schemas/ErrorMessage'
2162 message: Internal Server Error
2163 details: Internal Server Error occurred
2164 x-codegen-request-body-name: xpath
2170 description: apiVersion
2192 title: Anchor details by anchor Name
2200 example: my-dataspace
2203 example: my-schema-set
2205 title: Dataspace details by dataspace Name
2210 example: my-dataspace
2218 description: multipartFile
2221 title: Schema set details by dataspace and schemasetName
2228 example: my-dataspace
2232 $ref: '#/components/schemas/ModuleReferences'
2235 example: my-schema-set
2237 title: Module reference object
2242 example: my-module-reference-name
2245 example: my-module-reference-namespace
2248 example: my-module-reference-revision
2253 bookstore-name: Chapters