4 email: onap-discuss@lists.onap.org
6 url: https://onap.readthedocs.io
7 description: Configuration Persistence Service is a Model Driven Generic Database
10 url: http://www.apache.org/licenses/LICENSE-2.0
11 title: ONAP Open API v3 Configuration Persistence Service
13 x-planned-retirement-date: "202212"
22 - description: cps Admin
24 - description: cps Data
30 description: Create a new dataspace
31 operationId: createDataspace
33 - description: dataspace-name
54 details: The provided request is not valid
56 $ref: '#/components/schemas/ErrorMessage'
57 description: Bad Request
63 message: Unauthorized request
64 details: This request is unauthorized
66 $ref: '#/components/schemas/ErrorMessage'
67 description: Unauthorized
73 message: Request Forbidden
74 details: This request is forbidden
76 $ref: '#/components/schemas/ErrorMessage'
77 description: Forbidden
83 message: Conflicting request
84 details: The request cannot be processed as the resource is in use.
86 $ref: '#/components/schemas/ErrorMessage'
93 message: Internal Server Error
94 details: Internal Server Error occurred
96 $ref: '#/components/schemas/ErrorMessage'
97 description: Internal Server Error
98 summary: Create a dataspace
101 /{apiVersion}/dataspaces:
103 description: Delete a dataspace
104 operationId: deleteDataspace
106 - description: apiVersion
116 - description: dataspace-name
121 example: my-dataspace
126 description: No Content
133 details: The provided request is not valid
135 $ref: '#/components/schemas/ErrorMessage'
136 description: Bad Request
142 message: Unauthorized request
143 details: This request is unauthorized
145 $ref: '#/components/schemas/ErrorMessage'
146 description: Unauthorized
152 message: Request Forbidden
153 details: This request is forbidden
155 $ref: '#/components/schemas/ErrorMessage'
156 description: Forbidden
162 message: Conflicting request
163 details: The request cannot be processed as the resource is in use.
165 $ref: '#/components/schemas/ErrorMessage'
166 description: Conflict
172 message: Internal Server Error
173 details: Internal Server Error occurred
175 $ref: '#/components/schemas/ErrorMessage'
176 description: Internal Server Error
177 summary: Delete a dataspace
182 description: Create a new dataspace
183 operationId: createDataspaceV2
185 - description: dataspace-name
190 example: my-dataspace
194 description: Created without response body
201 details: The provided request is not valid
203 $ref: '#/components/schemas/ErrorMessage'
204 description: Bad Request
210 message: Unauthorized request
211 details: This request is unauthorized
213 $ref: '#/components/schemas/ErrorMessage'
214 description: Unauthorized
220 message: Request Forbidden
221 details: This request is forbidden
223 $ref: '#/components/schemas/ErrorMessage'
224 description: Forbidden
230 message: Conflicting request
231 details: The request cannot be processed as the resource is in use.
233 $ref: '#/components/schemas/ErrorMessage'
234 description: Conflict
240 message: Internal Server Error
241 details: Internal Server Error occurred
243 $ref: '#/components/schemas/ErrorMessage'
244 description: Internal Server Error
245 summary: Create a dataspace
248 /{apiVersion}/admin/dataspaces:
250 description: Read all dataspaces
251 operationId: getAllDataspaces
253 - description: apiVersion
269 $ref: '#/components/schemas/DataspaceDetails'
278 details: The provided request is not valid
280 $ref: '#/components/schemas/ErrorMessage'
281 description: Bad Request
287 message: Unauthorized request
288 details: This request is unauthorized
290 $ref: '#/components/schemas/ErrorMessage'
291 description: Unauthorized
297 message: Request Forbidden
298 details: This request is forbidden
300 $ref: '#/components/schemas/ErrorMessage'
301 description: Forbidden
307 message: Internal Server Error
308 details: Internal Server Error occurred
310 $ref: '#/components/schemas/ErrorMessage'
311 description: Internal Server Error
312 summary: Get all dataspaces
315 /{apiVersion}/admin/dataspaces/{dataspace-name}:
317 description: Read a dataspace given a dataspace name
318 operationId: getDataspace
320 - description: apiVersion
330 - description: dataspace-name
335 example: my-dataspace
342 $ref: '#/components/schemas/DataspaceDetails'
350 details: The provided request is not valid
352 $ref: '#/components/schemas/ErrorMessage'
353 description: Bad Request
359 message: Unauthorized request
360 details: This request is unauthorized
362 $ref: '#/components/schemas/ErrorMessage'
363 description: Unauthorized
369 message: Request Forbidden
370 details: This request is forbidden
372 $ref: '#/components/schemas/ErrorMessage'
373 description: Forbidden
379 message: Internal Server Error
380 details: Internal Server Error occurred
382 $ref: '#/components/schemas/ErrorMessage'
383 description: Internal Server Error
384 summary: Get a dataspace
387 /v1/dataspaces/{dataspace-name}/anchors:
390 description: Create a new anchor in the given dataspace
391 operationId: createAnchor
393 - description: dataspace-name
398 example: my-dataspace
400 - description: schema-set-name
402 name: schema-set-name
405 example: my-schema-set
407 - description: anchor-name
428 details: The provided request is not valid
430 $ref: '#/components/schemas/ErrorMessage'
431 description: Bad Request
437 message: Unauthorized request
438 details: This request is unauthorized
440 $ref: '#/components/schemas/ErrorMessage'
441 description: Unauthorized
447 message: Request Forbidden
448 details: This request is forbidden
450 $ref: '#/components/schemas/ErrorMessage'
451 description: Forbidden
457 message: Conflicting request
458 details: The request cannot be processed as the resource is in use.
460 $ref: '#/components/schemas/ErrorMessage'
461 description: Conflict
467 message: Internal Server Error
468 details: Internal Server Error occurred
470 $ref: '#/components/schemas/ErrorMessage'
471 description: Internal Server Error
472 summary: Create an anchor
475 /v2/dataspaces/{dataspace-name}/anchors:
477 description: Create a new anchor in the given dataspace
478 operationId: createAnchorV2
480 - description: dataspace-name
485 example: my-dataspace
487 - description: schema-set-name
489 name: schema-set-name
492 example: my-schema-set
494 - description: anchor-name
503 description: Created without response body
510 details: The provided request is not valid
512 $ref: '#/components/schemas/ErrorMessage'
513 description: Bad Request
519 message: Unauthorized request
520 details: This request is unauthorized
522 $ref: '#/components/schemas/ErrorMessage'
523 description: Unauthorized
529 message: Request Forbidden
530 details: This request is forbidden
532 $ref: '#/components/schemas/ErrorMessage'
533 description: Forbidden
539 message: Conflicting request
540 details: The request cannot be processed as the resource is in use.
542 $ref: '#/components/schemas/ErrorMessage'
543 description: Conflict
549 message: Internal Server Error
550 details: Internal Server Error occurred
552 $ref: '#/components/schemas/ErrorMessage'
553 description: Internal Server Error
554 summary: Create an anchor
557 /{apiVersion}/dataspaces/{dataspace-name}/anchors:
559 description: "Read all anchors, given a dataspace"
560 operationId: getAnchors
562 - description: apiVersion
572 - description: dataspace-name
577 example: my-dataspace
585 $ref: '#/components/schemas/AnchorDetails'
594 details: The provided request is not valid
596 $ref: '#/components/schemas/ErrorMessage'
597 description: Bad Request
603 message: Unauthorized request
604 details: This request is unauthorized
606 $ref: '#/components/schemas/ErrorMessage'
607 description: Unauthorized
613 message: Request Forbidden
614 details: This request is forbidden
616 $ref: '#/components/schemas/ErrorMessage'
617 description: Forbidden
623 message: Internal Server Error
624 details: Internal Server Error occurred
626 $ref: '#/components/schemas/ErrorMessage'
627 description: Internal Server Error
631 /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}:
633 description: Delete an anchor given an anchor name and a dataspace
634 operationId: deleteAnchor
636 - description: apiVersion
646 - description: dataspace-name
651 example: my-dataspace
653 - description: anchor-name
663 description: No Content
670 details: The provided request is not valid
672 $ref: '#/components/schemas/ErrorMessage'
673 description: Bad Request
679 message: Unauthorized request
680 details: This request is unauthorized
682 $ref: '#/components/schemas/ErrorMessage'
683 description: Unauthorized
689 message: Request Forbidden
690 details: This request is forbidden
692 $ref: '#/components/schemas/ErrorMessage'
693 description: Forbidden
699 message: Internal Server Error
700 details: Internal Server Error occurred
702 $ref: '#/components/schemas/ErrorMessage'
703 description: Internal Server Error
704 summary: Delete an anchor
708 description: Read an anchor given an anchor name and a dataspace
709 operationId: getAnchor
711 - description: apiVersion
721 - description: dataspace-name
726 example: my-dataspace
728 - description: anchor-name
740 $ref: '#/components/schemas/AnchorDetails'
748 details: The provided request is not valid
750 $ref: '#/components/schemas/ErrorMessage'
751 description: Bad Request
757 message: Unauthorized request
758 details: This request is unauthorized
760 $ref: '#/components/schemas/ErrorMessage'
761 description: Unauthorized
767 message: Request Forbidden
768 details: This request is forbidden
770 $ref: '#/components/schemas/ErrorMessage'
771 description: Forbidden
777 message: Internal Server Error
778 details: Internal Server Error occurred
780 $ref: '#/components/schemas/ErrorMessage'
781 description: Internal Server Error
782 summary: Get an anchor
785 /v1/dataspaces/{dataspace-name}/schema-sets:
788 description: Create a new schema set in the given dataspace
789 operationId: createSchemaSet
791 - description: dataspace-name
796 example: my-dataspace
798 - description: schema-set-name
800 name: schema-set-name
803 example: my-schema-set
809 $ref: '#/components/schemas/MultipartFile'
825 details: The provided request is not valid
827 $ref: '#/components/schemas/ErrorMessage'
828 description: Bad Request
834 message: Unauthorized request
835 details: This request is unauthorized
837 $ref: '#/components/schemas/ErrorMessage'
838 description: Unauthorized
844 message: Request Forbidden
845 details: This request is forbidden
847 $ref: '#/components/schemas/ErrorMessage'
848 description: Forbidden
854 message: Conflicting request
855 details: The request cannot be processed as the resource is in use.
857 $ref: '#/components/schemas/ErrorMessage'
858 description: Conflict
864 message: Internal Server Error
865 details: Internal Server Error occurred
867 $ref: '#/components/schemas/ErrorMessage'
868 description: Internal Server Error
869 summary: Create a schema set
872 /v2/dataspaces/{dataspace-name}/schema-sets:
874 description: Create a new schema set in the given dataspace
875 operationId: createSchemaSetV2
877 - description: dataspace-name
882 example: my-dataspace
884 - description: schema-set-name
886 name: schema-set-name
889 example: my-schema-set
895 $ref: '#/components/schemas/MultipartFile'
899 description: Created without response body
906 details: The provided request is not valid
908 $ref: '#/components/schemas/ErrorMessage'
909 description: Bad Request
915 message: Unauthorized request
916 details: This request is unauthorized
918 $ref: '#/components/schemas/ErrorMessage'
919 description: Unauthorized
925 message: Request Forbidden
926 details: This request is forbidden
928 $ref: '#/components/schemas/ErrorMessage'
929 description: Forbidden
935 message: Conflicting request
936 details: The request cannot be processed as the resource is in use.
938 $ref: '#/components/schemas/ErrorMessage'
939 description: Conflict
945 message: Internal Server Error
946 details: Internal Server Error occurred
948 $ref: '#/components/schemas/ErrorMessage'
949 description: Internal Server Error
950 summary: Create a schema set
953 /{apiVersion}/dataspaces/{dataspace-name}/schema-sets:
955 description: "Read all schema sets, given a dataspace"
956 operationId: getSchemaSets
958 - description: apiVersion
968 - description: dataspace-name
973 example: my-dataspace
981 $ref: '#/components/schemas/SchemaSetDetails'
990 details: The provided request is not valid
992 $ref: '#/components/schemas/ErrorMessage'
993 description: Bad Request
999 message: Unauthorized request
1000 details: This request is unauthorized
1002 $ref: '#/components/schemas/ErrorMessage'
1003 description: Unauthorized
1009 message: Request Forbidden
1010 details: This request is forbidden
1012 $ref: '#/components/schemas/ErrorMessage'
1013 description: Forbidden
1019 message: Internal Server Error
1020 details: Internal Server Error occurred
1022 $ref: '#/components/schemas/ErrorMessage'
1023 description: Internal Server Error
1024 summary: Get schema sets
1027 /{apiVersion}/dataspaces/{dataspace-name}/schema-sets/{schema-set-name}:
1029 description: Delete a schema set given a schema set name and a dataspace
1030 operationId: deleteSchemaSet
1032 - description: apiVersion
1042 - description: dataspace-name
1044 name: dataspace-name
1047 example: my-dataspace
1049 - description: schema-set-name
1051 name: schema-set-name
1054 example: my-schema-set
1059 description: No Content
1065 message: Bad Request
1066 details: The provided request is not valid
1068 $ref: '#/components/schemas/ErrorMessage'
1069 description: Bad Request
1075 message: Unauthorized request
1076 details: This request is unauthorized
1078 $ref: '#/components/schemas/ErrorMessage'
1079 description: Unauthorized
1085 message: Request Forbidden
1086 details: This request is forbidden
1088 $ref: '#/components/schemas/ErrorMessage'
1089 description: Forbidden
1095 message: Conflicting request
1096 details: The request cannot be processed as the resource is in use.
1098 $ref: '#/components/schemas/ErrorMessage'
1099 description: Conflict
1105 message: Internal Server Error
1106 details: Internal Server Error occurred
1108 $ref: '#/components/schemas/ErrorMessage'
1109 description: Internal Server Error
1110 summary: Delete a schema set
1114 description: Read a schema set given a schema set name and a dataspace
1115 operationId: getSchemaSet
1117 - description: apiVersion
1127 - description: dataspace-name
1129 name: dataspace-name
1132 example: my-dataspace
1134 - description: schema-set-name
1136 name: schema-set-name
1139 example: my-schema-set
1146 $ref: '#/components/schemas/SchemaSetDetails'
1153 message: Bad Request
1154 details: The provided request is not valid
1156 $ref: '#/components/schemas/ErrorMessage'
1157 description: Bad Request
1163 message: Unauthorized request
1164 details: This request is unauthorized
1166 $ref: '#/components/schemas/ErrorMessage'
1167 description: Unauthorized
1173 message: Request Forbidden
1174 details: This request is forbidden
1176 $ref: '#/components/schemas/ErrorMessage'
1177 description: Forbidden
1183 message: Internal Server Error
1184 details: Internal Server Error occurred
1186 $ref: '#/components/schemas/ErrorMessage'
1187 description: Internal Server Error
1188 summary: Get a schema set
1191 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
1194 description: Get a node with an option to retrieve all the children for a given
1195 anchor and dataspace
1196 operationId: getNodeByDataspaceAndAnchor
1198 - description: dataspace-name
1200 name: dataspace-name
1203 example: my-dataspace
1205 - description: anchor-name
1212 - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1215 value: /shops/bookstore
1216 list attributes xpath:
1217 value: "/shops/bookstore/categories[@code=1]"
1224 - description: include-descendants
1226 name: include-descendants
1238 $ref: '#/components/examples/dataSample'
1248 message: Bad Request
1249 details: The provided request is not valid
1251 $ref: '#/components/schemas/ErrorMessage'
1252 description: Bad Request
1258 message: Unauthorized request
1259 details: This request is unauthorized
1261 $ref: '#/components/schemas/ErrorMessage'
1262 description: Unauthorized
1268 message: Request Forbidden
1269 details: This request is forbidden
1271 $ref: '#/components/schemas/ErrorMessage'
1272 description: Forbidden
1278 message: Internal Server Error
1279 details: Internal Server Error occurred
1281 $ref: '#/components/schemas/ErrorMessage'
1282 description: Internal Server Error
1286 x-codegen-request-body-name: xpath
1287 /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
1289 description: Get a node with an option to retrieve all the children for a given
1290 anchor and dataspace
1291 operationId: getNodeByDataspaceAndAnchorV2
1293 - description: dataspace-name
1295 name: dataspace-name
1298 example: my-dataspace
1300 - description: anchor-name
1307 - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1310 value: /shops/bookstore
1311 list attributes xpath:
1312 value: "/shops/bookstore/categories[@code=1]"
1319 - description: "Number of descendants to query. Allowed values are 'none', 'all',\
1320 \ 'direct', 1 (for direct), -1 (for all), 0 (for none) and any positive\
1335 $ref: '#/components/examples/dataSample'
1345 message: Bad Request
1346 details: The provided request is not valid
1348 $ref: '#/components/schemas/ErrorMessage'
1349 description: Bad Request
1355 message: Unauthorized request
1356 details: This request is unauthorized
1358 $ref: '#/components/schemas/ErrorMessage'
1359 description: Unauthorized
1365 message: Request Forbidden
1366 details: This request is forbidden
1368 $ref: '#/components/schemas/ErrorMessage'
1369 description: Forbidden
1375 message: Internal Server Error
1376 details: Internal Server Error occurred
1378 $ref: '#/components/schemas/ErrorMessage'
1379 description: Internal Server Error
1383 x-codegen-request-body-name: xpath
1384 /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes:
1386 description: Delete a datanode for a given dataspace and anchor given a node
1388 operationId: deleteDataNode
1390 - description: apiVersion
1400 - description: dataspace-name
1402 name: dataspace-name
1405 example: my-dataspace
1407 - description: anchor-name
1414 - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1417 value: /shops/bookstore
1418 list attributes xpath:
1419 value: "/shops/bookstore/categories[@code=1]"
1426 - description: observed-timestamp
1428 name: observed-timestamp
1431 example: 2021-03-21T00:10:34.030-0100
1436 description: No Content
1442 message: Bad Request
1443 details: The provided request is not valid
1445 $ref: '#/components/schemas/ErrorMessage'
1446 description: Bad Request
1452 message: Unauthorized request
1453 details: This request is unauthorized
1455 $ref: '#/components/schemas/ErrorMessage'
1456 description: Unauthorized
1462 message: Request Forbidden
1463 details: This request is forbidden
1465 $ref: '#/components/schemas/ErrorMessage'
1466 description: Forbidden
1472 message: Internal Server Error
1473 details: Internal Server Error occurred
1475 $ref: '#/components/schemas/ErrorMessage'
1476 description: Internal Server Error
1477 summary: Delete a data node
1481 description: Update a data node leaves for a given dataspace and anchor and
1482 a parent node xpath. This operation is currently supported for one top level
1484 operationId: updateNodeLeaves
1486 - description: apiVersion
1496 - description: dataspace-name
1498 name: dataspace-name
1501 example: my-dataspace
1503 - description: anchor-name
1510 - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1513 value: /shops/bookstore
1514 list attributes xpath:
1515 value: "/shops/bookstore/categories[@code=1]"
1522 - description: observed-timestamp
1524 name: observed-timestamp
1527 example: 2021-03-21T00:10:34.030-0100
1534 $ref: '#/components/examples/dataSample'
1554 message: Bad Request
1555 details: The provided request is not valid
1557 $ref: '#/components/schemas/ErrorMessage'
1558 description: Bad Request
1564 message: Unauthorized request
1565 details: This request is unauthorized
1567 $ref: '#/components/schemas/ErrorMessage'
1568 description: Unauthorized
1574 message: Request Forbidden
1575 details: This request is forbidden
1577 $ref: '#/components/schemas/ErrorMessage'
1578 description: Forbidden
1584 message: Internal Server Error
1585 details: Internal Server Error occurred
1587 $ref: '#/components/schemas/ErrorMessage'
1588 description: Internal Server Error
1589 summary: Update node leaves
1593 description: Create a node for a given anchor and dataspace
1594 operationId: createNode
1596 - description: apiVersion
1606 - description: dataspace-name
1608 name: dataspace-name
1611 example: my-dataspace
1613 - description: anchor-name
1620 - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1623 value: /shops/bookstore
1624 list attributes xpath:
1625 value: "/shops/bookstore/categories[@code=1]"
1632 - description: observed-timestamp
1634 name: observed-timestamp
1637 example: 2021-03-21T00:10:34.030-0100
1639 - description: Content type header
1644 example: application/json
1651 $ref: '#/components/examples/dataSample'
1658 $ref: '#/components/examples/dataSampleXml'
1670 example: my-resource
1672 description: Created
1678 message: Bad Request
1679 details: The provided request is not valid
1681 $ref: '#/components/schemas/ErrorMessage'
1682 description: Bad Request
1688 message: Unauthorized request
1689 details: This request is unauthorized
1691 $ref: '#/components/schemas/ErrorMessage'
1692 description: Unauthorized
1698 message: Request Forbidden
1699 details: This request is forbidden
1701 $ref: '#/components/schemas/ErrorMessage'
1702 description: Forbidden
1708 message: Conflicting request
1709 details: The request cannot be processed as the resource is in use.
1711 $ref: '#/components/schemas/ErrorMessage'
1712 description: Conflict
1718 message: Internal Server Error
1719 details: Internal Server Error occurred
1721 $ref: '#/components/schemas/ErrorMessage'
1722 description: Internal Server Error
1723 summary: Create a node
1727 description: "Replace a node with descendants for a given dataspace, anchor\
1728 \ and a parent node xpath"
1729 operationId: replaceNode
1731 - description: apiVersion
1741 - description: dataspace-name
1743 name: dataspace-name
1746 example: my-dataspace
1748 - description: anchor-name
1755 - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1758 value: /shops/bookstore
1759 list attributes xpath:
1760 value: "/shops/bookstore/categories[@code=1]"
1767 - description: observed-timestamp
1769 name: observed-timestamp
1772 example: 2021-03-21T00:10:34.030-0100
1779 $ref: '#/components/examples/dataSample'
1799 message: Bad Request
1800 details: The provided request is not valid
1802 $ref: '#/components/schemas/ErrorMessage'
1803 description: Bad Request
1809 message: Unauthorized request
1810 details: This request is unauthorized
1812 $ref: '#/components/schemas/ErrorMessage'
1813 description: Unauthorized
1819 message: Request Forbidden
1820 details: This request is forbidden
1822 $ref: '#/components/schemas/ErrorMessage'
1823 description: Forbidden
1829 message: Internal Server Error
1830 details: Internal Server Error occurred
1832 $ref: '#/components/schemas/ErrorMessage'
1833 description: Internal Server Error
1834 summary: Replace a node with descendants
1837 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes:
1840 description: Delete one or all list element(s) for a given anchor and dataspace
1841 operationId: deleteListOrListElement
1843 - description: dataspace-name
1845 name: dataspace-name
1848 example: my-dataspace
1850 - description: anchor-name
1857 - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1860 value: /shops/bookstore
1861 list attributes xpath:
1862 value: "/shops/bookstore/categories[@code=1]"
1868 - description: observed-timestamp
1870 name: observed-timestamp
1873 example: 2021-03-21T00:10:34.030-0100
1878 description: No Content
1884 message: Bad Request
1885 details: The provided request is not valid
1887 $ref: '#/components/schemas/ErrorMessage'
1888 description: Bad Request
1894 message: Unauthorized request
1895 details: This request is unauthorized
1897 $ref: '#/components/schemas/ErrorMessage'
1898 description: Unauthorized
1904 message: Request Forbidden
1905 details: This request is forbidden
1907 $ref: '#/components/schemas/ErrorMessage'
1908 description: Forbidden
1914 message: Internal Server Error
1915 details: Internal Server Error occurred
1917 $ref: '#/components/schemas/ErrorMessage'
1918 description: Internal Server Error
1919 summary: Delete one or all list element(s)
1922 /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes:
1924 description: Add list element(s) to a list for a given anchor and dataspace
1925 operationId: addListElements
1927 - description: apiVersion
1937 - description: dataspace-name
1939 name: dataspace-name
1942 example: my-dataspace
1944 - description: anchor-name
1951 - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1954 value: /shops/bookstore
1955 list attributes xpath:
1956 value: "/shops/bookstore/categories[@code=1]"
1962 - description: observed-timestamp
1964 name: observed-timestamp
1967 example: 2021-03-21T00:10:34.030-0100
1974 $ref: '#/components/examples/dataSample'
1984 example: my-resource
1986 description: Created
1992 message: Bad Request
1993 details: The provided request is not valid
1995 $ref: '#/components/schemas/ErrorMessage'
1996 description: Bad Request
2002 message: Unauthorized request
2003 details: This request is unauthorized
2005 $ref: '#/components/schemas/ErrorMessage'
2006 description: Unauthorized
2012 message: Request Forbidden
2013 details: This request is forbidden
2015 $ref: '#/components/schemas/ErrorMessage'
2016 description: Forbidden
2022 message: Internal Server Error
2023 details: Internal Server Error occurred
2025 $ref: '#/components/schemas/ErrorMessage'
2026 description: Internal Server Error
2027 summary: Add list element(s)
2031 description: "Replace list content under a given parent, anchor and dataspace"
2032 operationId: replaceListContent
2034 - description: apiVersion
2044 - description: dataspace-name
2046 name: dataspace-name
2049 example: my-dataspace
2051 - description: anchor-name
2058 - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
2061 value: /shops/bookstore
2062 list attributes xpath:
2063 value: "/shops/bookstore/categories[@code=1]"
2069 - description: observed-timestamp
2071 name: observed-timestamp
2074 example: 2021-03-21T00:10:34.030-0100
2081 $ref: '#/components/examples/dataSample'
2101 message: Bad Request
2102 details: The provided request is not valid
2104 $ref: '#/components/schemas/ErrorMessage'
2105 description: Bad Request
2111 message: Unauthorized request
2112 details: This request is unauthorized
2114 $ref: '#/components/schemas/ErrorMessage'
2115 description: Unauthorized
2121 message: Request Forbidden
2122 details: This request is forbidden
2124 $ref: '#/components/schemas/ErrorMessage'
2125 description: Forbidden
2131 message: Internal Server Error
2132 details: Internal Server Error occurred
2134 $ref: '#/components/schemas/ErrorMessage'
2135 description: Internal Server Error
2136 summary: Replace list content
2139 /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/delta:
2141 description: Get delta between two anchors within a given dataspace
2142 operationId: getDeltaByDataspaceAndAnchors
2144 - description: dataspace-name
2146 name: dataspace-name
2149 example: my-dataspace
2151 - description: anchor-name
2158 - description: target-anchor-name
2160 name: target-anchor-name
2165 - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
2168 value: /shops/bookstore
2169 list attributes xpath:
2170 value: "/shops/bookstore/categories[@code=1]"
2177 - description: "Number of descendants to query. Allowed values are 'none', 'all',\
2178 \ 'direct', 1 (for direct), -1 (for all), 0 (for none) and any positive\
2193 $ref: '#/components/examples/deltaReportSample'
2203 message: Bad Request
2204 details: The provided request is not valid
2206 $ref: '#/components/schemas/ErrorMessage'
2207 description: Bad Request
2213 message: Unauthorized request
2214 details: This request is unauthorized
2216 $ref: '#/components/schemas/ErrorMessage'
2217 description: Unauthorized
2223 message: Request Forbidden
2224 details: This request is forbidden
2226 $ref: '#/components/schemas/ErrorMessage'
2227 description: Forbidden
2233 message: Internal Server Error
2234 details: Internal Server Error occurred
2236 $ref: '#/components/schemas/ErrorMessage'
2237 description: Internal Server Error
2238 summary: Get delta between anchors in the same dataspace
2241 x-codegen-request-body-name: xpath
2242 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
2245 description: Query data nodes for the given dataspace and anchor using CPS path
2246 operationId: getNodesByDataspaceAndAnchorAndCpsPath
2248 - description: dataspace-name
2250 name: dataspace-name
2253 example: my-dataspace
2255 - description: anchor-name
2262 - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
2266 list attributes cps path:
2267 value: "//categories[@code=1]"
2274 - description: include-descendants
2276 name: include-descendants
2288 $ref: '#/components/examples/dataSample'
2298 message: Bad Request
2299 details: The provided request is not valid
2301 $ref: '#/components/schemas/ErrorMessage'
2302 description: Bad Request
2308 message: Unauthorized request
2309 details: This request is unauthorized
2311 $ref: '#/components/schemas/ErrorMessage'
2312 description: Unauthorized
2318 message: Request Forbidden
2319 details: This request is forbidden
2321 $ref: '#/components/schemas/ErrorMessage'
2322 description: Forbidden
2328 message: Internal Server Error
2329 details: Internal Server Error occurred
2331 $ref: '#/components/schemas/ErrorMessage'
2332 description: Internal Server Error
2333 summary: Query data nodes
2336 x-codegen-request-body-name: xpath
2337 /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
2339 description: Query data nodes for the given dataspace and anchor using CPS path
2340 operationId: getNodesByDataspaceAndAnchorAndCpsPathV2
2342 - description: dataspace-name
2344 name: dataspace-name
2347 example: my-dataspace
2349 - description: anchor-name
2356 - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
2360 list attributes cps path:
2361 value: "//categories[@code=1]"
2368 - description: "Number of descendants to query. Allowed values are 'none', 'all',\
2369 \ 'direct', 1 (for direct), -1 (for all), 0 (for none) and any positive\
2384 $ref: '#/components/examples/dataSample'
2394 message: Bad Request
2395 details: The provided request is not valid
2397 $ref: '#/components/schemas/ErrorMessage'
2398 description: Bad Request
2404 message: Unauthorized request
2405 details: This request is unauthorized
2407 $ref: '#/components/schemas/ErrorMessage'
2408 description: Unauthorized
2414 message: Request Forbidden
2415 details: This request is forbidden
2417 $ref: '#/components/schemas/ErrorMessage'
2418 description: Forbidden
2424 message: Internal Server Error
2425 details: Internal Server Error occurred
2427 $ref: '#/components/schemas/ErrorMessage'
2428 description: Internal Server Error
2429 summary: Query data nodes
2432 x-codegen-request-body-name: xpath
2433 /v2/dataspaces/{dataspace-name}/nodes/query:
2435 description: Query data nodes for the given dataspace across anchors using CPS
2437 operationId: getNodesByDataspaceAndCpsPath
2439 - description: dataspace-name
2441 name: dataspace-name
2444 example: my-dataspace
2446 - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
2450 list attributes cps path:
2451 value: "//categories[@code=1]"
2458 - description: "Number of descendants to query. Allowed values are 'none', 'all',\
2459 \ 'direct', 1 (for direct), -1 (for all), 0 (for none) and any positive\
2468 - description: page index for pagination over anchors. It must be greater then
2476 - description: number of records (anchors) per page. It must be greater then
2490 $ref: '#/components/examples/dataSampleAcrossAnchors'
2500 message: Bad Request
2501 details: The provided request is not valid
2503 $ref: '#/components/schemas/ErrorMessage'
2504 description: Bad Request
2510 message: Unauthorized request
2511 details: This request is unauthorized
2513 $ref: '#/components/schemas/ErrorMessage'
2514 description: Unauthorized
2520 message: Request Forbidden
2521 details: This request is forbidden
2523 $ref: '#/components/schemas/ErrorMessage'
2524 description: Forbidden
2530 message: Internal Server Error
2531 details: Internal Server Error occurred
2533 $ref: '#/components/schemas/ErrorMessage'
2534 description: Internal Server Error
2535 summary: Query data nodes across anchors
2538 x-codegen-request-body-name: xpath
2544 bookstore-name: Chapters
2551 value: <stores xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <bookstore xmlns="org:onap:ccsdk:sample">
2552 <bookstore-name>Chapters</bookstore-name> <categories> <code>1</code> <name>SciFi</name>
2553 </categories> </bookstore> </stores>
2557 xpath: "/bookstore/categories/[@code=3]"
2562 xpath: "/bookstore/categories/[@code=1]"
2567 xpath: "/bookstore/categories/[@code=2]"
2572 dataSampleAcrossAnchors:
2574 - anchorName: bookstore1
2577 bookstore-name: Chapters
2583 - anchorName: bookstore2
2586 bookstore-name: Chapters
2593 dataspaceNameInQuery:
2594 description: dataspace-name
2596 name: dataspace-name
2599 example: my-dataspace
2602 description: apiVersion
2612 dataspaceNameInPath:
2613 description: dataspace-name
2615 name: dataspace-name
2618 example: my-dataspace
2620 schemaSetNameInQuery:
2621 description: schema-set-name
2623 name: schema-set-name
2626 example: my-schema-set
2629 description: anchor-name
2637 description: anchor-name
2644 schemaSetNameInPath:
2645 description: schema-set-name
2647 name: schema-set-name
2650 example: my-schema-set
2653 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
2656 value: /shops/bookstore
2657 list attributes xpath:
2658 value: "/shops/bookstore/categories[@code=1]"
2665 includeDescendantsOptionInQuery:
2666 description: include-descendants
2668 name: include-descendants
2675 description: "Number of descendants to query. Allowed values are 'none', 'all',\
2676 \ 'direct', 1 (for direct), -1 (for all), 0 (for none) and any positive number."
2684 observedTimestampInQuery:
2685 description: observed-timestamp
2687 name: observed-timestamp
2690 example: 2021-03-21T00:10:34.030-0100
2693 description: Content type header
2698 example: application/json
2700 requiredXpathInQuery:
2701 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
2704 value: /shops/bookstore
2705 list attributes xpath:
2706 value: "/shops/bookstore/categories[@code=1]"
2712 targetAnchorNameInQuery:
2713 description: target-anchor-name
2715 name: target-anchor-name
2721 description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
2725 list attributes cps path:
2726 value: "//categories[@code=1]"
2734 description: page index for pagination over anchors. It must be greater then
2743 description: number of records (anchors) per page. It must be greater then zero
2756 example: my-resource
2758 description: Created
2764 message: Bad Request
2765 details: The provided request is not valid
2767 $ref: '#/components/schemas/ErrorMessage'
2768 description: Bad Request
2774 message: Unauthorized request
2775 details: This request is unauthorized
2777 $ref: '#/components/schemas/ErrorMessage'
2778 description: Unauthorized
2784 message: Request Forbidden
2785 details: This request is forbidden
2787 $ref: '#/components/schemas/ErrorMessage'
2788 description: Forbidden
2794 message: Conflicting request
2795 details: The request cannot be processed as the resource is in use.
2797 $ref: '#/components/schemas/ErrorMessage'
2798 description: Conflict
2799 InternalServerError:
2804 message: Internal Server Error
2805 details: Internal Server Error occurred
2807 $ref: '#/components/schemas/ErrorMessage'
2808 description: Internal Server Error
2811 description: No Content
2813 description: Created without response body
2839 example: my-dataspace
2841 title: Dataspace details by dataspace Name
2845 schemaSetName: my-schema-set
2846 dataspaceName: my-dataspace
2853 example: my-dataspace
2856 example: my-schema-set
2858 title: Anchor details by anchor Name
2863 description: multipartFile
2871 dataspaceName: my-dataspace
2874 - name: my-module-reference-name
2875 namespace: my-module-reference-namespace
2876 revision: my-module-reference-revision
2877 - name: my-module-reference-name
2878 namespace: my-module-reference-namespace
2879 revision: my-module-reference-revision
2882 example: my-dataspace
2886 $ref: '#/components/schemas/ModuleReferences'
2889 example: my-schema-set
2893 title: Schema set details by dataspace and schemasetName
2897 name: my-module-reference-name
2898 namespace: my-module-reference-namespace
2899 revision: my-module-reference-revision
2902 example: my-module-reference-name
2905 example: my-module-reference-namespace
2908 example: my-module-reference-revision
2910 title: Module reference object