3 title: ONAP Open API v3 Configuration Persistence Service
4 description: Configuration Persistence Service is a Model Driven Generic Database
7 url: https://onap.readthedocs.io
8 email: onap-discuss@lists.onap.org
11 url: http://www.apache.org/licenses/LICENSE-2.0
13 x-planned-retirement-date: "202212"
21 description: cps Admin
29 summary: Create a dataspace
30 description: Create a new dataspace
31 operationId: createDataspace
33 - name: dataspace-name
35 description: dataspace-name
49 description: Bad Request
53 $ref: '#/components/schemas/ErrorMessage'
57 details: The provided request is not valid
59 description: Unauthorized
63 $ref: '#/components/schemas/ErrorMessage'
66 message: Unauthorized request
67 details: This request is unauthorized
69 description: Forbidden
73 $ref: '#/components/schemas/ErrorMessage'
76 message: Request Forbidden
77 details: This request is forbidden
83 $ref: '#/components/schemas/ErrorMessage'
86 message: Conflicting request
87 details: The request cannot be processed as the resource is in use.
89 description: Internal Server Error
93 $ref: '#/components/schemas/ErrorMessage'
96 message: Internal Server Error
97 details: Internal Server Error occurred
101 summary: Delete a dataspace
102 description: Delete a dataspace
103 operationId: deleteDataspace
105 - name: dataspace-name
107 description: dataspace-name
111 example: my-dataspace
114 description: No Content
117 description: Bad Request
121 $ref: '#/components/schemas/ErrorMessage'
125 details: The provided request is not valid
127 description: Unauthorized
131 $ref: '#/components/schemas/ErrorMessage'
134 message: Unauthorized request
135 details: This request is unauthorized
137 description: Forbidden
141 $ref: '#/components/schemas/ErrorMessage'
144 message: Request Forbidden
145 details: This request is forbidden
147 description: Conflict
151 $ref: '#/components/schemas/ErrorMessage'
154 message: Conflicting request
155 details: The request cannot be processed as the resource is in use.
157 description: Internal Server Error
161 $ref: '#/components/schemas/ErrorMessage'
164 message: Internal Server Error
165 details: Internal Server Error occurred
166 /v1/admin/dataspaces:
170 summary: Get dataspaces
171 description: "Read all dataspaces"
172 operationId: getAllDataspaces
181 $ref: '#/components/schemas/DataspaceDetails'
183 description: Bad Request
187 $ref: '#/components/schemas/ErrorMessage'
191 details: The provided request is not valid
193 description: Unauthorized
197 $ref: '#/components/schemas/ErrorMessage'
200 message: Unauthorized request
201 details: This request is unauthorized
203 description: Forbidden
207 $ref: '#/components/schemas/ErrorMessage'
210 message: Request Forbidden
211 details: This request is forbidden
213 description: Internal Server Error
217 $ref: '#/components/schemas/ErrorMessage'
220 message: Internal Server Error
221 details: Internal Server Error occurred
222 /v1/admin/dataspaces/{dataspace-name}:
226 summary: Get a dataspace
227 description: Read an dataspace given a dataspace name
228 operationId: getDataspace
230 - name: dataspace-name
232 description: dataspace-name
236 example: my-dataspace
243 $ref: '#/components/schemas/DataspaceDetails'
245 description: Bad Request
249 $ref: '#/components/schemas/ErrorMessage'
253 details: The provided request is not valid
255 description: Unauthorized
259 $ref: '#/components/schemas/ErrorMessage'
262 message: Unauthorized request
263 details: This request is unauthorized
265 description: Forbidden
269 $ref: '#/components/schemas/ErrorMessage'
272 message: Request Forbidden
273 details: This request is forbidden
275 description: Internal Server Error
279 $ref: '#/components/schemas/ErrorMessage'
282 message: Internal Server Error
283 details: Internal Server Error occurred
284 /v1/dataspaces/{dataspace-name}/anchors:
289 description: "Read all anchors, given a dataspace"
290 operationId: getAnchors
292 - name: dataspace-name
294 description: dataspace-name
298 example: my-dataspace
307 $ref: '#/components/schemas/AnchorDetails'
309 description: Bad Request
313 $ref: '#/components/schemas/ErrorMessage'
317 details: The provided request is not valid
319 description: Unauthorized
323 $ref: '#/components/schemas/ErrorMessage'
326 message: Unauthorized request
327 details: This request is unauthorized
329 description: Forbidden
333 $ref: '#/components/schemas/ErrorMessage'
336 message: Request Forbidden
337 details: This request is forbidden
339 description: Internal Server Error
343 $ref: '#/components/schemas/ErrorMessage'
346 message: Internal Server Error
347 details: Internal Server Error occurred
351 summary: Create an anchor
352 description: Create a new anchor in the given dataspace
353 operationId: createAnchor
355 - name: dataspace-name
357 description: dataspace-name
361 example: my-dataspace
362 - name: schema-set-name
364 description: schema-set-name
368 example: my-schema-set
371 description: anchor-name
385 description: Bad Request
389 $ref: '#/components/schemas/ErrorMessage'
393 details: The provided request is not valid
395 description: Unauthorized
399 $ref: '#/components/schemas/ErrorMessage'
402 message: Unauthorized request
403 details: This request is unauthorized
405 description: Forbidden
409 $ref: '#/components/schemas/ErrorMessage'
412 message: Request Forbidden
413 details: This request is forbidden
415 description: Conflict
419 $ref: '#/components/schemas/ErrorMessage'
422 message: Conflicting request
423 details: The request cannot be processed as the resource is in use.
425 description: Internal Server Error
429 $ref: '#/components/schemas/ErrorMessage'
432 message: Internal Server Error
433 details: Internal Server Error occurred
434 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}:
438 summary: Get an anchor
439 description: Read an anchor given an anchor name and a dataspace
440 operationId: getAnchor
442 - name: dataspace-name
444 description: dataspace-name
448 example: my-dataspace
451 description: anchor-name
462 $ref: '#/components/schemas/AnchorDetails'
464 description: Bad Request
468 $ref: '#/components/schemas/ErrorMessage'
472 details: The provided request is not valid
474 description: Unauthorized
478 $ref: '#/components/schemas/ErrorMessage'
481 message: Unauthorized request
482 details: This request is unauthorized
484 description: Forbidden
488 $ref: '#/components/schemas/ErrorMessage'
491 message: Request Forbidden
492 details: This request is forbidden
494 description: Internal Server Error
498 $ref: '#/components/schemas/ErrorMessage'
501 message: Internal Server Error
502 details: Internal Server Error occurred
506 summary: Delete an anchor
507 description: Delete an anchor given an anchor name and a dataspace
508 operationId: deleteAnchor
510 - name: dataspace-name
512 description: dataspace-name
516 example: my-dataspace
519 description: anchor-name
526 description: No Content
529 description: Bad Request
533 $ref: '#/components/schemas/ErrorMessage'
537 details: The provided request is not valid
539 description: Unauthorized
543 $ref: '#/components/schemas/ErrorMessage'
546 message: Unauthorized request
547 details: This request is unauthorized
549 description: Forbidden
553 $ref: '#/components/schemas/ErrorMessage'
556 message: Request Forbidden
557 details: This request is forbidden
559 description: Internal Server Error
563 $ref: '#/components/schemas/ErrorMessage'
566 message: Internal Server Error
567 details: Internal Server Error occurred
568 /v1/dataspaces/{dataspace-name}/schema-sets:
572 summary: Create a schema set
573 description: Create a new schema set in the given dataspace
574 operationId: createSchemaSet
576 - name: dataspace-name
578 description: dataspace-name
582 example: my-dataspace
583 - name: schema-set-name
585 description: schema-set-name
589 example: my-schema-set
594 $ref: '#/components/schemas/MultipartFile'
605 description: Bad Request
609 $ref: '#/components/schemas/ErrorMessage'
613 details: The provided request is not valid
615 description: Unauthorized
619 $ref: '#/components/schemas/ErrorMessage'
622 message: Unauthorized request
623 details: This request is unauthorized
625 description: Forbidden
629 $ref: '#/components/schemas/ErrorMessage'
632 message: Request Forbidden
633 details: This request is forbidden
635 description: Conflict
639 $ref: '#/components/schemas/ErrorMessage'
642 message: Conflicting request
643 details: The request cannot be processed as the resource is in use.
645 description: Internal Server Error
649 $ref: '#/components/schemas/ErrorMessage'
652 message: Internal Server Error
653 details: Internal Server Error occurred
654 /v1/dataspaces/{dataspace-name}/schema-sets/{schema-set-name}:
658 summary: Get a schema set
659 description: Read a schema set given a schema set name and a dataspace
660 operationId: getSchemaSet
662 - name: dataspace-name
664 description: dataspace-name
668 example: my-dataspace
669 - name: schema-set-name
671 description: schema-set-name
675 example: my-schema-set
682 $ref: '#/components/schemas/SchemaSetDetails'
684 description: Bad Request
688 $ref: '#/components/schemas/ErrorMessage'
692 details: The provided request is not valid
694 description: Unauthorized
698 $ref: '#/components/schemas/ErrorMessage'
701 message: Unauthorized request
702 details: This request is unauthorized
704 description: Forbidden
708 $ref: '#/components/schemas/ErrorMessage'
711 message: Request Forbidden
712 details: This request is forbidden
714 description: Internal Server Error
718 $ref: '#/components/schemas/ErrorMessage'
721 message: Internal Server Error
722 details: Internal Server Error occurred
726 summary: Delete a schema set
727 description: Delete a schema set given a schema set name and a dataspace
728 operationId: deleteSchemaSet
730 - name: dataspace-name
732 description: dataspace-name
736 example: my-dataspace
737 - name: schema-set-name
739 description: schema-set-name
743 example: my-schema-set
746 description: No Content
749 description: Bad Request
753 $ref: '#/components/schemas/ErrorMessage'
757 details: The provided request is not valid
759 description: Unauthorized
763 $ref: '#/components/schemas/ErrorMessage'
766 message: Unauthorized request
767 details: This request is unauthorized
769 description: Forbidden
773 $ref: '#/components/schemas/ErrorMessage'
776 message: Request Forbidden
777 details: This request is forbidden
779 description: Conflict
783 $ref: '#/components/schemas/ErrorMessage'
786 message: Conflicting request
787 details: The request cannot be processed as the resource is in use.
789 description: Internal Server Error
793 $ref: '#/components/schemas/ErrorMessage'
796 message: Internal Server Error
797 details: Internal Server Error occurred
798 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
803 description: Get a node with an option to retrieve all the children for a given
805 operationId: getNodeByDataspaceAndAnchor
807 - name: dataspace-name
809 description: dataspace-name
813 example: my-dataspace
816 description: anchor-name
823 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
830 value: /shops/bookstore
831 list attributes xpath:
832 value: "/shops/bookstore/categories[@code=1]"
833 - name: include-descendants
835 description: include-descendants
850 $ref: '#/components/examples/dataSample'
852 description: Bad Request
856 $ref: '#/components/schemas/ErrorMessage'
860 details: The provided request is not valid
862 description: Unauthorized
866 $ref: '#/components/schemas/ErrorMessage'
869 message: Unauthorized request
870 details: This request is unauthorized
872 description: Forbidden
876 $ref: '#/components/schemas/ErrorMessage'
879 message: Request Forbidden
880 details: This request is forbidden
882 description: Internal Server Error
886 $ref: '#/components/schemas/ErrorMessage'
889 message: Internal Server Error
890 details: Internal Server Error occurred
891 x-codegen-request-body-name: xpath
892 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes:
896 summary: Replace a node with descendants
897 description: "Replace a node with descendants for a given dataspace, anchor\
898 \ and a parent node xpath"
899 operationId: replaceNode
901 - name: dataspace-name
903 description: dataspace-name
907 example: my-dataspace
910 description: anchor-name
917 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
924 value: /shops/bookstore
925 list attributes xpath:
926 value: "/shops/bookstore/categories[@code=1]"
927 - name: observed-timestamp
929 description: observed-timestamp
933 example: 2021-03-21T00:10:34.030-0100
941 $ref: '#/components/examples/dataSample'
954 description: Bad Request
958 $ref: '#/components/schemas/ErrorMessage'
962 details: The provided request is not valid
964 description: Unauthorized
968 $ref: '#/components/schemas/ErrorMessage'
971 message: Unauthorized request
972 details: This request is unauthorized
974 description: Forbidden
978 $ref: '#/components/schemas/ErrorMessage'
981 message: Request Forbidden
982 details: This request is forbidden
984 description: Internal Server Error
988 $ref: '#/components/schemas/ErrorMessage'
991 message: Internal Server Error
992 details: Internal Server Error occurred
996 summary: Create a node
997 description: Create a node for a given anchor and dataspace
998 operationId: createNode
1000 - name: dataspace-name
1002 description: dataspace-name
1006 example: my-dataspace
1009 description: anchor-name
1016 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1023 value: /shops/bookstore
1024 list attributes xpath:
1025 value: "/shops/bookstore/categories[@code=1]"
1026 - name: observed-timestamp
1028 description: observed-timestamp
1032 example: 2021-03-21T00:10:34.030-0100
1040 $ref: '#/components/examples/dataSample'
1044 description: Created
1049 example: my-resource
1051 description: Bad Request
1055 $ref: '#/components/schemas/ErrorMessage'
1058 message: Bad Request
1059 details: The provided request is not valid
1061 description: Unauthorized
1065 $ref: '#/components/schemas/ErrorMessage'
1068 message: Unauthorized request
1069 details: This request is unauthorized
1071 description: Forbidden
1075 $ref: '#/components/schemas/ErrorMessage'
1078 message: Request Forbidden
1079 details: This request is forbidden
1081 description: Conflict
1085 $ref: '#/components/schemas/ErrorMessage'
1088 message: Conflicting request
1089 details: The request cannot be processed as the resource is in use.
1091 description: Internal Server Error
1095 $ref: '#/components/schemas/ErrorMessage'
1098 message: Internal Server Error
1099 details: Internal Server Error occurred
1103 summary: Delete a data node
1104 description: Delete a datanode for a given dataspace and anchor given a node
1106 operationId: deleteDataNode
1108 - name: dataspace-name
1110 description: dataspace-name
1114 example: my-dataspace
1117 description: anchor-name
1124 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1131 value: /shops/bookstore
1132 list attributes xpath:
1133 value: "/shops/bookstore/categories[@code=1]"
1134 - name: observed-timestamp
1136 description: observed-timestamp
1140 example: 2021-03-21T00:10:34.030-0100
1143 description: No Content
1146 description: Bad Request
1150 $ref: '#/components/schemas/ErrorMessage'
1153 message: Bad Request
1154 details: The provided request is not valid
1156 description: Unauthorized
1160 $ref: '#/components/schemas/ErrorMessage'
1163 message: Unauthorized request
1164 details: This request is unauthorized
1166 description: Forbidden
1170 $ref: '#/components/schemas/ErrorMessage'
1173 message: Request Forbidden
1174 details: This request is forbidden
1176 description: Internal Server Error
1180 $ref: '#/components/schemas/ErrorMessage'
1183 message: Internal Server Error
1184 details: Internal Server Error occurred
1188 summary: Update node leaves
1189 description: Update a data node leaves for a given dataspace and anchor and
1191 operationId: updateNodeLeaves
1193 - name: dataspace-name
1195 description: dataspace-name
1199 example: my-dataspace
1202 description: anchor-name
1209 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1216 value: /shops/bookstore
1217 list attributes xpath:
1218 value: "/shops/bookstore/categories[@code=1]"
1219 - name: observed-timestamp
1221 description: observed-timestamp
1225 example: 2021-03-21T00:10:34.030-0100
1233 $ref: '#/components/examples/dataSample'
1246 description: Bad Request
1250 $ref: '#/components/schemas/ErrorMessage'
1253 message: Bad Request
1254 details: The provided request is not valid
1256 description: Unauthorized
1260 $ref: '#/components/schemas/ErrorMessage'
1263 message: Unauthorized request
1264 details: This request is unauthorized
1266 description: Forbidden
1270 $ref: '#/components/schemas/ErrorMessage'
1273 message: Request Forbidden
1274 details: This request is forbidden
1276 description: Internal Server Error
1280 $ref: '#/components/schemas/ErrorMessage'
1283 message: Internal Server Error
1284 details: Internal Server Error occurred
1285 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes:
1289 summary: Replace list content
1290 description: "Replace list content under a given parent, anchor and dataspace"
1291 operationId: replaceListContent
1293 - name: dataspace-name
1295 description: dataspace-name
1299 example: my-dataspace
1302 description: anchor-name
1309 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1315 value: /shops/bookstore
1316 list attributes xpath:
1317 value: "/shops/bookstore/categories[@code=1]"
1318 - name: observed-timestamp
1320 description: observed-timestamp
1324 example: 2021-03-21T00:10:34.030-0100
1332 $ref: '#/components/examples/dataSample'
1345 description: Bad Request
1349 $ref: '#/components/schemas/ErrorMessage'
1352 message: Bad Request
1353 details: The provided request is not valid
1355 description: Unauthorized
1359 $ref: '#/components/schemas/ErrorMessage'
1362 message: Unauthorized request
1363 details: This request is unauthorized
1365 description: Forbidden
1369 $ref: '#/components/schemas/ErrorMessage'
1372 message: Request Forbidden
1373 details: This request is forbidden
1375 description: Internal Server Error
1379 $ref: '#/components/schemas/ErrorMessage'
1382 message: Internal Server Error
1383 details: Internal Server Error occurred
1387 summary: Add list element(s)
1388 description: Add list element(s) to a list for a given anchor and dataspace
1389 operationId: addListElements
1391 - name: dataspace-name
1393 description: dataspace-name
1397 example: my-dataspace
1400 description: anchor-name
1407 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1413 value: /shops/bookstore
1414 list attributes xpath:
1415 value: "/shops/bookstore/categories[@code=1]"
1416 - name: observed-timestamp
1418 description: observed-timestamp
1422 example: 2021-03-21T00:10:34.030-0100
1430 $ref: '#/components/examples/dataSample'
1434 description: Created
1439 example: my-resource
1441 description: Bad Request
1445 $ref: '#/components/schemas/ErrorMessage'
1448 message: Bad Request
1449 details: The provided request is not valid
1451 description: Unauthorized
1455 $ref: '#/components/schemas/ErrorMessage'
1458 message: Unauthorized request
1459 details: This request is unauthorized
1461 description: Forbidden
1465 $ref: '#/components/schemas/ErrorMessage'
1468 message: Request Forbidden
1469 details: This request is forbidden
1471 description: Internal Server Error
1475 $ref: '#/components/schemas/ErrorMessage'
1478 message: Internal Server Error
1479 details: Internal Server Error occurred
1483 summary: Delete one or all list element(s)
1484 description: Delete one or all list element(s) for a given anchor and dataspace
1485 operationId: deleteListOrListElement
1487 - name: dataspace-name
1489 description: dataspace-name
1493 example: my-dataspace
1496 description: anchor-name
1503 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1509 value: /shops/bookstore
1510 list attributes xpath:
1511 value: "/shops/bookstore/categories[@code=1]"
1512 - name: observed-timestamp
1514 description: observed-timestamp
1518 example: 2021-03-21T00:10:34.030-0100
1521 description: No Content
1524 description: Bad Request
1528 $ref: '#/components/schemas/ErrorMessage'
1531 message: Bad Request
1532 details: The provided request is not valid
1534 description: Unauthorized
1538 $ref: '#/components/schemas/ErrorMessage'
1541 message: Unauthorized request
1542 details: This request is unauthorized
1544 description: Forbidden
1548 $ref: '#/components/schemas/ErrorMessage'
1551 message: Request Forbidden
1552 details: This request is forbidden
1554 description: Internal Server Error
1558 $ref: '#/components/schemas/ErrorMessage'
1561 message: Internal Server Error
1562 details: Internal Server Error occurred
1564 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
1568 summary: Query data nodes
1569 description: Query data nodes for the given dataspace and anchor using CPS path
1570 operationId: getNodesByDataspaceAndAnchorAndCpsPath
1572 - name: dataspace-name
1574 description: dataspace-name
1578 example: my-dataspace
1581 description: anchor-name
1588 description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1596 list attributes cps path:
1597 value: "//categories[@code=1]"
1598 - name: include-descendants
1600 description: include-descendants
1615 $ref: '#/components/examples/dataSample'
1617 description: Bad Request
1621 $ref: '#/components/schemas/ErrorMessage'
1624 message: Bad Request
1625 details: The provided request is not valid
1627 description: Unauthorized
1631 $ref: '#/components/schemas/ErrorMessage'
1634 message: Unauthorized request
1635 details: This request is unauthorized
1637 description: Forbidden
1641 $ref: '#/components/schemas/ErrorMessage'
1644 message: Request Forbidden
1645 details: This request is forbidden
1647 description: Internal Server Error
1651 $ref: '#/components/schemas/ErrorMessage'
1654 message: Internal Server Error
1655 details: Internal Server Error occurred
1656 x-codegen-request-body-name: xpath
1674 title: Anchor details by anchor Name
1682 example: my-dataspace
1685 example: my-schema-set
1687 title: Dataspace details by dataspace Name
1692 example: my-dataspace
1700 description: multipartFile
1703 title: Schema set details by dataspace and schemasetName
1710 example: my-dataspace
1714 $ref: '#/components/schemas/ModuleReferences'
1717 example: my-schema-set
1719 title: Module reference object
1724 example: my-module-reference-name
1727 example: my-module-reference-namespace
1730 example: my-module-reference-revision
1735 bookstore-name: Chapters