1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
25 *Host* : localhost:8080 *BasePath* : /sdc2/rest *Schemes* : HTTP
30 - Additional Information Servlet
34 - Catalog Types Upload
40 - Distribution Service Servlet
46 - Lifecycle Actions Servlet
50 - Resource Artifact Servlet
52 - Resource Attribute Servlet
54 - Resource Group Servlet
56 - Resource Instance Servlet
58 - Resource Property Servlet
62 - Resources Catalog Upload
73 return aggregate BE health check of Titan, ES and BE
74 ----------------------------------------------------
83 return BE health check
88 +---------+----------------------------------------------------+----------------+
89 | HTTP | Description | Schema |
91 +=========+====================================================+================+
92 | **200** | Titan, ES and BE are all up | No Content |
93 +---------+----------------------------------------------------+----------------+
94 | **500** | One or more BE components (Titan, ES, BE) are down | No Content |
95 +---------+----------------------------------------------------+----------------+
100 - ``application/json``
105 - ``application/json``
118 +------------------+--------------------------+----------------------------------+
119 | Type | Name | Schema |
120 +==================+==========================+==================================+
121 | **Body** | **body**\ *optional* | string |
122 +------------------+--------------------------+----------------------------------+
127 +---------+----------------------------------------------------+----------------+
128 | HTTP | Description | Schema |
130 +=========+====================================================+================+
131 | **defau | successful operation | No Content |
133 +---------+----------------------------------------------------+----------------+
138 - ``application/json``
143 - ``application/json``
150 Retrieve all artifactTypes
151 --------------------------
155 GET /v1/artifactTypes
160 Retrieve all artifactTypes
165 +------------------+--------------------------+----------------------------------+
166 | Type | Name | Schema |
167 +==================+==========================+==================================+
168 | **Header** | **USER\_ID**\ *optional* | string |
169 +------------------+--------------------------+----------------------------------+
174 +---------+----------------------------------------------------+----------------+
175 | HTTP | Description | Schema |
177 +=========+====================================================+================+
178 | **200** | Returns artifactTypes Ok | No Content |
179 +---------+----------------------------------------------------+----------------+
180 | **404** | No artifactTypes were found | No Content |
181 +---------+----------------------------------------------------+----------------+
182 | **500** | Internal Server Error | No Content |
183 +---------+----------------------------------------------------+----------------+
188 - ``application/json``
193 - ``application/json``
200 get component audit records
201 ---------------------------
205 GET /v1/catalog/audit-records/{componentType}/{componentUniqueId}
210 get audit records for a service or a resource
215 +------------------+--------------------------+----------------------------------+
216 | Type | Name | Schema |
217 +==================+==========================+==================================+
218 | **Header** | **USER\_ID**\ *optional* | string |
219 +------------------+--------------------------+----------------------------------+
220 | **Path** | **componentType**\ *requ | string |
222 +------------------+--------------------------+----------------------------------+
223 | **Path** | **componentUniqueId**\ * | string |
225 +------------------+--------------------------+----------------------------------+
230 +---------+----------------------------------------------------+----------------+
231 | HTTP | Description | Schema |
233 +=========+====================================================+================+
234 | **200** | Service found | No Content |
235 +---------+----------------------------------------------------+----------------+
236 | **403** | Restricted operation | No Content |
237 +---------+----------------------------------------------------+----------------+
242 - ``application/json``
247 - ``application/json``
259 GET /v1/catalog/dataTypes
269 +------------------+--------------------------+----------------------------------+
270 | Type | Name | Schema |
271 +==================+==========================+==================================+
272 | **Header** | **USER\_ID**\ *optional* | string |
273 +------------------+--------------------------+----------------------------------+
278 +---------+----------------------------------------------------+----------------+
279 | HTTP | Description | Schema |
281 +=========+====================================================+================+
282 | **200** | datatypes | No Content |
283 +---------+----------------------------------------------------+----------------+
284 | **400** | Invalid content / Missing content | No Content |
285 +---------+----------------------------------------------------+----------------+
286 | **403** | Restricted operation | No Content |
287 +---------+----------------------------------------------------+----------------+
288 | **404** | Data types not found | No Content |
289 +---------+----------------------------------------------------+----------------+
294 - ``application/json``
299 - ``application/json``
304 - Types Fetch Servlet
311 POST /v1/catalog/products
316 Returns created product
321 +----------+-------------+--------------------------------------+------------------+
322 | Type | Name | Description | Schema |
323 +==========+=============+======================================+==================+
324 | **Header | **USER\_ID* | USER\_ID of product strategist user | string |
325 | ** | *\ *require | | |
327 +----------+-------------+--------------------------------------+------------------+
328 | **Body** | **body**\ * | Product object to be created | string |
330 +----------+-------------+--------------------------------------+------------------+
335 +---------+----------------------------------------------------+----------------+
336 | HTTP | Description | Schema |
338 +=========+====================================================+================+
339 | **200** | successful operation | `Product <#_pr |
341 +---------+----------------------------------------------------+----------------+
342 | **201** | Product created | No Content |
343 +---------+----------------------------------------------------+----------------+
344 | **400** | Invalid/missing content | No Content |
345 +---------+----------------------------------------------------+----------------+
346 | **403** | Restricted operation / Empty USER\_ID header | No Content |
347 +---------+----------------------------------------------------+----------------+
348 | **409** | Product already exists / User not found / Wrong | No Content |
350 +---------+----------------------------------------------------+----------------+
355 - ``application/json``
360 - ``application/json``
372 GET /v1/catalog/products/productName/{productName}/productVersion/{productVersion}
377 Returns product according to name and version
382 +------------------+--------------------------+----------------------------------+
383 | Type | Name | Schema |
384 +==================+==========================+==================================+
385 | **Header** | **USER\_ID**\ *optional* | string |
386 +------------------+--------------------------+----------------------------------+
387 | **Path** | **productName**\ *requir | string |
389 +------------------+--------------------------+----------------------------------+
390 | **Path** | **productVersion**\ *req | string |
392 +------------------+--------------------------+----------------------------------+
397 +---------+----------------------------------------------------+----------------+
398 | HTTP | Description | Schema |
400 +=========+====================================================+================+
401 | **200** | Product found | No Content |
402 +---------+----------------------------------------------------+----------------+
403 | **403** | Restricted operation | No Content |
404 +---------+----------------------------------------------------+----------------+
405 | **404** | Product not found | No Content |
406 +---------+----------------------------------------------------+----------------+
411 - ``application/json``
416 - ``application/json``
423 validate product name
424 ---------------------
428 GET /v1/catalog/products/validate-name/{productName}
433 checks if the chosen product name is available
438 +------------------+--------------------------+----------------------------------+
439 | Type | Name | Schema |
440 +==================+==========================+==================================+
441 | **Header** | **USER\_ID**\ *optional* | string |
442 +------------------+--------------------------+----------------------------------+
443 | **Path** | **productName**\ *requir | string |
445 +------------------+--------------------------+----------------------------------+
450 +---------+----------------------------------------------------+----------------+
451 | HTTP | Description | Schema |
453 +=========+====================================================+================+
454 | **200** | Service found | No Content |
455 +---------+----------------------------------------------------+----------------+
456 | **403** | Restricted operation | No Content |
457 +---------+----------------------------------------------------+----------------+
462 - ``application/json``
467 - ``application/json``
479 GET /v1/catalog/products/{productId}
484 Returns product according to productId
489 +------------------+--------------------------+----------------------------------+
490 | Type | Name | Schema |
491 +==================+==========================+==================================+
492 | **Header** | **USER\_ID**\ *optional* | string |
493 +------------------+--------------------------+----------------------------------+
494 | **Path** | **productId**\ *required | string |
496 +------------------+--------------------------+----------------------------------+
501 +---------+----------------------------------------------------+----------------+
502 | HTTP | Description | Schema |
504 +=========+====================================================+================+
505 | **200** | Product found | No Content |
506 +---------+----------------------------------------------------+----------------+
507 | **403** | Missing information | No Content |
508 +---------+----------------------------------------------------+----------------+
509 | **404** | Product not found | No Content |
510 +---------+----------------------------------------------------+----------------+
511 | **409** | Restricted operation | No Content |
512 +---------+----------------------------------------------------+----------------+
513 | **500** | Internal Server Error | No Content |
514 +---------+----------------------------------------------------+----------------+
519 - ``application/json``
524 - ``application/json``
531 DELETE /v1/catalog/products/{productid}
532 ---------------------------------------
537 +------------------+--------------------------+----------------------------------+
538 | Type | Name | Schema |
539 +==================+==========================+==================================+
540 | **Path** | **productId**\ *required | string |
542 +------------------+--------------------------+----------------------------------+
547 +---------+----------------------------------------------------+----------------+
548 | HTTP | Description | Schema |
550 +=========+====================================================+================+
551 | **defau | successful operation | No Content |
553 +---------+----------------------------------------------------+----------------+
560 Update Product Metadata
561 -----------------------
565 PUT /v1/catalog/products/{productId}/metadata
570 Returns updated product
575 +----------+-------------+--------------------------------------+------------------+
576 | Type | Name | Description | Schema |
577 +==========+=============+======================================+==================+
578 | **Header | **USER\_ID* | | string |
579 | ** | *\ *optiona | | |
581 +----------+-------------+--------------------------------------+------------------+
582 | **Path** | **productId | | string |
583 | | **\ *requir | | |
585 +----------+-------------+--------------------------------------+------------------+
586 | **Body** | **body**\ * | Product object to be Updated | string |
588 +----------+-------------+--------------------------------------+------------------+
593 +---------+----------------------------------------------------+----------------+
594 | HTTP | Description | Schema |
596 +=========+====================================================+================+
597 | **200** | Product Updated | No Content |
598 +---------+----------------------------------------------------+----------------+
599 | **400** | Invalid content / Missing content | No Content |
600 +---------+----------------------------------------------------+----------------+
601 | **403** | Restricted operation | No Content |
602 +---------+----------------------------------------------------+----------------+
607 - ``application/json``
612 - ``application/json``
624 POST /v1/catalog/resources
629 Returns created resource
634 +----------+-------------+--------------------------------------+------------------+
635 | Type | Name | Description | Schema |
636 +==========+=============+======================================+==================+
637 | **Header | **USER\_ID* | | string |
638 | ** | *\ *optiona | | |
640 +----------+-------------+--------------------------------------+------------------+
641 | **Body** | **body**\ * | Resource object to be created | string |
643 +----------+-------------+--------------------------------------+------------------+
648 +---------+----------------------------------------------------+----------------+
649 | HTTP | Description | Schema |
651 +=========+====================================================+================+
652 | **200** | successful operation | `Resource <#_r |
654 +---------+----------------------------------------------------+----------------+
655 | **201** | Resource created | No Content |
656 +---------+----------------------------------------------------+----------------+
657 | **400** | Invalid content / Missing content | No Content |
658 +---------+----------------------------------------------------+----------------+
659 | **403** | Restricted operation | No Content |
660 +---------+----------------------------------------------------+----------------+
661 | **409** | Resource already exist | No Content |
662 +---------+----------------------------------------------------+----------------+
667 - ``application/json``
672 - ``application/json``
679 GET /v1/catalog/resources/certified/abstract
680 --------------------------------------------
685 +------------------+--------------------------+----------------------------------+
686 | Type | Name | Schema |
687 +==================+==========================+==================================+
688 | **Header** | **USER\_ID**\ *optional* | string |
689 +------------------+--------------------------+----------------------------------+
694 +---------+----------------------------------------------------+----------------+
695 | HTTP | Description | Schema |
697 +=========+====================================================+================+
698 | **defau | successful operation | No Content |
700 +---------+----------------------------------------------------+----------------+
705 - ``application/json``
710 - ``application/json``
717 GET /v1/catalog/resources/certified/notabstract
718 -----------------------------------------------
723 +------------------+--------------------------+----------------------------------+
724 | Type | Name | Schema |
725 +==================+==========================+==================================+
726 | **Header** | **USER\_ID**\ *optional* | string |
727 +------------------+--------------------------+----------------------------------+
732 +---------+----------------------------------------------------+----------------+
733 | HTTP | Description | Schema |
735 +=========+====================================================+================+
736 | **defau | successful operation | No Content |
738 +---------+----------------------------------------------------+----------------+
743 - ``application/json``
748 - ``application/json``
760 POST /v1/catalog/resources/csar/{csaruuid}
765 Returns resource created from csar uuid
770 +------------------+--------------------------+----------------------------------+
771 | Type | Name | Schema |
772 +==================+==========================+==================================+
773 | **Header** | **USER\_ID**\ *optional* | string |
774 +------------------+--------------------------+----------------------------------+
775 | **Path** | **csaruuid**\ *required* | string |
776 +------------------+--------------------------+----------------------------------+
781 +---------+----------------------------------------------------+----------------+
782 | HTTP | Description | Schema |
784 +=========+====================================================+================+
785 | **200** | successful operation | `Resource <#_r |
787 +---------+----------------------------------------------------+----------------+
788 | **201** | Resource retrieced | No Content |
789 +---------+----------------------------------------------------+----------------+
790 | **400** | Invalid content / Missing content | No Content |
791 +---------+----------------------------------------------------+----------------+
792 | **403** | Restricted operation | No Content |
793 +---------+----------------------------------------------------+----------------+
798 - ``application/json``
803 - ``application/json``
810 Retrieve Resource by name and version
811 -------------------------------------
815 GET /v1/catalog/resources/resourceName/{resourceName}/resourceVersion/{resourceVersion}
820 Returns resource according to resourceId
825 +------------------+--------------------------+----------------------------------+
826 | Type | Name | Schema |
827 +==================+==========================+==================================+
828 | **Header** | **USER\_ID**\ *optional* | string |
829 +------------------+--------------------------+----------------------------------+
830 | **Path** | **resourceName**\ *requi | string |
832 +------------------+--------------------------+----------------------------------+
833 | **Path** | **resourceVersion**\ *re | string |
835 +------------------+--------------------------+----------------------------------+
840 +---------+----------------------------------------------------+----------------+
841 | HTTP | Description | Schema |
843 +=========+====================================================+================+
844 | **200** | Resource found | No Content |
845 +---------+----------------------------------------------------+----------------+
846 | **403** | Restricted operation | No Content |
847 +---------+----------------------------------------------------+----------------+
848 | **404** | Resource not found | No Content |
849 +---------+----------------------------------------------------+----------------+
854 - ``application/json``
859 - ``application/json``
866 validate resource name
867 ----------------------
871 GET /v1/catalog/resources/validate-name/{resourceName}
876 checks if the chosen resource name is available
881 +------------------+--------------------------+----------------------------------+
882 | Type | Name | Schema |
883 +==================+==========================+==================================+
884 | **Header** | **USER\_ID**\ *optional* | string |
885 +------------------+--------------------------+----------------------------------+
886 | **Path** | **resourceName**\ *requi | string |
888 +------------------+--------------------------+----------------------------------+
889 | **Query** | **subtype**\ *optional* | string |
890 +------------------+--------------------------+----------------------------------+
895 +---------+----------------------------------------------------+----------------+
896 | HTTP | Description | Schema |
898 +=========+====================================================+================+
899 | **200** | Resource found | No Content |
900 +---------+----------------------------------------------------+----------------+
901 | **403** | Restricted operation | No Content |
902 +---------+----------------------------------------------------+----------------+
907 - ``application/json``
912 - ``application/json``
924 GET /v1/catalog/resources/{resourceId}
929 Returns resource according to resourceId
934 +------------------+--------------------------+----------------------------------+
935 | Type | Name | Schema |
936 +==================+==========================+==================================+
937 | **Header** | **USER\_ID**\ *optional* | string |
938 +------------------+--------------------------+----------------------------------+
939 | **Path** | **resourceId**\ *require | string |
941 +------------------+--------------------------+----------------------------------+
946 +---------+----------------------------------------------------+----------------+
947 | HTTP | Description | Schema |
949 +=========+====================================================+================+
950 | **200** | Resource found | No Content |
951 +---------+----------------------------------------------------+----------------+
952 | **403** | Restricted operation | No Content |
953 +---------+----------------------------------------------------+----------------+
954 | **404** | Resource not found | No Content |
955 +---------+----------------------------------------------------+----------------+
960 - ``application/json``
965 - ``application/json``
977 PUT /v1/catalog/resources/{resourceId}
982 Returns updated resource
987 +----------+-------------+--------------------------------------+------------------+
988 | Type | Name | Description | Schema |
989 +==========+=============+======================================+==================+
990 | **Header | **USER\_ID* | | string |
991 | ** | *\ *optiona | | |
993 +----------+-------------+--------------------------------------+------------------+
994 | **Path** | **resourceI | | string |
995 | | d**\ *requi | | |
997 +----------+-------------+--------------------------------------+------------------+
998 | **Body** | **body**\ * | Resource object to be updated | string |
1000 +----------+-------------+--------------------------------------+------------------+
1005 +---------+----------------------------------------------------+----------------+
1006 | HTTP | Description | Schema |
1008 +=========+====================================================+================+
1009 | **200** | Resource updated | No Content |
1010 +---------+----------------------------------------------------+----------------+
1011 | **400** | Invalid content / Missing content | No Content |
1012 +---------+----------------------------------------------------+----------------+
1013 | **403** | Restricted operation | No Content |
1014 +---------+----------------------------------------------------+----------------+
1015 | **409** | Resource already exist | No Content |
1016 +---------+----------------------------------------------------+----------------+
1021 - ``application/json``
1026 - ``application/json``
1033 DELETE /v1/catalog/resources/{resourceid}
1034 -----------------------------------------
1039 +------------------+--------------------------+----------------------------------+
1040 | Type | Name | Schema |
1041 +==================+==========================+==================================+
1042 | **Path** | **resourceId**\ *require | string |
1044 +------------------+--------------------------+----------------------------------+
1049 +---------+----------------------------------------------------+----------------+
1050 | HTTP | Description | Schema |
1052 +=========+====================================================+================+
1053 | **defau | successful operation | No Content |
1055 +---------+----------------------------------------------------+----------------+
1062 Create Additional Information Label and Value
1063 ---------------------------------------------
1067 POST /v1/catalog/resources/{resourceId}/additionalinfo
1072 Returns created Additional Inforamtion property
1077 +----------+-------------+--------------------------------------+------------------+
1078 | Type | Name | Description | Schema |
1079 +==========+=============+======================================+==================+
1080 | **Header | **USER\_ID* | | string |
1081 | ** | *\ *optiona | | |
1083 +----------+-------------+--------------------------------------+------------------+
1084 | **Path** | **resourceI | resource id to update with new | string |
1085 | | d**\ *requi | property | |
1087 +----------+-------------+--------------------------------------+------------------+
1088 | **Body** | **body**\ * | Additional information key value to | string |
1089 | | required* | be created | |
1090 +----------+-------------+--------------------------------------+------------------+
1095 +---------+----------------------------------------------------+----------------+
1096 | HTTP | Description | Schema |
1098 +=========+====================================================+================+
1099 | **201** | Additional information created | No Content |
1100 +---------+----------------------------------------------------+----------------+
1101 | **400** | Invalid content / Missing content | No Content |
1102 +---------+----------------------------------------------------+----------------+
1103 | **403** | Restricted operation | No Content |
1104 +---------+----------------------------------------------------+----------------+
1105 | **409** | Additional information key already exist | No Content |
1106 +---------+----------------------------------------------------+----------------+
1111 - ``application/json``
1116 - ``application/json``
1121 - Additional Information Servlet
1123 Get all Additional Information under resource
1124 ---------------------------------------------
1128 GET /v1/catalog/resources/{resourceId}/additionalinfo
1133 Returns Additional Inforamtion property
1138 +----------+-------------+--------------------------------------+------------------+
1139 | Type | Name | Description | Schema |
1140 +==========+=============+======================================+==================+
1141 | **Header | **USER\_ID* | | string |
1142 | ** | *\ *optiona | | |
1144 +----------+-------------+--------------------------------------+------------------+
1145 | **Path** | **resourceI | resource id to update with new | string |
1146 | | d**\ *requi | property | |
1148 +----------+-------------+--------------------------------------+------------------+
1153 +---------+----------------------------------------------------+----------------+
1154 | HTTP | Description | Schema |
1156 +=========+====================================================+================+
1157 | **200** | list of additional information | No Content |
1158 +---------+----------------------------------------------------+----------------+
1159 | **400** | Invalid content / Missing content | No Content |
1160 +---------+----------------------------------------------------+----------------+
1161 | **403** | Restricted operation | No Content |
1162 +---------+----------------------------------------------------+----------------+
1163 | **409** | Additional information key already exist | No Content |
1164 +---------+----------------------------------------------------+----------------+
1169 - ``application/json``
1174 - ``application/json``
1179 - Additional Information Servlet
1181 Get Additional Information by id
1182 --------------------------------
1186 GET /v1/catalog/resources/{resourceId}/additionalinfo/{labelId}
1191 Returns Additional Inforamtion property
1196 +----------+-------------+--------------------------------------+------------------+
1197 | Type | Name | Description | Schema |
1198 +==========+=============+======================================+==================+
1199 | **Header | **USER\_ID* | | string |
1200 | ** | *\ *optiona | | |
1202 +----------+-------------+--------------------------------------+------------------+
1203 | **Path** | **labelId** | label id | string |
1204 | | \ *required | | |
1206 +----------+-------------+--------------------------------------+------------------+
1207 | **Path** | **resourceI | resource id to update with new | string |
1208 | | d**\ *requi | property | |
1210 +----------+-------------+--------------------------------------+------------------+
1215 +---------+----------------------------------------------------+----------------+
1216 | HTTP | Description | Schema |
1218 +=========+====================================================+================+
1219 | **200** | fetched additional information | No Content |
1220 +---------+----------------------------------------------------+----------------+
1221 | **400** | Invalid content / Missing content | No Content |
1222 +---------+----------------------------------------------------+----------------+
1223 | **403** | Restricted operation | No Content |
1224 +---------+----------------------------------------------------+----------------+
1225 | **409** | Additional information key already exist | No Content |
1226 +---------+----------------------------------------------------+----------------+
1231 - ``application/json``
1236 - ``application/json``
1241 - Additional Information Servlet
1243 Update Additional Information Label and Value
1244 ---------------------------------------------
1248 PUT /v1/catalog/resources/{resourceId}/additionalinfo/{labelId}
1253 Returns updated Additional Inforamtion property
1258 +----------+-------------+--------------------------------------+------------------+
1259 | Type | Name | Description | Schema |
1260 +==========+=============+======================================+==================+
1261 | **Header | **USER\_ID* | | string |
1262 | ** | *\ *optiona | | |
1264 +----------+-------------+--------------------------------------+------------------+
1265 | **Path** | **labelId** | label id | string |
1266 | | \ *required | | |
1268 +----------+-------------+--------------------------------------+------------------+
1269 | **Path** | **resourceI | resource id to update with new | string |
1270 | | d**\ *requi | property | |
1272 +----------+-------------+--------------------------------------+------------------+
1273 | **Body** | **body**\ * | Additional information key value to | string |
1274 | | required* | be created | |
1275 +----------+-------------+--------------------------------------+------------------+
1280 +---------+----------------------------------------------------+----------------+
1281 | HTTP | Description | Schema |
1283 +=========+====================================================+================+
1284 | **200** | Additional information updated | No Content |
1285 +---------+----------------------------------------------------+----------------+
1286 | **400** | Invalid content / Missing content | No Content |
1287 +---------+----------------------------------------------------+----------------+
1288 | **403** | Restricted operation | No Content |
1289 +---------+----------------------------------------------------+----------------+
1290 | **409** | Additional information key already exist | No Content |
1291 +---------+----------------------------------------------------+----------------+
1296 - ``application/json``
1301 - ``application/json``
1306 - Additional Information Servlet
1308 Create Additional Information Label and Value
1309 ---------------------------------------------
1313 DELETE /v1/catalog/resources/{resourceId}/additionalinfo/{labelId}
1318 Returns deleted Additional Inforamtion property
1323 +----------+-------------+--------------------------------------+------------------+
1324 | Type | Name | Description | Schema |
1325 +==========+=============+======================================+==================+
1326 | **Header | **USER\_ID* | | string |
1327 | ** | *\ *optiona | | |
1329 +----------+-------------+--------------------------------------+------------------+
1330 | **Path** | **labelId** | label id | string |
1331 | | \ *required | | |
1333 +----------+-------------+--------------------------------------+------------------+
1334 | **Path** | **resourceI | resource id to update with new | string |
1335 | | d**\ *requi | property | |
1337 +----------+-------------+--------------------------------------+------------------+
1342 +---------+----------------------------------------------------+----------------+
1343 | HTTP | Description | Schema |
1345 +=========+====================================================+================+
1346 | **200** | Additional information deleted | No Content |
1347 +---------+----------------------------------------------------+----------------+
1348 | **400** | Invalid content / Missing content | No Content |
1349 +---------+----------------------------------------------------+----------------+
1350 | **403** | Restricted operation | No Content |
1351 +---------+----------------------------------------------------+----------------+
1352 | **409** | Additional information key already exist | No Content |
1353 +---------+----------------------------------------------------+----------------+
1358 - ``application/json``
1363 - ``application/json``
1368 - Additional Information Servlet
1375 POST /v1/catalog/resources/{resourceId}/artifacts
1380 Returns created ArtifactDefinition
1385 +----------+-------------+--------------------------------------+------------------+
1386 | Type | Name | Description | Schema |
1387 +==========+=============+======================================+==================+
1388 | **Path** | **resourceI | | string |
1389 | | d**\ *requi | | |
1391 +----------+-------------+--------------------------------------+------------------+
1392 | **Body** | **body**\ * | json describe the artifact | string |
1394 +----------+-------------+--------------------------------------+------------------+
1399 +---------+----------------------------------------------------+----------------+
1400 | HTTP | Description | Schema |
1402 +=========+====================================================+================+
1403 | **201** | Resource created | No Content |
1404 +---------+----------------------------------------------------+----------------+
1405 | **400** | Invalid content / Missing content | No Content |
1406 +---------+----------------------------------------------------+----------------+
1407 | **403** | Restricted operation | No Content |
1408 +---------+----------------------------------------------------+----------------+
1409 | **409** | Artifact already exist | No Content |
1410 +---------+----------------------------------------------------+----------------+
1415 - ``application/json``
1420 - ``application/json``
1425 - Resource Artifact Servlet
1432 POST /v1/catalog/resources/{resourceId}/artifacts/{artifactId}
1437 Returns updated artifact
1442 +----------+-------------+--------------------------------------+------------------+
1443 | Type | Name | Description | Schema |
1444 +==========+=============+======================================+==================+
1445 | **Path** | **artifactI | | string |
1446 | | d**\ *requi | | |
1448 +----------+-------------+--------------------------------------+------------------+
1449 | **Path** | **resourceI | | string |
1450 | | d**\ *requi | | |
1452 +----------+-------------+--------------------------------------+------------------+
1453 | **Body** | **body**\ * | json describe the artifact | string |
1455 +----------+-------------+--------------------------------------+------------------+
1460 +---------+----------------------------------------------------+----------------+
1461 | HTTP | Description | Schema |
1463 +=========+====================================================+================+
1464 | **201** | Resource created | No Content |
1465 +---------+----------------------------------------------------+----------------+
1466 | **400** | Invalid content / Missing content | No Content |
1467 +---------+----------------------------------------------------+----------------+
1468 | **403** | Restricted operation | No Content |
1469 +---------+----------------------------------------------------+----------------+
1474 - ``application/json``
1479 - ``application/json``
1484 - Resource Artifact Servlet
1486 Download resource Artifact in Base64
1487 ------------------------------------
1491 GET /v1/catalog/resources/{resourceId}/artifacts/{artifactId}
1496 Returns downloaded artifact
1501 +------------------+--------------------------+----------------------------------+
1502 | Type | Name | Schema |
1503 +==================+==========================+==================================+
1504 | **Path** | **artifactId**\ *require | string |
1506 +------------------+--------------------------+----------------------------------+
1507 | **Path** | **resourceId**\ *require | string |
1509 +------------------+--------------------------+----------------------------------+
1514 +---------+----------------------------------------------------+----------------+
1515 | HTTP | Description | Schema |
1517 +=========+====================================================+================+
1518 | **200** | Resource artifact downloaded | No Content |
1519 +---------+----------------------------------------------------+----------------+
1520 | **404** | Resource/Artifact not found | No Content |
1521 +---------+----------------------------------------------------+----------------+
1526 - ``application/json``
1531 - ``application/json``
1536 - Resource Artifact Servlet
1543 DELETE /v1/catalog/resources/{resourceId}/artifacts/{artifactId}
1548 Returns delete artifact
1553 +------------------+--------------------------+----------------------------------+
1554 | Type | Name | Schema |
1555 +==================+==========================+==================================+
1556 | **Path** | **artifactId**\ *require | string |
1558 +------------------+--------------------------+----------------------------------+
1559 | **Path** | **resourceId**\ *require | string |
1561 +------------------+--------------------------+----------------------------------+
1566 +---------+----------------------------------------------------+----------------+
1567 | HTTP | Description | Schema |
1569 +=========+====================================================+================+
1570 | **201** | Resource created | No Content |
1571 +---------+----------------------------------------------------+----------------+
1572 | **400** | Invalid content / Missing content | No Content |
1573 +---------+----------------------------------------------------+----------------+
1574 | **403** | Restricted operation | No Content |
1575 +---------+----------------------------------------------------+----------------+
1580 - ``application/json``
1585 - ``application/json``
1590 - Resource Artifact Servlet
1592 Create Resource Attribute
1593 -------------------------
1597 POST /v1/catalog/resources/{resourceId}/attributes
1602 Returns created resource attribute
1607 +----------+-------------+--------------------------------------+------------------+
1608 | Type | Name | Description | Schema |
1609 +==========+=============+======================================+==================+
1610 | **Header | **USER\_ID* | | string |
1611 | ** | *\ *optiona | | |
1613 +----------+-------------+--------------------------------------+------------------+
1614 | **Path** | **resourceI | resource id to update with new | string |
1615 | | d**\ *requi | attribute | |
1617 +----------+-------------+--------------------------------------+------------------+
1618 | **Body** | **body**\ * | Resource attribute to be created | string |
1620 +----------+-------------+--------------------------------------+------------------+
1625 +---------+----------------------------------------------------+----------------+
1626 | HTTP | Description | Schema |
1628 +=========+====================================================+================+
1629 | **201** | Resource property created | No Content |
1630 +---------+----------------------------------------------------+----------------+
1631 | **400** | Invalid content / Missing content | No Content |
1632 +---------+----------------------------------------------------+----------------+
1633 | **403** | Restricted operation | No Content |
1634 +---------+----------------------------------------------------+----------------+
1635 | **409** | Resource attribute already exist | No Content |
1636 +---------+----------------------------------------------------+----------------+
1641 - ``application/json``
1646 - ``application/json``
1651 - Resource Attribute Servlet
1653 Update Resource Attribute
1654 -------------------------
1658 PUT /v1/catalog/resources/{resourceId}/attributes/{attributeId}
1663 Returns updated attribute
1668 +----------+-------------+--------------------------------------+------------------+
1669 | Type | Name | Description | Schema |
1670 +==========+=============+======================================+==================+
1671 | **Header | **USER\_ID* | | string |
1672 | ** | *\ *optiona | | |
1674 +----------+-------------+--------------------------------------+------------------+
1675 | **Path** | **attribute | attribute id to update | string |
1676 | | Id**\ *requ | | |
1678 +----------+-------------+--------------------------------------+------------------+
1679 | **Path** | **resourceI | resource id to update with new | string |
1680 | | d**\ *requi | attribute | |
1682 +----------+-------------+--------------------------------------+------------------+
1683 | **Body** | **body**\ * | Resource attribute to update | string |
1685 +----------+-------------+--------------------------------------+------------------+
1690 +---------+----------------------------------------------------+----------------+
1691 | HTTP | Description | Schema |
1693 +=========+====================================================+================+
1694 | **200** | Resource attribute updated | No Content |
1695 +---------+----------------------------------------------------+----------------+
1696 | **400** | Invalid content / Missing content | No Content |
1697 +---------+----------------------------------------------------+----------------+
1698 | **403** | Restricted operation | No Content |
1699 +---------+----------------------------------------------------+----------------+
1704 - ``application/json``
1709 - ``application/json``
1714 - Resource Attribute Servlet
1716 Create Resource Attribute
1717 -------------------------
1721 DELETE /v1/catalog/resources/{resourceId}/attributes/{attributeId}
1726 Returns deleted attribute
1731 +----------+-------------+--------------------------------------+------------------+
1732 | Type | Name | Description | Schema |
1733 +==========+=============+======================================+==================+
1734 | **Header | **USER\_ID* | | string |
1735 | ** | *\ *optiona | | |
1737 +----------+-------------+--------------------------------------+------------------+
1738 | **Path** | **attribute | Attribute id to delete | string |
1739 | | Id**\ *requ | | |
1741 +----------+-------------+--------------------------------------+------------------+
1742 | **Path** | **resourceI | resource id of attribute | string |
1743 | | d**\ *requi | | |
1745 +----------+-------------+--------------------------------------+------------------+
1750 +---------+----------------------------------------------------+----------------+
1751 | HTTP | Description | Schema |
1753 +=========+====================================================+================+
1754 | **204** | deleted attribute | No Content |
1755 +---------+----------------------------------------------------+----------------+
1756 | **400** | Invalid content / Missing content | No Content |
1757 +---------+----------------------------------------------------+----------------+
1758 | **403** | Restricted operation | No Content |
1759 +---------+----------------------------------------------------+----------------+
1760 | **404** | Resource property not found | No Content |
1761 +---------+----------------------------------------------------+----------------+
1766 - ``application/json``
1771 - ``application/json``
1776 - Resource Attribute Servlet
1778 Update Resource Metadata
1779 ------------------------
1783 PUT /v1/catalog/resources/{resourceId}/metadata
1788 Returns updated resource metadata
1793 +----------+-------------+--------------------------------------+------------------+
1794 | Type | Name | Description | Schema |
1795 +==========+=============+======================================+==================+
1796 | **Header | **USER\_ID* | | string |
1797 | ** | *\ *optiona | | |
1799 +----------+-------------+--------------------------------------+------------------+
1800 | **Path** | **resourceI | | string |
1801 | | d**\ *requi | | |
1803 +----------+-------------+--------------------------------------+------------------+
1804 | **Body** | **body**\ * | Resource metadata to be updated | string |
1806 +----------+-------------+--------------------------------------+------------------+
1811 +---------+----------------------------------------------------+----------------+
1812 | HTTP | Description | Schema |
1814 +=========+====================================================+================+
1815 | **200** | Resource metadata updated | No Content |
1816 +---------+----------------------------------------------------+----------------+
1817 | **400** | Invalid content | No Content |
1818 +---------+----------------------------------------------------+----------------+
1819 | **403** | Restricted operation | No Content |
1820 +---------+----------------------------------------------------+----------------+
1825 - ``application/json``
1830 - ``application/json``
1837 Create Resource Property
1838 ------------------------
1842 POST /v1/catalog/resources/{resourceId}/properties
1847 Returns created resource property
1852 +----------+-------------+--------------------------------------+------------------+
1853 | Type | Name | Description | Schema |
1854 +==========+=============+======================================+==================+
1855 | **Header | **USER\_ID* | | string |
1856 | ** | *\ *optiona | | |
1858 +----------+-------------+--------------------------------------+------------------+
1859 | **Path** | **resourceI | resource id to update with new | string |
1860 | | d**\ *requi | property | |
1862 +----------+-------------+--------------------------------------+------------------+
1863 | **Body** | **body**\ * | Resource property to be created | string |
1865 +----------+-------------+--------------------------------------+------------------+
1870 +---------+----------------------------------------------------+----------------+
1871 | HTTP | Description | Schema |
1873 +=========+====================================================+================+
1874 | **201** | Resource property created | No Content |
1875 +---------+----------------------------------------------------+----------------+
1876 | **400** | Invalid content / Missing content | No Content |
1877 +---------+----------------------------------------------------+----------------+
1878 | **403** | Restricted operation | No Content |
1879 +---------+----------------------------------------------------+----------------+
1880 | **409** | Resource property already exist | No Content |
1881 +---------+----------------------------------------------------+----------------+
1886 - ``application/json``
1891 - ``application/json``
1896 - Resource Property Servlet
1898 Create Resource Property
1899 ------------------------
1903 GET /v1/catalog/resources/{resourceId}/properties/{propertyId}
1908 Returns property of resource
1913 +----------+-------------+--------------------------------------+------------------+
1914 | Type | Name | Description | Schema |
1915 +==========+=============+======================================+==================+
1916 | **Header | **USER\_ID* | | string |
1917 | ** | *\ *optiona | | |
1919 +----------+-------------+--------------------------------------+------------------+
1920 | **Path** | **propertyI | proerty id to get | string |
1921 | | d**\ *requi | | |
1923 +----------+-------------+--------------------------------------+------------------+
1924 | **Path** | **resourceI | resource id of property | string |
1925 | | d**\ *requi | | |
1927 +----------+-------------+--------------------------------------+------------------+
1932 +---------+----------------------------------------------------+----------------+
1933 | HTTP | Description | Schema |
1935 +=========+====================================================+================+
1936 | **200** | property | No Content |
1937 +---------+----------------------------------------------------+----------------+
1938 | **400** | Invalid content / Missing content | No Content |
1939 +---------+----------------------------------------------------+----------------+
1940 | **403** | Restricted operation | No Content |
1941 +---------+----------------------------------------------------+----------------+
1942 | **404** | Resource property not found | No Content |
1943 +---------+----------------------------------------------------+----------------+
1948 - ``application/json``
1953 - ``application/json``
1958 - Resource Property Servlet
1960 Update Resource Property
1961 ------------------------
1965 PUT /v1/catalog/resources/{resourceId}/properties/{propertyId}
1970 Returns updated property
1975 +----------+-------------+--------------------------------------+------------------+
1976 | Type | Name | Description | Schema |
1977 +==========+=============+======================================+==================+
1978 | **Header | **USER\_ID* | | string |
1979 | ** | *\ *optiona | | |
1981 +----------+-------------+--------------------------------------+------------------+
1982 | **Path** | **propertyI | proerty id to update | string |
1983 | | d**\ *requi | | |
1985 +----------+-------------+--------------------------------------+------------------+
1986 | **Path** | **resourceI | resource id to update with new | string |
1987 | | d**\ *requi | property | |
1989 +----------+-------------+--------------------------------------+------------------+
1990 | **Body** | **body**\ * | Resource property to update | string |
1992 +----------+-------------+--------------------------------------+------------------+
1997 +---------+----------------------------------------------------+----------------+
1998 | HTTP | Description | Schema |
2000 +=========+====================================================+================+
2001 | **200** | Resource property updated | No Content |
2002 +---------+----------------------------------------------------+----------------+
2003 | **400** | Invalid content / Missing content | No Content |
2004 +---------+----------------------------------------------------+----------------+
2005 | **403** | Restricted operation | No Content |
2006 +---------+----------------------------------------------------+----------------+
2011 - ``application/json``
2016 - ``application/json``
2021 - Resource Property Servlet
2023 Create Resource Property
2024 ------------------------
2028 DELETE /v1/catalog/resources/{resourceId}/properties/{propertyId}
2033 Returns deleted property
2038 +----------+-------------+--------------------------------------+------------------+
2039 | Type | Name | Description | Schema |
2040 +==========+=============+======================================+==================+
2041 | **Header | **USER\_ID* | | string |
2042 | ** | *\ *optiona | | |
2044 +----------+-------------+--------------------------------------+------------------+
2045 | **Path** | **propertyI | Property id to delete | string |
2046 | | d**\ *requi | | |
2048 +----------+-------------+--------------------------------------+------------------+
2049 | **Path** | **resourceI | resource id of property | string |
2050 | | d**\ *requi | | |
2052 +----------+-------------+--------------------------------------+------------------+
2057 +---------+----------------------------------------------------+----------------+
2058 | HTTP | Description | Schema |
2060 +=========+====================================================+================+
2061 | **204** | deleted property | No Content |
2062 +---------+----------------------------------------------------+----------------+
2063 | **400** | Invalid content / Missing content | No Content |
2064 +---------+----------------------------------------------------+----------------+
2065 | **403** | Restricted operation | No Content |
2066 +---------+----------------------------------------------------+----------------+
2067 | **404** | Resource property not found | No Content |
2068 +---------+----------------------------------------------------+----------------+
2073 - ``application/json``
2078 - ``application/json``
2083 - Resource Property Servlet
2085 Create Artifact and Attach to interface
2086 ---------------------------------------
2090 POST /v1/catalog/resources/{resourceId}/{interfaceType}/{operation}/artifacts
2095 Returns created resource
2100 +----------+-------------+--------------------------------------+------------------+
2101 | Type | Name | Description | Schema |
2102 +==========+=============+======================================+==================+
2103 | **Header | **Content-M | | string |
2104 | ** | D5**\ *opti | | |
2106 +----------+-------------+--------------------------------------+------------------+
2107 | **Header | **USER\_ID* | | string |
2108 | ** | *\ *optiona | | |
2110 +----------+-------------+--------------------------------------+------------------+
2111 | **Path** | **interface | | string |
2112 | | Type**\ *re | | |
2114 +----------+-------------+--------------------------------------+------------------+
2115 | **Path** | **operation | | string |
2116 | | **\ *requir | | |
2118 +----------+-------------+--------------------------------------+------------------+
2119 | **Path** | **resourceI | | string |
2120 | | d**\ *requi | | |
2122 +----------+-------------+--------------------------------------+------------------+
2123 | **Body** | **body**\ * | json describe the artifact | string |
2125 +----------+-------------+--------------------------------------+------------------+
2130 +---------+----------------------------------------------------+----------------+
2131 | HTTP | Description | Schema |
2133 +=========+====================================================+================+
2134 | **201** | Resource created | No Content |
2135 +---------+----------------------------------------------------+----------------+
2136 | **400** | Invalid content / Missing content | No Content |
2137 +---------+----------------------------------------------------+----------------+
2138 | **403** | Restricted operation | No Content |
2139 +---------+----------------------------------------------------+----------------+
2140 | **409** | Artifact already exist | No Content |
2141 +---------+----------------------------------------------------+----------------+
2146 - ``application/json``
2151 - ``application/json``
2156 - Resource Artifact Servlet
2158 update Artifact Attach to interface
2159 -----------------------------------
2163 POST /v1/catalog/resources/{resourceId}/{interfaceType}/{operation}/artifacts/{artifactId}
2168 updates artifact by interface
2173 +----------+-------------+--------------------------------------+------------------+
2174 | Type | Name | Description | Schema |
2175 +==========+=============+======================================+==================+
2176 | **Header | **Content-M | | string |
2177 | ** | D5**\ *opti | | |
2179 +----------+-------------+--------------------------------------+------------------+
2180 | **Header | **USER\_ID* | | string |
2181 | ** | *\ *optiona | | |
2183 +----------+-------------+--------------------------------------+------------------+
2184 | **Path** | **artifactI | | string |
2185 | | d**\ *requi | | |
2187 +----------+-------------+--------------------------------------+------------------+
2188 | **Path** | **interface | | string |
2189 | | Type**\ *re | | |
2191 +----------+-------------+--------------------------------------+------------------+
2192 | **Path** | **operation | | string |
2193 | | **\ *requir | | |
2195 +----------+-------------+--------------------------------------+------------------+
2196 | **Path** | **resourceI | | string |
2197 | | d**\ *requi | | |
2199 +----------+-------------+--------------------------------------+------------------+
2200 | **Body** | **body**\ * | json describe the artifact | string |
2202 +----------+-------------+--------------------------------------+------------------+
2207 +---------+----------------------------------------------------+----------------+
2208 | HTTP | Description | Schema |
2210 +=========+====================================================+================+
2211 | **201** | delete artifact under interface deleted | No Content |
2212 +---------+----------------------------------------------------+----------------+
2213 | **400** | Invalid content / Missing content | No Content |
2214 +---------+----------------------------------------------------+----------------+
2215 | **403** | Restricted operation | No Content |
2216 +---------+----------------------------------------------------+----------------+
2217 | **409** | Artifact already exist | No Content |
2218 +---------+----------------------------------------------------+----------------+
2223 - ``application/json``
2228 - ``application/json``
2233 - Resource Artifact Servlet
2235 delete Artifact from interface
2236 ------------------------------
2240 DELETE /v1/catalog/resources/{resourceId}/{interfaceType}/{operation}/artifacts/{artifactId}
2245 delete matching artifact from interface
2250 +------------------+--------------------------+----------------------------------+
2251 | Type | Name | Schema |
2252 +==================+==========================+==================================+
2253 | **Path** | **artifactId**\ *require | string |
2255 +------------------+--------------------------+----------------------------------+
2256 | **Path** | **interfaceType**\ *requ | string |
2258 +------------------+--------------------------+----------------------------------+
2259 | **Path** | **operation**\ *required | string |
2261 +------------------+--------------------------+----------------------------------+
2262 | **Path** | **resourceId**\ *require | string |
2264 +------------------+--------------------------+----------------------------------+
2269 +---------+----------------------------------------------------+----------------+
2270 | HTTP | Description | Schema |
2272 +=========+====================================================+================+
2273 | **201** | delete artifact under interface deleted | No Content |
2274 +---------+----------------------------------------------------+----------------+
2275 | **400** | Invalid content / Missing content | No Content |
2276 +---------+----------------------------------------------------+----------------+
2277 | **403** | Restricted operation | No Content |
2278 +---------+----------------------------------------------------+----------------+
2279 | **409** | Artifact already exist | No Content |
2280 +---------+----------------------------------------------------+----------------+
2285 - ``application/json``
2290 - ``application/json``
2295 - Resource Artifact Servlet
2297 DELETE /v1/catalog/resources/{resourcename}/{version}
2298 -----------------------------------------------------
2303 +------------------+--------------------------+----------------------------------+
2304 | Type | Name | Schema |
2305 +==================+==========================+==================================+
2306 | **Path** | **resourceName**\ *requi | string |
2308 +------------------+--------------------------+----------------------------------+
2309 | **Path** | **version**\ *required* | string |
2310 +------------------+--------------------------+----------------------------------+
2315 +---------+----------------------------------------------------+----------------+
2316 | HTTP | Description | Schema |
2318 +=========+====================================================+================+
2319 | **defau | successful operation | No Content |
2321 +---------+----------------------------------------------------+----------------+
2333 POST /v1/catalog/services
2338 Returns created service
2343 +----------+-------------+--------------------------------------+------------------+
2344 | Type | Name | Description | Schema |
2345 +==========+=============+======================================+==================+
2346 | **Header | **USER\_ID* | | string |
2347 | ** | *\ *optiona | | |
2349 +----------+-------------+--------------------------------------+------------------+
2350 | **Body** | **body**\ * | Service object to be created | string |
2352 +----------+-------------+--------------------------------------+------------------+
2357 +---------+----------------------------------------------------+----------------+
2358 | HTTP | Description | Schema |
2360 +=========+====================================================+================+
2361 | **200** | successful operation | `Service <#_se |
2363 +---------+----------------------------------------------------+----------------+
2364 | **201** | Service created | No Content |
2365 +---------+----------------------------------------------------+----------------+
2366 | **400** | Invalid content / Missing content | No Content |
2367 +---------+----------------------------------------------------+----------------+
2368 | **403** | Restricted operation | No Content |
2369 +---------+----------------------------------------------------+----------------+
2370 | **409** | Service already exist | No Content |
2371 +---------+----------------------------------------------------+----------------+
2376 - ``application/json``
2381 - ``application/json``
2388 Retrieve Distributions
2389 ----------------------
2393 GET /v1/catalog/services/distribution/{did}
2398 Return the list of distribution status objects
2403 +------------------+--------------------------+----------------------------------+
2404 | Type | Name | Schema |
2405 +==================+==========================+==================================+
2406 | **Header** | **USER\_ID**\ *optional* | string |
2407 +------------------+--------------------------+----------------------------------+
2408 | **Path** | **did**\ *required* | string |
2409 +------------------+--------------------------+----------------------------------+
2414 +---------+----------------------------------------------------+----------------+
2415 | HTTP | Description | Schema |
2417 +=========+====================================================+================+
2418 | **200** | Service found | No Content |
2419 +---------+----------------------------------------------------+----------------+
2420 | **403** | Restricted operation | No Content |
2421 +---------+----------------------------------------------------+----------------+
2422 | **404** | Status not found | No Content |
2423 +---------+----------------------------------------------------+----------------+
2428 - ``application/json``
2433 - ``application/json``
2438 - Distribution Service Servlet
2445 GET /v1/catalog/services/serviceName/{serviceName}/serviceVersion/{serviceVersion}
2450 Returns service according to name and version
2455 +------------------+--------------------------+----------------------------------+
2456 | Type | Name | Schema |
2457 +==================+==========================+==================================+
2458 | **Header** | **USER\_ID**\ *optional* | string |
2459 +------------------+--------------------------+----------------------------------+
2460 | **Path** | **serviceName**\ *requir | string |
2462 +------------------+--------------------------+----------------------------------+
2463 | **Path** | **serviceVersion**\ *req | string |
2465 +------------------+--------------------------+----------------------------------+
2470 +---------+----------------------------------------------------+----------------+
2471 | HTTP | Description | Schema |
2473 +=========+====================================================+================+
2474 | **200** | Service found | No Content |
2475 +---------+----------------------------------------------------+----------------+
2476 | **403** | Restricted operation | No Content |
2477 +---------+----------------------------------------------------+----------------+
2478 | **404** | Service not found | No Content |
2479 +---------+----------------------------------------------------+----------------+
2484 - ``application/json``
2489 - ``application/json``
2496 Download service artifact
2497 -------------------------
2501 GET /v1/catalog/services/toscatoheat/{artifactName}
2506 Returns downloaded artifact
2511 +------------------+--------------------------+----------------------------------+
2512 | Type | Name | Schema |
2513 +==================+==========================+==================================+
2514 | **Path** | **artifactName**\ *requi | string |
2516 +------------------+--------------------------+----------------------------------+
2521 +---------+----------------------------------------------------+----------------+
2522 | HTTP | Description | Schema |
2524 +=========+====================================================+================+
2525 | **200** | Artifact downloaded | No Content |
2526 +---------+----------------------------------------------------+----------------+
2527 | **401** | Authorization required | No Content |
2528 +---------+----------------------------------------------------+----------------+
2529 | **403** | Restricted operation | No Content |
2530 +---------+----------------------------------------------------+----------------+
2531 | **404** | Artifact not found | No Content |
2532 +---------+----------------------------------------------------+----------------+
2537 - ``application/json``
2542 - ``application/octet-stream``
2549 validate service name
2550 ---------------------
2554 GET /v1/catalog/services/validate-name/{serviceName}
2559 checks if the chosen service name is available
2564 +------------------+--------------------------+----------------------------------+
2565 | Type | Name | Schema |
2566 +==================+==========================+==================================+
2567 | **Header** | **USER\_ID**\ *optional* | string |
2568 +------------------+--------------------------+----------------------------------+
2569 | **Path** | **serviceName**\ *requir | string |
2571 +------------------+--------------------------+----------------------------------+
2576 +---------+----------------------------------------------------+----------------+
2577 | HTTP | Description | Schema |
2579 +=========+====================================================+================+
2580 | **200** | Service found | No Content |
2581 +---------+----------------------------------------------------+----------------+
2582 | **403** | Restricted operation | No Content |
2583 +---------+----------------------------------------------------+----------------+
2588 - ``application/json``
2593 - ``application/json``
2605 GET /v1/catalog/services/{componentId}/inputs
2615 +------------------+--------------------------+----------------------------------+
2616 | Type | Name | Schema |
2617 +==================+==========================+==================================+
2618 | **Header** | **USER\_ID**\ *optional* | string |
2619 +------------------+--------------------------+----------------------------------+
2620 | **Path** | **componentId**\ *requir | string |
2622 +------------------+--------------------------+----------------------------------+
2623 | **Path** | **componentType**\ *requ | string |
2625 +------------------+--------------------------+----------------------------------+
2626 | **Query** | **amount**\ *optional* | integer (int32) |
2627 +------------------+--------------------------+----------------------------------+
2628 | **Query** | **fromId**\ *optional* | string |
2629 +------------------+--------------------------+----------------------------------+
2634 +---------+----------------------------------------------------+----------------+
2635 | HTTP | Description | Schema |
2637 +=========+====================================================+================+
2638 | **200** | Component found | No Content |
2639 +---------+----------------------------------------------------+----------------+
2640 | **403** | Restricted operation | No Content |
2641 +---------+----------------------------------------------------+----------------+
2642 | **404** | Component not found | No Content |
2643 +---------+----------------------------------------------------+----------------+
2648 - ``application/json``
2653 - ``application/json``
2665 GET /v1/catalog/services/{serviceId}
2670 Returns service according to serviceId
2675 +------------------+--------------------------+----------------------------------+
2676 | Type | Name | Schema |
2677 +==================+==========================+==================================+
2678 | **Header** | **USER\_ID**\ *optional* | string |
2679 +------------------+--------------------------+----------------------------------+
2680 | **Path** | **serviceId**\ *required | string |
2682 +------------------+--------------------------+----------------------------------+
2687 +---------+----------------------------------------------------+----------------+
2688 | HTTP | Description | Schema |
2690 +=========+====================================================+================+
2691 | **200** | Service found | No Content |
2692 +---------+----------------------------------------------------+----------------+
2693 | **403** | Restricted operation | No Content |
2694 +---------+----------------------------------------------------+----------------+
2695 | **404** | Service not found | No Content |
2696 +---------+----------------------------------------------------+----------------+
2701 - ``application/json``
2706 - ``application/json``
2713 DELETE /v1/catalog/services/{serviceid}
2714 ---------------------------------------
2719 +------------------+--------------------------+----------------------------------+
2720 | Type | Name | Schema |
2721 +==================+==========================+==================================+
2722 | **Path** | **serviceId**\ *required | string |
2724 +------------------+--------------------------+----------------------------------+
2729 +---------+----------------------------------------------------+----------------+
2730 | HTTP | Description | Schema |
2732 +=========+====================================================+================+
2733 | **defau | successful operation | No Content |
2735 +---------+----------------------------------------------------+----------------+
2742 Create Additional Information Label and Value
2743 ---------------------------------------------
2747 POST /v1/catalog/services/{serviceId}/additionalinfo
2752 Returns created Additional Inforamtion property
2757 +----------+-------------+--------------------------------------+------------------+
2758 | Type | Name | Description | Schema |
2759 +==========+=============+======================================+==================+
2760 | **Header | **USER\_ID* | | string |
2761 | ** | *\ *optiona | | |
2763 +----------+-------------+--------------------------------------+------------------+
2764 | **Path** | **serviceId | service id to update with new | string |
2765 | | **\ *requir | property | |
2767 +----------+-------------+--------------------------------------+------------------+
2768 | **Body** | **body**\ * | Additional information key value to | string |
2769 | | required* | be created | |
2770 +----------+-------------+--------------------------------------+------------------+
2775 +---------+----------------------------------------------------+----------------+
2776 | HTTP | Description | Schema |
2778 +=========+====================================================+================+
2779 | **201** | Additional information created | No Content |
2780 +---------+----------------------------------------------------+----------------+
2781 | **400** | Invalid content / Missing content | No Content |
2782 +---------+----------------------------------------------------+----------------+
2783 | **403** | Restricted operation | No Content |
2784 +---------+----------------------------------------------------+----------------+
2785 | **409** | Additional information key already exist | No Content |
2786 +---------+----------------------------------------------------+----------------+
2791 - ``application/json``
2796 - ``application/json``
2801 - Additional Information Servlet
2803 Get all Additional Information under service
2804 --------------------------------------------
2808 GET /v1/catalog/services/{serviceId}/additionalinfo
2813 Returns Additional Inforamtion property
2818 +----------+-------------+--------------------------------------+------------------+
2819 | Type | Name | Description | Schema |
2820 +==========+=============+======================================+==================+
2821 | **Header | **USER\_ID* | | string |
2822 | ** | *\ *optiona | | |
2824 +----------+-------------+--------------------------------------+------------------+
2825 | **Path** | **serviceId | service id to update with new | string |
2826 | | **\ *requir | property | |
2828 +----------+-------------+--------------------------------------+------------------+
2833 +---------+----------------------------------------------------+----------------+
2834 | HTTP | Description | Schema |
2836 +=========+====================================================+================+
2837 | **200** | list of additional information | No Content |
2838 +---------+----------------------------------------------------+----------------+
2839 | **400** | Invalid content / Missing content | No Content |
2840 +---------+----------------------------------------------------+----------------+
2841 | **403** | Restricted operation | No Content |
2842 +---------+----------------------------------------------------+----------------+
2843 | **409** | Additional information key already exist | No Content |
2844 +---------+----------------------------------------------------+----------------+
2849 - ``application/json``
2854 - ``application/json``
2859 - Additional Information Servlet
2861 Get Additional Information by id
2862 --------------------------------
2866 GET /v1/catalog/services/{serviceId}/additionalinfo/{labelId}
2871 Returns Additional Inforamtion property
2876 +----------+-------------+--------------------------------------+------------------+
2877 | Type | Name | Description | Schema |
2878 +==========+=============+======================================+==================+
2879 | **Header | **USER\_ID* | | string |
2880 | ** | *\ *optiona | | |
2882 +----------+-------------+--------------------------------------+------------------+
2883 | **Path** | **labelId** | label id | string |
2884 | | \ *required | | |
2886 +----------+-------------+--------------------------------------+------------------+
2887 | **Path** | **serviceId | service id to update with new | string |
2888 | | **\ *requir | property | |
2890 +----------+-------------+--------------------------------------+------------------+
2895 +---------+----------------------------------------------------+----------------+
2896 | HTTP | Description | Schema |
2898 +=========+====================================================+================+
2899 | **200** | fetched additional information | No Content |
2900 +---------+----------------------------------------------------+----------------+
2901 | **400** | Invalid content / Missing content | No Content |
2902 +---------+----------------------------------------------------+----------------+
2903 | **403** | Restricted operation | No Content |
2904 +---------+----------------------------------------------------+----------------+
2905 | **409** | Additional information key already exist | No Content |
2906 +---------+----------------------------------------------------+----------------+
2911 - ``application/json``
2916 - ``application/json``
2921 - Additional Information Servlet
2923 Update Additional Information Label and Value
2924 ---------------------------------------------
2928 PUT /v1/catalog/services/{serviceId}/additionalinfo/{labelId}
2933 Returns updated Additional Inforamtion property
2938 +----------+-------------+--------------------------------------+------------------+
2939 | Type | Name | Description | Schema |
2940 +==========+=============+======================================+==================+
2941 | **Header | **USER\_ID* | | string |
2942 | ** | *\ *optiona | | |
2944 +----------+-------------+--------------------------------------+------------------+
2945 | **Path** | **labelId** | label id | string |
2946 | | \ *required | | |
2948 +----------+-------------+--------------------------------------+------------------+
2949 | **Path** | **serviceId | service id to update with new | string |
2950 | | **\ *requir | property | |
2952 +----------+-------------+--------------------------------------+------------------+
2953 | **Body** | **body**\ * | Additional information key value to | string |
2954 | | required* | be created | |
2955 +----------+-------------+--------------------------------------+------------------+
2960 +---------+----------------------------------------------------+----------------+
2961 | HTTP | Description | Schema |
2963 +=========+====================================================+================+
2964 | **200** | Additional information updated | No Content |
2965 +---------+----------------------------------------------------+----------------+
2966 | **400** | Invalid content / Missing content | No Content |
2967 +---------+----------------------------------------------------+----------------+
2968 | **403** | Restricted operation | No Content |
2969 +---------+----------------------------------------------------+----------------+
2970 | **409** | Additional information key already exist | No Content |
2971 +---------+----------------------------------------------------+----------------+
2976 - ``application/json``
2981 - ``application/json``
2986 - Additional Information Servlet
2988 Create Additional Information Label and Value
2989 ---------------------------------------------
2993 DELETE /v1/catalog/services/{serviceId}/additionalinfo/{labelId}
2998 Returns deleted Additional Inforamtion property
3003 +----------+-------------+--------------------------------------+------------------+
3004 | Type | Name | Description | Schema |
3005 +==========+=============+======================================+==================+
3006 | **Header | **USER\_ID* | | string |
3007 | ** | *\ *optiona | | |
3009 +----------+-------------+--------------------------------------+------------------+
3010 | **Path** | **labelId** | label id | string |
3011 | | \ *required | | |
3013 +----------+-------------+--------------------------------------+------------------+
3014 | **Path** | **serviceId | service id to update with new | string |
3015 | | **\ *requir | property | |
3017 +----------+-------------+--------------------------------------+------------------+
3022 +---------+----------------------------------------------------+----------------+
3023 | HTTP | Description | Schema |
3025 +=========+====================================================+================+
3026 | **200** | Additional information deleted | No Content |
3027 +---------+----------------------------------------------------+----------------+
3028 | **400** | Invalid content / Missing content | No Content |
3029 +---------+----------------------------------------------------+----------------+
3030 | **403** | Restricted operation | No Content |
3031 +---------+----------------------------------------------------+----------------+
3032 | **409** | Additional information key already exist | No Content |
3033 +---------+----------------------------------------------------+----------------+
3038 - ``application/json``
3043 - ``application/json``
3048 - Additional Information Servlet
3055 POST /v1/catalog/services/{serviceId}/artifacts
3060 Returns created ArtifactDefinition
3065 +----------+-------------+--------------------------------------+------------------+
3066 | Type | Name | Description | Schema |
3067 +==========+=============+======================================+==================+
3068 | **Path** | **serviceId | | string |
3069 | | **\ *requir | | |
3071 +----------+-------------+--------------------------------------+------------------+
3072 | **Body** | **body**\ * | json describe the artifact | string |
3074 +----------+-------------+--------------------------------------+------------------+
3079 +---------+----------------------------------------------------+----------------+
3080 | HTTP | Description | Schema |
3082 +=========+====================================================+================+
3083 | **201** | Resource created | No Content |
3084 +---------+----------------------------------------------------+----------------+
3085 | **400** | Invalid content / Missing content | No Content |
3086 +---------+----------------------------------------------------+----------------+
3087 | **403** | Restricted operation | No Content |
3088 +---------+----------------------------------------------------+----------------+
3089 | **409** | Artifact already exist | No Content |
3090 +---------+----------------------------------------------------+----------------+
3095 - ``application/json``
3100 - ``application/json``
3105 - Resource Artifact Servlet
3112 POST /v1/catalog/services/{serviceId}/artifacts/api/{artifactId}
3117 Returns created ArtifactDefinition
3122 +----------+-------------+--------------------------------------+------------------+
3123 | Type | Name | Description | Schema |
3124 +==========+=============+======================================+==================+
3125 | **Header | **Content-M | | string |
3126 | ** | D5**\ *opti | | |
3128 +----------+-------------+--------------------------------------+------------------+
3129 | **Header | **USER\_ID* | | string |
3130 | ** | *\ *optiona | | |
3132 +----------+-------------+--------------------------------------+------------------+
3133 | **Path** | **artifactI | | string |
3134 | | d**\ *requi | | |
3136 +----------+-------------+--------------------------------------+------------------+
3137 | **Path** | **serviceId | | string |
3138 | | **\ *requir | | |
3140 +----------+-------------+--------------------------------------+------------------+
3141 | **Body** | **body**\ * | json describe the artifact | string |
3143 +----------+-------------+--------------------------------------+------------------+
3148 +---------+----------------------------------------------------+----------------+
3149 | HTTP | Description | Schema |
3151 +=========+====================================================+================+
3152 | **200** | Api Artifact Updated | No Content |
3153 +---------+----------------------------------------------------+----------------+
3154 | **400** | Invalid content / Missing content | No Content |
3155 +---------+----------------------------------------------------+----------------+
3156 | **403** | Restricted operation | No Content |
3157 +---------+----------------------------------------------------+----------------+
3162 - ``application/json``
3167 - ``application/json``
3172 - Resource Artifact Servlet
3179 DELETE /v1/catalog/services/{serviceId}/artifacts/api/{artifactId}
3184 Returns Deleted ArtifactDefinition
3189 +------------------+--------------------------+----------------------------------+
3190 | Type | Name | Schema |
3191 +==================+==========================+==================================+
3192 | **Header** | **Content-MD5**\ *option | string |
3194 +------------------+--------------------------+----------------------------------+
3195 | **Header** | **USER\_ID**\ *optional* | string |
3196 +------------------+--------------------------+----------------------------------+
3197 | **Path** | **artifactId**\ *require | string |
3199 +------------------+--------------------------+----------------------------------+
3200 | **Path** | **serviceId**\ *required | string |
3202 +------------------+--------------------------+----------------------------------+
3207 +---------+----------------------------------------------------+----------------+
3208 | HTTP | Description | Schema |
3210 +=========+====================================================+================+
3211 | **204** | Api Artifact deleted | No Content |
3212 +---------+----------------------------------------------------+----------------+
3213 | **403** | Restricted operation | No Content |
3214 +---------+----------------------------------------------------+----------------+
3219 - ``application/json``
3224 - ``application/json``
3229 - Resource Artifact Servlet
3236 POST /v1/catalog/services/{serviceId}/artifacts/{artifactId}
3241 Returns updated artifact
3246 +----------+-------------+--------------------------------------+------------------+
3247 | Type | Name | Description | Schema |
3248 +==========+=============+======================================+==================+
3249 | **Path** | **artifactI | | string |
3250 | | d**\ *requi | | |
3252 +----------+-------------+--------------------------------------+------------------+
3253 | **Path** | **serviceId | | string |
3254 | | **\ *requir | | |
3256 +----------+-------------+--------------------------------------+------------------+
3257 | **Body** | **body**\ * | json describe the artifact | string |
3259 +----------+-------------+--------------------------------------+------------------+
3264 +---------+----------------------------------------------------+----------------+
3265 | HTTP | Description | Schema |
3267 +=========+====================================================+================+
3268 | **201** | Service artifact created | No Content |
3269 +---------+----------------------------------------------------+----------------+
3270 | **400** | Invalid content / Missing content | No Content |
3271 +---------+----------------------------------------------------+----------------+
3272 | **403** | Restricted operation | No Content |
3273 +---------+----------------------------------------------------+----------------+
3278 - ``application/json``
3283 - ``application/json``
3288 - Resource Artifact Servlet
3290 Download service Artifact in Base64
3291 -----------------------------------
3295 GET /v1/catalog/services/{serviceId}/artifacts/{artifactId}
3300 Returns downloaded artifact
3305 +------------------+--------------------------+----------------------------------+
3306 | Type | Name | Schema |
3307 +==================+==========================+==================================+
3308 | **Path** | **artifactId**\ *require | string |
3310 +------------------+--------------------------+----------------------------------+
3311 | **Path** | **serviceId**\ *required | string |
3313 +------------------+--------------------------+----------------------------------+
3318 +---------+----------------------------------------------------+----------------+
3319 | HTTP | Description | Schema |
3321 +=========+====================================================+================+
3322 | **200** | Service artifact downloaded | No Content |
3323 +---------+----------------------------------------------------+----------------+
3324 | **404** | Service/Artifact not found | No Content |
3325 +---------+----------------------------------------------------+----------------+
3330 - ``application/json``
3335 - ``application/json``
3340 - Resource Artifact Servlet
3347 DELETE /v1/catalog/services/{serviceId}/artifacts/{artifactId}
3352 Returns delete artifact
3357 +------------------+--------------------------+----------------------------------+
3358 | Type | Name | Schema |
3359 +==================+==========================+==================================+
3360 | **Path** | **artifactId**\ *require | string |
3362 +------------------+--------------------------+----------------------------------+
3363 | **Path** | **serviceId**\ *required | string |
3365 +------------------+--------------------------+----------------------------------+
3370 +---------+----------------------------------------------------+----------------+
3371 | HTTP | Description | Schema |
3373 +=========+====================================================+================+
3374 | **201** | Service artifact deleted | No Content |
3375 +---------+----------------------------------------------------+----------------+
3376 | **400** | Invalid content / Missing content | No Content |
3377 +---------+----------------------------------------------------+----------------+
3378 | **403** | Restricted operation | No Content |
3379 +---------+----------------------------------------------------+----------------+
3384 - ``application/json``
3389 - ``application/json``
3394 - Resource Artifact Servlet
3396 Update Service Distribution State
3397 ---------------------------------
3401 POST /v1/catalog/services/{serviceId}/distribution-state/{state}
3406 service with the changed distribution status
3411 +----------+-------------+--------------------------------------+------------------+
3412 | Type | Name | Description | Schema |
3413 +==========+=============+======================================+==================+
3414 | **Header | **USER\_ID* | | string |
3415 | ** | *\ *optiona | | |
3417 +----------+-------------+--------------------------------------+------------------+
3418 | **Path** | **serviceId | | string |
3419 | | **\ *requir | | |
3421 +----------+-------------+--------------------------------------+------------------+
3422 | **Path** | **state**\ | | enum (approve, |
3423 | | *required* | | reject) |
3424 +----------+-------------+--------------------------------------+------------------+
3425 | **Body** | **body**\ * | DistributionChangeInfo - get comment | `LifecycleChange |
3426 | | required* | out of body | InfoWithAction < |
3427 | | | | #_lifecyclechang |
3428 | | | | einfowithaction> |
3430 +----------+-------------+--------------------------------------+------------------+
3435 +---------+----------------------------------------------------+----------------+
3436 | HTTP | Description | Schema |
3438 +=========+====================================================+================+
3439 | **200** | Service distribution state changed | No Content |
3440 +---------+----------------------------------------------------+----------------+
3441 | **400** | Invalid content / Missing content | No Content |
3442 +---------+----------------------------------------------------+----------------+
3443 | **403** | Service is not available for distribution | No Content |
3444 +---------+----------------------------------------------------+----------------+
3445 | **404** | Requested service was not found | No Content |
3446 +---------+----------------------------------------------------+----------------+
3447 | **409** | Restricted operation | No Content |
3448 +---------+----------------------------------------------------+----------------+
3449 | **500** | Internal Server Error. Please try again later. | No Content |
3450 +---------+----------------------------------------------------+----------------+
3455 - ``application/json``
3460 - ``application/json``
3467 Mark distribution as deployed
3468 -----------------------------
3472 POST /v1/catalog/services/{serviceId}/distribution/{did}/markDeployed
3477 relevant audit record will be created
3482 +------------------+--------------------------+----------------------------------+
3483 | Type | Name | Schema |
3484 +==================+==========================+==================================+
3485 | **Header** | **USER\_ID**\ *optional* | string |
3486 +------------------+--------------------------+----------------------------------+
3487 | **Path** | **did**\ *required* | string |
3488 +------------------+--------------------------+----------------------------------+
3489 | **Path** | **serviceId**\ *required | string |
3491 +------------------+--------------------------+----------------------------------+
3496 +---------+----------------------------------------------------+----------------+
3497 | HTTP | Description | Schema |
3499 +=========+====================================================+================+
3500 | **200** | Service was marked as deployed | No Content |
3501 +---------+----------------------------------------------------+----------------+
3502 | **400** | Invalid content / Missing content | No Content |
3503 +---------+----------------------------------------------------+----------------+
3504 | **403** | Service is not available | No Content |
3505 +---------+----------------------------------------------------+----------------+
3506 | **404** | Requested service was not found | No Content |
3507 +---------+----------------------------------------------------+----------------+
3508 | **409** | Restricted operation | No Content |
3509 +---------+----------------------------------------------------+----------------+
3510 | **500** | Internal Server Error. Please try again later. | No Content |
3511 +---------+----------------------------------------------------+----------------+
3516 - ``application/json``
3521 - ``application/json``
3528 Activate distribution
3529 ---------------------
3533 POST /v1/catalog/services/{serviceId}/distribution/{env}/activate
3538 activate distribution
3543 +------------------+--------------------------+----------------------------------+
3544 | Type | Name | Schema |
3545 +==================+==========================+==================================+
3546 | **Header** | **USER\_ID**\ *optional* | string |
3547 +------------------+--------------------------+----------------------------------+
3548 | **Path** | **env**\ *required* | string |
3549 +------------------+--------------------------+----------------------------------+
3550 | **Path** | **serviceId**\ *required | string |
3552 +------------------+--------------------------+----------------------------------+
3557 +---------+----------------------------------------------------+----------------+
3558 | HTTP | Description | Schema |
3560 +=========+====================================================+================+
3561 | **200** | OK | No Content |
3562 +---------+----------------------------------------------------+----------------+
3563 | **404** | Requested service was not found | No Content |
3564 +---------+----------------------------------------------------+----------------+
3565 | **409** | Service cannot be distributed due to missing | No Content |
3566 | | deployment artifacts | |
3567 +---------+----------------------------------------------------+----------------+
3568 | **500** | Internal Server Error. Please try again later. | No Content |
3569 +---------+----------------------------------------------------+----------------+
3574 - ``application/json``
3579 - ``application/json``
3586 Update Service Metadata
3587 -----------------------
3591 PUT /v1/catalog/services/{serviceId}/metadata
3596 Returns updated service
3601 +----------+-------------+--------------------------------------+------------------+
3602 | Type | Name | Description | Schema |
3603 +==========+=============+======================================+==================+
3604 | **Header | **USER\_ID* | | string |
3605 | ** | *\ *optiona | | |
3607 +----------+-------------+--------------------------------------+------------------+
3608 | **Path** | **serviceId | | string |
3609 | | **\ *requir | | |
3611 +----------+-------------+--------------------------------------+------------------+
3612 | **Body** | **body**\ * | Service object to be Updated | string |
3614 +----------+-------------+--------------------------------------+------------------+
3619 +---------+----------------------------------------------------+----------------+
3620 | HTTP | Description | Schema |
3622 +=========+====================================================+================+
3623 | **200** | Service Updated | No Content |
3624 +---------+----------------------------------------------------+----------------+
3625 | **400** | Invalid content / Missing content | No Content |
3626 +---------+----------------------------------------------------+----------------+
3627 | **403** | Restricted operation | No Content |
3628 +---------+----------------------------------------------------+----------------+
3633 - ``application/json``
3638 - ``application/json``
3645 POST /v1/catalog/services/{serviceid}/tempUrlToBeDeleted
3646 --------------------------------------------------------
3651 +------------------+--------------------------+----------------------------------+
3652 | Type | Name | Schema |
3653 +==================+==========================+==================================+
3654 | **Header** | **USER\_ID**\ *optional* | string |
3655 +------------------+--------------------------+----------------------------------+
3656 | **Path** | **serviceId**\ *required | string |
3658 +------------------+--------------------------+----------------------------------+
3663 +---------+----------------------------------------------------+----------------+
3664 | HTTP | Description | Schema |
3666 +=========+====================================================+================+
3667 | **200** | OK | No Content |
3668 +---------+----------------------------------------------------+----------------+
3669 | **500** | Internal Server Error. Please try again later. | No Content |
3670 +---------+----------------------------------------------------+----------------+
3675 - ``application/json``
3680 - ``application/json``
3687 DELETE /v1/catalog/services/{servicename}/{version}
3688 ---------------------------------------------------
3693 +------------------+--------------------------+----------------------------------+
3694 | Type | Name | Schema |
3695 +==================+==========================+==================================+
3696 | **Path** | **serviceName**\ *requir | string |
3698 +------------------+--------------------------+----------------------------------+
3699 | **Path** | **version**\ *required* | string |
3700 +------------------+--------------------------+----------------------------------+
3705 +---------+----------------------------------------------------+----------------+
3706 | HTTP | Description | Schema |
3708 +=========+====================================================+================+
3709 | **defau | successful operation | No Content |
3711 +---------+----------------------------------------------------+----------------+
3718 Retrieve Distributions
3719 ----------------------
3723 GET /v1/catalog/services/{serviceUUID}/distribution
3728 Returns list bases on the information extracted from Auditing Records
3729 according to service uuid
3734 +------------------+--------------------------+----------------------------------+
3735 | Type | Name | Schema |
3736 +==================+==========================+==================================+
3737 | **Header** | **USER\_ID**\ *optional* | string |
3738 +------------------+--------------------------+----------------------------------+
3739 | **Path** | **serviceUUID**\ *requir | string |
3741 +------------------+--------------------------+----------------------------------+
3746 +---------+----------------------------------------------------+----------------+
3747 | HTTP | Description | Schema |
3749 +=========+====================================================+================+
3750 | **200** | Service found | No Content |
3751 +---------+----------------------------------------------------+----------------+
3752 | **403** | Restricted operation | No Content |
3753 +---------+----------------------------------------------------+----------------+
3754 | **404** | Service not found | No Content |
3755 +---------+----------------------------------------------------+----------------+
3760 - ``application/json``
3765 - ``application/json``
3770 - Distribution Service Servlet
3772 Create Resource from yaml
3773 -------------------------
3777 POST /v1/catalog/upload/{resourceAuthority}
3782 Returns created resource
3787 +---------+------------+----------------------------------+----------------+---------+
3788 | Type | Name | Description | Schema | Default |
3789 +=========+============+==================================+================+=========+
3790 | **Heade | **USER\_ID | | string | |
3791 | r** | **\ *optio | | | |
3793 +---------+------------+----------------------------------+----------------+---------+
3794 | **Path* | **resource | validValues: normative-resource | enum | |
3795 | * | Authority* | / user-resource | (multipart, | |
3796 | | *\ *requir | | user-resource, | |
3797 | | ed* | | user-resource- | |
3798 | | | | ui-import) | |
3799 +---------+------------+----------------------------------+----------------+---------+
3800 | **Query | **createNe | | boolean | ``"true |
3801 | ** | wVersion** | | | "`` |
3802 | | \ *optiona | | | |
3804 +---------+------------+----------------------------------+----------------+---------+
3805 | **FormD | **resource | resourceMetadata | string | |
3806 | ata** | Metadata** | | | |
3807 | | \ *optiona | | | |
3809 +---------+------------+----------------------------------+----------------+---------+
3810 | **FormD | **resource | FileInputStream | file | |
3811 | ata** | Zip**\ *op | | | |
3813 +---------+------------+----------------------------------+----------------+---------+
3818 +---------+----------------------------------------------------+----------------+
3819 | HTTP | Description | Schema |
3821 +=========+====================================================+================+
3822 | **201** | Resource created | No Content |
3823 +---------+----------------------------------------------------+----------------+
3824 | **400** | Invalid content / Missing content | No Content |
3825 +---------+----------------------------------------------------+----------------+
3826 | **403** | Restricted operation | No Content |
3827 +---------+----------------------------------------------------+----------------+
3828 | **409** | Resource already exist | No Content |
3829 +---------+----------------------------------------------------+----------------+
3834 - ``multipart/form-data``
3839 - ``application/json``
3844 - Resources Catalog Upload
3846 Create Capability Type from yaml
3847 --------------------------------
3851 POST /v1/catalog/uploadType/capability
3856 Returns created Capability Type
3861 +----------+-------------+--------------------------------------+------------------+
3862 | Type | Name | Description | Schema |
3863 +==========+=============+======================================+==================+
3864 | **Header | **USER\_ID* | | string |
3865 | ** | *\ *optiona | | |
3867 +----------+-------------+--------------------------------------+------------------+
3868 | **FormDa | **capabilit | FileInputStream | file |
3869 | ta** | yTypeZip**\ | | |
3870 | | *optional* | | |
3871 +----------+-------------+--------------------------------------+------------------+
3876 +---------+----------------------------------------------------+----------------+
3877 | HTTP | Description | Schema |
3879 +=========+====================================================+================+
3880 | **201** | Capability Type created | No Content |
3881 +---------+----------------------------------------------------+----------------+
3882 | **400** | Invalid content / Missing content | No Content |
3883 +---------+----------------------------------------------------+----------------+
3884 | **403** | Restricted operation | No Content |
3885 +---------+----------------------------------------------------+----------------+
3886 | **409** | Capability Type already exist | No Content |
3887 +---------+----------------------------------------------------+----------------+
3892 - ``multipart/form-data``
3897 - ``application/json``
3902 - Catalog Types Upload
3904 Create Categories from yaml
3905 ---------------------------
3909 POST /v1/catalog/uploadType/categories
3914 Returns created categories
3919 +----------+-------------+--------------------------------------+------------------+
3920 | Type | Name | Description | Schema |
3921 +==========+=============+======================================+==================+
3922 | **Header | **USER\_ID* | | string |
3923 | ** | *\ *optiona | | |
3925 +----------+-------------+--------------------------------------+------------------+
3926 | **FormDa | **categorie | FileInputStream | file |
3927 | ta** | sZip**\ *op | | |
3929 +----------+-------------+--------------------------------------+------------------+
3934 +---------+----------------------------------------------------+----------------+
3935 | HTTP | Description | Schema |
3937 +=========+====================================================+================+
3938 | **201** | Categories created | No Content |
3939 +---------+----------------------------------------------------+----------------+
3940 | **400** | Invalid content / Missing content | No Content |
3941 +---------+----------------------------------------------------+----------------+
3942 | **403** | Restricted operation | No Content |
3943 +---------+----------------------------------------------------+----------------+
3944 | **409** | Category already exist | No Content |
3945 +---------+----------------------------------------------------+----------------+
3950 - ``multipart/form-data``
3955 - ``application/json``
3960 - Catalog Types Upload
3962 Create Categories from yaml
3963 ---------------------------
3967 POST /v1/catalog/uploadType/datatypes
3972 Returns created data types
3977 +----------+-------------+--------------------------------------+------------------+
3978 | Type | Name | Description | Schema |
3979 +==========+=============+======================================+==================+
3980 | **Header | **USER\_ID* | | string |
3981 | ** | *\ *optiona | | |
3983 +----------+-------------+--------------------------------------+------------------+
3984 | **FormDa | **dataTypes | FileInputStream | file |
3985 | ta** | Zip**\ *opt | | |
3987 +----------+-------------+--------------------------------------+------------------+
3992 +---------+----------------------------------------------------+----------------+
3993 | HTTP | Description | Schema |
3995 +=========+====================================================+================+
3996 | **201** | Data types created | No Content |
3997 +---------+----------------------------------------------------+----------------+
3998 | **400** | Invalid content / Missing content | No Content |
3999 +---------+----------------------------------------------------+----------------+
4000 | **403** | Restricted operation | No Content |
4001 +---------+----------------------------------------------------+----------------+
4002 | **409** | Data types already exist | No Content |
4003 +---------+----------------------------------------------------+----------------+
4008 - ``multipart/form-data``
4013 - ``application/json``
4018 - Catalog Types Upload
4020 Create GroupTypes from yaml
4021 ---------------------------
4025 POST /v1/catalog/uploadType/grouptypes
4030 Returns created group types
4035 +----------+-------------+--------------------------------------+------------------+
4036 | Type | Name | Description | Schema |
4037 +==========+=============+======================================+==================+
4038 | **Header | **USER\_ID* | | string |
4039 | ** | *\ *optiona | | |
4041 +----------+-------------+--------------------------------------+------------------+
4042 | **FormDa | **groupType | FileInputStream | file |
4043 | ta** | sZip**\ *op | | |
4045 +----------+-------------+--------------------------------------+------------------+
4050 +---------+----------------------------------------------------+----------------+
4051 | HTTP | Description | Schema |
4053 +=========+====================================================+================+
4054 | **201** | group types created | No Content |
4055 +---------+----------------------------------------------------+----------------+
4056 | **400** | Invalid content / Missing content | No Content |
4057 +---------+----------------------------------------------------+----------------+
4058 | **403** | Restricted operation | No Content |
4059 +---------+----------------------------------------------------+----------------+
4060 | **409** | group types already exist | No Content |
4061 +---------+----------------------------------------------------+----------------+
4066 - ``multipart/form-data``
4071 - ``application/json``
4076 - Catalog Types Upload
4078 Create Interface Lyfecycle Type from yaml
4079 -----------------------------------------
4083 POST /v1/catalog/uploadType/interfaceLifecycle
4088 Returns created Interface Lifecycle Type
4093 +----------+-------------+--------------------------------------+------------------+
4094 | Type | Name | Description | Schema |
4095 +==========+=============+======================================+==================+
4096 | **Header | **USER\_ID* | | string |
4097 | ** | *\ *optiona | | |
4099 +----------+-------------+--------------------------------------+------------------+
4100 | **FormDa | **interface | FileInputStream | file |
4101 | ta** | LifecycleTy | | |
4102 | | peZip**\ *o | | |
4104 +----------+-------------+--------------------------------------+------------------+
4109 +---------+----------------------------------------------------+----------------+
4110 | HTTP | Description | Schema |
4112 +=========+====================================================+================+
4113 | **201** | Interface Lifecycle Type created | No Content |
4114 +---------+----------------------------------------------------+----------------+
4115 | **400** | Invalid content / Missing content | No Content |
4116 +---------+----------------------------------------------------+----------------+
4117 | **403** | Restricted operation | No Content |
4118 +---------+----------------------------------------------------+----------------+
4119 | **409** | Interface Lifecycle Type already exist | No Content |
4120 +---------+----------------------------------------------------+----------------+
4125 - ``multipart/form-data``
4130 - ``application/json``
4135 - Catalog Types Upload
4137 Create PolicyTypes from yaml
4138 ----------------------------
4142 POST /v1/catalog/uploadType/policytypes
4147 Returns created policy types
4152 +----------+-------------+--------------------------------------+------------------+
4153 | Type | Name | Description | Schema |
4154 +==========+=============+======================================+==================+
4155 | **Header | **USER\_ID* | | string |
4156 | ** | *\ *optiona | | |
4158 +----------+-------------+--------------------------------------+------------------+
4159 | **FormDa | **policyTyp | FileInputStream | file |
4160 | ta** | esZip**\ *o | | |
4162 +----------+-------------+--------------------------------------+------------------+
4167 +---------+----------------------------------------------------+----------------+
4168 | HTTP | Description | Schema |
4170 +=========+====================================================+================+
4171 | **201** | policy types created | No Content |
4172 +---------+----------------------------------------------------+----------------+
4173 | **400** | Invalid content / Missing content | No Content |
4174 +---------+----------------------------------------------------+----------------+
4175 | **403** | Restricted operation | No Content |
4176 +---------+----------------------------------------------------+----------------+
4177 | **409** | policy types already exist | No Content |
4178 +---------+----------------------------------------------------+----------------+
4183 - ``multipart/form-data``
4188 - ``application/json``
4193 - Catalog Types Upload
4195 Change Resource lifecycle State
4196 -------------------------------
4200 POST /v1/catalog/{componentCollection}/{componentId}/lifecycleState/{lifecycleOperation}
4205 +----------+-------------+--------------------------------------+------------------+
4206 | Type | Name | Description | Schema |
4207 +==========+=============+======================================+==================+
4208 | **Header | **USER\_ID* | id of user initiating the operation | string |
4209 | ** | *\ *optiona | | |
4211 +----------+-------------+--------------------------------------+------------------+
4212 | **Path** | **component | validValues: resources / services / | enum (resources, |
4213 | | Collection* | products | services, |
4214 | | *\ *require | | products) |
4216 +----------+-------------+--------------------------------------+------------------+
4217 | **Path** | **component | id of component to be changed | string |
4218 | | Id**\ *requ | | |
4220 +----------+-------------+--------------------------------------+------------------+
4221 | **Path** | **lifecycle | | enum (checkout, |
4222 | | Operation** | | undoCheckout, |
4223 | | \ *required | | checkin, |
4224 | | * | | certificationReq |
4226 | | | | startCertificati |
4228 | | | | failCertificatio |
4230 | | | | cancelCertificat |
4233 +----------+-------------+--------------------------------------+------------------+
4234 | **Body** | **body**\ * | LifecycleChangeInfo - relevant for | string |
4235 | | optional* | checkin, failCertification, | |
4236 | | | cancelCertification | |
4237 +----------+-------------+--------------------------------------+------------------+
4242 +---------+----------------------------------------------------+----------------+
4243 | HTTP | Description | Schema |
4245 +=========+====================================================+================+
4246 | **200** | Resource state changed | No Content |
4247 +---------+----------------------------------------------------+----------------+
4248 | **403** | Restricted operation | No Content |
4249 +---------+----------------------------------------------------+----------------+
4250 | **409** | Resource already exist | No Content |
4251 +---------+----------------------------------------------------+----------------+
4256 - ``application/json``
4261 - ``application/json``
4266 - Lifecycle Actions Servlet
4268 Get Component Requirments And Capabilities
4269 ------------------------------------------
4273 GET /v1/catalog/{componentType}/latestversion/notabstract
4278 Returns Requirments And Capabilities according to componentId
4283 +----------+-------------+--------------------------------------+------------------+
4284 | Type | Name | Description | Schema |
4285 +==========+=============+======================================+==================+
4286 | **Header | **USER\_ID* | | string |
4287 | ** | *\ *optiona | | |
4289 +----------+-------------+--------------------------------------+------------------+
4290 | **Path** | **component | | string |
4291 | | Type**\ *re | | |
4293 +----------+-------------+--------------------------------------+------------------+
4294 | **Query* | **internalC | | string |
4295 | * | omponentTyp | | |
4296 | | e**\ *optio | | |
4298 +----------+-------------+--------------------------------------+------------------+
4299 | **Body** | **body**\ * | Consumer Object to be created | < string > array |
4301 +----------+-------------+--------------------------------------+------------------+
4306 +---------+----------------------------------------------------+----------------+
4307 | HTTP | Description | Schema |
4309 +=========+====================================================+================+
4310 | **200** | Component found | No Content |
4311 +---------+----------------------------------------------------+----------------+
4312 | **403** | Restricted operation | No Content |
4313 +---------+----------------------------------------------------+----------------+
4314 | **404** | Component not found | No Content |
4315 +---------+----------------------------------------------------+----------------+
4320 - ``application/json``
4325 - ``application/json``
4332 Get Component uid only
4333 ----------------------
4337 GET /v1/catalog/{componentType}/latestversion/notabstract/metadata
4347 +----------+-------------+--------------------------------------+------------------+
4348 | Type | Name | Description | Schema |
4349 +==========+=============+======================================+==================+
4350 | **Header | **USER\_ID* | | string |
4351 | ** | *\ *optiona | | |
4353 +----------+-------------+--------------------------------------+------------------+
4354 | **Path** | **component | | string |
4355 | | Type**\ *re | | |
4357 +----------+-------------+--------------------------------------+------------------+
4358 | **Query* | **internalC | | string |
4359 | * | omponentTyp | | |
4360 | | e**\ *optio | | |
4362 +----------+-------------+--------------------------------------+------------------+
4363 | **Body** | **body**\ * | uid list | string |
4365 +----------+-------------+--------------------------------------+------------------+
4370 +---------+----------------------------------------------------+----------------+
4371 | HTTP | Description | Schema |
4373 +=========+====================================================+================+
4374 | **200** | Component found | No Content |
4375 +---------+----------------------------------------------------+----------------+
4376 | **403** | Restricted operation | No Content |
4377 +---------+----------------------------------------------------+----------------+
4378 | **404** | Component not found | No Content |
4379 +---------+----------------------------------------------------+----------------+
4384 - ``application/json``
4389 - ``application/json``
4396 Get Component instances
4397 -----------------------
4401 GET /v1/catalog/{componentType}/{componentId}/componentInstances
4406 Returns component instances
4411 +----------+-------------+--------------------------------------+------------------+
4412 | Type | Name | Description | Schema |
4413 +==========+=============+======================================+==================+
4414 | **Header | **USER\_ID* | | string |
4415 | ** | *\ *optiona | | |
4417 +----------+-------------+--------------------------------------+------------------+
4418 | **Path** | **component | | string |
4419 | | Id**\ *requ | | |
4421 +----------+-------------+--------------------------------------+------------------+
4422 | **Path** | **component | | string |
4423 | | Type**\ *re | | |
4425 +----------+-------------+--------------------------------------+------------------+
4426 | **Query* | **searchTex | | string |
4427 | * | t**\ *optio | | |
4429 +----------+-------------+--------------------------------------+------------------+
4430 | **Body** | **body**\ * | uid list | string |
4432 +----------+-------------+--------------------------------------+------------------+
4437 +---------+----------------------------------------------------+----------------+
4438 | HTTP | Description | Schema |
4440 +=========+====================================================+================+
4441 | **200** | Component found | No Content |
4442 +---------+----------------------------------------------------+----------------+
4443 | **403** | Restricted operation | No Content |
4444 +---------+----------------------------------------------------+----------------+
4445 | **404** | Component not found | No Content |
4446 +---------+----------------------------------------------------+----------------+
4451 - ``application/json``
4456 - ``application/json``
4468 GET /v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{inputId}/properties
4473 Returns properties list
4478 +------------------+--------------------------+----------------------------------+
4479 | Type | Name | Schema |
4480 +==================+==========================+==================================+
4481 | **Header** | **USER\_ID**\ *optional* | string |
4482 +------------------+--------------------------+----------------------------------+
4483 | **Path** | **componentId**\ *requir | string |
4485 +------------------+--------------------------+----------------------------------+
4486 | **Path** | **componentType**\ *requ | string |
4488 +------------------+--------------------------+----------------------------------+
4489 | **Path** | **inputId**\ *required* | string |
4490 +------------------+--------------------------+----------------------------------+
4491 | **Path** | **instanceId**\ *require | string |
4493 +------------------+--------------------------+----------------------------------+
4498 +---------+----------------------------------------------------+----------------+
4499 | HTTP | Description | Schema |
4501 +=========+====================================================+================+
4502 | **200** | Component found | No Content |
4503 +---------+----------------------------------------------------+----------------+
4504 | **403** | Restricted operation | No Content |
4505 +---------+----------------------------------------------------+----------------+
4506 | **404** | Component not found | No Content |
4507 +---------+----------------------------------------------------+----------------+
4512 - ``application/json``
4517 - ``application/json``
4529 GET /v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{originComponentUid}/inputs
4539 +------------------+--------------------------+----------------------------------+
4540 | Type | Name | Schema |
4541 +==================+==========================+==================================+
4542 | **Header** | **USER\_ID**\ *optional* | string |
4543 +------------------+--------------------------+----------------------------------+
4544 | **Path** | **componentId**\ *requir | string |
4546 +------------------+--------------------------+----------------------------------+
4547 | **Path** | **componentType**\ *requ | string |
4549 +------------------+--------------------------+----------------------------------+
4550 | **Path** | **instanceId**\ *require | string |
4552 +------------------+--------------------------+----------------------------------+
4553 | **Path** | **originComponentUid**\ | string |
4555 +------------------+--------------------------+----------------------------------+
4560 +---------+----------------------------------------------------+----------------+
4561 | HTTP | Description | Schema |
4563 +=========+====================================================+================+
4564 | **200** | Component found | No Content |
4565 +---------+----------------------------------------------------+----------------+
4566 | **403** | Restricted operation | No Content |
4567 +---------+----------------------------------------------------+----------------+
4568 | **404** | Component not found | No Content |
4569 +---------+----------------------------------------------------+----------------+
4574 - ``application/json``
4579 - ``application/json``
4586 Create inputs on service
4587 ------------------------
4591 POST /v1/catalog/{componentType}/{componentId}/create/inputs
4601 +----------+-------------+--------------------------------------+------------------+
4602 | Type | Name | Description | Schema |
4603 +==========+=============+======================================+==================+
4604 | **Header | **USER\_ID* | | string |
4605 | ** | *\ *optiona | | |
4607 +----------+-------------+--------------------------------------+------------------+
4608 | **Path** | **component | | string |
4609 | | Id**\ *requ | | |
4611 +----------+-------------+--------------------------------------+------------------+
4612 | **Path** | **component | | string |
4613 | | Type**\ *re | | |
4615 +----------+-------------+--------------------------------------+------------------+
4616 | **Body** | **body**\ * | ComponentIns Inputs Object to be | string |
4617 | | required* | created | |
4618 +----------+-------------+--------------------------------------+------------------+
4623 +---------+----------------------------------------------------+----------------+
4624 | HTTP | Description | Schema |
4626 +=========+====================================================+================+
4627 | **200** | Component found | No Content |
4628 +---------+----------------------------------------------------+----------------+
4629 | **403** | Restricted operation | No Content |
4630 +---------+----------------------------------------------------+----------------+
4631 | **404** | Component not found | No Content |
4632 +---------+----------------------------------------------------+----------------+
4637 - ``application/json``
4642 - ``application/json``
4649 Delete input from service
4650 -------------------------
4654 DELETE /v1/catalog/{componentType}/{componentId}/delete/{inputId}/input
4659 Delete service input
4664 +----------+-------------+--------------------------------------+------------------+
4665 | Type | Name | Description | Schema |
4666 +==========+=============+======================================+==================+
4667 | **Header | **USER\_ID* | | string |
4668 | ** | *\ *optiona | | |
4670 +----------+-------------+--------------------------------------+------------------+
4671 | **Path** | **component | | string |
4672 | | Id**\ *requ | | |
4674 +----------+-------------+--------------------------------------+------------------+
4675 | **Path** | **component | | string |
4676 | | Type**\ *re | | |
4678 +----------+-------------+--------------------------------------+------------------+
4679 | **Path** | **inputId** | | string |
4680 | | \ *required | | |
4682 +----------+-------------+--------------------------------------+------------------+
4683 | **Body** | **body**\ * | Service Input to be deleted | string |
4685 +----------+-------------+--------------------------------------+------------------+
4690 +---------+----------------------------------------------------+----------------+
4691 | HTTP | Description | Schema |
4693 +=========+====================================================+================+
4694 | **200** | Input deleted | No Content |
4695 +---------+----------------------------------------------------+----------------+
4696 | **403** | Restricted operation | No Content |
4697 +---------+----------------------------------------------------+----------------+
4698 | **404** | Input not found | No Content |
4699 +---------+----------------------------------------------------+----------------+
4704 - ``application/json``
4709 - ``application/json``
4721 GET /v1/catalog/{componentType}/{componentId}/filteredDataByParams
4726 Returns resource according to resourceId
4731 +------------------+--------------------------+----------------------------------+
4732 | Type | Name | Schema |
4733 +==================+==========================+==================================+
4734 | **Header** | **USER\_ID**\ *optional* | string |
4735 +------------------+--------------------------+----------------------------------+
4736 | **Path** | **componentId**\ *requir | string |
4738 +------------------+--------------------------+----------------------------------+
4739 | **Path** | **componentType**\ *requ | string |
4741 +------------------+--------------------------+----------------------------------+
4742 | **Query** | **include**\ *optional* | < string > array(multi) |
4743 +------------------+--------------------------+----------------------------------+
4748 +---------+----------------------------------------------------+----------------+
4749 | HTTP | Description | Schema |
4751 +=========+====================================================+================+
4752 | **200** | Resource found | No Content |
4753 +---------+----------------------------------------------------+----------------+
4754 | **403** | Restricted operation | No Content |
4755 +---------+----------------------------------------------------+----------------+
4756 | **404** | Resource not found | No Content |
4757 +---------+----------------------------------------------------+----------------+
4762 - ``application/json``
4767 - ``application/json``
4774 Retrieve properties belonging to component instances of specific component by name and optionally resource type
4775 ---------------------------------------------------------------------------------------------------------------
4779 GET /v1/catalog/{componentType}/{componentId}/filteredproperties/{propertyNameFragment}
4784 Returns properties belonging to component instances of specific
4785 component by name and optionally resource type
4790 +------------------+--------------------------+----------------------------------+
4791 | Type | Name | Schema |
4792 +==================+==========================+==================================+
4793 | **Header** | **USER\_ID**\ *optional* | string |
4794 +------------------+--------------------------+----------------------------------+
4795 | **Path** | **componentId**\ *requir | string |
4797 +------------------+--------------------------+----------------------------------+
4798 | **Path** | **componentType**\ *requ | string |
4800 +------------------+--------------------------+----------------------------------+
4801 | **Path** | **propertyNameFragment** | string |
4802 | | \ *required* | |
4803 +------------------+--------------------------+----------------------------------+
4804 | **Query** | **resourceType**\ *optio | < string > array(multi) |
4806 +------------------+--------------------------+----------------------------------+
4811 +---------+----------------------------------------------------+----------------+
4812 | HTTP | Description | Schema |
4814 +=========+====================================================+================+
4815 | **200** | Component found | No Content |
4816 +---------+----------------------------------------------------+----------------+
4817 | **403** | Restricted operation | No Content |
4818 +---------+----------------------------------------------------+----------------+
4819 | **404** | Component not found | No Content |
4820 +---------+----------------------------------------------------+----------------+
4825 - ``application/json``
4830 - ``application/json``
4842 GET /v1/catalog/{componentType}/{componentId}/inputs/{inputId}
4852 +------------------+--------------------------+----------------------------------+
4853 | Type | Name | Schema |
4854 +==================+==========================+==================================+
4855 | **Header** | **USER\_ID**\ *optional* | string |
4856 +------------------+--------------------------+----------------------------------+
4857 | **Path** | **componentId**\ *requir | string |
4859 +------------------+--------------------------+----------------------------------+
4860 | **Path** | **componentType**\ *requ | string |
4862 +------------------+--------------------------+----------------------------------+
4863 | **Path** | **inputId**\ *required* | string |
4864 +------------------+--------------------------+----------------------------------+
4869 +---------+----------------------------------------------------+----------------+
4870 | HTTP | Description | Schema |
4872 +=========+====================================================+================+
4873 | **200** | Component found | No Content |
4874 +---------+----------------------------------------------------+----------------+
4875 | **403** | Restricted operation | No Content |
4876 +---------+----------------------------------------------------+----------------+
4877 | **404** | Component not found | No Content |
4878 +---------+----------------------------------------------------+----------------+
4883 - ``application/json``
4888 - ``application/json``
4900 GET /v1/catalog/{componentType}/{componentId}/inputs/{inputId}/inputs
4910 +------------------+--------------------------+----------------------------------+
4911 | Type | Name | Schema |
4912 +==================+==========================+==================================+
4913 | **Header** | **USER\_ID**\ *optional* | string |
4914 +------------------+--------------------------+----------------------------------+
4915 | **Path** | **componentId**\ *requir | string |
4917 +------------------+--------------------------+----------------------------------+
4918 | **Path** | **componentType**\ *requ | string |
4920 +------------------+--------------------------+----------------------------------+
4921 | **Path** | **inputId**\ *required* | string |
4922 +------------------+--------------------------+----------------------------------+
4927 +---------+----------------------------------------------------+----------------+
4928 | HTTP | Description | Schema |
4930 +=========+====================================================+================+
4931 | **200** | Component found | No Content |
4932 +---------+----------------------------------------------------+----------------+
4933 | **403** | Restricted operation | No Content |
4934 +---------+----------------------------------------------------+----------------+
4935 | **404** | Component not found | No Content |
4936 +---------+----------------------------------------------------+----------------+
4941 - ``application/json``
4946 - ``application/json``
4953 Get Component Requirments And Capabilities
4954 ------------------------------------------
4958 GET /v1/catalog/{componentType}/{componentId}/requirmentsCapabilities
4963 Returns Requirements And Capabilities according to componentId
4968 +------------------+--------------------------+----------------------------------+
4969 | Type | Name | Schema |
4970 +==================+==========================+==================================+
4971 | **Header** | **USER\_ID**\ *optional* | string |
4972 +------------------+--------------------------+----------------------------------+
4973 | **Path** | **componentId**\ *requir | string |
4975 +------------------+--------------------------+----------------------------------+
4976 | **Path** | **componentType**\ *requ | string |
4978 +------------------+--------------------------+----------------------------------+
4983 +---------+----------------------------------------------------+----------------+
4984 | HTTP | Description | Schema |
4986 +=========+====================================================+================+
4987 | **200** | Component found | No Content |
4988 +---------+----------------------------------------------------+----------------+
4989 | **403** | Restricted operation | No Content |
4990 +---------+----------------------------------------------------+----------------+
4991 | **404** | Component not found | No Content |
4992 +---------+----------------------------------------------------+----------------+
4997 - ``application/json``
5002 - ``application/json``
5009 Validate Component Conformance Level
5010 ------------------------------------
5014 GET /v1/catalog/{componentType}/{componentUuid}/conformanceLevelValidation
5019 Returns the result according to conformance level in BE config
5024 +------------------+--------------------------+----------------------------------+
5025 | Type | Name | Schema |
5026 +==================+==========================+==================================+
5027 | **Header** | **USER\_ID**\ *optional* | string |
5028 +------------------+--------------------------+----------------------------------+
5029 | **Path** | **componentType**\ *requ | string |
5031 +------------------+--------------------------+----------------------------------+
5032 | **Path** | **componentUuid**\ *requ | string |
5034 +------------------+--------------------------+----------------------------------+
5039 +---------+----------------------------------------------------+----------------+
5040 | HTTP | Description | Schema |
5042 +=========+====================================================+================+
5043 | **200** | Component found | No Content |
5044 +---------+----------------------------------------------------+----------------+
5045 | **403** | Restricted operation | No Content |
5046 +---------+----------------------------------------------------+----------------+
5047 | **404** | Component not found | No Content |
5048 +---------+----------------------------------------------------+----------------+
5053 - ``application/json``
5058 - ``application/json``
5065 Get component Artifacts
5066 -----------------------
5070 GET /v1/catalog/{containerComponentType}/{componentId}/artifactsByType/{artifactGroupType}
5080 +----------+-------------+--------------------------------------+------------------+
5081 | Type | Name | Description | Schema |
5082 +==========+=============+======================================+==================+
5083 | **Path** | **artifactG | | string |
5084 | | roupType**\ | | |
5085 | | *required* | | |
5086 +----------+-------------+--------------------------------------+------------------+
5087 | **Path** | **component | | string |
5088 | | Id**\ *requ | | |
5090 +----------+-------------+--------------------------------------+------------------+
5091 | **Path** | **container | valid values: resources / services | enum (resources, |
5092 | | ComponentTy | | services) |
5093 | | pe**\ *requ | | |
5095 +----------+-------------+--------------------------------------+------------------+
5100 +---------+----------------------------------------------------+----------------+
5101 | HTTP | Description | Schema |
5103 +=========+====================================================+================+
5104 | **200** | Component artifacts | No Content |
5105 +---------+----------------------------------------------------+----------------+
5106 | **404** | Resource/Artifact not found | No Content |
5107 +---------+----------------------------------------------------+----------------+
5112 - ``application/json``
5117 - ``application/json``
5122 - Resource Artifact Servlet
5129 GET /v1/catalog/{containerComponentType}/{componentId}/groups/{groupId}
5134 Returns artifacts metadata according to groupId
5139 +------------------+--------------------------+----------------------------------+
5140 | Type | Name | Schema |
5141 +==================+==========================+==================================+
5142 | **Header** | **USER\_ID**\ *optional* | string |
5143 +------------------+--------------------------+----------------------------------+
5144 | **Path** | **componentId**\ *requir | string |
5146 +------------------+--------------------------+----------------------------------+
5147 | **Path** | **containerComponentType | string |
5148 | | **\ *required* | |
5149 +------------------+--------------------------+----------------------------------+
5150 | **Path** | **groupId**\ *required* | string |
5151 +------------------+--------------------------+----------------------------------+
5156 +---------+----------------------------------------------------+----------------+
5157 | HTTP | Description | Schema |
5159 +=========+====================================================+================+
5160 | **200** | group found | No Content |
5161 +---------+----------------------------------------------------+----------------+
5162 | **403** | Restricted operation | No Content |
5163 +---------+----------------------------------------------------+----------------+
5164 | **404** | Group not found | No Content |
5165 +---------+----------------------------------------------------+----------------+
5170 - ``application/json``
5175 - ``application/json``
5180 - Resource Group Servlet
5182 Update Group Metadata
5183 ---------------------
5187 PUT /v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/metadata
5192 Returns updated group definition
5197 +----------+-------------+--------------------------------------+------------------+
5198 | Type | Name | Description | Schema |
5199 +==========+=============+======================================+==================+
5200 | **Header | **USER\_ID* | | string |
5201 | ** | *\ *optiona | | |
5203 +----------+-------------+--------------------------------------+------------------+
5204 | **Path** | **component | | string |
5205 | | Id**\ *requ | | |
5207 +----------+-------------+--------------------------------------+------------------+
5208 | **Path** | **container | | string |
5209 | | ComponentTy | | |
5210 | | pe**\ *requ | | |
5212 +----------+-------------+--------------------------------------+------------------+
5213 | **Path** | **groupUniq | | string |
5214 | | ueId**\ *re | | |
5216 +----------+-------------+--------------------------------------+------------------+
5217 | **Body** | **body**\ * | Service object to be Updated | string |
5219 +----------+-------------+--------------------------------------+------------------+
5224 +---------+----------------------------------------------------+----------------+
5225 | HTTP | Description | Schema |
5227 +=========+====================================================+================+
5228 | **200** | Group Updated | No Content |
5229 +---------+----------------------------------------------------+----------------+
5230 | **400** | Invalid content / Missing content | No Content |
5231 +---------+----------------------------------------------------+----------------+
5232 | **403** | Restricted operation | No Content |
5233 +---------+----------------------------------------------------+----------------+
5238 - ``application/json``
5243 - ``application/json``
5248 - Resource Group Servlet
5250 Updates List of properties on a group (only values)
5251 ---------------------------------------------------
5255 PUT /v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/properties
5260 Returns updated list of properties
5265 +----------+-------------+--------------------------------------+------------------+
5266 | Type | Name | Description | Schema |
5267 +==========+=============+======================================+==================+
5268 | **Header | **USER\_ID* | | string |
5269 | ** | *\ *optiona | | |
5271 +----------+-------------+--------------------------------------+------------------+
5272 | **Path** | **component | | string |
5273 | | Id**\ *requ | | |
5275 +----------+-------------+--------------------------------------+------------------+
5276 | **Path** | **container | | string |
5277 | | ComponentTy | | |
5278 | | pe**\ *requ | | |
5280 +----------+-------------+--------------------------------------+------------------+
5281 | **Path** | **groupUniq | | string |
5282 | | ueId**\ *re | | |
5284 +----------+-------------+--------------------------------------+------------------+
5285 | **Body** | **body**\ * | Service object to be Updated | string |
5287 +----------+-------------+--------------------------------------+------------------+
5292 +---------+----------------------------------------------------+----------------+
5293 | HTTP | Description | Schema |
5295 +=========+====================================================+================+
5296 | **200** | Group Updated | No Content |
5297 +---------+----------------------------------------------------+----------------+
5298 | **400** | Invalid content / Missing content | No Content |
5299 +---------+----------------------------------------------------+----------------+
5300 | **403** | Restricted operation | No Content |
5301 +---------+----------------------------------------------------+----------------+
5306 - ``application/json``
5311 - ``application/json``
5316 - Resource Group Servlet
5318 Create ComponentInstance
5319 ------------------------
5323 POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance
5328 Returns created ComponentInstance
5333 +----------+-------------+--------------------------------------+------------------+
5334 | Type | Name | Description | Schema |
5335 +==========+=============+======================================+==================+
5336 | **Header | **USER\_ID* | USER\_ID of modifier user | string |
5337 | ** | *\ *require | | |
5339 +----------+-------------+--------------------------------------+------------------+
5340 | **Path** | **component | | string |
5341 | | Id**\ *requ | | |
5343 +----------+-------------+--------------------------------------+------------------+
5344 | **Path** | **container | valid values: resources / services | enum (resources, |
5345 | | ComponentTy | | services) |
5346 | | pe**\ *requ | | |
5348 +----------+-------------+--------------------------------------+------------------+
5349 | **Body** | **body**\ * | RI object to be created | string |
5351 +----------+-------------+--------------------------------------+------------------+
5356 +---------+----------------------------------------------------+----------------+
5357 | HTTP | Description | Schema |
5359 +=========+====================================================+================+
5360 | **201** | Component created | No Content |
5361 +---------+----------------------------------------------------+----------------+
5362 | **400** | Invalid content / Missing content | No Content |
5363 +---------+----------------------------------------------------+----------------+
5364 | **403** | Restricted operation | No Content |
5365 +---------+----------------------------------------------------+----------------+
5366 | **409** | Component instance already exist | No Content |
5367 +---------+----------------------------------------------------+----------------+
5372 - ``application/json``
5377 - ``application/json``
5382 - Resource Instance Servlet
5389 POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/associate
5394 Returns created RelationshipInfo
5399 +----------+-------------+--------------------------------------+------------------+
5400 | Type | Name | Description | Schema |
5401 +==========+=============+======================================+==================+
5402 | **Header | **USER\_ID* | | string |
5403 | ** | *\ *optiona | | |
5405 +----------+-------------+--------------------------------------+------------------+
5406 | **Path** | **component | unique id of the container component | string |
5407 | | Id**\ *requ | | |
5409 +----------+-------------+--------------------------------------+------------------+
5410 | **Path** | **container | allowed values are resources | enum (resources, |
5411 | | ComponentTy | /services / products | services, |
5412 | | pe**\ *requ | | products) |
5414 +----------+-------------+--------------------------------------+------------------+
5415 | **Body** | **body**\ * | RelationshipInfo | string |
5417 +----------+-------------+--------------------------------------+------------------+
5422 +---------+----------------------------------------------------+----------------+
5423 | HTTP | Description | Schema |
5425 +=========+====================================================+================+
5426 | **201** | Relationship created | No Content |
5427 +---------+----------------------------------------------------+----------------+
5428 | **400** | Invalid content / Missing content | No Content |
5429 +---------+----------------------------------------------------+----------------+
5430 | **403** | Missing information | No Content |
5431 +---------+----------------------------------------------------+----------------+
5432 | **409** | Relationship already exist | No Content |
5433 +---------+----------------------------------------------------+----------------+
5438 - ``application/json``
5443 - ``application/json``
5448 - Resource Instance Servlet
5450 Create RI and associate RI to RI
5451 --------------------------------
5455 POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/createAndAssociate
5460 Returns created RI and RelationshipInfo
5465 +----------+-------------+--------------------------------------+------------------+
5466 | Type | Name | Description | Schema |
5467 +==========+=============+======================================+==================+
5468 | **Path** | **component | | string |
5469 | | Id**\ *requ | | |
5471 +----------+-------------+--------------------------------------+------------------+
5472 | **Path** | **container | valid values: resources / services | enum (resources, |
5473 | | ComponentTy | | services) |
5474 | | pe**\ *requ | | |
5476 +----------+-------------+--------------------------------------+------------------+
5481 +---------+----------------------------------------------------+----------------+
5482 | HTTP | Description | Schema |
5484 +=========+====================================================+================+
5485 | **201** | RI created | No Content |
5486 +---------+----------------------------------------------------+----------------+
5487 | **400** | Invalid content / Missing content | No Content |
5488 +---------+----------------------------------------------------+----------------+
5489 | **403** | Restricted operation | No Content |
5490 +---------+----------------------------------------------------+----------------+
5491 | **409** | Relationship already exist | No Content |
5492 +---------+----------------------------------------------------+----------------+
5497 - ``application/json``
5502 - ``application/json``
5507 - Resource Instance Servlet
5509 Dissociate RI from RI
5510 ---------------------
5514 PUT /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/dissociate
5519 Returns deleted RelationshipInfo
5524 +----------+-------------+--------------------------------------+------------------+
5525 | Type | Name | Description | Schema |
5526 +==========+=============+======================================+==================+
5527 | **Header | **USER\_ID* | | string |
5528 | ** | *\ *optiona | | |
5530 +----------+-------------+--------------------------------------+------------------+
5531 | **Path** | **component | unique id of the container component | string |
5532 | | Id**\ *requ | | |
5534 +----------+-------------+--------------------------------------+------------------+
5535 | **Path** | **container | allowed values are resources | enum (resources, |
5536 | | ComponentTy | /services / products | services, |
5537 | | pe**\ *requ | | products) |
5539 +----------+-------------+--------------------------------------+------------------+
5540 | **Body** | **body**\ * | RelationshipInfo | string |
5542 +----------+-------------+--------------------------------------+------------------+
5547 +---------+----------------------------------------------------+----------------+
5548 | HTTP | Description | Schema |
5550 +=========+====================================================+================+
5551 | **201** | Relationship deleted | No Content |
5552 +---------+----------------------------------------------------+----------------+
5553 | **400** | Invalid content / Missing content | No Content |
5554 +---------+----------------------------------------------------+----------------+
5555 | **403** | Missing information | No Content |
5556 +---------+----------------------------------------------------+----------------+
5561 - ``application/json``
5566 - ``application/json``
5571 - Resource Instance Servlet
5573 Update resource instance multiple component
5574 -------------------------------------------
5578 POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/multipleComponentInstance
5583 Returns updated resource instance
5588 +----------+-------------+--------------------------------------+------------------+
5589 | Type | Name | Description | Schema |
5590 +==========+=============+======================================+==================+
5591 | **Path** | **component | | string |
5592 | | Id**\ *requ | | |
5594 +----------+-------------+--------------------------------------+------------------+
5595 | **Path** | **container | valid values: resources / services / | enum (resources, |
5596 | | ComponentTy | products | services, |
5597 | | pe**\ *requ | | products) |
5599 +----------+-------------+--------------------------------------+------------------+
5600 | **Body** | **body**\ * | Component Instance JSON Array | string |
5602 +----------+-------------+--------------------------------------+------------------+
5607 +---------+----------------------------------------------------+----------------+
5608 | HTTP | Description | Schema |
5610 +=========+====================================================+================+
5611 | **200** | Resource instance updated | No Content |
5612 +---------+----------------------------------------------------+----------------+
5613 | **400** | Invalid content / Missing content | No Content |
5614 +---------+----------------------------------------------------+----------------+
5615 | **403** | Restricted operation | No Content |
5616 +---------+----------------------------------------------------+----------------+
5621 - ``application/json``
5626 - ``application/json``
5631 - Resource Instance Servlet
5633 Update resource instance
5634 ------------------------
5638 POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}
5643 Returns updated resource instance
5648 +----------+-------------+--------------------------------------+------------------+
5649 | Type | Name | Description | Schema |
5650 +==========+=============+======================================+==================+
5651 | **Path** | **component | | string |
5652 | | Id**\ *requ | | |
5654 +----------+-------------+--------------------------------------+------------------+
5655 | **Path** | **component | | string |
5656 | | InstanceId* | | |
5657 | | *\ *require | | |
5659 +----------+-------------+--------------------------------------+------------------+
5660 | **Path** | **container | valid values: resources / services / | enum (resources, |
5661 | | ComponentTy | products | services, |
5662 | | pe**\ *requ | | products) |
5664 +----------+-------------+--------------------------------------+------------------+
5669 +---------+----------------------------------------------------+----------------+
5670 | HTTP | Description | Schema |
5672 +=========+====================================================+================+
5673 | **200** | Resource instance updated | No Content |
5674 +---------+----------------------------------------------------+----------------+
5675 | **400** | Invalid content / Missing content | No Content |
5676 +---------+----------------------------------------------------+----------------+
5677 | **403** | Restricted operation | No Content |
5678 +---------+----------------------------------------------------+----------------+
5683 - ``application/json``
5688 - ``application/json``
5693 - Resource Instance Servlet
5695 Load Resource Instance artifact payload
5696 ---------------------------------------
5700 POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts
5705 Returns updated artifact
5710 +----------+-------------+--------------------------------------+------------------+
5711 | Type | Name | Description | Schema |
5712 +==========+=============+======================================+==================+
5713 | **Header | **Content-M | | string |
5714 | ** | D5**\ *opti | | |
5716 +----------+-------------+--------------------------------------+------------------+
5717 | **Header | **USER\_ID* | | string |
5718 | ** | *\ *optiona | | |
5720 +----------+-------------+--------------------------------------+------------------+
5721 | **Path** | **component | | string |
5722 | | Id**\ *requ | | |
5724 +----------+-------------+--------------------------------------+------------------+
5725 | **Path** | **component | | string |
5726 | | InstanceId* | | |
5727 | | *\ *require | | |
5729 +----------+-------------+--------------------------------------+------------------+
5730 | **Path** | **container | valid values: resources / services | enum (resources, |
5731 | | ComponentTy | | services) |
5732 | | pe**\ *requ | | |
5734 +----------+-------------+--------------------------------------+------------------+
5735 | **Body** | **body**\ * | json describe the artifact | string |
5737 +----------+-------------+--------------------------------------+------------------+
5742 +---------+----------------------------------------------------+----------------+
5743 | HTTP | Description | Schema |
5745 +=========+====================================================+================+
5746 | **200** | Artifact updated | No Content |
5747 +---------+----------------------------------------------------+----------------+
5748 | **400** | Invalid content / Missing content | No Content |
5749 +---------+----------------------------------------------------+----------------+
5750 | **403** | Restricted operation | No Content |
5751 +---------+----------------------------------------------------+----------------+
5756 - ``application/json``
5761 - ``application/json``
5766 - Resource Artifact Servlet
5768 Delete Resource Instance artifact
5769 ---------------------------------
5773 POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}
5778 Returns deleted artifact
5783 +----------+-------------+--------------------------------------+------------------+
5784 | Type | Name | Description | Schema |
5785 +==========+=============+======================================+==================+
5786 | **Header | **Content-M | | string |
5787 | ** | D5**\ *opti | | |
5789 +----------+-------------+--------------------------------------+------------------+
5790 | **Header | **USER\_ID* | | string |
5791 | ** | *\ *optiona | | |
5793 +----------+-------------+--------------------------------------+------------------+
5794 | **Path** | **artifactI | | string |
5795 | | d**\ *requi | | |
5797 +----------+-------------+--------------------------------------+------------------+
5798 | **Path** | **component | | string |
5799 | | Id**\ *requ | | |
5801 +----------+-------------+--------------------------------------+------------------+
5802 | **Path** | **component | | string |
5803 | | InstanceId* | | |
5804 | | *\ *require | | |
5806 +----------+-------------+--------------------------------------+------------------+
5807 | **Path** | **container | valid values: resources / services | enum (resources, |
5808 | | ComponentTy | | services) |
5809 | | pe**\ *requ | | |
5811 +----------+-------------+--------------------------------------+------------------+
5812 | **Body** | **body**\ * | json describe the artifact | string |
5814 +----------+-------------+--------------------------------------+------------------+
5819 +---------+----------------------------------------------------+----------------+
5820 | HTTP | Description | Schema |
5822 +=========+====================================================+================+
5823 | **200** | Artifact updated | No Content |
5824 +---------+----------------------------------------------------+----------------+
5825 | **400** | Invalid content / Missing content | No Content |
5826 +---------+----------------------------------------------------+----------------+
5827 | **403** | Restricted operation | No Content |
5828 +---------+----------------------------------------------------+----------------+
5833 - ``application/json``
5838 - ``application/json``
5843 - Resource Artifact Servlet
5845 Update Resource Instance HEAT\_ENV parameters
5846 ---------------------------------------------
5850 POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}/heatParams
5855 Returns updated artifact
5860 +----------+-------------+--------------------------------------+------------------+
5861 | Type | Name | Description | Schema |
5862 +==========+=============+======================================+==================+
5863 | **Path** | **artifactI | | string |
5864 | | d**\ *requi | | |
5866 +----------+-------------+--------------------------------------+------------------+
5867 | **Path** | **component | | string |
5868 | | Id**\ *requ | | |
5870 +----------+-------------+--------------------------------------+------------------+
5871 | **Path** | **component | | string |
5872 | | InstanceId* | | |
5873 | | *\ *require | | |
5875 +----------+-------------+--------------------------------------+------------------+
5876 | **Path** | **container | valid values: resources / services | enum (resources, |
5877 | | ComponentTy | | services) |
5878 | | pe**\ *requ | | |
5880 +----------+-------------+--------------------------------------+------------------+
5881 | **Body** | **body**\ * | json describe the artifact | string |
5883 +----------+-------------+--------------------------------------+------------------+
5888 +---------+----------------------------------------------------+----------------+
5889 | HTTP | Description | Schema |
5891 +=========+====================================================+================+
5892 | **200** | Artifact updated | No Content |
5893 +---------+----------------------------------------------------+----------------+
5894 | **400** | Invalid content / Missing content | No Content |
5895 +---------+----------------------------------------------------+----------------+
5896 | **403** | Restricted operation | No Content |
5897 +---------+----------------------------------------------------+----------------+
5902 - ``application/json``
5907 - ``application/json``
5912 - Resource Artifact Servlet
5914 Update resource instance attribute
5915 ----------------------------------
5919 POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/attribute
5924 Returns updated resource instance attribute
5929 +----------+-------------+--------------------------------------+------------------+
5930 | Type | Name | Description | Schema |
5931 +==========+=============+======================================+==================+
5932 | **Header | **USER\_ID* | id of user initiating the operation | string |
5933 | ** | *\ *optiona | | |
5935 +----------+-------------+--------------------------------------+------------------+
5936 | **Path** | **component | service id | string |
5937 | | Id**\ *requ | | |
5939 +----------+-------------+--------------------------------------+------------------+
5940 | **Path** | **component | resource instance id | string |
5941 | | InstanceId* | | |
5942 | | *\ *require | | |
5944 +----------+-------------+--------------------------------------+------------------+
5945 | **Path** | **container | valid values: resources / services | enum (resources, |
5946 | | ComponentTy | | services) |
5947 | | pe**\ *requ | | |
5949 +----------+-------------+--------------------------------------+------------------+
5954 +---------+----------------------------------------------------+----------------+
5955 | HTTP | Description | Schema |
5957 +=========+====================================================+================+
5958 | **201** | Resource instance created | No Content |
5959 +---------+----------------------------------------------------+----------------+
5960 | **400** | Invalid content / Missing content | No Content |
5961 +---------+----------------------------------------------------+----------------+
5962 | **403** | Restricted operation | No Content |
5963 +---------+----------------------------------------------------+----------------+
5968 - ``application/json``
5973 - ``application/json``
5978 - Resource Instance Servlet
5980 Update resource instance
5981 ------------------------
5985 POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/changeVersion
5990 Returns updated resource instance
5995 +----------+-------------+--------------------------------------+------------------+
5996 | Type | Name | Description | Schema |
5997 +==========+=============+======================================+==================+
5998 | **Path** | **component | | string |
5999 | | Id**\ *requ | | |
6001 +----------+-------------+--------------------------------------+------------------+
6002 | **Path** | **component | | string |
6003 | | InstanceId* | | |
6004 | | *\ *require | | |
6006 +----------+-------------+--------------------------------------+------------------+
6007 | **Path** | **container | valid values: resources / services | enum (resources, |
6008 | | ComponentTy | | services) |
6009 | | pe**\ *requ | | |
6011 +----------+-------------+--------------------------------------+------------------+
6016 +---------+----------------------------------------------------+----------------+
6017 | HTTP | Description | Schema |
6019 +=========+====================================================+================+
6020 | **201** | Resource instance created | No Content |
6021 +---------+----------------------------------------------------+----------------+
6022 | **400** | Invalid content / Missing content | No Content |
6023 +---------+----------------------------------------------------+----------------+
6024 | **403** | Restricted operation | No Content |
6025 +---------+----------------------------------------------------+----------------+
6030 - ``application/json``
6035 - ``application/json``
6040 - Resource Instance Servlet
6047 GET /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstId}
6052 Returns artifacts metadata according to groupInstId
6057 +------------------+--------------------------+----------------------------------+
6058 | Type | Name | Schema |
6059 +==================+==========================+==================================+
6060 | **Header** | **USER\_ID**\ *optional* | string |
6061 +------------------+--------------------------+----------------------------------+
6062 | **Path** | **componentId**\ *requir | string |
6064 +------------------+--------------------------+----------------------------------+
6065 | **Path** | **componentInstanceId**\ | string |
6067 +------------------+--------------------------+----------------------------------+
6068 | **Path** | **containerComponentType | string |
6069 | | **\ *required* | |
6070 +------------------+--------------------------+----------------------------------+
6071 | **Path** | **groupInstId**\ *requir | string |
6073 +------------------+--------------------------+----------------------------------+
6078 +---------+----------------------------------------------------+----------------+
6079 | HTTP | Description | Schema |
6081 +=========+====================================================+================+
6082 | **200** | group found | No Content |
6083 +---------+----------------------------------------------------+----------------+
6084 | **403** | Restricted operation | No Content |
6085 +---------+----------------------------------------------------+----------------+
6086 | **404** | Group not found | No Content |
6087 +---------+----------------------------------------------------+----------------+
6092 - ``application/json``
6097 - ``application/json``
6102 - Resource Instance Servlet
6104 Update resource instance property
6105 ---------------------------------
6109 POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}/property
6114 Returns updated resource instance property
6119 +----------+-------------+--------------------------------------+------------------+
6120 | Type | Name | Description | Schema |
6121 +==========+=============+======================================+==================+
6122 | **Header | **USER\_ID* | id of user initiating the operation | string |
6123 | ** | *\ *optiona | | |
6125 +----------+-------------+--------------------------------------+------------------+
6126 | **Path** | **component | service id | string |
6127 | | Id**\ *requ | | |
6129 +----------+-------------+--------------------------------------+------------------+
6130 | **Path** | **component | resource instance id | string |
6131 | | InstanceId* | | |
6132 | | *\ *require | | |
6134 +----------+-------------+--------------------------------------+------------------+
6135 | **Path** | **container | valid values: resources / services | enum (resources, |
6136 | | ComponentTy | | services) |
6137 | | pe**\ *requ | | |
6139 +----------+-------------+--------------------------------------+------------------+
6140 | **Path** | **groupInst | group instance id | string |
6141 | | anceId**\ * | | |
6143 +----------+-------------+--------------------------------------+------------------+
6148 +---------+----------------------------------------------------+----------------+
6149 | HTTP | Description | Schema |
6151 +=========+====================================================+================+
6152 | **201** | Resource instance created | No Content |
6153 +---------+----------------------------------------------------+----------------+
6154 | **400** | Invalid content / Missing content | No Content |
6155 +---------+----------------------------------------------------+----------------+
6156 | **403** | Restricted operation | No Content |
6157 +---------+----------------------------------------------------+----------------+
6162 - ``application/json``
6167 - ``application/json``
6172 - Resource Instance Servlet
6174 Update resource instance property
6175 ---------------------------------
6179 POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/input
6184 Returns updated resource instance property
6189 +----------+-------------+--------------------------------------+------------------+
6190 | Type | Name | Description | Schema |
6191 +==========+=============+======================================+==================+
6192 | **Header | **USER\_ID* | id of user initiating the operation | string |
6193 | ** | *\ *optiona | | |
6195 +----------+-------------+--------------------------------------+------------------+
6196 | **Path** | **component | service id | string |
6197 | | Id**\ *requ | | |
6199 +----------+-------------+--------------------------------------+------------------+
6200 | **Path** | **component | resource instance id | string |
6201 | | InstanceId* | | |
6202 | | *\ *require | | |
6204 +----------+-------------+--------------------------------------+------------------+
6205 | **Path** | **container | valid values: resources / services | enum (resources, |
6206 | | ComponentTy | | services) |
6207 | | pe**\ *requ | | |
6209 +----------+-------------+--------------------------------------+------------------+
6214 +---------+----------------------------------------------------+----------------+
6215 | HTTP | Description | Schema |
6217 +=========+====================================================+================+
6218 | **201** | Resource instance created | No Content |
6219 +---------+----------------------------------------------------+----------------+
6220 | **400** | Invalid content / Missing content | No Content |
6221 +---------+----------------------------------------------------+----------------+
6222 | **403** | Restricted operation | No Content |
6223 +---------+----------------------------------------------------+----------------+
6228 - ``application/json``
6233 - ``application/json``
6238 - Resource Instance Servlet
6240 Update resource instance property
6241 ---------------------------------
6245 POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/property
6250 Returns updated resource instance property
6255 +----------+-------------+--------------------------------------+------------------+
6256 | Type | Name | Description | Schema |
6257 +==========+=============+======================================+==================+
6258 | **Header | **USER\_ID* | id of user initiating the operation | string |
6259 | ** | *\ *optiona | | |
6261 +----------+-------------+--------------------------------------+------------------+
6262 | **Path** | **component | service id | string |
6263 | | Id**\ *requ | | |
6265 +----------+-------------+--------------------------------------+------------------+
6266 | **Path** | **component | resource instance id | string |
6267 | | InstanceId* | | |
6268 | | *\ *require | | |
6270 +----------+-------------+--------------------------------------+------------------+
6271 | **Path** | **container | valid values: resources / services | enum (resources, |
6272 | | ComponentTy | | services) |
6273 | | pe**\ *requ | | |
6275 +----------+-------------+--------------------------------------+------------------+
6280 +---------+----------------------------------------------------+----------------+
6281 | HTTP | Description | Schema |
6283 +=========+====================================================+================+
6284 | **201** | Resource instance created | No Content |
6285 +---------+----------------------------------------------------+----------------+
6286 | **400** | Invalid content / Missing content | No Content |
6287 +---------+----------------------------------------------------+----------------+
6288 | **403** | Restricted operation | No Content |
6289 +---------+----------------------------------------------------+----------------+
6294 - ``application/json``
6299 - ``application/json``
6304 - Resource Instance Servlet
6306 Update resource instance
6307 ------------------------
6311 DELETE /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/property/{propertyId}
6316 Returns deleted resource instance property
6321 +----------+-------------+--------------------------------------+------------------+
6322 | Type | Name | Description | Schema |
6323 +==========+=============+======================================+==================+
6324 | **Header | **USER\_ID* | id of user initiating the operation | string |
6325 | ** | *\ *optiona | | |
6327 +----------+-------------+--------------------------------------+------------------+
6328 | **Path** | **component | service id | string |
6329 | | Id**\ *requ | | |
6331 +----------+-------------+--------------------------------------+------------------+
6332 | **Path** | **component | resource instance id | string |
6333 | | InstanceId* | | |
6334 | | *\ *require | | |
6336 +----------+-------------+--------------------------------------+------------------+
6337 | **Path** | **container | valid values: resources / services | enum (resources, |
6338 | | ComponentTy | | services) |
6339 | | pe**\ *requ | | |
6341 +----------+-------------+--------------------------------------+------------------+
6342 | **Path** | **propertyI | property id | string |
6343 | | d**\ *requi | | |
6345 +----------+-------------+--------------------------------------+------------------+
6350 +---------+----------------------------------------------------+----------------+
6351 | HTTP | Description | Schema |
6353 +=========+====================================================+================+
6354 | **201** | Resource instance created | No Content |
6355 +---------+----------------------------------------------------+----------------+
6356 | **400** | Invalid content / Missing content | No Content |
6357 +---------+----------------------------------------------------+----------------+
6358 | **403** | Restricted operation | No Content |
6359 +---------+----------------------------------------------------+----------------+
6364 - ``application/json``
6369 - ``application/json``
6374 - Resource Instance Servlet
6376 Delete ResourceInstance
6377 -----------------------
6381 DELETE /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{resourceInstanceId}
6386 Returns delete resourceInstance
6391 +----------+-------------+--------------------------------------+------------------+
6392 | Type | Name | Description | Schema |
6393 +==========+=============+======================================+==================+
6394 | **Path** | **component | | string |
6395 | | Id**\ *requ | | |
6397 +----------+-------------+--------------------------------------+------------------+
6398 | **Path** | **container | valid values: resources / services / | enum (resources, |
6399 | | ComponentTy | products | services, |
6400 | | pe**\ *requ | | products) |
6402 +----------+-------------+--------------------------------------+------------------+
6403 | **Path** | **resourceI | | string |
6404 | | nstanceId** | | |
6405 | | \ *required | | |
6407 +----------+-------------+--------------------------------------+------------------+
6412 +---------+----------------------------------------------------+----------------+
6413 | HTTP | Description | Schema |
6415 +=========+====================================================+================+
6416 | **201** | ResourceInstance deleted | No Content |
6417 +---------+----------------------------------------------------+----------------+
6418 | **400** | Invalid content / Missing content | No Content |
6419 +---------+----------------------------------------------------+----------------+
6420 | **403** | Restricted operation | No Content |
6421 +---------+----------------------------------------------------+----------------+
6426 - ``application/json``
6431 - ``application/json``
6436 - Resource Instance Servlet
6438 Download component Artifact in Base64
6439 -------------------------------------
6443 GET /v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifacts/{artifactId}
6448 Returns downloaded artifact
6453 +----------+-------------+--------------------------------------+------------------+
6454 | Type | Name | Description | Schema |
6455 +==========+=============+======================================+==================+
6456 | **Path** | **artifactI | | string |
6457 | | d**\ *requi | | |
6459 +----------+-------------+--------------------------------------+------------------+
6460 | **Path** | **component | | string |
6461 | | Id**\ *requ | | |
6463 +----------+-------------+--------------------------------------+------------------+
6464 | **Path** | **component | | string |
6465 | | InstanceId* | | |
6466 | | *\ *require | | |
6468 +----------+-------------+--------------------------------------+------------------+
6469 | **Path** | **container | valid values: resources / services | enum (resources, |
6470 | | ComponentTy | | services) |
6471 | | pe**\ *requ | | |
6473 +----------+-------------+--------------------------------------+------------------+
6478 +---------+----------------------------------------------------+----------------+
6479 | HTTP | Description | Schema |
6481 +=========+====================================================+================+
6482 | **200** | ResourceInstance artifact downloaded | No Content |
6483 +---------+----------------------------------------------------+----------------+
6484 | **404** | ResourceInstance/Artifact not found | No Content |
6485 +---------+----------------------------------------------------+----------------+
6490 - ``application/json``
6495 - ``application/json``
6500 - Resource Artifact Servlet
6502 Get component Artifacts
6503 -----------------------
6507 GET /v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifactsByType/{artifactGroupType}
6517 +----------+-------------+--------------------------------------+------------------+
6518 | Type | Name | Description | Schema |
6519 +==========+=============+======================================+==================+
6520 | **Path** | **artifactG | | string |
6521 | | roupType**\ | | |
6522 | | *required* | | |
6523 +----------+-------------+--------------------------------------+------------------+
6524 | **Path** | **component | | string |
6525 | | Id**\ *requ | | |
6527 +----------+-------------+--------------------------------------+------------------+
6528 | **Path** | **component | | string |
6529 | | InstanceId* | | |
6530 | | *\ *require | | |
6532 +----------+-------------+--------------------------------------+------------------+
6533 | **Path** | **container | valid values: resources / services | enum (resources, |
6534 | | ComponentTy | | services) |
6535 | | pe**\ *requ | | |
6537 +----------+-------------+--------------------------------------+------------------+
6542 +---------+----------------------------------------------------+----------------+
6543 | HTTP | Description | Schema |
6545 +=========+====================================================+================+
6546 | **200** | Component artifacts | No Content |
6547 +---------+----------------------------------------------------+----------------+
6548 | **404** | Resource/Artifact not found | No Content |
6549 +---------+----------------------------------------------------+----------------+
6554 - ``application/json``
6559 - ``application/json``
6564 - Resource Artifact Servlet
6566 Update resource inputs
6567 ----------------------
6571 POST /v1/catalog/{containerComponentType}/{componentId}/update/inputs
6576 Returns updated input
6581 +----------+-------------+--------------------------------------+------------------+
6582 | Type | Name | Description | Schema |
6583 +==========+=============+======================================+==================+
6584 | **Path** | **component | | string |
6585 | | Id**\ *requ | | |
6587 +----------+-------------+--------------------------------------+------------------+
6588 | **Path** | **container | valid values: resources / services | enum (resources, |
6589 | | ComponentTy | | services) |
6590 | | pe**\ *requ | | |
6592 +----------+-------------+--------------------------------------+------------------+
6593 | **Body** | **body**\ * | json describe the input | string |
6595 +----------+-------------+--------------------------------------+------------------+
6600 +---------+----------------------------------------------------+----------------+
6601 | HTTP | Description | Schema |
6603 +=========+====================================================+================+
6604 | **200** | Input updated | No Content |
6605 +---------+----------------------------------------------------+----------------+
6606 | **400** | Invalid content / Missing content | No Content |
6607 +---------+----------------------------------------------------+----------------+
6608 | **403** | Restricted operation | No Content |
6609 +---------+----------------------------------------------------+----------------+
6614 - ``application/json``
6619 - ``application/json``
6626 Get component instance properties
6627 ---------------------------------
6631 GET /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/properties
6636 Returns component instance properties
6641 +------------------+--------------------------+----------------------------------+
6642 | Type | Name | Schema |
6643 +==================+==========================+==================================+
6644 | **Header** | **USER\_ID**\ *optional* | string |
6645 +------------------+--------------------------+----------------------------------+
6646 | **Path** | **componentInstanceUniqu | string |
6647 | | eId**\ *required* | |
6648 +------------------+--------------------------+----------------------------------+
6649 | **Path** | **containerComponentId** | string |
6650 | | \ *required* | |
6651 +------------------+--------------------------+----------------------------------+
6652 | **Path** | **containerComponentType | string |
6653 | | **\ *required* | |
6654 +------------------+--------------------------+----------------------------------+
6659 +---------+----------------------------------------------------+----------------+
6660 | HTTP | Description | Schema |
6662 +=========+====================================================+================+
6663 | **200** | Properties found | No Content |
6664 +---------+----------------------------------------------------+----------------+
6665 | **403** | Restricted operation | No Content |
6666 +---------+----------------------------------------------------+----------------+
6667 | **404** | Component/Component Instance - not found | No Content |
6668 +---------+----------------------------------------------------+----------------+
6673 - ``application/json``
6678 - ``application/json``
6683 - Resource Instance Servlet
6685 Create service proxy
6686 --------------------
6690 POST /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy
6695 Returns created service proxy
6700 +----------+-------------+--------------------------------------+------------------+
6701 | Type | Name | Description | Schema |
6702 +==========+=============+======================================+==================+
6703 | **Header | **USER\_ID* | USER\_ID of modifier user | string |
6704 | ** | *\ *require | | |
6706 +----------+-------------+--------------------------------------+------------------+
6707 | **Path** | **container | | string |
6708 | | ComponentId | | |
6709 | | **\ *requir | | |
6711 +----------+-------------+--------------------------------------+------------------+
6712 | **Path** | **container | valid values: resources / services | enum (resources, |
6713 | | ComponentTy | | services) |
6714 | | pe**\ *requ | | |
6716 +----------+-------------+--------------------------------------+------------------+
6717 | **Body** | **body**\ * | RI object to be created | string |
6719 +----------+-------------+--------------------------------------+------------------+
6724 +---------+----------------------------------------------------+----------------+
6725 | HTTP | Description | Schema |
6727 +=========+====================================================+================+
6728 | **201** | Service proxy created | No Content |
6729 +---------+----------------------------------------------------+----------------+
6730 | **400** | Invalid content / Missing content | No Content |
6731 +---------+----------------------------------------------------+----------------+
6732 | **403** | Restricted operation | No Content |
6733 +---------+----------------------------------------------------+----------------+
6734 | **409** | Service proxy already exist | No Content |
6735 +---------+----------------------------------------------------+----------------+
6740 - ``application/json``
6745 - ``application/json``
6750 - Resource Instance Servlet
6752 Delete service proxy
6753 --------------------
6757 DELETE /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy/{serviceProxyId}
6762 Returns delete service proxy
6767 +----------+-------------+--------------------------------------+------------------+
6768 | Type | Name | Description | Schema |
6769 +==========+=============+======================================+==================+
6770 | **Path** | **container | | string |
6771 | | ComponentId | | |
6772 | | **\ *requir | | |
6774 +----------+-------------+--------------------------------------+------------------+
6775 | **Path** | **container | valid values: resources / services / | enum (resources, |
6776 | | ComponentTy | products | services, |
6777 | | pe**\ *requ | | products) |
6779 +----------+-------------+--------------------------------------+------------------+
6780 | **Path** | **servicePr | | string |
6781 | | oxyId**\ *r | | |
6783 +----------+-------------+--------------------------------------+------------------+
6788 +---------+----------------------------------------------------+----------------+
6789 | HTTP | Description | Schema |
6791 +=========+====================================================+================+
6792 | **201** | Service proxy deleted | No Content |
6793 +---------+----------------------------------------------------+----------------+
6794 | **400** | Invalid content / Missing content | No Content |
6795 +---------+----------------------------------------------------+----------------+
6796 | **403** | Restricted operation | No Content |
6797 +---------+----------------------------------------------------+----------------+
6802 - ``application/json``
6807 - ``application/json``
6812 - Resource Instance Servlet
6814 Update service proxy with new version
6815 -------------------------------------
6819 POST /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy/{serviceProxyId}/changeVersion/{newServiceId}
6824 Returns updated service proxy
6829 +----------+-------------+--------------------------------------+------------------+
6830 | Type | Name | Description | Schema |
6831 +==========+=============+======================================+==================+
6832 | **Path** | **container | | string |
6833 | | ComponentId | | |
6834 | | **\ *requir | | |
6836 +----------+-------------+--------------------------------------+------------------+
6837 | **Path** | **container | valid values: resources / services | enum (resources, |
6838 | | ComponentTy | | services) |
6839 | | pe**\ *requ | | |
6841 +----------+-------------+--------------------------------------+------------------+
6842 | **Path** | **servicePr | | string |
6843 | | oxyId**\ *r | | |
6845 +----------+-------------+--------------------------------------+------------------+
6850 +---------+----------------------------------------------------+----------------+
6851 | HTTP | Description | Schema |
6853 +=========+====================================================+================+
6854 | **201** | Service proxy created | No Content |
6855 +---------+----------------------------------------------------+----------------+
6856 | **400** | Invalid content / Missing content | No Content |
6857 +---------+----------------------------------------------------+----------------+
6858 | **403** | Restricted operation | No Content |
6859 +---------+----------------------------------------------------+----------------+
6864 - ``application/json``
6869 - ``application/json``
6874 - Resource Instance Servlet
6876 Update Group Instance Property Values
6877 -------------------------------------
6881 PUT /v1/catalog/{containerComponentType}/{serviceId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}
6886 Returns updated group instance
6891 +----------+-------------+--------------------------------------+------------------+
6892 | Type | Name | Description | Schema |
6893 +==========+=============+======================================+==================+
6894 | **Header | **USER\_ID* | | string |
6895 | ** | *\ *optiona | | |
6897 +----------+-------------+--------------------------------------+------------------+
6898 | **Path** | **component | | string |
6899 | | InstanceId* | | |
6900 | | *\ *require | | |
6902 +----------+-------------+--------------------------------------+------------------+
6903 | **Path** | **groupInst | | string |
6904 | | anceId**\ * | | |
6906 +----------+-------------+--------------------------------------+------------------+
6907 | **Path** | **serviceId | | string |
6908 | | **\ *requir | | |
6910 +----------+-------------+--------------------------------------+------------------+
6911 | **Body** | **body**\ * | Group instance object to be Updated | string |
6913 +----------+-------------+--------------------------------------+------------------+
6918 +---------+----------------------------------------------------+----------------+
6919 | HTTP | Description | Schema |
6921 +=========+====================================================+================+
6922 | **200** | Group Instance Property Values Updated | No Content |
6923 +---------+----------------------------------------------------+----------------+
6924 | **400** | Invalid content / Missing content | No Content |
6925 +---------+----------------------------------------------------+----------------+
6926 | **403** | Restricted operation | No Content |
6927 +---------+----------------------------------------------------+----------------+
6932 - ``application/json``
6937 - ``application/json``
6944 Retrieve the all resource, service and product categories
6945 ---------------------------------------------------------
6954 Retrieve the all resource, service and product categories
6959 +------------------+--------------------------+----------------------------------+
6960 | Type | Name | Schema |
6961 +==================+==========================+==================================+
6962 | **Header** | **USER\_ID**\ *optional* | string |
6963 +------------------+--------------------------+----------------------------------+
6968 +---------+----------------------------------------------------+----------------+
6969 | HTTP | Description | Schema |
6971 +=========+====================================================+================+
6972 | **200** | Returns categories Ok | No Content |
6973 +---------+----------------------------------------------------+----------------+
6974 | **403** | Missing information | No Content |
6975 +---------+----------------------------------------------------+----------------+
6976 | **409** | Restricted operation | No Content |
6977 +---------+----------------------------------------------------+----------------+
6978 | **500** | Internal Server Error | No Content |
6979 +---------+----------------------------------------------------+----------------+
6984 - ``application/json``
6989 - ``application/json``
6996 Retrieve the list of all resource/service/product categories/sub-categories/groupings
6997 -------------------------------------------------------------------------------------
7001 GET /v1/categories/{componentType}
7006 Retrieve the list of all resource/service/product
7007 categories/sub-categories/groupings.
7012 +----------+-------------+--------------------------------------+------------------+
7013 | Type | Name | Description | Schema |
7014 +==========+=============+======================================+==================+
7015 | **Header | **USER\_ID* | | string |
7016 | ** | *\ *optiona | | |
7018 +----------+-------------+--------------------------------------+------------------+
7019 | **Path** | **component | allowed values are resources / | enum (resources, |
7020 | | Type**\ *re | services/ products | services, |
7021 | | quired* | | products) |
7022 +----------+-------------+--------------------------------------+------------------+
7027 +---------+----------------------------------------------------+----------------+
7028 | HTTP | Description | Schema |
7030 +=========+====================================================+================+
7031 | **200** | Returns categories Ok | No Content |
7032 +---------+----------------------------------------------------+----------------+
7033 | **400** | Invalid component type | No Content |
7034 +---------+----------------------------------------------------+----------------+
7035 | **403** | Missing information | No Content |
7036 +---------+----------------------------------------------------+----------------+
7037 | **409** | Restricted operation | No Content |
7038 +---------+----------------------------------------------------+----------------+
7039 | **500** | Internal Server Error | No Content |
7040 +---------+----------------------------------------------------+----------------+
7045 - ``application/json``
7050 - ``application/json``
7057 Create new component category
7058 -----------------------------
7062 POST /v1/category/{componentType}
7067 Create new component category
7072 +----------+-------------+--------------------------------------+------------------+
7073 | Type | Name | Description | Schema |
7074 +==========+=============+======================================+==================+
7075 | **Header | **USER\_ID* | | string |
7076 | ** | *\ *optiona | | |
7078 +----------+-------------+--------------------------------------+------------------+
7079 | **Path** | **component | allowed values are resources | enum (resources, |
7080 | | Type**\ *re | /services / products | services, |
7081 | | quired* | | products) |
7082 +----------+-------------+--------------------------------------+------------------+
7083 | **Body** | **body**\ * | Category to be created | string |
7085 +----------+-------------+--------------------------------------+------------------+
7090 +---------+----------------------------------------------------+----------------+
7091 | HTTP | Description | Schema |
7093 +=========+====================================================+================+
7094 | **201** | Category created | No Content |
7095 +---------+----------------------------------------------------+----------------+
7096 | **400** | Invalid category data | No Content |
7097 +---------+----------------------------------------------------+----------------+
7098 | **403** | USER\_ID header is missing | No Content |
7099 +---------+----------------------------------------------------+----------------+
7100 | **409** | Category already exists / User not permitted to | No Content |
7101 | | perform the action | |
7102 +---------+----------------------------------------------------+----------------+
7103 | **500** | General Error | No Content |
7104 +---------+----------------------------------------------------+----------------+
7109 - ``application/json``
7114 - ``application/json``
7121 Create new component sub-category
7122 ---------------------------------
7126 POST /v1/category/{componentType}/{categoryId}/subCategory
7131 Create new component sub-category for existing category
7136 +----------+-------------+--------------------------------------+------------------+
7137 | Type | Name | Description | Schema |
7138 +==========+=============+======================================+==================+
7139 | **Header | **USER\_ID* | | string |
7140 | ** | *\ *optiona | | |
7142 +----------+-------------+--------------------------------------+------------------+
7143 | **Path** | **categoryI | Parent category unique ID | string |
7144 | | d**\ *requi | | |
7146 +----------+-------------+--------------------------------------+------------------+
7147 | **Path** | **component | allowed values are resources / | enum (resources, |
7148 | | Type**\ *re | products | products) |
7150 +----------+-------------+--------------------------------------+------------------+
7151 | **Body** | **body**\ * | Subcategory to be created. e.g. | string |
7152 | | required* | {"name":"Resource-subcat"} | |
7153 +----------+-------------+--------------------------------------+------------------+
7158 +---------+----------------------------------------------------+----------------+
7159 | HTTP | Description | Schema |
7161 +=========+====================================================+================+
7162 | **201** | Subcategory created | No Content |
7163 +---------+----------------------------------------------------+----------------+
7164 | **400** | Invalid subcategory data | No Content |
7165 +---------+----------------------------------------------------+----------------+
7166 | **403** | USER\_ID header is missing | No Content |
7167 +---------+----------------------------------------------------+----------------+
7168 | **404** | Parent category wasn’t found | No Content |
7169 +---------+----------------------------------------------------+----------------+
7170 | **409** | Subcategory already exists / User not permitted to | No Content |
7171 | | perform the action | |
7172 +---------+----------------------------------------------------+----------------+
7173 | **500** | General Error | No Content |
7174 +---------+----------------------------------------------------+----------------+
7179 - ``application/json``
7184 - ``application/json``
7191 Create new component grouping
7192 -----------------------------
7196 POST /v1/category/{componentType}/{categoryId}/subCategory/{subCategoryId}/grouping
7201 Create new component grouping for existing sub-category
7206 +----------+-------------+--------------------------------------+------------------+
7207 | Type | Name | Description | Schema |
7208 +==========+=============+======================================+==================+
7209 | **Header | **USER\_ID* | | string |
7210 | ** | *\ *optiona | | |
7212 +----------+-------------+--------------------------------------+------------------+
7213 | **Path** | **categoryI | Parent category unique ID | string |
7214 | | d**\ *requi | | |
7216 +----------+-------------+--------------------------------------+------------------+
7217 | **Path** | **component | allowed values are products | enum (products) |
7218 | | Type**\ *re | | |
7220 +----------+-------------+--------------------------------------+------------------+
7221 | **Path** | **subCatego | Parent sub-category unique ID | string |
7222 | | ryId**\ *re | | |
7224 +----------+-------------+--------------------------------------+------------------+
7225 | **Body** | **body**\ * | Subcategory to be created | string |
7227 +----------+-------------+--------------------------------------+------------------+
7232 +---------+----------------------------------------------------+----------------+
7233 | HTTP | Description | Schema |
7235 +=========+====================================================+================+
7236 | **201** | Grouping created | No Content |
7237 +---------+----------------------------------------------------+----------------+
7238 | **400** | Invalid grouping data | No Content |
7239 +---------+----------------------------------------------------+----------------+
7240 | **403** | USER\_ID header is missing | No Content |
7241 +---------+----------------------------------------------------+----------------+
7242 | **404** | Parent category or subcategory were not found | No Content |
7243 +---------+----------------------------------------------------+----------------+
7244 | **409** | Grouping already exists / User not permitted to | No Content |
7245 | | perform the action | |
7246 +---------+----------------------------------------------------+----------------+
7247 | **500** | General Error | No Content |
7248 +---------+----------------------------------------------------+----------------+
7253 - ``application/json``
7258 - ``application/json``
7265 Delete component category
7266 -------------------------
7270 DELETE /v1/category/{componentType}/{categoryUniqueId}
7275 Delete component category
7280 +------------------+--------------------------+----------------------------------+
7281 | Type | Name | Schema |
7282 +==================+==========================+==================================+
7283 | **Header** | **USER\_ID**\ *optional* | string |
7284 +------------------+--------------------------+----------------------------------+
7285 | **Path** | **categoryUniqueId**\ *r | string |
7287 +------------------+--------------------------+----------------------------------+
7288 | **Path** | **componentType**\ *requ | string |
7290 +------------------+--------------------------+----------------------------------+
7295 +---------+----------------------------------------------------+----------------+
7296 | HTTP | Description | Schema |
7298 +=========+====================================================+================+
7299 | **200** | successful operation | `Category <#_c |
7301 +---------+----------------------------------------------------+----------------+
7302 | **204** | Category deleted | No Content |
7303 +---------+----------------------------------------------------+----------------+
7304 | **403** | USER\_ID header is missing | No Content |
7305 +---------+----------------------------------------------------+----------------+
7306 | **404** | Category not found | No Content |
7307 +---------+----------------------------------------------------+----------------+
7308 | **409** | User not permitted to perform the action | No Content |
7309 +---------+----------------------------------------------------+----------------+
7310 | **500** | General Error | No Content |
7311 +---------+----------------------------------------------------+----------------+
7316 - ``application/json``
7321 - ``application/json``
7328 Delete component category
7329 -------------------------
7333 DELETE /v1/category/{componentType}/{categoryUniqueId}/subCategory/{subCategoryUniqueId}
7338 Delete component category
7343 +------------------+--------------------------+----------------------------------+
7344 | Type | Name | Schema |
7345 +==================+==========================+==================================+
7346 | **Header** | **USER\_ID**\ *optional* | string |
7347 +------------------+--------------------------+----------------------------------+
7348 | **Path** | **categoryUniqueId**\ *r | string |
7350 +------------------+--------------------------+----------------------------------+
7351 | **Path** | **componentType**\ *requ | string |
7353 +------------------+--------------------------+----------------------------------+
7354 | **Path** | **subCategoryUniqueId**\ | string |
7356 +------------------+--------------------------+----------------------------------+
7361 +---------+----------------------------------------------------+----------------+
7362 | HTTP | Description | Schema |
7364 +=========+====================================================+================+
7365 | **200** | successful operation | `Category <#_c |
7367 +---------+----------------------------------------------------+----------------+
7368 | **204** | Category deleted | No Content |
7369 +---------+----------------------------------------------------+----------------+
7370 | **403** | USER\_ID header is missing | No Content |
7371 +---------+----------------------------------------------------+----------------+
7372 | **404** | Category not found | No Content |
7373 +---------+----------------------------------------------------+----------------+
7374 | **409** | User not permitted to perform the action | No Content |
7375 +---------+----------------------------------------------------+----------------+
7376 | **500** | General Error | No Content |
7377 +---------+----------------------------------------------------+----------------+
7382 - ``application/json``
7387 - ``application/json``
7394 Delete component category
7395 -------------------------
7399 DELETE /v1/category/{componentType}/{categoryUniqueId}/subCategory/{subCategoryUniqueId}/grouping/{groupingUniqueId}
7404 Delete component category
7409 +------------------+--------------------------+----------------------------------+
7410 | Type | Name | Schema |
7411 +==================+==========================+==================================+
7412 | **Header** | **USER\_ID**\ *optional* | string |
7413 +------------------+--------------------------+----------------------------------+
7414 | **Path** | **categoryUniqueId**\ *r | string |
7416 +------------------+--------------------------+----------------------------------+
7417 | **Path** | **componentType**\ *requ | string |
7419 +------------------+--------------------------+----------------------------------+
7420 | **Path** | **groupingUniqueId**\ *r | string |
7422 +------------------+--------------------------+----------------------------------+
7423 | **Path** | **subCategoryUniqueId**\ | string |
7425 +------------------+--------------------------+----------------------------------+
7430 +---------+----------------------------------------------------+----------------+
7431 | HTTP | Description | Schema |
7433 +=========+====================================================+================+
7434 | **200** | successful operation | `Category <#_c |
7436 +---------+----------------------------------------------------+----------------+
7437 | **204** | Category deleted | No Content |
7438 +---------+----------------------------------------------------+----------------+
7439 | **403** | USER\_ID header is missing | No Content |
7440 +---------+----------------------------------------------------+----------------+
7441 | **404** | Category not found | No Content |
7442 +---------+----------------------------------------------------+----------------+
7443 | **409** | User not permitted to perform the action | No Content |
7444 +---------+----------------------------------------------------+----------------+
7445 | **500** | General Error | No Content |
7446 +---------+----------------------------------------------------+----------------+
7451 - ``application/json``
7456 - ``application/json``
7463 Retrieve all artifactTypes
7464 --------------------------
7468 GET /v1/configuration/ui
7473 Retrieve all artifactTypes
7478 +------------------+--------------------------+----------------------------------+
7479 | Type | Name | Schema |
7480 +==================+==========================+==================================+
7481 | **Header** | **USER\_ID**\ *optional* | string |
7482 +------------------+--------------------------+----------------------------------+
7487 +---------+----------------------------------------------------+----------------+
7488 | HTTP | Description | Schema |
7490 +=========+====================================================+================+
7491 | **200** | Returns artifactTypes Ok | No Content |
7492 +---------+----------------------------------------------------+----------------+
7493 | **404** | No artifactTypes were found | No Content |
7494 +---------+----------------------------------------------------+----------------+
7495 | **500** | Internal Server Error | No Content |
7496 +---------+----------------------------------------------------+----------------+
7501 - ``application/json``
7506 - ``application/json``
7513 Consumer credentials
7514 --------------------
7523 Returns created ONAP consumer credentials
7528 +----------+-------------+--------------------------------------+------------------+
7529 | Type | Name | Description | Schema |
7530 +==========+=============+======================================+==================+
7531 | **Header | **USER\_ID* | | string |
7532 | ** | *\ *optiona | | |
7534 +----------+-------------+--------------------------------------+------------------+
7535 | **Body** | **body**\ * | Consumer Object to be created | string |
7537 +----------+-------------+--------------------------------------+------------------+
7542 +---------+----------------------------------------------------+----------------+
7543 | HTTP | Description | Schema |
7545 +=========+====================================================+================+
7546 | **201** | Consumer credentials created | No Content |
7547 +---------+----------------------------------------------------+----------------+
7548 | **400** | Invalid content / Missing content | No Content |
7549 +---------+----------------------------------------------------+----------------+
7550 | **403** | Restricted operation | No Content |
7551 +---------+----------------------------------------------------+----------------+
7556 - ``application/json``
7561 - ``application/json``
7573 GET /v1/consumers/{consumerId}
7578 Returns consumer according to ConsumerID
7583 +------------------+--------------------------+----------------------------------+
7584 | Type | Name | Schema |
7585 +==================+==========================+==================================+
7586 | **Header** | **USER\_ID**\ *optional* | string |
7587 +------------------+--------------------------+----------------------------------+
7588 | **Path** | **consumerId**\ *require | string |
7590 +------------------+--------------------------+----------------------------------+
7595 +---------+----------------------------------------------------+----------------+
7596 | HTTP | Description | Schema |
7598 +=========+====================================================+================+
7599 | **200** | Consumer found | No Content |
7600 +---------+----------------------------------------------------+----------------+
7601 | **403** | Restricted operation | No Content |
7602 +---------+----------------------------------------------------+----------------+
7603 | **404** | Consumer not found | No Content |
7604 +---------+----------------------------------------------------+----------------+
7609 - ``application/json``
7614 - ``application/json``
7626 DELETE /v1/consumers/{consumerId}
7631 Returns deleted consumer according to ConsumerID
7636 +------------------+--------------------------+----------------------------------+
7637 | Type | Name | Schema |
7638 +==================+==========================+==================================+
7639 | **Header** | **USER\_ID**\ *optional* | string |
7640 +------------------+--------------------------+----------------------------------+
7641 | **Path** | **consumerId**\ *require | string |
7643 +------------------+--------------------------+----------------------------------+
7648 +---------+----------------------------------------------------+----------------+
7649 | HTTP | Description | Schema |
7651 +=========+====================================================+================+
7652 | **200** | successful operation | `ConsumerDefin |
7653 | | | ition <#_consu |
7654 | | | merdefinition> |
7656 +---------+----------------------------------------------------+----------------+
7657 | **204** | Consumer deleted | No Content |
7658 +---------+----------------------------------------------------+----------------+
7659 | **403** | Restricted operation | No Content |
7660 +---------+----------------------------------------------------+----------------+
7661 | **404** | Consumer not found | No Content |
7662 +---------+----------------------------------------------------+----------------+
7667 - ``application/json``
7672 - ``application/json``
7679 Retrieve ONAP portal menu - MOC
7680 -------------------------------
7684 GET /v1/ecompPortalMenu
7689 Retrieve ONAP portal menu
7694 +---------+----------------------------------------------------+----------------+
7695 | HTTP | Description | Schema |
7697 +=========+====================================================+================+
7698 | **200** | Retrieve ONAP portal menu | No Content |
7699 +---------+----------------------------------------------------+----------------+
7704 - ``application/json``
7709 - ``application/json``
7716 Retrieve all followed
7717 ---------------------
7726 Retrieve all followed
7731 +------------------+--------------------------+----------------------------------+
7732 | Type | Name | Schema |
7733 +==================+==========================+==================================+
7734 | **Header** | **USER\_ID**\ *optional* | string |
7735 +------------------+--------------------------+----------------------------------+
7740 +---------+----------------------------------------------------+----------------+
7741 | HTTP | Description | Schema |
7743 +=========+====================================================+================+
7744 | **200** | Returns followed Ok | No Content |
7745 +---------+----------------------------------------------------+----------------+
7746 | **404** | User not found | No Content |
7747 +---------+----------------------------------------------------+----------------+
7748 | **500** | Internal Server Error | No Content |
7749 +---------+----------------------------------------------------+----------------+
7754 - ``application/json``
7759 - ``application/json``
7766 DELETE /v1/inactiveComponents/{componenttype}
7767 ---------------------------------------------
7772 +------------------+--------------------------+----------------------------------+
7773 | Type | Name | Schema |
7774 +==================+==========================+==================================+
7775 | **Path** | **componentType**\ *requ | string |
7777 +------------------+--------------------------+----------------------------------+
7782 +---------+----------------------------------------------------+----------------+
7783 | HTTP | Description | Schema |
7785 +=========+====================================================+================+
7786 | **defau | successful operation | No Content |
7788 +---------+----------------------------------------------------+----------------+
7795 Retrieve all propertyScopes
7796 ---------------------------
7800 GET /v1/propertyScopes
7805 Retrieve all propertyScopes
7810 +------------------+--------------------------+----------------------------------+
7811 | Type | Name | Schema |
7812 +==================+==========================+==================================+
7813 | **Header** | **USER\_ID**\ *optional* | string |
7814 +------------------+--------------------------+----------------------------------+
7819 +---------+----------------------------------------------------+----------------+
7820 | HTTP | Description | Schema |
7822 +=========+====================================================+================+
7823 | **200** | Returns propertyScopes Ok | No Content |
7824 +---------+----------------------------------------------------+----------------+
7825 | **404** | No propertyScopes were found | No Content |
7826 +---------+----------------------------------------------------+----------------+
7827 | **500** | Internal Server Error | No Content |
7828 +---------+----------------------------------------------------+----------------+
7833 - ``application/json``
7838 - ``application/json``
7845 Retrieve catalog resources and services
7846 ---------------------------------------
7855 Retrieve catalog resources and services
7860 +------------------+--------------------------+----------------------------------+
7861 | Type | Name | Schema |
7862 +==================+==========================+==================================+
7863 | **Header** | **USER\_ID**\ *optional* | string |
7864 +------------------+--------------------------+----------------------------------+
7865 | **Query** | **excludeTypes**\ *optio | < enum (PRODUCT, SERVICE, VF, |
7866 | | nal* | VFC, CP, VL, VFCMT, CVFC, PNF) > |
7867 | | | array(multi) |
7868 +------------------+--------------------------+----------------------------------+
7873 +---------+----------------------------------------------------+----------------+
7874 | HTTP | Description | Schema |
7876 +=========+====================================================+================+
7877 | **200** | Returns resources and services Ok | No Content |
7878 +---------+----------------------------------------------------+----------------+
7879 | **404** | User not found | No Content |
7880 +---------+----------------------------------------------------+----------------+
7881 | **500** | Internal Server Error | No Content |
7882 +---------+----------------------------------------------------+----------------+
7887 - ``application/json``
7892 - ``application/json``
7914 +------------------+--------------------------+----------------------------------+
7915 | Type | Name | Schema |
7916 +==================+==========================+==================================+
7917 | **Header** | **USER\_ID**\ *optional* | string |
7918 +------------------+--------------------------+----------------------------------+
7923 +---------+----------------------------------------------------+----------------+
7924 | HTTP | Description | Schema |
7926 +=========+====================================================+================+
7927 | **200** | Returns tags Ok | No Content |
7928 +---------+----------------------------------------------------+----------------+
7929 | **404** | No tags were found | No Content |
7930 +---------+----------------------------------------------------+----------------+
7931 | **500** | Internal Server Error | No Content |
7932 +---------+----------------------------------------------------+----------------+
7937 - ``application/json``
7942 - ``application/json``
7964 +----------+-------------+--------------------------------------+------------------+
7965 | Type | Name | Description | Schema |
7966 +==========+=============+======================================+==================+
7967 | **Header | **USER\_ID* | | string |
7968 | ** | *\ *optiona | | |
7970 +----------+-------------+--------------------------------------+------------------+
7971 | **Body** | **body**\ * | json describe the user | string |
7973 +----------+-------------+--------------------------------------+------------------+
7978 +---------+----------------------------------------------------+----------------+
7979 | HTTP | Description | Schema |
7981 +=========+====================================================+================+
7982 | **200** | successful operation | `User <#_user> |
7984 +---------+----------------------------------------------------+----------------+
7985 | **201** | New user created | No Content |
7986 +---------+----------------------------------------------------+----------------+
7987 | **400** | Invalid Content. | No Content |
7988 +---------+----------------------------------------------------+----------------+
7989 | **403** | Missing information | No Content |
7990 +---------+----------------------------------------------------+----------------+
7991 | **405** | Method Not Allowed | No Content |
7992 +---------+----------------------------------------------------+----------------+
7993 | **409** | User already exists | No Content |
7994 +---------+----------------------------------------------------+----------------+
7995 | **500** | Internal Server Error | No Content |
7996 +---------+----------------------------------------------------+----------------+
8001 - ``application/json``
8006 - ``application/json``
8011 - User Administration
8013 retrieve all administrators
8014 ---------------------------
8023 Returns all administrators
8028 +------------------+--------------------------+----------------------------------+
8029 | Type | Name | Schema |
8030 +==================+==========================+==================================+
8031 | **Path** | **userId**\ *required* | string |
8032 +------------------+--------------------------+----------------------------------+
8037 +---------+----------------------------------------------------+----------------+
8038 | HTTP | Description | Schema |
8040 +=========+====================================================+================+
8041 | **200** | Returns user Ok | No Content |
8042 +---------+----------------------------------------------------+----------------+
8043 | **405** | Method Not Allowed | No Content |
8044 +---------+----------------------------------------------------+----------------+
8045 | **500** | Internal Server Error | No Content |
8046 +---------+----------------------------------------------------+----------------+
8051 - ``application/json``
8056 - ``application/json``
8061 - User Administration
8068 GET /v1/user/authorize
8078 +------------------+--------------------------+----------------------------------+
8079 | Type | Name | Schema |
8080 +==================+==========================+==================================+
8081 | **Header** | **HTTP\_CSP\_EMAIL**\ *o | string |
8083 +------------------+--------------------------+----------------------------------+
8084 | **Header** | **HTTP\_CSP\_FIRSTNAME** | string |
8085 | | \ *optional* | |
8086 +------------------+--------------------------+----------------------------------+
8087 | **Header** | **HTTP\_CSP\_LASTNAME**\ | string |
8089 +------------------+--------------------------+----------------------------------+
8090 | **Header** | **USER\_ID**\ *optional* | string |
8091 +------------------+--------------------------+----------------------------------+
8096 +---------+----------------------------------------------------+----------------+
8097 | HTTP | Description | Schema |
8099 +=========+====================================================+================+
8100 | **200** | Returns user Ok | No Content |
8101 +---------+----------------------------------------------------+----------------+
8102 | **403** | Restricted Access | No Content |
8103 +---------+----------------------------------------------------+----------------+
8104 | **500** | Internal Server Error | No Content |
8105 +---------+----------------------------------------------------+----------------+
8110 - ``application/json``
8115 - ``application/json``
8120 - User Administration
8122 Retrieve the list of all active ASDC users or only group of users having specific roles.
8123 ----------------------------------------------------------------------------------------
8132 Returns list of users with the specified roles, or all of users in the
8133 case of empty *roles* header
8138 +----------+-------------+--------------------------------------+------------------+
8139 | Type | Name | Description | Schema |
8140 +==========+=============+======================================+==================+
8141 | **Header | **USER\_ID* | Any active user’s USER\_ID | string |
8142 | ** | *\ *optiona | | |
8144 +----------+-------------+--------------------------------------+------------------+
8145 | **Query* | **roles**\ | TESTER,DESIGNER,PRODUCT\_STRATEGIST, | string |
8146 | * | *optional* | OPS,PRODUCT\_MANAGER,GOVERNOR, | |
8147 | | | ADMIN OR all users by not typing | |
8149 +----------+-------------+--------------------------------------+------------------+
8154 +---------+----------------------------------------------------+----------------+
8155 | HTTP | Description | Schema |
8157 +=========+====================================================+================+
8158 | **200** | Returns users Ok | No Content |
8159 +---------+----------------------------------------------------+----------------+
8160 | **204** | No provisioned ASDC users of requested role | No Content |
8161 +---------+----------------------------------------------------+----------------+
8162 | **400** | Missing content | No Content |
8163 +---------+----------------------------------------------------+----------------+
8164 | **403** | Restricted Access | No Content |
8165 +---------+----------------------------------------------------+----------------+
8166 | **500** | Internal Server Error | No Content |
8167 +---------+----------------------------------------------------+----------------+
8172 - ``application/json``
8177 - ``application/json``
8182 - User Administration
8184 retrieve user details
8185 ---------------------
8189 GET /v1/user/{userId}
8194 Returns user details according to userId
8199 +----------+-------------+--------------------------------------+------------------+
8200 | Type | Name | Description | Schema |
8201 +==========+=============+======================================+==================+
8202 | **Path** | **userId**\ | userId of user to get | string |
8203 | | *required* | | |
8204 +----------+-------------+--------------------------------------+------------------+
8209 +---------+----------------------------------------------------+----------------+
8210 | HTTP | Description | Schema |
8212 +=========+====================================================+================+
8213 | **200** | Returns user Ok | No Content |
8214 +---------+----------------------------------------------------+----------------+
8215 | **404** | User not found | No Content |
8216 +---------+----------------------------------------------------+----------------+
8217 | **405** | Method Not Allowed | No Content |
8218 +---------+----------------------------------------------------+----------------+
8219 | **500** | Internal Server Error | No Content |
8220 +---------+----------------------------------------------------+----------------+
8225 - ``application/json``
8230 - ``application/json``
8235 - User Administration
8242 DELETE /v1/user/{userId}
8252 +----------+-------------+--------------------------------------+------------------+
8253 | Type | Name | Description | Schema |
8254 +==========+=============+======================================+==================+
8255 | **Header | **USER\_ID* | | string |
8256 | ** | *\ *optiona | | |
8258 +----------+-------------+--------------------------------------+------------------+
8259 | **Path** | **userId**\ | userId of user to get | string |
8260 | | *required* | | |
8261 +----------+-------------+--------------------------------------+------------------+
8266 +---------+----------------------------------------------------+----------------+
8267 | HTTP | Description | Schema |
8269 +=========+====================================================+================+
8270 | **200** | Update deleted OK | No Content |
8271 +---------+----------------------------------------------------+----------------+
8272 | **400** | Invalid Content. | No Content |
8273 +---------+----------------------------------------------------+----------------+
8274 | **403** | Missing information | No Content |
8275 +---------+----------------------------------------------------+----------------+
8276 | **404** | User not found | No Content |
8277 +---------+----------------------------------------------------+----------------+
8278 | **405** | Method Not Allowed | No Content |
8279 +---------+----------------------------------------------------+----------------+
8280 | **409** | Restricted operation | No Content |
8281 +---------+----------------------------------------------------+----------------+
8282 | **500** | Internal Server Error | No Content |
8283 +---------+----------------------------------------------------+----------------+
8288 - ``application/json``
8293 - ``application/json``
8298 - User Administration
8305 POST /v1/user/{userId}/role
8315 +----------+-------------+--------------------------------------+------------------+
8316 | Type | Name | Description | Schema |
8317 +==========+=============+======================================+==================+
8318 | **Header | **USER\_ID* | | string |
8319 | ** | *\ *optiona | | |
8321 +----------+-------------+--------------------------------------+------------------+
8322 | **Path** | **userId**\ | userId of user to get | string |
8323 | | *required* | | |
8324 +----------+-------------+--------------------------------------+------------------+
8325 | **Body** | **body**\ * | json describe the update role | string |
8327 +----------+-------------+--------------------------------------+------------------+
8332 +---------+----------------------------------------------------+----------------+
8333 | HTTP | Description | Schema |
8335 +=========+====================================================+================+
8336 | **200** | Update user OK | No Content |
8337 +---------+----------------------------------------------------+----------------+
8338 | **400** | Invalid Content. | No Content |
8339 +---------+----------------------------------------------------+----------------+
8340 | **403** | Missing information/Restricted operation | No Content |
8341 +---------+----------------------------------------------------+----------------+
8342 | **404** | User not found | No Content |
8343 +---------+----------------------------------------------------+----------------+
8344 | **405** | Method Not Allowed | No Content |
8345 +---------+----------------------------------------------------+----------------+
8346 | **409** | User already exists | No Content |
8347 +---------+----------------------------------------------------+----------------+
8348 | **500** | Internal Server Error | No Content |
8349 +---------+----------------------------------------------------+----------------+
8354 - ``application/json``
8359 - ``application/json``
8364 - User Administration
8371 GET /v1/user/{userId}/role
8376 Returns user role according to userId
8381 +----------+-------------+--------------------------------------+------------------+
8382 | Type | Name | Description | Schema |
8383 +==========+=============+======================================+==================+
8384 | **Path** | **userId**\ | userId of user to get | string |
8385 | | *required* | | |
8386 +----------+-------------+--------------------------------------+------------------+
8391 +---------+----------------------------------------------------+----------------+
8392 | HTTP | Description | Schema |
8394 +=========+====================================================+================+
8395 | **200** | Returns user role Ok | No Content |
8396 +---------+----------------------------------------------------+----------------+
8397 | **404** | User not found | No Content |
8398 +---------+----------------------------------------------------+----------------+
8399 | **405** | Method Not Allowed | No Content |
8400 +---------+----------------------------------------------------+----------------+
8401 | **500** | Internal Server Error | No Content |
8402 +---------+----------------------------------------------------+----------------+
8407 - ``application/json``
8412 - ``application/json``
8417 - User Administration
8419 return the ASDC application version
8420 -----------------------------------
8429 return the ASDC application version
8434 +---------+----------------------------------------------------+----------------+
8435 | HTTP | Description | Schema |
8437 +=========+====================================================+================+
8438 | **200** | return ASDC version | No Content |
8439 +---------+----------------------------------------------------+----------------+
8440 | **500** | Internal Error | No Content |
8441 +---------+----------------------------------------------------+----------------+
8446 - ``application/json``
8451 - ``application/json``
8461 AdditionalInfoParameterInfo
8462 ---------------------------
8464 +--------------------------------+-------------------------------------------+
8466 +================================+===========================================+
8467 | **key**\ *optional* | string |
8468 +--------------------------------+-------------------------------------------+
8469 | **ownerId**\ *optional* | string |
8470 +--------------------------------+-------------------------------------------+
8471 | **uniqueId**\ *optional* | string |
8472 +--------------------------------+-------------------------------------------+
8473 | **value**\ *optional* | string |
8474 +--------------------------------+-------------------------------------------+
8476 AdditionalInformationDefinition
8477 -------------------------------
8479 +--------------------------------+-------------------------------------------+
8481 +================================+===========================================+
8482 | **creationTime**\ *optional* | integer (int64) |
8483 +--------------------------------+-------------------------------------------+
8484 | **lastCreatedCounter**\ *optio | integer (int32) |
8486 +--------------------------------+-------------------------------------------+
8487 | **modificationTime**\ *optiona | integer (int64) |
8489 +--------------------------------+-------------------------------------------+
8490 | **ownerId**\ *optional* | string |
8491 +--------------------------------+-------------------------------------------+
8492 | **parameters**\ *optional* | < |
8493 | | `AdditionalInfoParameterInfo <#_additiona |
8494 | | linfoparameterinfo>`__ |
8496 +--------------------------------+-------------------------------------------+
8497 | **parentUniqueId**\ *optional* | string |
8498 +--------------------------------+-------------------------------------------+
8499 | **uniqueId**\ *optional* | string |
8500 +--------------------------------+-------------------------------------------+
8502 ArtifactDataDefinition
8503 ----------------------
8505 +--------------------------------+-------------------------------------------+
8507 +================================+===========================================+
8508 | **apiUrl**\ *optional* | string |
8509 +--------------------------------+-------------------------------------------+
8510 | **artifactChecksum**\ *optiona | string |
8512 +--------------------------------+-------------------------------------------+
8513 | **artifactCreator**\ *optional | string |
8515 +--------------------------------+-------------------------------------------+
8516 | **artifactDisplayName**\ *opti | string |
8518 +--------------------------------+-------------------------------------------+
8519 | **artifactGroupType**\ *option | enum (INFORMATIONAL, DEPLOYMENT, |
8520 | al* | LIFE\_CYCLE, SERVICE\_API, TOSCA, OTHER) |
8521 +--------------------------------+-------------------------------------------+
8522 | **artifactLabel**\ *optional* | string |
8523 +--------------------------------+-------------------------------------------+
8524 | **artifactName**\ *optional* | string |
8525 +--------------------------------+-------------------------------------------+
8526 | **artifactRef**\ *optional* | string |
8527 +--------------------------------+-------------------------------------------+
8528 | **artifactRepository**\ *optio | string |
8530 +--------------------------------+-------------------------------------------+
8531 | **artifactType**\ *optional* | string |
8532 +--------------------------------+-------------------------------------------+
8533 | **artifactUUID**\ *optional* | string |
8534 +--------------------------------+-------------------------------------------+
8535 | **artifactVersion**\ *optional | string |
8537 +--------------------------------+-------------------------------------------+
8538 | **creationDate**\ *optional* | integer (int64) |
8539 +--------------------------------+-------------------------------------------+
8540 | **creatorFullName**\ *optional | string |
8542 +--------------------------------+-------------------------------------------+
8543 | **description**\ *optional* | string |
8544 +--------------------------------+-------------------------------------------+
8545 | **duplicated**\ *optional* | boolean |
8546 +--------------------------------+-------------------------------------------+
8547 | **esId**\ *optional* | string |
8548 +--------------------------------+-------------------------------------------+
8549 | **generated**\ *optional* | boolean |
8550 +--------------------------------+-------------------------------------------+
8551 | **generatedFromId**\ *optional | string |
8553 +--------------------------------+-------------------------------------------+
8554 | **heatParameters**\ *optional* | < |
8555 | | `HeatParameterDataDefinition <#_heatparam |
8556 | | eterdatadefinition>`__ |
8558 +--------------------------------+-------------------------------------------+
8559 | **heatParamsUpdateDate**\ *opt | integer (int64) |
8561 +--------------------------------+-------------------------------------------+
8562 | **lastUpdateDate**\ *optional* | integer (int64) |
8563 +--------------------------------+-------------------------------------------+
8564 | **mandatory**\ *optional* | boolean |
8565 +--------------------------------+-------------------------------------------+
8566 | **ownerId**\ *optional* | string |
8567 +--------------------------------+-------------------------------------------+
8568 | **payloadUpdateDate**\ *option | integer (int64) |
8570 +--------------------------------+-------------------------------------------+
8571 | **requiredArtifacts**\ *option | < string > array |
8573 +--------------------------------+-------------------------------------------+
8574 | **serviceApi**\ *optional* | boolean |
8575 +--------------------------------+-------------------------------------------+
8576 | **timeout**\ *optional* | integer (int32) |
8577 +--------------------------------+-------------------------------------------+
8578 | **uniqueId**\ *optional* | string |
8579 +--------------------------------+-------------------------------------------+
8580 | **updaterFullName**\ *optional | string |
8582 +--------------------------------+-------------------------------------------+
8583 | **userIdCreator**\ *optional* | string |
8584 +--------------------------------+-------------------------------------------+
8585 | **userIdLastUpdater**\ *option | string |
8587 +--------------------------------+-------------------------------------------+
8592 +--------------------------------+-------------------------------------------+
8594 +================================+===========================================+
8595 | **apiUrl**\ *optional* | string |
8596 +--------------------------------+-------------------------------------------+
8597 | **artifactChecksum**\ *optiona | string |
8599 +--------------------------------+-------------------------------------------+
8600 | **artifactCreator**\ *optional | string |
8602 +--------------------------------+-------------------------------------------+
8603 | **artifactDisplayName**\ *opti | string |
8605 +--------------------------------+-------------------------------------------+
8606 | **artifactGroupType**\ *option | enum (INFORMATIONAL, DEPLOYMENT, |
8607 | al* | LIFE\_CYCLE, SERVICE\_API, TOSCA, OTHER) |
8608 +--------------------------------+-------------------------------------------+
8609 | **artifactLabel**\ *optional* | string |
8610 +--------------------------------+-------------------------------------------+
8611 | **artifactName**\ *optional* | string |
8612 +--------------------------------+-------------------------------------------+
8613 | **artifactRef**\ *optional* | string |
8614 +--------------------------------+-------------------------------------------+
8615 | **artifactRepository**\ *optio | string |
8617 +--------------------------------+-------------------------------------------+
8618 | **artifactType**\ *optional* | string |
8619 +--------------------------------+-------------------------------------------+
8620 | **artifactUUID**\ *optional* | string |
8621 +--------------------------------+-------------------------------------------+
8622 | **artifactVersion**\ *optional | string |
8624 +--------------------------------+-------------------------------------------+
8625 | **creationDate**\ *optional* | integer (int64) |
8626 +--------------------------------+-------------------------------------------+
8627 | **creatorFullName**\ *optional | string |
8629 +--------------------------------+-------------------------------------------+
8630 | **description**\ *optional* | string |
8631 +--------------------------------+-------------------------------------------+
8632 | **duplicated**\ *optional* | boolean |
8633 +--------------------------------+-------------------------------------------+
8634 | **esId**\ *optional* | string |
8635 +--------------------------------+-------------------------------------------+
8636 | **generated**\ *optional* | boolean |
8637 +--------------------------------+-------------------------------------------+
8638 | **generatedFromId**\ *optional | string |
8640 +--------------------------------+-------------------------------------------+
8641 | **heatParameters**\ *optional* | < |
8642 | | `HeatParameterDataDefinition <#_heatparam |
8643 | | eterdatadefinition>`__ |
8645 +--------------------------------+-------------------------------------------+
8646 | **heatParamsUpdateDate**\ *opt | integer (int64) |
8648 +--------------------------------+-------------------------------------------+
8649 | **lastUpdateDate**\ *optional* | integer (int64) |
8650 +--------------------------------+-------------------------------------------+
8651 | **listHeatParameters**\ *optio | < |
8652 | nal* | `HeatParameterDefinition <#_heatparameter |
8653 | | definition>`__ |
8655 +--------------------------------+-------------------------------------------+
8656 | **mandatory**\ *optional* | boolean |
8657 +--------------------------------+-------------------------------------------+
8658 | **ownerId**\ *optional* | string |
8659 +--------------------------------+-------------------------------------------+
8660 | **payloadData**\ *optional* | < string (byte) > array |
8661 +--------------------------------+-------------------------------------------+
8662 | **payloadUpdateDate**\ *option | integer (int64) |
8664 +--------------------------------+-------------------------------------------+
8665 | **requiredArtifacts**\ *option | < string > array |
8667 +--------------------------------+-------------------------------------------+
8668 | **serviceApi**\ *optional* | boolean |
8669 +--------------------------------+-------------------------------------------+
8670 | **timeout**\ *optional* | integer (int32) |
8671 +--------------------------------+-------------------------------------------+
8672 | **uniqueId**\ *optional* | string |
8673 +--------------------------------+-------------------------------------------+
8674 | **updaterFullName**\ *optional | string |
8676 +--------------------------------+-------------------------------------------+
8677 | **userIdCreator**\ *optional* | string |
8678 +--------------------------------+-------------------------------------------+
8679 | **userIdLastUpdater**\ *option | string |
8681 +--------------------------------+-------------------------------------------+
8683 CapabilityDefinition
8684 --------------------
8686 +--------------------------------+-------------------------------------------+
8688 +================================+===========================================+
8689 | **capabilitySources**\ *option | < string > array |
8691 +--------------------------------+-------------------------------------------+
8692 | **description**\ *optional* | string |
8693 +--------------------------------+-------------------------------------------+
8694 | **leftOccurrences**\ *optional | string |
8696 +--------------------------------+-------------------------------------------+
8697 | **maxOccurrences**\ *optional* | string |
8698 +--------------------------------+-------------------------------------------+
8699 | **minOccurrences**\ *optional* | string |
8700 +--------------------------------+-------------------------------------------+
8701 | **name**\ *optional* | string |
8702 +--------------------------------+-------------------------------------------+
8703 | **ownerId**\ *optional* | string |
8704 +--------------------------------+-------------------------------------------+
8705 | **ownerName**\ *optional* | string |
8706 +--------------------------------+-------------------------------------------+
8707 | **parentName**\ *optional* | string |
8708 +--------------------------------+-------------------------------------------+
8709 | **path**\ *optional* | < string > array |
8710 +--------------------------------+-------------------------------------------+
8711 | **properties**\ *optional* | < |
8712 | | `ComponentInstanceProperty <#_componentin |
8713 | | stanceproperty>`__ |
8715 +--------------------------------+-------------------------------------------+
8716 | **source**\ *optional* | string |
8717 +--------------------------------+-------------------------------------------+
8718 | **type**\ *optional* | string |
8719 +--------------------------------+-------------------------------------------+
8720 | **uniqueId**\ *optional* | string |
8721 +--------------------------------+-------------------------------------------+
8722 | **validSourceTypes**\ *optiona | < string > array |
8724 +--------------------------------+-------------------------------------------+
8729 +--------------------------------+-------------------------------------------+
8731 +================================+===========================================+
8732 | **name**\ *optional* | string |
8733 +--------------------------------+-------------------------------------------+
8738 +--------------------------------+-------------------------------------------+
8740 +================================+===========================================+
8741 | **icons**\ *optional* | < string > array |
8742 +--------------------------------+-------------------------------------------+
8743 | **name**\ *optional* | string |
8744 +--------------------------------+-------------------------------------------+
8745 | **normalizedName**\ *optional* | string |
8746 +--------------------------------+-------------------------------------------+
8747 | **ownerId**\ *optional* | string |
8748 +--------------------------------+-------------------------------------------+
8749 | **subcategories**\ *optional* | < |
8750 | | `SubCategoryDefinition <#_subcategorydefi |
8753 +--------------------------------+-------------------------------------------+
8754 | **uniqueId**\ *optional* | string |
8755 +--------------------------------+-------------------------------------------+
8760 +--------------------------------+-------------------------------------------+
8762 +================================+===========================================+
8763 | **artifacts**\ *optional* | < string, |
8764 | | `ArtifactDefinition <#_artifactdefinition |
8767 +--------------------------------+-------------------------------------------+
8768 | **attributeValueCounter**\ *op | integer (int32) |
8770 +--------------------------------+-------------------------------------------+
8771 | **capabilities**\ *optional* | < string, < |
8772 | | `CapabilityDefinition <#_capabilitydefini |
8775 +--------------------------------+-------------------------------------------+
8776 | **componentName**\ *optional* | string |
8777 +--------------------------------+-------------------------------------------+
8778 | **componentUid**\ *optional* | string |
8779 +--------------------------------+-------------------------------------------+
8780 | **componentVersion**\ *optiona | string |
8782 +--------------------------------+-------------------------------------------+
8783 | **creationTime**\ *optional* | integer (int64) |
8784 +--------------------------------+-------------------------------------------+
8785 | **customizationUUID**\ *option | string |
8787 +--------------------------------+-------------------------------------------+
8788 | **deploymentArtifacts**\ *opti | < string, |
8789 | onal* | `ArtifactDefinition <#_artifactdefinition |
8792 +--------------------------------+-------------------------------------------+
8793 | **description**\ *optional* | string |
8794 +--------------------------------+-------------------------------------------+
8795 | **groupInstances**\ *optional* | < `GroupInstance <#_groupinstance>`__ > |
8797 +--------------------------------+-------------------------------------------+
8798 | **icon**\ *optional* | string |
8799 +--------------------------------+-------------------------------------------+
8800 | **inputValueCounter**\ *option | integer (int32) |
8802 +--------------------------------+-------------------------------------------+
8803 | **invariantName**\ *optional* | string |
8804 +--------------------------------+-------------------------------------------+
8805 | **modificationTime**\ *optiona | integer (int64) |
8807 +--------------------------------+-------------------------------------------+
8808 | **name**\ *optional* | string |
8809 +--------------------------------+-------------------------------------------+
8810 | **normalizedName**\ *optional* | string |
8811 +--------------------------------+-------------------------------------------+
8812 | **originType**\ *optional* | enum (PRODUCT, SERVICE, VF, VFC, CP, VL, |
8813 | | VFCMT, CVFC, PNF) |
8814 +--------------------------------+-------------------------------------------+
8815 | **ownerId**\ *optional* | string |
8816 +--------------------------------+-------------------------------------------+
8817 | **posX**\ *optional* | string |
8818 +--------------------------------+-------------------------------------------+
8819 | **posY**\ *optional* | string |
8820 +--------------------------------+-------------------------------------------+
8821 | **propertyValueCounter**\ *opt | integer (int32) |
8823 +--------------------------------+-------------------------------------------+
8824 | **requirements**\ *optional* | < string, < |
8825 | | `RequirementDefinition <#_requirementdefi |
8828 +--------------------------------+-------------------------------------------+
8829 | **toscaComponentName**\ *optio | string |
8831 +--------------------------------+-------------------------------------------+
8832 | **uniqueId**\ *optional* | string |
8833 +--------------------------------+-------------------------------------------+
8835 ComponentInstanceInput
8836 ----------------------
8838 +--------------------------------+-------------------------------------------+
8840 +================================+===========================================+
8841 | **componentInstanceId**\ *opti | string |
8843 +--------------------------------+-------------------------------------------+
8844 | **componentInstanceName**\ *op | string |
8846 +--------------------------------+-------------------------------------------+
8847 | **constraints**\ *optional* | < |
8848 | | `PropertyConstraint <#_propertyconstraint |
8851 +--------------------------------+-------------------------------------------+
8852 | **defaultValue**\ *optional* | string |
8853 +--------------------------------+-------------------------------------------+
8854 | **definition**\ *optional* | boolean |
8855 +--------------------------------+-------------------------------------------+
8856 | **description**\ *optional* | string |
8857 +--------------------------------+-------------------------------------------+
8858 | **getInputValues**\ *optional* | < |
8859 | | `GetInputValueDataDefinition <#_getinputv |
8860 | | aluedatadefinition>`__ |
8862 +--------------------------------+-------------------------------------------+
8863 | **hidden**\ *optional* | boolean |
8864 +--------------------------------+-------------------------------------------+
8865 | **immutable**\ *optional* | boolean |
8866 +--------------------------------+-------------------------------------------+
8867 | **inputId**\ *optional* | string |
8868 +--------------------------------+-------------------------------------------+
8869 | **inputPath**\ *optional* | string |
8870 +--------------------------------+-------------------------------------------+
8871 | **inputs**\ *optional* | < |
8872 | | `ComponentInstanceInput <#_componentinsta |
8875 +--------------------------------+-------------------------------------------+
8876 | **instanceUniqueId**\ *optiona | string |
8878 +--------------------------------+-------------------------------------------+
8879 | **label**\ *optional* | string |
8880 +--------------------------------+-------------------------------------------+
8881 | **name**\ *optional* | string |
8882 +--------------------------------+-------------------------------------------+
8883 | **ownerId**\ *optional* | string |
8884 +--------------------------------+-------------------------------------------+
8885 | **parentUniqueId**\ *optional* | string |
8886 +--------------------------------+-------------------------------------------+
8887 | **password**\ *optional* | boolean |
8888 +--------------------------------+-------------------------------------------+
8889 | **path**\ *optional* | < string > array |
8890 +--------------------------------+-------------------------------------------+
8891 | **properties**\ *optional* | < |
8892 | | `ComponentInstanceProperty <#_componentin |
8893 | | stanceproperty>`__ |
8895 +--------------------------------+-------------------------------------------+
8896 | **propertyId**\ *optional* | string |
8897 +--------------------------------+-------------------------------------------+
8898 | **required**\ *optional* | boolean |
8899 +--------------------------------+-------------------------------------------+
8900 | **rules**\ *optional* | < `PropertyRule <#_propertyrule>`__ > |
8902 +--------------------------------+-------------------------------------------+
8903 | **schema**\ *optional* | `SchemaDefinition <#_schemadefinition>`__ |
8904 +--------------------------------+-------------------------------------------+
8905 | **status**\ *optional* | string |
8906 +--------------------------------+-------------------------------------------+
8907 | **type**\ *optional* | string |
8908 +--------------------------------+-------------------------------------------+
8909 | **uniqueId**\ *optional* | string |
8910 +--------------------------------+-------------------------------------------+
8911 | **value**\ *optional* | string |
8912 +--------------------------------+-------------------------------------------+
8913 | **valueUniqueUid**\ *optional* | string |
8914 +--------------------------------+-------------------------------------------+
8916 ComponentInstanceProperty
8917 -------------------------
8919 +--------------------------------+-------------------------------------------+
8921 +================================+===========================================+
8922 | **componentInstanceId**\ *opti | string |
8924 +--------------------------------+-------------------------------------------+
8925 | **componentInstanceName**\ *op | string |
8927 +--------------------------------+-------------------------------------------+
8928 | **constraints**\ *optional* | < |
8929 | | `PropertyConstraint <#_propertyconstraint |
8932 +--------------------------------+-------------------------------------------+
8933 | **defaultValue**\ *optional* | string |
8934 +--------------------------------+-------------------------------------------+
8935 | **definition**\ *optional* | boolean |
8936 +--------------------------------+-------------------------------------------+
8937 | **description**\ *optional* | string |
8938 +--------------------------------+-------------------------------------------+
8939 | **getInputValues**\ *optional* | < |
8940 | | `GetInputValueDataDefinition <#_getinputv |
8941 | | aluedatadefinition>`__ |
8943 +--------------------------------+-------------------------------------------+
8944 | **hidden**\ *optional* | boolean |
8945 +--------------------------------+-------------------------------------------+
8946 | **immutable**\ *optional* | boolean |
8947 +--------------------------------+-------------------------------------------+
8948 | **inputId**\ *optional* | string |
8949 +--------------------------------+-------------------------------------------+
8950 | **inputPath**\ *optional* | string |
8951 +--------------------------------+-------------------------------------------+
8952 | **instanceUniqueId**\ *optiona | string |
8954 +--------------------------------+-------------------------------------------+
8955 | **label**\ *optional* | string |
8956 +--------------------------------+-------------------------------------------+
8957 | **name**\ *optional* | string |
8958 +--------------------------------+-------------------------------------------+
8959 | **ownerId**\ *optional* | string |
8960 +--------------------------------+-------------------------------------------+
8961 | **parentUniqueId**\ *optional* | string |
8962 +--------------------------------+-------------------------------------------+
8963 | **password**\ *optional* | boolean |
8964 +--------------------------------+-------------------------------------------+
8965 | **path**\ *optional* | < string > array |
8966 +--------------------------------+-------------------------------------------+
8967 | **propertyId**\ *optional* | string |
8968 +--------------------------------+-------------------------------------------+
8969 | **required**\ *optional* | boolean |
8970 +--------------------------------+-------------------------------------------+
8971 | **rules**\ *optional* | < `PropertyRule <#_propertyrule>`__ > |
8973 +--------------------------------+-------------------------------------------+
8974 | **schema**\ *optional* | `SchemaDefinition <#_schemadefinition>`__ |
8975 +--------------------------------+-------------------------------------------+
8976 | **status**\ *optional* | string |
8977 +--------------------------------+-------------------------------------------+
8978 | **type**\ *optional* | string |
8979 +--------------------------------+-------------------------------------------+
8980 | **uniqueId**\ *optional* | string |
8981 +--------------------------------+-------------------------------------------+
8982 | **value**\ *optional* | string |
8983 +--------------------------------+-------------------------------------------+
8984 | **valueUniqueUid**\ *optional* | string |
8985 +--------------------------------+-------------------------------------------+
8987 ComponentMetadataDataDefinition
8988 -------------------------------
8990 +--------------------------------+-------------------------------------------+
8992 +================================+===========================================+
8993 | **allVersions**\ *optional* | < string, string > map |
8994 +--------------------------------+-------------------------------------------+
8995 | **componentType**\ *optional* | enum (RESOURCE, SERVICE, |
8996 | | RESOURCE\_INSTANCE, PRODUCT, |
8997 | | SERVICE\_INSTANCE) |
8998 +--------------------------------+-------------------------------------------+
8999 | **conformanceLevel**\ *optiona | string |
9001 +--------------------------------+-------------------------------------------+
9002 | **contactId**\ *optional* | string |
9003 +--------------------------------+-------------------------------------------+
9004 | **creationDate**\ *optional* | integer (int64) |
9005 +--------------------------------+-------------------------------------------+
9006 | **creatorFullName**\ *optional | string |
9008 +--------------------------------+-------------------------------------------+
9009 | **creatorUserId**\ *optional* | string |
9010 +--------------------------------+-------------------------------------------+
9011 | **csarUUID**\ *optional* | string |
9012 +--------------------------------+-------------------------------------------+
9013 | **csarVersion**\ *optional* | string |
9014 +--------------------------------+-------------------------------------------+
9015 | **deleted**\ *optional* | boolean |
9016 +--------------------------------+-------------------------------------------+
9017 | **description**\ *optional* | string |
9018 +--------------------------------+-------------------------------------------+
9019 | **highestVersion**\ *optional* | boolean |
9020 +--------------------------------+-------------------------------------------+
9021 | **icon**\ *optional* | string |
9022 +--------------------------------+-------------------------------------------+
9023 | **importedToscaChecksum**\ *op | string |
9025 +--------------------------------+-------------------------------------------+
9026 | **invariantUUID**\ *optional* | string |
9027 +--------------------------------+-------------------------------------------+
9028 | **isDeleted**\ *optional* | boolean |
9029 +--------------------------------+-------------------------------------------+
9030 | **isHighestVersion**\ *optiona | boolean |
9032 +--------------------------------+-------------------------------------------+
9033 | **lastUpdateDate**\ *optional* | integer (int64) |
9034 +--------------------------------+-------------------------------------------+
9035 | **lastUpdaterFullName**\ *opti | string |
9037 +--------------------------------+-------------------------------------------+
9038 | **lastUpdaterUserId**\ *option | string |
9040 +--------------------------------+-------------------------------------------+
9041 | **lifecycleState**\ *optional* | string |
9042 +--------------------------------+-------------------------------------------+
9043 | **name**\ *optional* | string |
9044 +--------------------------------+-------------------------------------------+
9045 | **normalizedName**\ *optional* | string |
9046 +--------------------------------+-------------------------------------------+
9047 | **ownerId**\ *optional* | string |
9048 +--------------------------------+-------------------------------------------+
9049 | **projectCode**\ *optional* | string |
9050 +--------------------------------+-------------------------------------------+
9051 | **state**\ *optional* | string |
9052 +--------------------------------+-------------------------------------------+
9053 | **systemName**\ *optional* | string |
9054 +--------------------------------+-------------------------------------------+
9055 | **tags**\ *optional* | < string > array |
9056 +--------------------------------+-------------------------------------------+
9057 | **uniqueId**\ *optional* | string |
9058 +--------------------------------+-------------------------------------------+
9059 | **uuid**\ *optional* | string |
9060 +--------------------------------+-------------------------------------------+
9061 | **version**\ *optional* | string |
9062 +--------------------------------+-------------------------------------------+
9064 ComponentMetadataDefinition
9065 ---------------------------
9067 +--------------------------------+-------------------------------------------+
9069 +================================+===========================================+
9070 | **metadataDataDefinition**\ *o | `ComponentMetadataDataDefinition <#_compo |
9071 | ptional* | nentmetadatadatadefinition>`__ |
9072 +--------------------------------+-------------------------------------------+
9077 +--------------------------------+-------------------------------------------+
9079 +================================+===========================================+
9080 | **consumerDetailsLastupdatedti | integer (int64) |
9081 | me**\ *optional* | |
9082 +--------------------------------+-------------------------------------------+
9083 | **consumerLastAuthenticationTi | integer (int64) |
9084 | me**\ *optional* | |
9085 +--------------------------------+-------------------------------------------+
9086 | **consumerName**\ *optional* | string |
9087 +--------------------------------+-------------------------------------------+
9088 | **consumerPassword**\ *optiona | string |
9090 +--------------------------------+-------------------------------------------+
9091 | **consumerSalt**\ *optional* | string |
9092 +--------------------------------+-------------------------------------------+
9093 | **lastModfierAtuid**\ *optiona | string |
9095 +--------------------------------+-------------------------------------------+
9096 | **ownerId**\ *optional* | string |
9097 +--------------------------------+-------------------------------------------+
9099 DistributionStatusInfo
9100 ----------------------
9102 +--------------------------------+-------------------------------------------+
9104 +================================+===========================================+
9105 | **errorReason**\ *optional* | string |
9106 +--------------------------------+-------------------------------------------+
9107 | **omfComponentID**\ *optional* | string |
9108 +--------------------------------+-------------------------------------------+
9109 | **status**\ *optional* | string |
9110 +--------------------------------+-------------------------------------------+
9111 | **timestamp**\ *optional* | string |
9112 +--------------------------------+-------------------------------------------+
9113 | **url**\ *optional* | string |
9114 +--------------------------------+-------------------------------------------+
9116 DistributionStatusListResponse
9117 ------------------------------
9119 +--------------------------------+-------------------------------------------+
9121 +================================+===========================================+
9122 | **distributionStatusList**\ *o | < |
9123 | ptional* | `DistributionStatusInfo <#_distributionst |
9126 +--------------------------------+-------------------------------------------+
9128 GetInputValueDataDefinition
9129 ---------------------------
9131 +--------------------------------+-------------------------------------------+
9133 +================================+===========================================+
9134 | **getInputIndex**\ *optional* | `GetInputValueDataDefinition <#_getinputv |
9135 | | aluedatadefinition>`__ |
9136 +--------------------------------+-------------------------------------------+
9137 | **indexValue**\ *optional* | integer (int32) |
9138 +--------------------------------+-------------------------------------------+
9139 | **inputId**\ *optional* | string |
9140 +--------------------------------+-------------------------------------------+
9141 | **inputName**\ *optional* | string |
9142 +--------------------------------+-------------------------------------------+
9143 | **list**\ *optional* | boolean |
9144 +--------------------------------+-------------------------------------------+
9145 | **ownerId**\ *optional* | string |
9146 +--------------------------------+-------------------------------------------+
9147 | **propName**\ *optional* | string |
9148 +--------------------------------+-------------------------------------------+
9153 +--------------------------------+-------------------------------------------+
9155 +================================+===========================================+
9156 | **artifacts**\ *optional* | < string > array |
9157 +--------------------------------+-------------------------------------------+
9158 | **artifactsUuid**\ *optional* | < string > array |
9159 +--------------------------------+-------------------------------------------+
9160 | **description**\ *optional* | string |
9161 +--------------------------------+-------------------------------------------+
9162 | **groupUUID**\ *optional* | string |
9163 +--------------------------------+-------------------------------------------+
9164 | **invariantUUID**\ *optional* | string |
9165 +--------------------------------+-------------------------------------------+
9166 | **members**\ *optional* | < string, string > map |
9167 +--------------------------------+-------------------------------------------+
9168 | **name**\ *optional* | string |
9169 +--------------------------------+-------------------------------------------+
9170 | **ownerId**\ *optional* | string |
9171 +--------------------------------+-------------------------------------------+
9172 | **properties**\ *optional* | < |
9173 | | `PropertyDataDefinition <#_propertydatade |
9176 +--------------------------------+-------------------------------------------+
9177 | **propertyValueCounter**\ *opt | integer (int32) |
9179 +--------------------------------+-------------------------------------------+
9180 | **type**\ *optional* | string |
9181 +--------------------------------+-------------------------------------------+
9182 | **typeUid**\ *optional* | string |
9183 +--------------------------------+-------------------------------------------+
9184 | **uniqueId**\ *optional* | string |
9185 +--------------------------------+-------------------------------------------+
9186 | **version**\ *optional* | string |
9187 +--------------------------------+-------------------------------------------+
9192 +--------------------------------+-------------------------------------------+
9194 +================================+===========================================+
9195 | **artifacts**\ *optional* | < string > array |
9196 +--------------------------------+-------------------------------------------+
9197 | **artifactsUuid**\ *optional* | < string > array |
9198 +--------------------------------+-------------------------------------------+
9199 | **creationTime**\ *optional* | integer (int64) |
9200 +--------------------------------+-------------------------------------------+
9201 | **customizationUUID**\ *option | string |
9203 +--------------------------------+-------------------------------------------+
9204 | **description**\ *optional* | string |
9205 +--------------------------------+-------------------------------------------+
9206 | **groupInstanceArtifacts**\ *o | < string > array |
9208 +--------------------------------+-------------------------------------------+
9209 | **groupInstanceArtifactsUuid** | < string > array |
9211 +--------------------------------+-------------------------------------------+
9212 | **groupName**\ *optional* | string |
9213 +--------------------------------+-------------------------------------------+
9214 | **groupUUID**\ *optional* | string |
9215 +--------------------------------+-------------------------------------------+
9216 | **groupUid**\ *optional* | string |
9217 +--------------------------------+-------------------------------------------+
9218 | **invariantUUID**\ *optional* | string |
9219 +--------------------------------+-------------------------------------------+
9220 | **modificationTime**\ *optiona | integer (int64) |
9222 +--------------------------------+-------------------------------------------+
9223 | **name**\ *optional* | string |
9224 +--------------------------------+-------------------------------------------+
9225 | **normalizedName**\ *optional* | string |
9226 +--------------------------------+-------------------------------------------+
9227 | **ownerId**\ *optional* | string |
9228 +--------------------------------+-------------------------------------------+
9229 | **posX**\ *optional* | string |
9230 +--------------------------------+-------------------------------------------+
9231 | **posY**\ *optional* | string |
9232 +--------------------------------+-------------------------------------------+
9233 | **properties**\ *optional* | < |
9234 | | `PropertyDataDefinition <#_propertydatade |
9237 +--------------------------------+-------------------------------------------+
9238 | **propertyValueCounter**\ *opt | integer (int32) |
9240 +--------------------------------+-------------------------------------------+
9241 | **type**\ *optional* | string |
9242 +--------------------------------+-------------------------------------------+
9243 | **uniqueId**\ *optional* | string |
9244 +--------------------------------+-------------------------------------------+
9245 | **version**\ *optional* | string |
9246 +--------------------------------+-------------------------------------------+
9251 +--------------------------------+-------------------------------------------+
9253 +================================+===========================================+
9254 | **name**\ *optional* | string |
9255 +--------------------------------+-------------------------------------------+
9256 | **normalizedName**\ *optional* | string |
9257 +--------------------------------+-------------------------------------------+
9258 | **ownerId**\ *optional* | string |
9259 +--------------------------------+-------------------------------------------+
9260 | **uniqueId**\ *optional* | string |
9261 +--------------------------------+-------------------------------------------+
9263 HeatParameterDataDefinition
9264 ---------------------------
9266 +--------------------------------+-------------------------------------------+
9268 +================================+===========================================+
9269 | **currentValue**\ *optional* | string |
9270 +--------------------------------+-------------------------------------------+
9271 | **defaultValue**\ *optional* | string |
9272 +--------------------------------+-------------------------------------------+
9273 | **description**\ *optional* | string |
9274 +--------------------------------+-------------------------------------------+
9275 | **name**\ *optional* | string |
9276 +--------------------------------+-------------------------------------------+
9277 | **ownerId**\ *optional* | string |
9278 +--------------------------------+-------------------------------------------+
9279 | **type**\ *optional* | string |
9280 +--------------------------------+-------------------------------------------+
9281 | **uniqueId**\ *optional* | string |
9282 +--------------------------------+-------------------------------------------+
9284 HeatParameterDefinition
9285 -----------------------
9287 +--------------------------------+-------------------------------------------+
9289 +================================+===========================================+
9290 | **currentValue**\ *optional* | string |
9291 +--------------------------------+-------------------------------------------+
9292 | **defaultValue**\ *optional* | string |
9293 +--------------------------------+-------------------------------------------+
9294 | **description**\ *optional* | string |
9295 +--------------------------------+-------------------------------------------+
9296 | **name**\ *optional* | string |
9297 +--------------------------------+-------------------------------------------+
9298 | **ownerId**\ *optional* | string |
9299 +--------------------------------+-------------------------------------------+
9300 | **type**\ *optional* | string |
9301 +--------------------------------+-------------------------------------------+
9302 | **uniqueId**\ *optional* | string |
9303 +--------------------------------+-------------------------------------------+
9308 +--------------------------------+-------------------------------------------+
9310 +================================+===========================================+
9311 | **constraints**\ *optional* | < |
9312 | | `PropertyConstraint <#_propertyconstraint |
9315 +--------------------------------+-------------------------------------------+
9316 | **defaultValue**\ *optional* | string |
9317 +--------------------------------+-------------------------------------------+
9318 | **definition**\ *optional* | boolean |
9319 +--------------------------------+-------------------------------------------+
9320 | **description**\ *optional* | string |
9321 +--------------------------------+-------------------------------------------+
9322 | **getInputValues**\ *optional* | < |
9323 | | `GetInputValueDataDefinition <#_getinputv |
9324 | | aluedatadefinition>`__ |
9326 +--------------------------------+-------------------------------------------+
9327 | **hidden**\ *optional* | boolean |
9328 +--------------------------------+-------------------------------------------+
9329 | **immutable**\ *optional* | boolean |
9330 +--------------------------------+-------------------------------------------+
9331 | **inputId**\ *optional* | string |
9332 +--------------------------------+-------------------------------------------+
9333 | **inputPath**\ *optional* | string |
9334 +--------------------------------+-------------------------------------------+
9335 | **inputs**\ *optional* | < |
9336 | | `ComponentInstanceInput <#_componentinsta |
9339 +--------------------------------+-------------------------------------------+
9340 | **instanceUniqueId**\ *optiona | string |
9342 +--------------------------------+-------------------------------------------+
9343 | **label**\ *optional* | string |
9344 +--------------------------------+-------------------------------------------+
9345 | **name**\ *optional* | string |
9346 +--------------------------------+-------------------------------------------+
9347 | **ownerId**\ *optional* | string |
9348 +--------------------------------+-------------------------------------------+
9349 | **parentUniqueId**\ *optional* | string |
9350 +--------------------------------+-------------------------------------------+
9351 | **password**\ *optional* | boolean |
9352 +--------------------------------+-------------------------------------------+
9353 | **properties**\ *optional* | < |
9354 | | `ComponentInstanceProperty <#_componentin |
9355 | | stanceproperty>`__ |
9357 +--------------------------------+-------------------------------------------+
9358 | **propertyId**\ *optional* | string |
9359 +--------------------------------+-------------------------------------------+
9360 | **required**\ *optional* | boolean |
9361 +--------------------------------+-------------------------------------------+
9362 | **schema**\ *optional* | `SchemaDefinition <#_schemadefinition>`__ |
9363 +--------------------------------+-------------------------------------------+
9364 | **status**\ *optional* | string |
9365 +--------------------------------+-------------------------------------------+
9366 | **type**\ *optional* | string |
9367 +--------------------------------+-------------------------------------------+
9368 | **uniqueId**\ *optional* | string |
9369 +--------------------------------+-------------------------------------------+
9370 | **value**\ *optional* | string |
9371 +--------------------------------+-------------------------------------------+
9376 +--------------------------------+-------------------------------------------+
9378 +================================+===========================================+
9379 | **creationDate**\ *optional* | integer (int64) |
9380 +--------------------------------+-------------------------------------------+
9381 | **definition**\ *optional* | boolean |
9382 +--------------------------------+-------------------------------------------+
9383 | **description**\ *optional* | string |
9384 +--------------------------------+-------------------------------------------+
9385 | **lastUpdateDate**\ *optional* | integer (int64) |
9386 +--------------------------------+-------------------------------------------+
9387 | **operations**\ *optional* | < string, |
9388 | | `OperationDataDefinition <#_operationdata |
9389 | | definition>`__ |
9391 +--------------------------------+-------------------------------------------+
9392 | **operationsMap**\ *optional* | < string, `Operation <#_operation>`__ > |
9394 +--------------------------------+-------------------------------------------+
9395 | **ownerId**\ *optional* | string |
9396 +--------------------------------+-------------------------------------------+
9397 | **type**\ *optional* | string |
9398 +--------------------------------+-------------------------------------------+
9399 | **uniqueId**\ *optional* | string |
9400 +--------------------------------+-------------------------------------------+
9402 LifecycleChangeInfoWithAction
9403 -----------------------------
9405 +--------------------------------+-------------------------------------------+
9407 +================================+===========================================+
9408 | **action**\ *optional* | enum (CREATE\_FROM\_CSAR, |
9409 | | UPDATE\_FROM\_EXTERNAL\_API) |
9410 +--------------------------------+-------------------------------------------+
9411 | **userRemarks**\ *optional* | string |
9412 +--------------------------------+-------------------------------------------+
9417 +--------------------------------+-------------------------------------------+
9419 +================================+===========================================+
9420 | **creationDate**\ *optional* | integer (int64) |
9421 +--------------------------------+-------------------------------------------+
9422 | **definition**\ *optional* | boolean |
9423 +--------------------------------+-------------------------------------------+
9424 | **description**\ *optional* | string |
9425 +--------------------------------+-------------------------------------------+
9426 | **implementation**\ *optional* | `ArtifactDataDefinition <#_artifactdatade |
9428 +--------------------------------+-------------------------------------------+
9429 | **implementationArtifact**\ *o | `ArtifactDefinition <#_artifactdefinition |
9431 +--------------------------------+-------------------------------------------+
9432 | **inputs**\ *optional* | < string, |
9433 | | `PropertyDataDefinition <#_propertydatade |
9436 +--------------------------------+-------------------------------------------+
9437 | **lastUpdateDate**\ *optional* | integer (int64) |
9438 +--------------------------------+-------------------------------------------+
9439 | **ownerId**\ *optional* | string |
9440 +--------------------------------+-------------------------------------------+
9441 | **uniqueId**\ *optional* | string |
9442 +--------------------------------+-------------------------------------------+
9444 OperationDataDefinition
9445 -----------------------
9447 +--------------------------------+-------------------------------------------+
9449 +================================+===========================================+
9450 | **creationDate**\ *optional* | integer (int64) |
9451 +--------------------------------+-------------------------------------------+
9452 | **description**\ *optional* | string |
9453 +--------------------------------+-------------------------------------------+
9454 | **implementation**\ *optional* | `ArtifactDataDefinition <#_artifactdatade |
9456 +--------------------------------+-------------------------------------------+
9457 | **inputs**\ *optional* | < string, |
9458 | | `PropertyDataDefinition <#_propertydatade |
9461 +--------------------------------+-------------------------------------------+
9462 | **lastUpdateDate**\ *optional* | integer (int64) |
9463 +--------------------------------+-------------------------------------------+
9464 | **ownerId**\ *optional* | string |
9465 +--------------------------------+-------------------------------------------+
9466 | **uniqueId**\ *optional* | string |
9467 +--------------------------------+-------------------------------------------+
9472 +--------------------------------+-------------------------------------------+
9474 +================================+===========================================+
9475 | **additionalInformation**\ *op | < |
9476 | tional* | `AdditionalInformationDefinition <#_addit |
9477 | | ionalinformationdefinition>`__ |
9479 +--------------------------------+-------------------------------------------+
9480 | **allArtifacts**\ *optional* | < string, |
9481 | | `ArtifactDefinition <#_artifactdefinition |
9484 +--------------------------------+-------------------------------------------+
9485 | **allVersions**\ *optional* | < string, string > map |
9486 +--------------------------------+-------------------------------------------+
9487 | **artifacts**\ *optional* | < string, |
9488 | | `ArtifactDefinition <#_artifactdefinition |
9491 +--------------------------------+-------------------------------------------+
9492 | **capabilities**\ *optional* | < string, < |
9493 | | `CapabilityDefinition <#_capabilitydefini |
9496 +--------------------------------+-------------------------------------------+
9497 | **categories**\ *optional* | < |
9498 | | `CategoryDefinition <#_categorydefinition |
9501 +--------------------------------+-------------------------------------------+
9502 | **componentInstances**\ *optio | < |
9503 | nal* | `ComponentInstance <#_componentinstance>` |
9506 +--------------------------------+-------------------------------------------+
9507 | **componentInstancesAttributes | < string, < |
9508 | **\ *optional* | `ComponentInstanceProperty <#_componentin |
9509 | | stanceproperty>`__ |
9511 +--------------------------------+-------------------------------------------+
9512 | **componentInstancesInputs**\ | < string, < |
9513 | *optional* | `ComponentInstanceInput <#_componentinsta |
9516 +--------------------------------+-------------------------------------------+
9517 | **componentInstancesProperties | < string, < |
9518 | **\ *optional* | `ComponentInstanceProperty <#_componentin |
9519 | | stanceproperty>`__ |
9521 +--------------------------------+-------------------------------------------+
9522 | **componentInstancesRelations* | < |
9523 | *\ *optional* | `RequirementCapabilityRelDef <#_requireme |
9524 | | ntcapabilityreldef>`__ |
9526 +--------------------------------+-------------------------------------------+
9527 | **componentMetadataDefinition* | `ComponentMetadataDefinition <#_component |
9528 | *\ *optional* | metadatadefinition>`__ |
9529 +--------------------------------+-------------------------------------------+
9530 | **componentType**\ *optional* | enum (RESOURCE, SERVICE, |
9531 | | RESOURCE\_INSTANCE, PRODUCT, |
9532 | | SERVICE\_INSTANCE) |
9533 +--------------------------------+-------------------------------------------+
9534 | **conformanceLevel**\ *optiona | string |
9536 +--------------------------------+-------------------------------------------+
9537 | **contactId**\ *optional* | string |
9538 +--------------------------------+-------------------------------------------+
9539 | **contacts**\ *optional* | < string > array |
9540 +--------------------------------+-------------------------------------------+
9541 | **creationDate**\ *optional* | integer (int64) |
9542 +--------------------------------+-------------------------------------------+
9543 | **creatorFullName**\ *optional | string |
9545 +--------------------------------+-------------------------------------------+
9546 | **creatorUserId**\ *optional* | string |
9547 +--------------------------------+-------------------------------------------+
9548 | **csarUUID**\ *optional* | string |
9549 +--------------------------------+-------------------------------------------+
9550 | **csarVersion**\ *optional* | string |
9551 +--------------------------------+-------------------------------------------+
9552 | **deploymentArtifacts**\ *opti | < string, |
9553 | onal* | `ArtifactDefinition <#_artifactdefinition |
9556 +--------------------------------+-------------------------------------------+
9557 | **derivedFromGenericType**\ *o | string |
9559 +--------------------------------+-------------------------------------------+
9560 | **derivedFromGenericVersion**\ | string |
9562 +--------------------------------+-------------------------------------------+
9563 | **description**\ *optional* | string |
9564 +--------------------------------+-------------------------------------------+
9565 | **fullName**\ *optional* | string |
9566 +--------------------------------+-------------------------------------------+
9567 | **groups**\ *optional* | < `GroupDefinition <#_groupdefinition>`__ |
9569 +--------------------------------+-------------------------------------------+
9570 | **highestVersion**\ *optional* | boolean |
9571 +--------------------------------+-------------------------------------------+
9572 | **icon**\ *optional* | string |
9573 +--------------------------------+-------------------------------------------+
9574 | **importedToscaChecksum**\ *op | string |
9576 +--------------------------------+-------------------------------------------+
9577 | **inputs**\ *optional* | < `InputDefinition <#_inputdefinition>`__ |
9579 +--------------------------------+-------------------------------------------+
9580 | **invariantUUID**\ *optional* | string |
9581 +--------------------------------+-------------------------------------------+
9582 | **isActive**\ *optional* | boolean |
9583 +--------------------------------+-------------------------------------------+
9584 | **isDeleted**\ *optional* | boolean |
9585 +--------------------------------+-------------------------------------------+
9586 | **lastUpdateDate**\ *optional* | integer (int64) |
9587 +--------------------------------+-------------------------------------------+
9588 | **lastUpdaterFullName**\ *opti | string |
9590 +--------------------------------+-------------------------------------------+
9591 | **lastUpdaterUserId**\ *option | string |
9593 +--------------------------------+-------------------------------------------+
9594 | **lifecycleState**\ *optional* | enum (READY\_FOR\_CERTIFICATION, |
9595 | | CERTIFICATION\_IN\_PROGRESS, CERTIFIED, |
9596 | | NOT\_CERTIFIED\_CHECKIN, |
9597 | | NOT\_CERTIFIED\_CHECKOUT) |
9598 +--------------------------------+-------------------------------------------+
9599 | **name**\ *optional* | string |
9600 +--------------------------------+-------------------------------------------+
9601 | **normalizedName**\ *optional* | string |
9602 +--------------------------------+-------------------------------------------+
9603 | **projectCode**\ *optional* | string |
9604 +--------------------------------+-------------------------------------------+
9605 | **requirements**\ *optional* | < string, < |
9606 | | `RequirementDefinition <#_requirementdefi |
9609 +--------------------------------+-------------------------------------------+
9610 | **systemName**\ *optional* | string |
9611 +--------------------------------+-------------------------------------------+
9612 | **tags**\ *optional* | < string > array |
9613 +--------------------------------+-------------------------------------------+
9614 | **toscaArtifacts**\ *optional* | < string, |
9615 | | `ArtifactDefinition <#_artifactdefinition |
9618 +--------------------------------+-------------------------------------------+
9619 | **toscaType**\ *optional* | string |
9620 +--------------------------------+-------------------------------------------+
9621 | **uniqueId**\ *optional* | string |
9622 +--------------------------------+-------------------------------------------+
9623 | **uuid**\ *optional* | string |
9624 +--------------------------------+-------------------------------------------+
9625 | **version**\ *optional* | string |
9626 +--------------------------------+-------------------------------------------+
9633 PropertyDataDefinition
9634 ----------------------
9636 +--------------------------------+-------------------------------------------+
9638 +================================+===========================================+
9639 | **defaultValue**\ *optional* | string |
9640 +--------------------------------+-------------------------------------------+
9641 | **definition**\ *optional* | boolean |
9642 +--------------------------------+-------------------------------------------+
9643 | **description**\ *optional* | string |
9644 +--------------------------------+-------------------------------------------+
9645 | **getInputValues**\ *optional* | < |
9646 | | `GetInputValueDataDefinition <#_getinputv |
9647 | | aluedatadefinition>`__ |
9649 +--------------------------------+-------------------------------------------+
9650 | **hidden**\ *optional* | boolean |
9651 +--------------------------------+-------------------------------------------+
9652 | **immutable**\ *optional* | boolean |
9653 +--------------------------------+-------------------------------------------+
9654 | **inputId**\ *optional* | string |
9655 +--------------------------------+-------------------------------------------+
9656 | **inputPath**\ *optional* | string |
9657 +--------------------------------+-------------------------------------------+
9658 | **instanceUniqueId**\ *optiona | string |
9660 +--------------------------------+-------------------------------------------+
9661 | **label**\ *optional* | string |
9662 +--------------------------------+-------------------------------------------+
9663 | **name**\ *optional* | string |
9664 +--------------------------------+-------------------------------------------+
9665 | **ownerId**\ *optional* | string |
9666 +--------------------------------+-------------------------------------------+
9667 | **parentUniqueId**\ *optional* | string |
9668 +--------------------------------+-------------------------------------------+
9669 | **password**\ *optional* | boolean |
9670 +--------------------------------+-------------------------------------------+
9671 | **propertyId**\ *optional* | string |
9672 +--------------------------------+-------------------------------------------+
9673 | **required**\ *optional* | boolean |
9674 +--------------------------------+-------------------------------------------+
9675 | **schema**\ *optional* | `SchemaDefinition <#_schemadefinition>`__ |
9676 +--------------------------------+-------------------------------------------+
9677 | **status**\ *optional* | string |
9678 +--------------------------------+-------------------------------------------+
9679 | **type**\ *optional* | string |
9680 +--------------------------------+-------------------------------------------+
9681 | **uniqueId**\ *optional* | string |
9682 +--------------------------------+-------------------------------------------+
9683 | **value**\ *optional* | string |
9684 +--------------------------------+-------------------------------------------+
9689 +--------------------------------+-------------------------------------------+
9691 +================================+===========================================+
9692 | **constraints**\ *optional* | < |
9693 | | `PropertyConstraint <#_propertyconstraint |
9696 +--------------------------------+-------------------------------------------+
9697 | **defaultValue**\ *optional* | string |
9698 +--------------------------------+-------------------------------------------+
9699 | **definition**\ *optional* | boolean |
9700 +--------------------------------+-------------------------------------------+
9701 | **description**\ *optional* | string |
9702 +--------------------------------+-------------------------------------------+
9703 | **getInputValues**\ *optional* | < |
9704 | | `GetInputValueDataDefinition <#_getinputv |
9705 | | aluedatadefinition>`__ |
9707 +--------------------------------+-------------------------------------------+
9708 | **hidden**\ *optional* | boolean |
9709 +--------------------------------+-------------------------------------------+
9710 | **immutable**\ *optional* | boolean |
9711 +--------------------------------+-------------------------------------------+
9712 | **inputId**\ *optional* | string |
9713 +--------------------------------+-------------------------------------------+
9714 | **inputPath**\ *optional* | string |
9715 +--------------------------------+-------------------------------------------+
9716 | **instanceUniqueId**\ *optiona | string |
9718 +--------------------------------+-------------------------------------------+
9719 | **label**\ *optional* | string |
9720 +--------------------------------+-------------------------------------------+
9721 | **name**\ *optional* | string |
9722 +--------------------------------+-------------------------------------------+
9723 | **ownerId**\ *optional* | string |
9724 +--------------------------------+-------------------------------------------+
9725 | **parentUniqueId**\ *optional* | string |
9726 +--------------------------------+-------------------------------------------+
9727 | **password**\ *optional* | boolean |
9728 +--------------------------------+-------------------------------------------+
9729 | **propertyId**\ *optional* | string |
9730 +--------------------------------+-------------------------------------------+
9731 | **required**\ *optional* | boolean |
9732 +--------------------------------+-------------------------------------------+
9733 | **schema**\ *optional* | `SchemaDefinition <#_schemadefinition>`__ |
9734 +--------------------------------+-------------------------------------------+
9735 | **status**\ *optional* | string |
9736 +--------------------------------+-------------------------------------------+
9737 | **type**\ *optional* | string |
9738 +--------------------------------+-------------------------------------------+
9739 | **uniqueId**\ *optional* | string |
9740 +--------------------------------+-------------------------------------------+
9741 | **value**\ *optional* | string |
9742 +--------------------------------+-------------------------------------------+
9747 +--------------------------------+-------------------------------------------+
9749 +================================+===========================================+
9750 | **firstToken**\ *optional* | string |
9751 +--------------------------------+-------------------------------------------+
9752 | **ownerId**\ *optional* | string |
9753 +--------------------------------+-------------------------------------------+
9754 | **rule**\ *optional* | < string > array |
9755 +--------------------------------+-------------------------------------------+
9756 | **ruleSize**\ *optional* | integer (int32) |
9757 +--------------------------------+-------------------------------------------+
9758 | **value**\ *optional* | string |
9759 +--------------------------------+-------------------------------------------+
9764 +--------------------------------+-------------------------------------------+
9766 +================================+===========================================+
9767 | **type**\ *optional* | string |
9768 +--------------------------------+-------------------------------------------+
9770 RequirementAndRelationshipPair
9771 ------------------------------
9773 +--------------------------------+-------------------------------------------+
9775 +================================+===========================================+
9776 | **capability**\ *optional* | string |
9777 +--------------------------------+-------------------------------------------+
9778 | **capabilityOwnerId**\ *option | string |
9780 +--------------------------------+-------------------------------------------+
9781 | **capabilityUid**\ *optional* | string |
9782 +--------------------------------+-------------------------------------------+
9783 | **id**\ *optional* | string |
9784 +--------------------------------+-------------------------------------------+
9785 | **relationship**\ *optional* | `RelationshipImpl <#_relationshipimpl>`__ |
9786 +--------------------------------+-------------------------------------------+
9787 | **requirement**\ *optional* | string |
9788 +--------------------------------+-------------------------------------------+
9789 | **requirementOwnerId**\ *optio | string |
9791 +--------------------------------+-------------------------------------------+
9792 | **requirementUid**\ *optional* | string |
9793 +--------------------------------+-------------------------------------------+
9795 RequirementCapabilityRelDef
9796 ---------------------------
9798 +--------------------------------+-------------------------------------------+
9800 +================================+===========================================+
9801 | **fromNode**\ *optional* | string |
9802 +--------------------------------+-------------------------------------------+
9803 | **relationships**\ *optional* | < |
9804 | | `RequirementAndRelationshipPair <#_requir |
9805 | | ementandrelationshippair>`__ |
9807 +--------------------------------+-------------------------------------------+
9808 | **toNode**\ *optional* | string |
9809 +--------------------------------+-------------------------------------------+
9810 | **uid**\ *optional* | string |
9811 +--------------------------------+-------------------------------------------+
9813 RequirementDefinition
9814 ---------------------
9816 +--------------------------------+-------------------------------------------+
9818 +================================+===========================================+
9819 | **capability**\ *optional* | string |
9820 +--------------------------------+-------------------------------------------+
9821 | **leftOccurrences**\ *optional | string |
9823 +--------------------------------+-------------------------------------------+
9824 | **maxOccurrences**\ *optional* | string |
9825 +--------------------------------+-------------------------------------------+
9826 | **minOccurrences**\ *optional* | string |
9827 +--------------------------------+-------------------------------------------+
9828 | **name**\ *optional* | string |
9829 +--------------------------------+-------------------------------------------+
9830 | **node**\ *optional* | string |
9831 +--------------------------------+-------------------------------------------+
9832 | **ownerId**\ *optional* | string |
9833 +--------------------------------+-------------------------------------------+
9834 | **ownerName**\ *optional* | string |
9835 +--------------------------------+-------------------------------------------+
9836 | **parentName**\ *optional* | string |
9837 +--------------------------------+-------------------------------------------+
9838 | **path**\ *optional* | < string > array |
9839 +--------------------------------+-------------------------------------------+
9840 | **relationship**\ *optional* | string |
9841 +--------------------------------+-------------------------------------------+
9842 | **source**\ *optional* | string |
9843 +--------------------------------+-------------------------------------------+
9844 | **uniqueId**\ *optional* | string |
9845 +--------------------------------+-------------------------------------------+
9850 +--------------------------------+-------------------------------------------+
9852 +================================+===========================================+
9853 | **abstract**\ *optional* | boolean |
9854 +--------------------------------+-------------------------------------------+
9855 | **additionalInformation**\ *op | < |
9856 | tional* | `AdditionalInformationDefinition <#_addit |
9857 | | ionalinformationdefinition>`__ |
9859 +--------------------------------+-------------------------------------------+
9860 | **allArtifacts**\ *optional* | < string, |
9861 | | `ArtifactDefinition <#_artifactdefinition |
9864 +--------------------------------+-------------------------------------------+
9865 | **allVersions**\ *optional* | < string, string > map |
9866 +--------------------------------+-------------------------------------------+
9867 | **artifacts**\ *optional* | < string, |
9868 | | `ArtifactDefinition <#_artifactdefinition |
9871 +--------------------------------+-------------------------------------------+
9872 | **attributes**\ *optional* | < |
9873 | | `PropertyDefinition <#_propertydefinition |
9876 +--------------------------------+-------------------------------------------+
9877 | **capabilities**\ *optional* | < string, < |
9878 | | `CapabilityDefinition <#_capabilitydefini |
9881 +--------------------------------+-------------------------------------------+
9882 | **categories**\ *optional* | < |
9883 | | `CategoryDefinition <#_categorydefinition |
9886 +--------------------------------+-------------------------------------------+
9887 | **componentInstances**\ *optio | < |
9888 | nal* | `ComponentInstance <#_componentinstance>` |
9891 +--------------------------------+-------------------------------------------+
9892 | **componentInstancesAttributes | < string, < |
9893 | **\ *optional* | `ComponentInstanceProperty <#_componentin |
9894 | | stanceproperty>`__ |
9896 +--------------------------------+-------------------------------------------+
9897 | **componentInstancesInputs**\ | < string, < |
9898 | *optional* | `ComponentInstanceInput <#_componentinsta |
9901 +--------------------------------+-------------------------------------------+
9902 | **componentInstancesProperties | < string, < |
9903 | **\ *optional* | `ComponentInstanceProperty <#_componentin |
9904 | | stanceproperty>`__ |
9906 +--------------------------------+-------------------------------------------+
9907 | **componentInstancesRelations* | < |
9908 | *\ *optional* | `RequirementCapabilityRelDef <#_requireme |
9909 | | ntcapabilityreldef>`__ |
9911 +--------------------------------+-------------------------------------------+
9912 | **componentMetadataDefinition* | `ComponentMetadataDefinition <#_component |
9913 | *\ *optional* | metadatadefinition>`__ |
9914 +--------------------------------+-------------------------------------------+
9915 | **componentType**\ *optional* | enum (RESOURCE, SERVICE, |
9916 | | RESOURCE\_INSTANCE, PRODUCT, |
9917 | | SERVICE\_INSTANCE) |
9918 +--------------------------------+-------------------------------------------+
9919 | **conformanceLevel**\ *optiona | string |
9921 +--------------------------------+-------------------------------------------+
9922 | **contactId**\ *optional* | string |
9923 +--------------------------------+-------------------------------------------+
9924 | **cost**\ *optional* | string |
9925 +--------------------------------+-------------------------------------------+
9926 | **creationDate**\ *optional* | integer (int64) |
9927 +--------------------------------+-------------------------------------------+
9928 | **creatorFullName**\ *optional | string |
9930 +--------------------------------+-------------------------------------------+
9931 | **creatorUserId**\ *optional* | string |
9932 +--------------------------------+-------------------------------------------+
9933 | **csarUUID**\ *optional* | string |
9934 +--------------------------------+-------------------------------------------+
9935 | **csarVersion**\ *optional* | string |
9936 +--------------------------------+-------------------------------------------+
9937 | **defaultCapabilities**\ *opti | < string > array |
9939 +--------------------------------+-------------------------------------------+
9940 | **deploymentArtifacts**\ *opti | < string, |
9941 | onal* | `ArtifactDefinition <#_artifactdefinition |
9944 +--------------------------------+-------------------------------------------+
9945 | **derivedFrom**\ *optional* | < string > array |
9946 +--------------------------------+-------------------------------------------+
9947 | **derivedFromGenericType**\ *o | string |
9949 +--------------------------------+-------------------------------------------+
9950 | **derivedFromGenericVersion**\ | string |
9952 +--------------------------------+-------------------------------------------+
9953 | **derivedList**\ *optional* | < string > array |
9954 +--------------------------------+-------------------------------------------+
9955 | **description**\ *optional* | string |
9956 +--------------------------------+-------------------------------------------+
9957 | **groups**\ *optional* | < `GroupDefinition <#_groupdefinition>`__ |
9959 +--------------------------------+-------------------------------------------+
9960 | **highestVersion**\ *optional* | boolean |
9961 +--------------------------------+-------------------------------------------+
9962 | **icon**\ *optional* | string |
9963 +--------------------------------+-------------------------------------------+
9964 | **importedToscaChecksum**\ *op | string |
9966 +--------------------------------+-------------------------------------------+
9967 | **inputs**\ *optional* | < `InputDefinition <#_inputdefinition>`__ |
9969 +--------------------------------+-------------------------------------------+
9970 | **interfaces**\ *optional* | < string, |
9971 | | `InterfaceDefinition <#_interfacedefiniti |
9974 +--------------------------------+-------------------------------------------+
9975 | **invariantUUID**\ *optional* | string |
9976 +--------------------------------+-------------------------------------------+
9977 | **isDeleted**\ *optional* | boolean |
9978 +--------------------------------+-------------------------------------------+
9979 | **lastUpdateDate**\ *optional* | integer (int64) |
9980 +--------------------------------+-------------------------------------------+
9981 | **lastUpdaterFullName**\ *opti | string |
9983 +--------------------------------+-------------------------------------------+
9984 | **lastUpdaterUserId**\ *option | string |
9986 +--------------------------------+-------------------------------------------+
9987 | **licenseType**\ *optional* | string |
9988 +--------------------------------+-------------------------------------------+
9989 | **lifecycleState**\ *optional* | enum (READY\_FOR\_CERTIFICATION, |
9990 | | CERTIFICATION\_IN\_PROGRESS, CERTIFIED, |
9991 | | NOT\_CERTIFIED\_CHECKIN, |
9992 | | NOT\_CERTIFIED\_CHECKOUT) |
9993 +--------------------------------+-------------------------------------------+
9994 | **name**\ *optional* | string |
9995 +--------------------------------+-------------------------------------------+
9996 | **normalizedName**\ *optional* | string |
9997 +--------------------------------+-------------------------------------------+
9998 | **projectCode**\ *optional* | string |
9999 +--------------------------------+-------------------------------------------+
10000 | **properties**\ *optional* | < |
10001 | | `PropertyDefinition <#_propertydefinition |
10004 +--------------------------------+-------------------------------------------+
10005 | **requirements**\ *optional* | < string, < |
10006 | | `RequirementDefinition <#_requirementdefi |
10008 | | > array > map |
10009 +--------------------------------+-------------------------------------------+
10010 | **resourceType**\ *optional* | enum (VFC, VF, CP, PNF, CVFC, VL, VFCMT, |
10012 +--------------------------------+-------------------------------------------+
10013 | **resourceVendorModelNumber**\ | string |
10015 +--------------------------------+-------------------------------------------+
10016 | **systemName**\ *optional* | string |
10017 +--------------------------------+-------------------------------------------+
10018 | **tags**\ *optional* | < string > array |
10019 +--------------------------------+-------------------------------------------+
10020 | **toscaArtifacts**\ *optional* | < string, |
10021 | | `ArtifactDefinition <#_artifactdefinition |
10024 +--------------------------------+-------------------------------------------+
10025 | **toscaResourceName**\ *option | string |
10027 +--------------------------------+-------------------------------------------+
10028 | **toscaType**\ *optional* | string |
10029 +--------------------------------+-------------------------------------------+
10030 | **uniqueId**\ *optional* | string |
10031 +--------------------------------+-------------------------------------------+
10032 | **uuid**\ *optional* | string |
10033 +--------------------------------+-------------------------------------------+
10034 | **vendorName**\ *optional* | string |
10035 +--------------------------------+-------------------------------------------+
10036 | **vendorRelease**\ *optional* | string |
10037 +--------------------------------+-------------------------------------------+
10038 | **version**\ *optional* | string |
10039 +--------------------------------+-------------------------------------------+
10044 +--------------------------------+-------------------------------------------+
10046 +================================+===========================================+
10047 | **constraints**\ *optional* | < string > array |
10048 +--------------------------------+-------------------------------------------+
10049 | **derivedFrom**\ *optional* | string |
10050 +--------------------------------+-------------------------------------------+
10051 | **ownerId**\ *optional* | string |
10052 +--------------------------------+-------------------------------------------+
10053 | **properties**\ *optional* | < string, |
10054 | | `PropertyDataDefinition <#_propertydatade |
10057 +--------------------------------+-------------------------------------------+
10058 | **property**\ *optional* | `PropertyDataDefinition <#_propertydatade |
10060 +--------------------------------+-------------------------------------------+
10065 +--------------------------------+-------------------------------------------+
10067 +================================+===========================================+
10068 | **additionalInformation**\ *op | < |
10069 | tional* | `AdditionalInformationDefinition <#_addit |
10070 | | ionalinformationdefinition>`__ |
10072 +--------------------------------+-------------------------------------------+
10073 | **allArtifacts**\ *optional* | < string, |
10074 | | `ArtifactDefinition <#_artifactdefinition |
10077 +--------------------------------+-------------------------------------------+
10078 | **allVersions**\ *optional* | < string, string > map |
10079 +--------------------------------+-------------------------------------------+
10080 | **artifacts**\ *optional* | < string, |
10081 | | `ArtifactDefinition <#_artifactdefinition |
10084 +--------------------------------+-------------------------------------------+
10085 | **capabilities**\ *optional* | < string, < |
10086 | | `CapabilityDefinition <#_capabilitydefini |
10088 | | > array > map |
10089 +--------------------------------+-------------------------------------------+
10090 | **categories**\ *optional* | < |
10091 | | `CategoryDefinition <#_categorydefinition |
10094 +--------------------------------+-------------------------------------------+
10095 | **componentInstances**\ *optio | < |
10096 | nal* | `ComponentInstance <#_componentinstance>` |
10099 +--------------------------------+-------------------------------------------+
10100 | **componentInstancesAttributes | < string, < |
10101 | **\ *optional* | `ComponentInstanceProperty <#_componentin |
10102 | | stanceproperty>`__ |
10103 | | > array > map |
10104 +--------------------------------+-------------------------------------------+
10105 | **componentInstancesInputs**\ | < string, < |
10106 | *optional* | `ComponentInstanceInput <#_componentinsta |
10108 | | > array > map |
10109 +--------------------------------+-------------------------------------------+
10110 | **componentInstancesProperties | < string, < |
10111 | **\ *optional* | `ComponentInstanceProperty <#_componentin |
10112 | | stanceproperty>`__ |
10113 | | > array > map |
10114 +--------------------------------+-------------------------------------------+
10115 | **componentInstancesRelations* | < |
10116 | *\ *optional* | `RequirementCapabilityRelDef <#_requireme |
10117 | | ntcapabilityreldef>`__ |
10119 +--------------------------------+-------------------------------------------+
10120 | **componentMetadataDefinition* | `ComponentMetadataDefinition <#_component |
10121 | *\ *optional* | metadatadefinition>`__ |
10122 +--------------------------------+-------------------------------------------+
10123 | **componentType**\ *optional* | enum (RESOURCE, SERVICE, |
10124 | | RESOURCE\_INSTANCE, PRODUCT, |
10125 | | SERVICE\_INSTANCE) |
10126 +--------------------------------+-------------------------------------------+
10127 | **conformanceLevel**\ *optiona | string |
10129 +--------------------------------+-------------------------------------------+
10130 | **contactId**\ *optional* | string |
10131 +--------------------------------+-------------------------------------------+
10132 | **creationDate**\ *optional* | integer (int64) |
10133 +--------------------------------+-------------------------------------------+
10134 | **creatorFullName**\ *optional | string |
10136 +--------------------------------+-------------------------------------------+
10137 | **creatorUserId**\ *optional* | string |
10138 +--------------------------------+-------------------------------------------+
10139 | **csarUUID**\ *optional* | string |
10140 +--------------------------------+-------------------------------------------+
10141 | **csarVersion**\ *optional* | string |
10142 +--------------------------------+-------------------------------------------+
10143 | **deploymentArtifacts**\ *opti | < string, |
10144 | onal* | `ArtifactDefinition <#_artifactdefinition |
10147 +--------------------------------+-------------------------------------------+
10148 | **derivedFromGenericType**\ *o | string |
10150 +--------------------------------+-------------------------------------------+
10151 | **derivedFromGenericVersion**\ | string |
10153 +--------------------------------+-------------------------------------------+
10154 | **description**\ *optional* | string |
10155 +--------------------------------+-------------------------------------------+
10156 | **distributionStatus**\ *optio | enum (DISTRIBUTION\_NOT\_APPROVED, |
10157 | nal* | DISTRIBUTION\_APPROVED, DISTRIBUTED, |
10158 | | DISTRIBUTION\_REJECTED) |
10159 +--------------------------------+-------------------------------------------+
10160 | **ecompGeneratedNaming**\ *opt | boolean |
10162 +--------------------------------+-------------------------------------------+
10163 | **groups**\ *optional* | < `GroupDefinition <#_groupdefinition>`__ |
10165 +--------------------------------+-------------------------------------------+
10166 | **highestVersion**\ *optional* | boolean |
10167 +--------------------------------+-------------------------------------------+
10168 | **icon**\ *optional* | string |
10169 +--------------------------------+-------------------------------------------+
10170 | **importedToscaChecksum**\ *op | string |
10172 +--------------------------------+-------------------------------------------+
10173 | **inputs**\ *optional* | < `InputDefinition <#_inputdefinition>`__ |
10175 +--------------------------------+-------------------------------------------+
10176 | **invariantUUID**\ *optional* | string |
10177 +--------------------------------+-------------------------------------------+
10178 | **isDeleted**\ *optional* | boolean |
10179 +--------------------------------+-------------------------------------------+
10180 | **lastUpdateDate**\ *optional* | integer (int64) |
10181 +--------------------------------+-------------------------------------------+
10182 | **lastUpdaterFullName**\ *opti | string |
10184 +--------------------------------+-------------------------------------------+
10185 | **lastUpdaterUserId**\ *option | string |
10187 +--------------------------------+-------------------------------------------+
10188 | **lifecycleState**\ *optional* | enum (READY\_FOR\_CERTIFICATION, |
10189 | | CERTIFICATION\_IN\_PROGRESS, CERTIFIED, |
10190 | | NOT\_CERTIFIED\_CHECKIN, |
10191 | | NOT\_CERTIFIED\_CHECKOUT) |
10192 +--------------------------------+-------------------------------------------+
10193 | **name**\ *optional* | string |
10194 +--------------------------------+-------------------------------------------+
10195 | **namingPolicy**\ *optional* | string |
10196 +--------------------------------+-------------------------------------------+
10197 | **normalizedName**\ *optional* | string |
10198 +--------------------------------+-------------------------------------------+
10199 | **projectCode**\ *optional* | string |
10200 +--------------------------------+-------------------------------------------+
10201 | **requirements**\ *optional* | < string, < |
10202 | | `RequirementDefinition <#_requirementdefi |
10204 | | > array > map |
10205 +--------------------------------+-------------------------------------------+
10206 | **serviceApiArtifacts**\ *opti | < string, |
10207 | onal* | `ArtifactDefinition <#_artifactdefinition |
10210 +--------------------------------+-------------------------------------------+
10211 | **serviceRole**\ *optional* | string |
10212 +--------------------------------+-------------------------------------------+
10213 | **serviceType**\ *optional* | string |
10214 +--------------------------------+-------------------------------------------+
10215 | **systemName**\ *optional* | string |
10216 +--------------------------------+-------------------------------------------+
10217 | **tags**\ *optional* | < string > array |
10218 +--------------------------------+-------------------------------------------+
10219 | **toscaArtifacts**\ *optional* | < string, |
10220 | | `ArtifactDefinition <#_artifactdefinition |
10223 +--------------------------------+-------------------------------------------+
10224 | **toscaType**\ *optional* | string |
10225 +--------------------------------+-------------------------------------------+
10226 | **uniqueId**\ *optional* | string |
10227 +--------------------------------+-------------------------------------------+
10228 | **uuid**\ *optional* | string |
10229 +--------------------------------+-------------------------------------------+
10230 | **version**\ *optional* | string |
10231 +--------------------------------+-------------------------------------------+
10233 SubCategoryDefinition
10234 ---------------------
10236 +--------------------------------+-------------------------------------------+
10238 +================================+===========================================+
10239 | **groupings**\ *optional* | < |
10240 | | `GroupingDefinition <#_groupingdefinition |
10243 +--------------------------------+-------------------------------------------+
10244 | **icons**\ *optional* | < string > array |
10245 +--------------------------------+-------------------------------------------+
10246 | **name**\ *optional* | string |
10247 +--------------------------------+-------------------------------------------+
10248 | **normalizedName**\ *optional* | string |
10249 +--------------------------------+-------------------------------------------+
10250 | **ownerId**\ *optional* | string |
10251 +--------------------------------+-------------------------------------------+
10252 | **uniqueId**\ *optional* | string |
10253 +--------------------------------+-------------------------------------------+
10258 +--------------------------------+-------------------------------------------+
10260 +================================+===========================================+
10261 | **email**\ *optional* | string |
10262 +--------------------------------+-------------------------------------------+
10263 | **firstName**\ *optional* | string |
10264 +--------------------------------+-------------------------------------------+
10265 | **fullName**\ *optional* | string |
10266 +--------------------------------+-------------------------------------------+
10267 | **lastLoginTime**\ *optional* | integer (int64) |
10268 +--------------------------------+-------------------------------------------+
10269 | **lastName**\ *optional* | string |
10270 +--------------------------------+-------------------------------------------+
10271 | **role**\ *optional* | string |
10272 +--------------------------------+-------------------------------------------+
10273 | **status**\ *optional* | enum (ACTIVE, INACTIVE) |
10274 +--------------------------------+-------------------------------------------+
10275 | **userId**\ *optional* | string |
10276 +--------------------------------+-------------------------------------------+