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"
23 description: cps Admin
31 summary: Create a dataspace
32 description: Create a new dataspace
33 operationId: createDataspace
35 - name: dataspace-name
37 description: dataspace-name
51 description: Bad Request
55 $ref: '#/components/schemas/ErrorMessage'
59 details: The provided request is not valid
61 description: Unauthorized
65 $ref: '#/components/schemas/ErrorMessage'
68 message: Unauthorized request
69 details: This request is unauthorized
71 description: Forbidden
75 $ref: '#/components/schemas/ErrorMessage'
78 message: Request Forbidden
79 details: This request is forbidden
85 $ref: '#/components/schemas/ErrorMessage'
88 message: Conflicting request
89 details: The request cannot be processed as the resource is in use.
91 description: Internal Server Error
95 $ref: '#/components/schemas/ErrorMessage'
98 message: Internal Server Error
99 details: Internal Server Error occurred
101 /{apiVersion}/dataspaces:
105 summary: Delete a dataspace
106 description: Delete a dataspace
107 operationId: deleteDataspace
111 description: apiVersion
119 - name: dataspace-name
121 description: dataspace-name
125 example: my-dataspace
128 description: No Content
131 description: Bad Request
135 $ref: '#/components/schemas/ErrorMessage'
139 details: The provided request is not valid
141 description: Unauthorized
145 $ref: '#/components/schemas/ErrorMessage'
148 message: Unauthorized request
149 details: This request is unauthorized
151 description: Forbidden
155 $ref: '#/components/schemas/ErrorMessage'
158 message: Request Forbidden
159 details: This request is forbidden
161 description: Conflict
165 $ref: '#/components/schemas/ErrorMessage'
168 message: Conflicting request
169 details: The request cannot be processed as the resource is in use.
171 description: Internal Server Error
175 $ref: '#/components/schemas/ErrorMessage'
178 message: Internal Server Error
179 details: Internal Server Error occurred
184 summary: Create a dataspace
185 description: Create a new dataspace
186 operationId: createDataspaceV2
188 - name: dataspace-name
190 description: dataspace-name
194 example: my-dataspace
197 description: Created without response body
199 description: Bad Request
203 $ref: '#/components/schemas/ErrorMessage'
207 details: The provided request is not valid
209 description: Unauthorized
213 $ref: '#/components/schemas/ErrorMessage'
216 message: Unauthorized request
217 details: This request is unauthorized
219 description: Forbidden
223 $ref: '#/components/schemas/ErrorMessage'
226 message: Request Forbidden
227 details: This request is forbidden
229 description: Conflict
233 $ref: '#/components/schemas/ErrorMessage'
236 message: Conflicting request
237 details: The request cannot be processed as the resource is in use.
239 description: Internal Server Error
243 $ref: '#/components/schemas/ErrorMessage'
246 message: Internal Server Error
247 details: Internal Server Error occurred
248 /{apiVersion}/admin/dataspaces:
252 summary: Get all dataspaces
253 description: Read all dataspaces
254 operationId: getAllDataspaces
258 description: apiVersion
274 $ref: '#/components/schemas/DataspaceDetails'
276 description: Bad Request
280 $ref: '#/components/schemas/ErrorMessage'
284 details: The provided request is not valid
286 description: Unauthorized
290 $ref: '#/components/schemas/ErrorMessage'
293 message: Unauthorized request
294 details: This request is unauthorized
296 description: Forbidden
300 $ref: '#/components/schemas/ErrorMessage'
303 message: Request Forbidden
304 details: This request is forbidden
306 description: Internal Server Error
310 $ref: '#/components/schemas/ErrorMessage'
313 message: Internal Server Error
314 details: Internal Server Error occurred
315 /{apiVersion}/admin/dataspaces/{dataspace-name}:
319 summary: Get a dataspace
320 description: Read a dataspace given a dataspace name
321 operationId: getDataspace
325 description: apiVersion
333 - name: dataspace-name
335 description: dataspace-name
339 example: my-dataspace
346 $ref: '#/components/schemas/DataspaceDetails'
348 description: Bad Request
352 $ref: '#/components/schemas/ErrorMessage'
356 details: The provided request is not valid
358 description: Unauthorized
362 $ref: '#/components/schemas/ErrorMessage'
365 message: Unauthorized request
366 details: This request is unauthorized
368 description: Forbidden
372 $ref: '#/components/schemas/ErrorMessage'
375 message: Request Forbidden
376 details: This request is forbidden
378 description: Internal Server Error
382 $ref: '#/components/schemas/ErrorMessage'
385 message: Internal Server Error
386 details: Internal Server Error occurred
387 /v1/dataspaces/{dataspace-name}/anchors:
391 summary: Create an anchor
392 description: Create a new anchor in the given dataspace
393 operationId: createAnchor
395 - name: dataspace-name
397 description: dataspace-name
401 example: my-dataspace
402 - name: schema-set-name
404 description: schema-set-name
408 example: my-schema-set
411 description: anchor-name
425 description: Bad Request
429 $ref: '#/components/schemas/ErrorMessage'
433 details: The provided request is not valid
435 description: Unauthorized
439 $ref: '#/components/schemas/ErrorMessage'
442 message: Unauthorized request
443 details: This request is unauthorized
445 description: Forbidden
449 $ref: '#/components/schemas/ErrorMessage'
452 message: Request Forbidden
453 details: This request is forbidden
455 description: Conflict
459 $ref: '#/components/schemas/ErrorMessage'
462 message: Conflicting request
463 details: The request cannot be processed as the resource is in use.
465 description: Internal Server Error
469 $ref: '#/components/schemas/ErrorMessage'
472 message: Internal Server Error
473 details: Internal Server Error occurred
475 /v2/dataspaces/{dataspace-name}/anchors:
479 summary: Create an anchor
480 description: Create a new anchor in the given dataspace
481 operationId: createAnchorV2
483 - name: dataspace-name
485 description: dataspace-name
489 example: my-dataspace
490 - name: schema-set-name
492 description: schema-set-name
496 example: my-schema-set
499 description: anchor-name
506 description: Created without response body
508 description: Bad Request
512 $ref: '#/components/schemas/ErrorMessage'
516 details: The provided request is not valid
518 description: Unauthorized
522 $ref: '#/components/schemas/ErrorMessage'
525 message: Unauthorized request
526 details: This request is unauthorized
528 description: Forbidden
532 $ref: '#/components/schemas/ErrorMessage'
535 message: Request Forbidden
536 details: This request is forbidden
538 description: Conflict
542 $ref: '#/components/schemas/ErrorMessage'
545 message: Conflicting request
546 details: The request cannot be processed as the resource is in use.
548 description: Internal Server Error
552 $ref: '#/components/schemas/ErrorMessage'
555 message: Internal Server Error
556 details: Internal Server Error occurred
557 /{apiVersion}/dataspaces/{dataspace-name}/anchors:
562 description: "Read all anchors, given a dataspace"
563 operationId: getAnchors
567 description: apiVersion
575 - name: dataspace-name
577 description: dataspace-name
581 example: my-dataspace
590 $ref: '#/components/schemas/AnchorDetails'
592 description: Bad Request
596 $ref: '#/components/schemas/ErrorMessage'
600 details: The provided request is not valid
602 description: Unauthorized
606 $ref: '#/components/schemas/ErrorMessage'
609 message: Unauthorized request
610 details: This request is unauthorized
612 description: Forbidden
616 $ref: '#/components/schemas/ErrorMessage'
619 message: Request Forbidden
620 details: This request is forbidden
622 description: Internal Server Error
626 $ref: '#/components/schemas/ErrorMessage'
629 message: Internal Server Error
630 details: Internal Server Error occurred
631 /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}:
635 summary: Get an anchor
636 description: Read an anchor given an anchor name and a dataspace
637 operationId: getAnchor
641 description: apiVersion
649 - name: dataspace-name
651 description: dataspace-name
655 example: my-dataspace
658 description: anchor-name
669 $ref: '#/components/schemas/AnchorDetails'
671 description: Bad Request
675 $ref: '#/components/schemas/ErrorMessage'
679 details: The provided request is not valid
681 description: Unauthorized
685 $ref: '#/components/schemas/ErrorMessage'
688 message: Unauthorized request
689 details: This request is unauthorized
691 description: Forbidden
695 $ref: '#/components/schemas/ErrorMessage'
698 message: Request Forbidden
699 details: This request is forbidden
701 description: Internal Server Error
705 $ref: '#/components/schemas/ErrorMessage'
708 message: Internal Server Error
709 details: Internal Server Error occurred
713 summary: Delete an anchor
714 description: Delete an anchor given an anchor name and a dataspace
715 operationId: deleteAnchor
719 description: apiVersion
727 - name: dataspace-name
729 description: dataspace-name
733 example: my-dataspace
736 description: anchor-name
743 description: No Content
746 description: Bad Request
750 $ref: '#/components/schemas/ErrorMessage'
754 details: The provided request is not valid
756 description: Unauthorized
760 $ref: '#/components/schemas/ErrorMessage'
763 message: Unauthorized request
764 details: This request is unauthorized
766 description: Forbidden
770 $ref: '#/components/schemas/ErrorMessage'
773 message: Request Forbidden
774 details: This request is forbidden
776 description: Internal Server Error
780 $ref: '#/components/schemas/ErrorMessage'
783 message: Internal Server Error
784 details: Internal Server Error occurred
785 /v1/dataspaces/{dataspace-name}/schema-sets:
789 summary: Create a schema set
790 description: Create a new schema set in the given dataspace
791 operationId: createSchemaSet
793 - name: dataspace-name
795 description: dataspace-name
799 example: my-dataspace
800 - name: schema-set-name
802 description: schema-set-name
806 example: my-schema-set
811 $ref: '#/components/schemas/MultipartFile'
822 description: Bad Request
826 $ref: '#/components/schemas/ErrorMessage'
830 details: The provided request is not valid
832 description: Unauthorized
836 $ref: '#/components/schemas/ErrorMessage'
839 message: Unauthorized request
840 details: This request is unauthorized
842 description: Forbidden
846 $ref: '#/components/schemas/ErrorMessage'
849 message: Request Forbidden
850 details: This request is forbidden
852 description: Conflict
856 $ref: '#/components/schemas/ErrorMessage'
859 message: Conflicting request
860 details: The request cannot be processed as the resource is in use.
862 description: Internal Server Error
866 $ref: '#/components/schemas/ErrorMessage'
869 message: Internal Server Error
870 details: Internal Server Error occurred
872 /v2/dataspaces/{dataspace-name}/schema-sets:
876 summary: Create a schema set
877 description: Create a new schema set in the given dataspace
878 operationId: createSchemaSetV2
880 - name: dataspace-name
882 description: dataspace-name
886 example: my-dataspace
887 - name: schema-set-name
889 description: schema-set-name
893 example: my-schema-set
898 $ref: '#/components/schemas/MultipartFile'
902 description: Created without response body
904 description: Bad Request
908 $ref: '#/components/schemas/ErrorMessage'
912 details: The provided request is not valid
914 description: Unauthorized
918 $ref: '#/components/schemas/ErrorMessage'
921 message: Unauthorized request
922 details: This request is unauthorized
924 description: Forbidden
928 $ref: '#/components/schemas/ErrorMessage'
931 message: Request Forbidden
932 details: This request is forbidden
934 description: Conflict
938 $ref: '#/components/schemas/ErrorMessage'
941 message: Conflicting request
942 details: The request cannot be processed as the resource is in use.
944 description: Internal Server Error
948 $ref: '#/components/schemas/ErrorMessage'
951 message: Internal Server Error
952 details: Internal Server Error occurred
953 /{apiVersion}/dataspaces/{dataspace-name}/schema-sets:
957 summary: Get schema sets
958 description: "Read all schema sets, given a dataspace"
959 operationId: getSchemaSets
963 description: apiVersion
971 - name: dataspace-name
973 description: dataspace-name
977 example: my-dataspace
986 $ref: '#/components/schemas/SchemaSetDetails'
988 description: Bad Request
992 $ref: '#/components/schemas/ErrorMessage'
996 details: The provided request is not valid
998 description: Unauthorized
1002 $ref: '#/components/schemas/ErrorMessage'
1005 message: Unauthorized request
1006 details: This request is unauthorized
1008 description: Forbidden
1012 $ref: '#/components/schemas/ErrorMessage'
1015 message: Request Forbidden
1016 details: This request is forbidden
1018 description: Internal Server Error
1022 $ref: '#/components/schemas/ErrorMessage'
1025 message: Internal Server Error
1026 details: Internal Server Error occurred
1027 /{apiVersion}/dataspaces/{dataspace-name}/schema-sets/{schema-set-name}:
1031 summary: Get a schema set
1032 description: Read a schema set given a schema set name and a dataspace
1033 operationId: getSchemaSet
1037 description: apiVersion
1045 - name: dataspace-name
1047 description: dataspace-name
1051 example: my-dataspace
1052 - name: schema-set-name
1054 description: schema-set-name
1058 example: my-schema-set
1065 $ref: '#/components/schemas/SchemaSetDetails'
1067 description: Bad Request
1071 $ref: '#/components/schemas/ErrorMessage'
1074 message: Bad Request
1075 details: The provided request is not valid
1077 description: Unauthorized
1081 $ref: '#/components/schemas/ErrorMessage'
1084 message: Unauthorized request
1085 details: This request is unauthorized
1087 description: Forbidden
1091 $ref: '#/components/schemas/ErrorMessage'
1094 message: Request Forbidden
1095 details: This request is forbidden
1097 description: Internal Server Error
1101 $ref: '#/components/schemas/ErrorMessage'
1104 message: Internal Server Error
1105 details: Internal Server Error occurred
1109 summary: Delete a schema set
1110 description: Delete a schema set given a schema set name and a dataspace
1111 operationId: deleteSchemaSet
1115 description: apiVersion
1123 - name: dataspace-name
1125 description: dataspace-name
1129 example: my-dataspace
1130 - name: schema-set-name
1132 description: schema-set-name
1136 example: my-schema-set
1139 description: No Content
1142 description: Bad Request
1146 $ref: '#/components/schemas/ErrorMessage'
1149 message: Bad Request
1150 details: The provided request is not valid
1152 description: Unauthorized
1156 $ref: '#/components/schemas/ErrorMessage'
1159 message: Unauthorized request
1160 details: This request is unauthorized
1162 description: Forbidden
1166 $ref: '#/components/schemas/ErrorMessage'
1169 message: Request Forbidden
1170 details: This request is forbidden
1172 description: Conflict
1176 $ref: '#/components/schemas/ErrorMessage'
1179 message: Conflicting request
1180 details: The request cannot be processed as the resource is in use.
1182 description: Internal Server Error
1186 $ref: '#/components/schemas/ErrorMessage'
1189 message: Internal Server Error
1190 details: Internal Server Error occurred
1191 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
1196 description: Get a node with an option to retrieve all the children for a given
1197 anchor and dataspace
1198 operationId: getNodeByDataspaceAndAnchor
1200 - name: dataspace-name
1202 description: dataspace-name
1206 example: my-dataspace
1209 description: anchor-name
1216 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1223 value: /shops/bookstore
1224 list attributes xpath:
1225 value: "/shops/bookstore/categories[@code=1]"
1226 - name: include-descendants
1228 description: include-descendants
1243 $ref: '#/components/examples/dataSample'
1245 description: Bad Request
1249 $ref: '#/components/schemas/ErrorMessage'
1252 message: Bad Request
1253 details: The provided request is not valid
1255 description: Unauthorized
1259 $ref: '#/components/schemas/ErrorMessage'
1262 message: Unauthorized request
1263 details: This request is unauthorized
1265 description: Forbidden
1269 $ref: '#/components/schemas/ErrorMessage'
1272 message: Request Forbidden
1273 details: This request is forbidden
1275 description: Internal Server Error
1279 $ref: '#/components/schemas/ErrorMessage'
1282 message: Internal Server Error
1283 details: Internal Server Error occurred
1285 x-codegen-request-body-name: xpath
1286 /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
1291 description: Get a node with an option to retrieve all the children for a given
1292 anchor and dataspace
1293 operationId: getNodeByDataspaceAndAnchorV2
1295 - name: dataspace-name
1297 description: dataspace-name
1301 example: my-dataspace
1304 description: anchor-name
1311 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1318 value: /shops/bookstore
1319 list attributes xpath:
1320 value: "/shops/bookstore/categories[@code=1]"
1323 description: "Number of descendants to query. Allowed values are 'none', 'all',\
1324 \ -1 (for all), 0 (for none) and any positive number."
1339 $ref: '#/components/examples/dataSample'
1341 description: Bad Request
1345 $ref: '#/components/schemas/ErrorMessage'
1348 message: Bad Request
1349 details: The provided request is not valid
1351 description: Unauthorized
1355 $ref: '#/components/schemas/ErrorMessage'
1358 message: Unauthorized request
1359 details: This request is unauthorized
1361 description: Forbidden
1365 $ref: '#/components/schemas/ErrorMessage'
1368 message: Request Forbidden
1369 details: This request is forbidden
1371 description: Internal Server Error
1375 $ref: '#/components/schemas/ErrorMessage'
1378 message: Internal Server Error
1379 details: Internal Server Error occurred
1380 x-codegen-request-body-name: xpath
1381 /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes:
1385 summary: Replace a node with descendants
1386 description: "Replace a node with descendants for a given dataspace, anchor\
1387 \ and a parent node xpath"
1388 operationId: replaceNode
1392 description: apiVersion
1400 - name: dataspace-name
1402 description: dataspace-name
1406 example: my-dataspace
1409 description: anchor-name
1416 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1423 value: /shops/bookstore
1424 list attributes xpath:
1425 value: "/shops/bookstore/categories[@code=1]"
1426 - name: observed-timestamp
1428 description: observed-timestamp
1432 example: 2021-03-21T00:10:34.030-0100
1440 $ref: '#/components/examples/dataSample'
1453 description: Bad Request
1457 $ref: '#/components/schemas/ErrorMessage'
1460 message: Bad Request
1461 details: The provided request is not valid
1463 description: Unauthorized
1467 $ref: '#/components/schemas/ErrorMessage'
1470 message: Unauthorized request
1471 details: This request is unauthorized
1473 description: Forbidden
1477 $ref: '#/components/schemas/ErrorMessage'
1480 message: Request Forbidden
1481 details: This request is forbidden
1483 description: Internal Server Error
1487 $ref: '#/components/schemas/ErrorMessage'
1490 message: Internal Server Error
1491 details: Internal Server Error occurred
1495 summary: Create a node
1496 description: Create a node for a given anchor and dataspace
1497 operationId: createNode
1501 description: apiVersion
1509 - name: dataspace-name
1511 description: dataspace-name
1515 example: my-dataspace
1518 description: anchor-name
1525 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1532 value: /shops/bookstore
1533 list attributes xpath:
1534 value: "/shops/bookstore/categories[@code=1]"
1535 - name: observed-timestamp
1537 description: observed-timestamp
1541 example: 2021-03-21T00:10:34.030-0100
1542 - name: Content-Type
1544 description: Content type header
1548 example: application/json
1556 $ref: '#/components/examples/dataSample'
1564 $ref: '#/components/examples/dataSampleXml'
1568 description: Created
1573 example: my-resource
1575 description: Bad Request
1579 $ref: '#/components/schemas/ErrorMessage'
1582 message: Bad Request
1583 details: The provided request is not valid
1585 description: Unauthorized
1589 $ref: '#/components/schemas/ErrorMessage'
1592 message: Unauthorized request
1593 details: This request is unauthorized
1595 description: Forbidden
1599 $ref: '#/components/schemas/ErrorMessage'
1602 message: Request Forbidden
1603 details: This request is forbidden
1605 description: Conflict
1609 $ref: '#/components/schemas/ErrorMessage'
1612 message: Conflicting request
1613 details: The request cannot be processed as the resource is in use.
1615 description: Internal Server Error
1619 $ref: '#/components/schemas/ErrorMessage'
1622 message: Internal Server Error
1623 details: Internal Server Error occurred
1627 summary: Delete a data node
1628 description: Delete a datanode for a given dataspace and anchor given a node
1630 operationId: deleteDataNode
1634 description: apiVersion
1642 - name: dataspace-name
1644 description: dataspace-name
1648 example: my-dataspace
1651 description: anchor-name
1658 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1665 value: /shops/bookstore
1666 list attributes xpath:
1667 value: "/shops/bookstore/categories[@code=1]"
1668 - name: observed-timestamp
1670 description: observed-timestamp
1674 example: 2021-03-21T00:10:34.030-0100
1677 description: No Content
1680 description: Bad Request
1684 $ref: '#/components/schemas/ErrorMessage'
1687 message: Bad Request
1688 details: The provided request is not valid
1690 description: Unauthorized
1694 $ref: '#/components/schemas/ErrorMessage'
1697 message: Unauthorized request
1698 details: This request is unauthorized
1700 description: Forbidden
1704 $ref: '#/components/schemas/ErrorMessage'
1707 message: Request Forbidden
1708 details: This request is forbidden
1710 description: Internal Server Error
1714 $ref: '#/components/schemas/ErrorMessage'
1717 message: Internal Server Error
1718 details: Internal Server Error occurred
1722 summary: Update node leaves
1723 description: Update a data node leaves for a given dataspace and anchor and
1724 a parent node xpath. This operation is currently supported for one top level
1726 operationId: updateNodeLeaves
1730 description: apiVersion
1738 - name: dataspace-name
1740 description: dataspace-name
1744 example: my-dataspace
1747 description: anchor-name
1754 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1761 value: /shops/bookstore
1762 list attributes xpath:
1763 value: "/shops/bookstore/categories[@code=1]"
1764 - name: observed-timestamp
1766 description: observed-timestamp
1770 example: 2021-03-21T00:10:34.030-0100
1778 $ref: '#/components/examples/dataSample'
1791 description: Bad Request
1795 $ref: '#/components/schemas/ErrorMessage'
1798 message: Bad Request
1799 details: The provided request is not valid
1801 description: Unauthorized
1805 $ref: '#/components/schemas/ErrorMessage'
1808 message: Unauthorized request
1809 details: This request is unauthorized
1811 description: Forbidden
1815 $ref: '#/components/schemas/ErrorMessage'
1818 message: Request Forbidden
1819 details: This request is forbidden
1821 description: Internal Server Error
1825 $ref: '#/components/schemas/ErrorMessage'
1828 message: Internal Server Error
1829 details: Internal Server Error occurred
1830 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes:
1834 summary: Delete one or all list element(s)
1835 description: Delete one or all list element(s) for a given anchor and dataspace
1836 operationId: deleteListOrListElement
1838 - name: dataspace-name
1840 description: dataspace-name
1844 example: my-dataspace
1847 description: anchor-name
1854 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1860 value: /shops/bookstore
1861 list attributes xpath:
1862 value: "/shops/bookstore/categories[@code=1]"
1863 - name: observed-timestamp
1865 description: observed-timestamp
1869 example: 2021-03-21T00:10:34.030-0100
1872 description: No Content
1875 description: Bad Request
1879 $ref: '#/components/schemas/ErrorMessage'
1882 message: Bad Request
1883 details: The provided request is not valid
1885 description: Unauthorized
1889 $ref: '#/components/schemas/ErrorMessage'
1892 message: Unauthorized request
1893 details: This request is unauthorized
1895 description: Forbidden
1899 $ref: '#/components/schemas/ErrorMessage'
1902 message: Request Forbidden
1903 details: This request is forbidden
1905 description: Internal Server Error
1909 $ref: '#/components/schemas/ErrorMessage'
1912 message: Internal Server Error
1913 details: Internal Server Error occurred
1915 /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes:
1919 summary: Replace list content
1920 description: "Replace list content under a given parent, anchor and dataspace"
1921 operationId: replaceListContent
1925 description: apiVersion
1933 - name: dataspace-name
1935 description: dataspace-name
1939 example: my-dataspace
1942 description: anchor-name
1949 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1955 value: /shops/bookstore
1956 list attributes xpath:
1957 value: "/shops/bookstore/categories[@code=1]"
1958 - name: observed-timestamp
1960 description: observed-timestamp
1964 example: 2021-03-21T00:10:34.030-0100
1972 $ref: '#/components/examples/dataSample'
1985 description: Bad Request
1989 $ref: '#/components/schemas/ErrorMessage'
1992 message: Bad Request
1993 details: The provided request is not valid
1995 description: Unauthorized
1999 $ref: '#/components/schemas/ErrorMessage'
2002 message: Unauthorized request
2003 details: This request is unauthorized
2005 description: Forbidden
2009 $ref: '#/components/schemas/ErrorMessage'
2012 message: Request Forbidden
2013 details: This request is forbidden
2015 description: Internal Server Error
2019 $ref: '#/components/schemas/ErrorMessage'
2022 message: Internal Server Error
2023 details: Internal Server Error occurred
2027 summary: Add list element(s)
2028 description: Add list element(s) to a list for a given anchor and dataspace
2029 operationId: addListElements
2033 description: apiVersion
2041 - name: dataspace-name
2043 description: dataspace-name
2047 example: my-dataspace
2050 description: anchor-name
2057 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
2063 value: /shops/bookstore
2064 list attributes xpath:
2065 value: "/shops/bookstore/categories[@code=1]"
2066 - name: observed-timestamp
2068 description: observed-timestamp
2072 example: 2021-03-21T00:10:34.030-0100
2080 $ref: '#/components/examples/dataSample'
2084 description: Created
2089 example: my-resource
2091 description: Bad Request
2095 $ref: '#/components/schemas/ErrorMessage'
2098 message: Bad Request
2099 details: The provided request is not valid
2101 description: Unauthorized
2105 $ref: '#/components/schemas/ErrorMessage'
2108 message: Unauthorized request
2109 details: This request is unauthorized
2111 description: Forbidden
2115 $ref: '#/components/schemas/ErrorMessage'
2118 message: Request Forbidden
2119 details: This request is forbidden
2121 description: Internal Server Error
2125 $ref: '#/components/schemas/ErrorMessage'
2128 message: Internal Server Error
2129 details: Internal Server Error occurred
2130 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
2134 summary: Query data nodes
2135 description: Query data nodes for the given dataspace and anchor using CPS path
2136 operationId: getNodesByDataspaceAndAnchorAndCpsPath
2138 - name: dataspace-name
2140 description: dataspace-name
2144 example: my-dataspace
2147 description: anchor-name
2154 description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
2162 list attributes cps path:
2163 value: "//categories[@code=1]"
2164 - name: include-descendants
2166 description: include-descendants
2181 $ref: '#/components/examples/dataSample'
2183 description: Bad Request
2187 $ref: '#/components/schemas/ErrorMessage'
2190 message: Bad Request
2191 details: The provided request is not valid
2193 description: Unauthorized
2197 $ref: '#/components/schemas/ErrorMessage'
2200 message: Unauthorized request
2201 details: This request is unauthorized
2203 description: Forbidden
2207 $ref: '#/components/schemas/ErrorMessage'
2210 message: Request Forbidden
2211 details: This request is forbidden
2213 description: Internal Server Error
2217 $ref: '#/components/schemas/ErrorMessage'
2220 message: Internal Server Error
2221 details: Internal Server Error occurred
2223 x-codegen-request-body-name: xpath
2224 /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
2228 summary: Query data nodes
2229 description: Query data nodes for the given dataspace and anchor using CPS path
2230 operationId: getNodesByDataspaceAndAnchorAndCpsPathV2
2232 - name: dataspace-name
2234 description: dataspace-name
2238 example: my-dataspace
2241 description: anchor-name
2248 description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
2256 list attributes cps path:
2257 value: "//categories[@code=1]"
2260 description: "Number of descendants to query. Allowed values are 'none', 'all',\
2261 \ -1 (for all), 0 (for none) and any positive number."
2276 $ref: '#/components/examples/dataSample'
2278 description: Bad Request
2282 $ref: '#/components/schemas/ErrorMessage'
2285 message: Bad Request
2286 details: The provided request is not valid
2288 description: Unauthorized
2292 $ref: '#/components/schemas/ErrorMessage'
2295 message: Unauthorized request
2296 details: This request is unauthorized
2298 description: Forbidden
2302 $ref: '#/components/schemas/ErrorMessage'
2305 message: Request Forbidden
2306 details: This request is forbidden
2308 description: Internal Server Error
2312 $ref: '#/components/schemas/ErrorMessage'
2315 message: Internal Server Error
2316 details: Internal Server Error occurred
2317 x-codegen-request-body-name: xpath
2318 /v2/dataspaces/{dataspace-name}/nodes/query:
2322 summary: Query data nodes
2323 description: Query data nodes for the given dataspace across anchors using CPS
2325 operationId: getNodesByDataspaceAndCpsPath
2327 - name: dataspace-name
2329 description: dataspace-name
2333 example: my-dataspace
2336 description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
2344 list attributes cps path:
2345 value: "//categories[@code=1]"
2348 description: "Number of descendants to query. Allowed values are 'none', 'all',\
2349 \ -1 (for all), 0 (for none) and any positive number."
2364 $ref: '#/components/examples/dataSampleAcrossAnchors'
2366 description: Bad Request
2370 $ref: '#/components/schemas/ErrorMessage'
2373 message: Bad Request
2374 details: The provided request is not valid
2376 description: Unauthorized
2380 $ref: '#/components/schemas/ErrorMessage'
2383 message: Unauthorized request
2384 details: This request is unauthorized
2386 description: Forbidden
2390 $ref: '#/components/schemas/ErrorMessage'
2393 message: Request Forbidden
2394 details: This request is forbidden
2396 description: Internal Server Error
2400 $ref: '#/components/schemas/ErrorMessage'
2403 message: Internal Server Error
2404 details: Internal Server Error occurred
2405 x-codegen-request-body-name: xpath
2419 title: Dataspace details by dataspace Name
2424 example: my-dataspace
2426 title: Anchor details by anchor Name
2434 example: my-dataspace
2437 example: my-schema-set
2445 description: multipartFile
2448 title: Schema set details by dataspace and schemasetName
2455 example: my-dataspace
2459 $ref: '#/components/schemas/ModuleReferences'
2462 example: my-schema-set
2464 title: Module reference object
2469 example: my-module-reference-name
2472 example: my-module-reference-namespace
2475 example: my-module-reference-revision
2480 bookstore-name: Chapters
2487 value: <stores xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <bookstore xmlns="org:onap:ccsdk:sample">
2488 <bookstore-name>Chapters</bookstore-name> <categories> <code>1</code> <name>SciFi</name>
2489 </categories> </bookstore> </stores>
2490 dataSampleAcrossAnchors:
2492 - anchorName: bookstore1
2495 bookstore-name: Chapters
2501 - anchorName: bookstore2
2504 bookstore-name: Chapters