Gitiles
Code Review Sign In
gerrit.nordix.org / onap / sdc / 84f9386df07ddf463e53070a8199a238240f5ef3 / . / docs / openapi / openapi-sdce-2-sdce-5.yaml
blob: 216fc62945c97e007ef5300d3a4bc82c1b6f89e3 [file] [log] [blame]
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]1openapi: 3.0.1
2info:
3 contact:
4 email: onap-discuss@lists.onap.org
5 name: ONAP
6 url: https://onap.readthedocs.io
7 description: SDC API for designing services and resources (SDCE-2) and distributing
8 services (SDCE-5)
9 license:
10 name: Apache 2.0
11 url: http://www.apache.org/licenses/LICENSE-2.0
12 title: "SPC API: SDCE-2 and SDCE-5"
13 version: "1.0"
14servers:
15- description: SDCE-2 and SDCE-5 APIs
16 url: /sdc
17paths:
18 /actuator/prometheus:
19 get:
20 description: Gets the prometheus micrometer application metrics
21 operationId: prometheus
22 parameters:
23 - description: The Accept header to determine the output content type
24 in: header
25 name: Accept
26 schema:
27 type: string
28 responses:
29 default:
30 content:
31 '*/*':
32 schema:
33 type: string
34 description: default response
35 servers:
36 - url: /sdc2/rest
37 variables: {}
38 summary: Prometheus Micrometer Metrics
39 tags:
40 - SDCE-2 APIs
41 /config/get:
42 get:
43 description: Retrieve configuration
44 operationId: getConfig_1
45 responses:
46 "200":
47 content:
48 application/json:
49 schema:
50 type: string
51 description: OK
52 servers:
53 - url: /sdc2/rest
54 variables: {}
55 tags:
56 - SDCE-2 APIs
57 /configmgr/get:
58 get:
59 operationId: getConfig
60 parameters:
61 - in: query
62 name: type
63 schema:
64 type: string
65 responses:
66 default:
67 content:
68 application/json:
69 schema:
70 type: string
71 description: default response
72 servers:
73 - url: /sdc2/rest
74 variables: {}
75 tags:
76 - SDCE-2 APIs
77 /configmgr/set1:
78 post:
79 operationId: setConfig1
80 requestBody:
81 content:
82 application/json:
83 schema:
84 $ref: '#/components/schemas/Configuration'
85 responses:
86 default:
87 content:
88 text/plain:
89 schema:
90 type: string
91 description: default response
92 servers:
93 - url: /sdc2/rest
94 variables: {}
95 tags:
96 - SDCE-2 APIs
97 /configmgr/set2:
98 post:
99 operationId: setConfig2
100 requestBody:
101 content:
102 application/json:
103 schema:
104 $ref: '#/components/schemas/Configuration'
105 responses:
106 default:
107 content:
108 text/plain: {}
109 description: default response
110 servers:
111 - url: /sdc2/rest
112 variables: {}
113 tags:
114 - SDCE-2 APIs
115 /configmgr/setput1:
116 put:
117 operationId: setConfig3
118 requestBody:
119 content:
120 application/json:
121 schema:
122 $ref: '#/components/schemas/Configuration'
123 responses:
124 default:
125 content:
126 text/plain:
127 schema:
128 type: string
129 description: default response
130 servers:
131 - url: /sdc2/rest
132 variables: {}
133 tags:
134 - SDCE-2 APIs
135 /configmgr/setput2:
136 put:
137 operationId: setConfig4
138 requestBody:
139 content:
140 application/json:
141 schema:
142 $ref: '#/components/schemas/Configuration'
143 responses:
144 default:
145 content:
146 text/plain: {}
147 description: default response
148 servers:
149 - url: /sdc2/rest
150 variables: {}
151 tags:
152 - SDCE-2 APIs
153 /healthCheck:
154 get:
155 description: Return aggregate BE health check of SDC BE components
156 operationId: getHealthCheck
157 responses:
158 "200":
159 description: SDC BE components are all up
160 "500":
161 description: One or more SDC BE components are down
162 default:
163 content:
164 application/json:
165 schema:
166 type: array
167 items:
168 type: string
169 servers:
170 - url: /sdc2/rest
171 variables: {}
172 summary: return BE health check
173 tags:
174 - SDCE-2 APIs
175 /v1/artifactTypes:
176 get:
177 description: Retrieve all artifactTypes
178 operationId: getArtifactTypes
179 parameters:
180 - in: header
181 name: USER_ID
182 schema:
183 type: string
184 responses:
185 "200":
186 description: Returns artifactTypes Ok
187 "404":
188 description: No artifactTypes were found
189 "500":
190 description: Internal Server Error
191 default:
192 content:
193 application/json:
194 schema:
195 type: array
196 items:
197 $ref: '#/components/schemas/User'
198 servers:
199 - url: /sdc2/rest
200 variables: {}
201 summary: Retrieve all artifactTypes
202 tags:
203 - SDCE-2 APIs
204 /v1/catalog/allDataTypes:
205 get:
206 description: Get data types
207 operationId: getAllDataTypesFromAllModels
208 parameters:
209 - in: header
210 name: USER_ID
211 schema:
212 type: string
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]213 - in: query
214 name: excludePrimitives
215 schema:
216 type: string
217 default: "false"
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]218 responses:
219 "200":
220 description: allDataTypes
221 "400":
222 description: Invalid content / Missing content
223 "403":
224 description: Restricted operation
225 "404":
226 description: Data types not found
227 default:
228 content:
229 application/json:
230 schema:
231 type: array
232 items:
233 type: object
234 properties:
235 allowedMethods:
236 type: array
237 items:
238 type: string
239 uniqueItems: true
240 cookies:
241 type: object
242 additionalProperties:
243 type: object
244 properties:
245 comment:
246 type: string
247 domain:
248 type: string
249 expiry:
250 type: string
251 format: date-time
252 httpOnly:
253 type: boolean
254 maxAge:
255 type: integer
256 format: int32
257 name:
258 type: string
259 path:
260 type: string
261 secure:
262 type: boolean
263 value:
264 type: string
265 version:
266 type: integer
267 format: int32
268 date:
269 type: string
270 format: date-time
271 entity:
272 type: object
273 entityTag:
274 type: object
275 properties:
276 value:
277 type: string
278 weak:
279 type: boolean
280 headers:
281 type: object
282 additionalProperties:
283 type: array
284 items:
285 type: object
286 language:
287 type: object
288 properties:
289 country:
290 type: string
291 displayCountry:
292 type: string
293 displayLanguage:
294 type: string
295 displayName:
296 type: string
297 displayScript:
298 type: string
299 displayVariant:
300 type: string
301 extensionKeys:
302 type: array
303 items:
304 type: string
305 uniqueItems: true
306 iso3Country:
307 type: string
308 iso3Language:
309 type: string
310 language:
311 type: string
312 script:
313 type: string
314 unicodeLocaleAttributes:
315 type: array
316 items:
317 type: string
318 uniqueItems: true
319 unicodeLocaleKeys:
320 type: array
321 items:
322 type: string
323 uniqueItems: true
324 variant:
325 type: string
326 lastModified:
327 type: string
328 format: date-time
329 length:
330 type: integer
331 format: int32
332 links:
333 type: array
334 items:
335 type: object
336 properties:
337 params:
338 type: object
339 additionalProperties:
340 type: string
341 rel:
342 type: string
343 rels:
344 type: array
345 items:
346 type: string
347 title:
348 type: string
349 type:
350 type: string
351 uri:
352 type: string
353 format: uri
354 uriBuilder:
355 type: object
356 uniqueItems: true
357 location:
358 type: string
359 format: uri
360 mediaType:
361 type: object
362 properties:
363 parameters:
364 type: object
365 additionalProperties:
366 type: string
367 subtype:
368 type: string
369 type:
370 type: string
371 wildcardSubtype:
372 type: boolean
373 wildcardType:
374 type: boolean
375 metadata:
376 type: object
377 additionalProperties:
378 type: array
379 items:
380 type: object
381 status:
382 type: integer
383 format: int32
384 statusInfo:
385 type: object
386 properties:
387 family:
388 type: string
389 enum:
390 - INFORMATIONAL
391 - SUCCESSFUL
392 - REDIRECTION
393 - CLIENT_ERROR
394 - SERVER_ERROR
395 - OTHER
396 reasonPhrase:
397 type: string
398 statusCode:
399 type: integer
400 format: int32
401 stringHeaders:
402 type: object
403 additionalProperties:
404 type: array
405 items:
406 type: string
407 servers:
408 - url: /sdc2/rest
409 variables: {}
410 summary: Returns all data types from all models
411 tags:
412 - SDCE-2 APIs
413 /v1/catalog/archive:
414 get:
415 description: Get all Archived Components
416 operationId: getArchivedComponents
417 parameters:
418 - in: header
419 name: USER_ID
420 schema:
421 type: string
422 responses:
423 "200":
424 description: Success
425 "400":
426 description: Bad request
427 "403":
428 description: Restricted operation
429 "500":
430 description: Internal Error
431 default:
432 content:
433 application/json:
434 schema:
435 type: array
436 items:
437 type: string
438 servers:
439 - url: /sdc2/rest
440 variables: {}
441 summary: Get all Archived Components
442 tags:
443 - SDCE-2 APIs
444 /v1/catalog/artifactTypes:
445 get:
446 description: Get Tosca ArtifactTypes
447 operationId: getAllToscaArtifactTypes
448 parameters:
449 - description: Model name
450 in: query
451 name: model
452 schema:
453 type: string
454 - in: header
455 name: USER_ID
456 schema:
457 type: string
458 responses:
459 "200":
460 description: Listing successful
461 "400":
462 description: Invalid content / Missing content
463 "403":
464 description: Restricted operation
465 "404":
466 description: Tosca Artifact Types not found
467 default:
468 content:
469 '*/*':
470 schema:
471 type: array
472 items:
473 type: object
474 properties:
475 allowedMethods:
476 type: array
477 items:
478 type: string
479 uniqueItems: true
480 cookies:
481 type: object
482 additionalProperties:
483 type: object
484 properties:
485 comment:
486 type: string
487 domain:
488 type: string
489 expiry:
490 type: string
491 format: date-time
492 httpOnly:
493 type: boolean
494 maxAge:
495 type: integer
496 format: int32
497 name:
498 type: string
499 path:
500 type: string
501 secure:
502 type: boolean
503 value:
504 type: string
505 version:
506 type: integer
507 format: int32
508 date:
509 type: string
510 format: date-time
511 entity:
512 type: object
513 entityTag:
514 type: object
515 properties:
516 value:
517 type: string
518 weak:
519 type: boolean
520 headers:
521 type: object
522 additionalProperties:
523 type: array
524 items:
525 type: object
526 language:
527 type: object
528 properties:
529 country:
530 type: string
531 displayCountry:
532 type: string
533 displayLanguage:
534 type: string
535 displayName:
536 type: string
537 displayScript:
538 type: string
539 displayVariant:
540 type: string
541 extensionKeys:
542 type: array
543 items:
544 type: string
545 uniqueItems: true
546 iso3Country:
547 type: string
548 iso3Language:
549 type: string
550 language:
551 type: string
552 script:
553 type: string
554 unicodeLocaleAttributes:
555 type: array
556 items:
557 type: string
558 uniqueItems: true
559 unicodeLocaleKeys:
560 type: array
561 items:
562 type: string
563 uniqueItems: true
564 variant:
565 type: string
566 lastModified:
567 type: string
568 format: date-time
569 length:
570 type: integer
571 format: int32
572 links:
573 type: array
574 items:
575 type: object
576 properties:
577 params:
578 type: object
579 additionalProperties:
580 type: string
581 rel:
582 type: string
583 rels:
584 type: array
585 items:
586 type: string
587 title:
588 type: string
589 type:
590 type: string
591 uri:
592 type: string
593 format: uri
594 uriBuilder:
595 type: object
596 uniqueItems: true
597 location:
598 type: string
599 format: uri
600 mediaType:
601 type: object
602 properties:
603 parameters:
604 type: object
605 additionalProperties:
606 type: string
607 subtype:
608 type: string
609 type:
610 type: string
611 wildcardSubtype:
612 type: boolean
613 wildcardType:
614 type: boolean
615 metadata:
616 type: object
617 additionalProperties:
618 type: array
619 items:
620 type: object
621 status:
622 type: integer
623 format: int32
624 statusInfo:
625 type: object
626 properties:
627 family:
628 type: string
629 enum:
630 - INFORMATIONAL
631 - SUCCESSFUL
632 - REDIRECTION
633 - CLIENT_ERROR
634 - SERVER_ERROR
635 - OTHER
636 reasonPhrase:
637 type: string
638 statusCode:
639 type: integer
640 format: int32
641 stringHeaders:
642 type: object
643 additionalProperties:
644 type: array
645 items:
646 type: string
647 servers:
648 - url: /sdc2/rest
649 variables: {}
650 summary: Returns tosca artifact types
651 tags:
652 - SDCE-2 APIs
653 /v1/catalog/audit-records/{componentType}/{componentUniqueId}:
654 get:
655 description: get component audit records
656 operationId: getComponentAuditRecords
657 parameters:
658 - in: path
659 name: componentType
660 required: true
661 schema:
662 type: string
663 - in: path
664 name: componentUniqueId
665 required: true
666 schema:
667 type: string
668 - in: header
669 name: USER_ID
670 schema:
671 type: string
672 responses:
673 "200":
674 description: Service found
675 "403":
676 description: Restricted operation
677 default:
678 content:
679 application/json:
680 schema:
681 type: array
682 items:
683 type: object
684 properties:
685 allowedMethods:
686 type: array
687 items:
688 type: string
689 uniqueItems: true
690 cookies:
691 type: object
692 additionalProperties:
693 type: object
694 properties:
695 comment:
696 type: string
697 domain:
698 type: string
699 expiry:
700 type: string
701 format: date-time
702 httpOnly:
703 type: boolean
704 maxAge:
705 type: integer
706 format: int32
707 name:
708 type: string
709 path:
710 type: string
711 secure:
712 type: boolean
713 value:
714 type: string
715 version:
716 type: integer
717 format: int32
718 date:
719 type: string
720 format: date-time
721 entity:
722 type: object
723 entityTag:
724 type: object
725 properties:
726 value:
727 type: string
728 weak:
729 type: boolean
730 headers:
731 type: object
732 additionalProperties:
733 type: array
734 items:
735 type: object
736 language:
737 type: object
738 properties:
739 country:
740 type: string
741 displayCountry:
742 type: string
743 displayLanguage:
744 type: string
745 displayName:
746 type: string
747 displayScript:
748 type: string
749 displayVariant:
750 type: string
751 extensionKeys:
752 type: array
753 items:
754 type: string
755 uniqueItems: true
756 iso3Country:
757 type: string
758 iso3Language:
759 type: string
760 language:
761 type: string
762 script:
763 type: string
764 unicodeLocaleAttributes:
765 type: array
766 items:
767 type: string
768 uniqueItems: true
769 unicodeLocaleKeys:
770 type: array
771 items:
772 type: string
773 uniqueItems: true
774 variant:
775 type: string
776 lastModified:
777 type: string
778 format: date-time
779 length:
780 type: integer
781 format: int32
782 links:
783 type: array
784 items:
785 type: object
786 properties:
787 params:
788 type: object
789 additionalProperties:
790 type: string
791 rel:
792 type: string
793 rels:
794 type: array
795 items:
796 type: string
797 title:
798 type: string
799 type:
800 type: string
801 uri:
802 type: string
803 format: uri
804 uriBuilder:
805 type: object
806 uniqueItems: true
807 location:
808 type: string
809 format: uri
810 mediaType:
811 type: object
812 properties:
813 parameters:
814 type: object
815 additionalProperties:
816 type: string
817 subtype:
818 type: string
819 type:
820 type: string
821 wildcardSubtype:
822 type: boolean
823 wildcardType:
824 type: boolean
825 metadata:
826 type: object
827 additionalProperties:
828 type: array
829 items:
830 type: object
831 status:
832 type: integer
833 format: int32
834 statusInfo:
835 type: object
836 properties:
837 family:
838 type: string
839 enum:
840 - INFORMATIONAL
841 - SUCCESSFUL
842 - REDIRECTION
843 - CLIENT_ERROR
844 - SERVER_ERROR
845 - OTHER
846 reasonPhrase:
847 type: string
848 statusCode:
849 type: integer
850 format: int32
851 stringHeaders:
852 type: object
853 additionalProperties:
854 type: array
855 items:
856 type: string
857 servers:
858 - url: /sdc2/rest
859 variables: {}
860 summary: get audit records for a service or a resource
861 tags:
862 - SDCE-2 APIs
863 /v1/catalog/capabilityTypes:
864 get:
865 description: Get capability types
866 operationId: getAllCapabilityTypesServlet
867 parameters:
868 - in: header
869 name: USER_ID
870 schema:
871 type: string
872 - description: model
873 in: query
874 name: model
875 schema:
876 type: string
877 responses:
878 "200":
879 description: capabilityTypes
880 "400":
881 description: Invalid content / Missing content
882 "403":
883 description: Restricted operation
884 "404":
885 description: Capability types not found
886 default:
887 content:
888 application/json:
889 schema:
890 type: array
891 items:
892 type: object
893 properties:
894 allowedMethods:
895 type: array
896 items:
897 type: string
898 uniqueItems: true
899 cookies:
900 type: object
901 additionalProperties:
902 type: object
903 properties:
904 comment:
905 type: string
906 domain:
907 type: string
908 expiry:
909 type: string
910 format: date-time
911 httpOnly:
912 type: boolean
913 maxAge:
914 type: integer
915 format: int32
916 name:
917 type: string
918 path:
919 type: string
920 secure:
921 type: boolean
922 value:
923 type: string
924 version:
925 type: integer
926 format: int32
927 date:
928 type: string
929 format: date-time
930 entity:
931 type: object
932 entityTag:
933 type: object
934 properties:
935 value:
936 type: string
937 weak:
938 type: boolean
939 headers:
940 type: object
941 additionalProperties:
942 type: array
943 items:
944 type: object
945 language:
946 type: object
947 properties:
948 country:
949 type: string
950 displayCountry:
951 type: string
952 displayLanguage:
953 type: string
954 displayName:
955 type: string
956 displayScript:
957 type: string
958 displayVariant:
959 type: string
960 extensionKeys:
961 type: array
962 items:
963 type: string
964 uniqueItems: true
965 iso3Country:
966 type: string
967 iso3Language:
968 type: string
969 language:
970 type: string
971 script:
972 type: string
973 unicodeLocaleAttributes:
974 type: array
975 items:
976 type: string
977 uniqueItems: true
978 unicodeLocaleKeys:
979 type: array
980 items:
981 type: string
982 uniqueItems: true
983 variant:
984 type: string
985 lastModified:
986 type: string
987 format: date-time
988 length:
989 type: integer
990 format: int32
991 links:
992 type: array
993 items:
994 type: object
995 properties:
996 params:
997 type: object
998 additionalProperties:
999 type: string
1000 rel:
1001 type: string
1002 rels:
1003 type: array
1004 items:
1005 type: string
1006 title:
1007 type: string
1008 type:
1009 type: string
1010 uri:
1011 type: string
1012 format: uri
1013 uriBuilder:
1014 type: object
1015 uniqueItems: true
1016 location:
1017 type: string
1018 format: uri
1019 mediaType:
1020 type: object
1021 properties:
1022 parameters:
1023 type: object
1024 additionalProperties:
1025 type: string
1026 subtype:
1027 type: string
1028 type:
1029 type: string
1030 wildcardSubtype:
1031 type: boolean
1032 wildcardType:
1033 type: boolean
1034 metadata:
1035 type: object
1036 additionalProperties:
1037 type: array
1038 items:
1039 type: object
1040 status:
1041 type: integer
1042 format: int32
1043 statusInfo:
1044 type: object
1045 properties:
1046 family:
1047 type: string
1048 enum:
1049 - INFORMATIONAL
1050 - SUCCESSFUL
1051 - REDIRECTION
1052 - CLIENT_ERROR
1053 - SERVER_ERROR
1054 - OTHER
1055 reasonPhrase:
1056 type: string
1057 statusCode:
1058 type: integer
1059 format: int32
1060 stringHeaders:
1061 type: object
1062 additionalProperties:
1063 type: array
1064 items:
1065 type: string
1066 servers:
1067 - url: /sdc2/rest
1068 variables: {}
1069 summary: Returns capability types
1070 tags:
1071 - SDCE-2 APIs
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]1072 /v1/catalog/customToscaFunctions/{type}:
1073 get:
1074 description: Retrieve default custom tosca functions values from the configuration
1075 file based on type
1076 operationId: getDefaultCustomToscaFunctionValues
1077 parameters:
1078 - in: header
1079 name: USER_ID
1080 schema:
1081 type: string
1082 - in: path
1083 name: type
1084 required: true
1085 schema:
1086 type: string
1087 enum:
1088 - ALL
1089 - CUSTOM
1090 - GET_INPUT
1091 responses:
1092 "200":
1093 description: Returns default custom tosca functions values from configuration
1094 file Ok
1095 "404":
1096 description: Default custom tosca functions not found
1097 "500":
1098 description: Internal Server Error
1099 default:
1100 content:
1101 application/json:
1102 schema:
1103 type: array
1104 items:
1105 $ref: '#/components/schemas/User'
1106 summary: Retrieve all custom tosca functions
1107 tags:
1108 - SDCE-2 APIs
1109 /v1/catalog/data-types/{dataTypeId}:
1110 delete:
1111 operationId: deleteDatatype
1112 parameters:
1113 - description: The data type id
1114 in: path
1115 name: dataTypeId
1116 required: true
1117 schema:
1118 type: string
1119 responses:
1120 default:
1121 content:
1122 '*/*': {}
1123 description: default response
1124 servers:
1125 - url: /sdc2/rest
1126 variables: {}
1127 tags:
1128 - SDCE-2 APIs
1129 /v1/catalog/data-types/{dataTypeId}/{propertyId}:
1130 delete:
1131 operationId: deleteProperty
1132 parameters:
1133 - description: The data type id
1134 in: path
1135 name: dataTypeId
1136 required: true
1137 schema:
1138 type: string
1139 - description: The property id to delete
1140 in: path
1141 name: propertyId
1142 required: true
1143 schema:
1144 type: string
1145 responses:
1146 default:
1147 content:
1148 '*/*': {}
1149 description: default response
1150 servers:
1151 - url: /sdc2/rest
1152 variables: {}
1153 tags:
1154 - SDCE-2 APIs
1155 /v1/catalog/data-types/{dataTypeName}/models:
1156 get:
1157 description: Get models for type
1158 operationId: getDataTypeModels
1159 parameters:
1160 - in: path
1161 name: dataTypeName
1162 required: true
1163 schema:
1164 type: string
1165 responses:
1166 "200":
1167 description: dataTypeModels
1168 "400":
1169 description: Invalid content / Missing content
1170 "403":
1171 description: Restricted operation
1172 "404":
1173 description: Data type not found
1174 default:
1175 content:
1176 application/json:
1177 schema:
1178 type: array
1179 items:
1180 type: object
1181 properties:
1182 allowedMethods:
1183 type: array
1184 items:
1185 type: string
1186 uniqueItems: true
1187 cookies:
1188 type: object
1189 additionalProperties:
1190 type: object
1191 properties:
1192 comment:
1193 type: string
1194 domain:
1195 type: string
1196 expiry:
1197 type: string
1198 format: date-time
1199 httpOnly:
1200 type: boolean
1201 maxAge:
1202 type: integer
1203 format: int32
1204 name:
1205 type: string
1206 path:
1207 type: string
1208 secure:
1209 type: boolean
1210 value:
1211 type: string
1212 version:
1213 type: integer
1214 format: int32
1215 date:
1216 type: string
1217 format: date-time
1218 entity:
1219 type: object
1220 entityTag:
1221 type: object
1222 properties:
1223 value:
1224 type: string
1225 weak:
1226 type: boolean
1227 headers:
1228 type: object
1229 additionalProperties:
1230 type: array
1231 items:
1232 type: object
1233 language:
1234 type: object
1235 properties:
1236 country:
1237 type: string
1238 displayCountry:
1239 type: string
1240 displayLanguage:
1241 type: string
1242 displayName:
1243 type: string
1244 displayScript:
1245 type: string
1246 displayVariant:
1247 type: string
1248 extensionKeys:
1249 type: array
1250 items:
1251 type: string
1252 uniqueItems: true
1253 iso3Country:
1254 type: string
1255 iso3Language:
1256 type: string
1257 language:
1258 type: string
1259 script:
1260 type: string
1261 unicodeLocaleAttributes:
1262 type: array
1263 items:
1264 type: string
1265 uniqueItems: true
1266 unicodeLocaleKeys:
1267 type: array
1268 items:
1269 type: string
1270 uniqueItems: true
1271 variant:
1272 type: string
1273 lastModified:
1274 type: string
1275 format: date-time
1276 length:
1277 type: integer
1278 format: int32
1279 links:
1280 type: array
1281 items:
1282 type: object
1283 properties:
1284 params:
1285 type: object
1286 additionalProperties:
1287 type: string
1288 rel:
1289 type: string
1290 rels:
1291 type: array
1292 items:
1293 type: string
1294 title:
1295 type: string
1296 type:
1297 type: string
1298 uri:
1299 type: string
1300 format: uri
1301 uriBuilder:
1302 type: object
1303 uniqueItems: true
1304 location:
1305 type: string
1306 format: uri
1307 mediaType:
1308 type: object
1309 properties:
1310 parameters:
1311 type: object
1312 additionalProperties:
1313 type: string
1314 subtype:
1315 type: string
1316 type:
1317 type: string
1318 wildcardSubtype:
1319 type: boolean
1320 wildcardType:
1321 type: boolean
1322 metadata:
1323 type: object
1324 additionalProperties:
1325 type: array
1326 items:
1327 type: object
1328 status:
1329 type: integer
1330 format: int32
1331 statusInfo:
1332 type: object
1333 properties:
1334 family:
1335 type: string
1336 enum:
1337 - INFORMATIONAL
1338 - SUCCESSFUL
1339 - REDIRECTION
1340 - CLIENT_ERROR
1341 - SERVER_ERROR
1342 - OTHER
1343 reasonPhrase:
1344 type: string
1345 statusCode:
1346 type: integer
1347 format: int32
1348 stringHeaders:
1349 type: object
1350 additionalProperties:
1351 type: array
1352 items:
1353 type: string
1354 servers:
1355 - url: /sdc2/rest
1356 variables: {}
1357 summary: Returns list of models for type
1358 tags:
1359 - SDCE-2 APIs
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]1360 /v1/catalog/data-types/{dataTypeUid}:
1361 get:
1362 description: Get data types
1363 operationId: fetchDataType
1364 parameters:
1365 - in: header
1366 name: USER_ID
1367 schema:
1368 type: string
1369 - in: path
1370 name: dataTypeUid
1371 required: true
1372 schema:
1373 type: string
1374 responses:
1375 "200":
1376 description: Data type found
1377 "400":
1378 description: Invalid content / Missing content
1379 "403":
1380 description: Restricted operation
1381 "404":
1382 description: Data types not found
1383 default:
1384 content:
1385 application/json:
1386 schema:
1387 $ref: '#/components/schemas/DataTypeDataDefinition'
1388 servers:
1389 - url: /sdc2/rest
1390 variables: {}
1391 summary: Returns data types
1392 tags:
1393 - SDCE-2 APIs
1394 /v1/catalog/data-types/{id}/properties:
1395 get:
1396 description: Get a data type properties
1397 operationId: fetchProperties
1398 parameters:
1399 - description: The data type id
1400 in: path
1401 name: id
1402 required: true
1403 schema:
1404 type: string
1405 responses:
1406 "200":
1407 description: "Data type found, properties may be empty"
1408 "403":
1409 description: Restricted operation
1410 "404":
1411 description: Data type not found
1412 default:
1413 content:
1414 application/json:
1415 schema:
1416 type: array
1417 items:
1418 $ref: '#/components/schemas/PropertyDefinition'
1419 servers:
1420 - url: /sdc2/rest
1421 variables: {}
1422 summary: Returns the data type properties
1423 tags:
1424 - SDCE-2 APIs
1425 post:
1426 description: Create a property in the given data type
1427 operationId: createProperty
1428 parameters:
1429 - description: The data type id
1430 in: path
1431 name: id
1432 required: true
1433 schema:
1434 type: string
1435 requestBody:
1436 content:
1437 application/json:
1438 schema:
1439 $ref: '#/components/schemas/PropertyDefinitionDto'
1440 description: Property to add
1441 required: true
1442 responses:
1443 "201":
1444 description: Property created in the data type
1445 "400":
1446 description: Invalid payload
1447 "403":
1448 description: Restricted operation
1449 "404":
1450 description: Data type not found
1451 "409":
1452 description: Property already exists in the data type
1453 default:
1454 content:
1455 application/json:
1456 schema:
1457 $ref: '#/components/schemas/PropertyDefinitionDto'
1458 servers:
1459 - url: /sdc2/rest
1460 variables: {}
1461 summary: Create a property in the given data type
1462 tags:
1463 - SDCE-2 APIs
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]1464 put:
1465 description: Update a property in the given data type
1466 operationId: updateProperty
1467 parameters:
1468 - description: The data type id
1469 in: path
1470 name: id
1471 required: true
1472 schema:
1473 type: string
1474 requestBody:
1475 content:
1476 application/json:
1477 schema:
1478 $ref: '#/components/schemas/PropertyDefinitionDto'
1479 description: Property to update
1480 required: true
1481 responses:
1482 "201":
1483 description: Property updated in the data type
1484 "400":
1485 description: Invalid payload
1486 "403":
1487 description: Restricted operation
1488 "404":
1489 description: Data type not found
1490 default:
1491 content:
1492 application/json:
1493 schema:
1494 $ref: '#/components/schemas/PropertyDefinitionDto'
1495 servers:
1496 - url: /sdc2/rest
1497 variables: {}
1498 summary: Update a property in the given data type
1499 tags:
1500 - SDCE-2 APIs
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]1501 /v1/catalog/dataTypes:
1502 get:
1503 description: Get data types
1504 operationId: getAllDataTypesServlet
1505 parameters:
1506 - in: header
1507 name: USER_ID
1508 schema:
1509 type: string
1510 - description: model
1511 in: query
1512 name: model
1513 schema:
1514 type: string
1515 responses:
1516 "200":
1517 description: datatypes
1518 "400":
1519 description: Invalid content / Missing content
1520 "403":
1521 description: Restricted operation
1522 "404":
1523 description: Data types not found
1524 default:
1525 content:
1526 application/json:
1527 schema:
1528 type: array
1529 items:
1530 type: object
1531 properties:
1532 allowedMethods:
1533 type: array
1534 items:
1535 type: string
1536 uniqueItems: true
1537 cookies:
1538 type: object
1539 additionalProperties:
1540 type: object
1541 properties:
1542 comment:
1543 type: string
1544 domain:
1545 type: string
1546 expiry:
1547 type: string
1548 format: date-time
1549 httpOnly:
1550 type: boolean
1551 maxAge:
1552 type: integer
1553 format: int32
1554 name:
1555 type: string
1556 path:
1557 type: string
1558 secure:
1559 type: boolean
1560 value:
1561 type: string
1562 version:
1563 type: integer
1564 format: int32
1565 date:
1566 type: string
1567 format: date-time
1568 entity:
1569 type: object
1570 entityTag:
1571 type: object
1572 properties:
1573 value:
1574 type: string
1575 weak:
1576 type: boolean
1577 headers:
1578 type: object
1579 additionalProperties:
1580 type: array
1581 items:
1582 type: object
1583 language:
1584 type: object
1585 properties:
1586 country:
1587 type: string
1588 displayCountry:
1589 type: string
1590 displayLanguage:
1591 type: string
1592 displayName:
1593 type: string
1594 displayScript:
1595 type: string
1596 displayVariant:
1597 type: string
1598 extensionKeys:
1599 type: array
1600 items:
1601 type: string
1602 uniqueItems: true
1603 iso3Country:
1604 type: string
1605 iso3Language:
1606 type: string
1607 language:
1608 type: string
1609 script:
1610 type: string
1611 unicodeLocaleAttributes:
1612 type: array
1613 items:
1614 type: string
1615 uniqueItems: true
1616 unicodeLocaleKeys:
1617 type: array
1618 items:
1619 type: string
1620 uniqueItems: true
1621 variant:
1622 type: string
1623 lastModified:
1624 type: string
1625 format: date-time
1626 length:
1627 type: integer
1628 format: int32
1629 links:
1630 type: array
1631 items:
1632 type: object
1633 properties:
1634 params:
1635 type: object
1636 additionalProperties:
1637 type: string
1638 rel:
1639 type: string
1640 rels:
1641 type: array
1642 items:
1643 type: string
1644 title:
1645 type: string
1646 type:
1647 type: string
1648 uri:
1649 type: string
1650 format: uri
1651 uriBuilder:
1652 type: object
1653 uniqueItems: true
1654 location:
1655 type: string
1656 format: uri
1657 mediaType:
1658 type: object
1659 properties:
1660 parameters:
1661 type: object
1662 additionalProperties:
1663 type: string
1664 subtype:
1665 type: string
1666 type:
1667 type: string
1668 wildcardSubtype:
1669 type: boolean
1670 wildcardType:
1671 type: boolean
1672 metadata:
1673 type: object
1674 additionalProperties:
1675 type: array
1676 items:
1677 type: object
1678 status:
1679 type: integer
1680 format: int32
1681 statusInfo:
1682 type: object
1683 properties:
1684 family:
1685 type: string
1686 enum:
1687 - INFORMATIONAL
1688 - SUCCESSFUL
1689 - REDIRECTION
1690 - CLIENT_ERROR
1691 - SERVER_ERROR
1692 - OTHER
1693 reasonPhrase:
1694 type: string
1695 statusCode:
1696 type: integer
1697 format: int32
1698 stringHeaders:
1699 type: object
1700 additionalProperties:
1701 type: array
1702 items:
1703 type: string
1704 servers:
1705 - url: /sdc2/rest
1706 variables: {}
1707 summary: Returns data types
1708 tags:
1709 - SDCE-2 APIs
1710 /v1/catalog/directives:
1711 get:
1712 description: Retrieve all Directives values from configuration file
1713 operationId: getConfCategoriesAndVersion
1714 parameters:
1715 - in: header
1716 name: USER_ID
1717 schema:
1718 type: string
1719 responses:
1720 "200":
1721 description: Returns Directive values from configuration file Ok
1722 "404":
1723 description: Directive not found
1724 "500":
1725 description: Internal Server Error
1726 default:
1727 content:
1728 application/json:
1729 schema:
1730 type: array
1731 items:
1732 $ref: '#/components/schemas/User'
1733 summary: Retrieve all Directives
1734 tags:
1735 - SDCE-2 APIs
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]1736 /v1/catalog/downloadDataType:
1737 get:
1738 description: Get data types
1739 operationId: downloadDataType
1740 parameters:
1741 - in: header
1742 name: USER_ID
1743 schema:
1744 type: string
1745 - description: dataTypeId
1746 in: query
1747 name: dataTypeId
1748 schema:
1749 type: string
1750 responses:
1751 "200":
1752 description: allDataTypes
1753 "400":
1754 description: Invalid content / Missing content
1755 "403":
1756 description: Restricted operation
1757 "404":
1758 description: Data types not found
1759 default:
1760 content:
1761 application/json:
1762 schema:
1763 type: array
1764 items:
1765 type: object
1766 properties:
1767 allowedMethods:
1768 type: array
1769 items:
1770 type: string
1771 uniqueItems: true
1772 cookies:
1773 type: object
1774 additionalProperties:
1775 type: object
1776 properties:
1777 comment:
1778 type: string
1779 domain:
1780 type: string
1781 expiry:
1782 type: string
1783 format: date-time
1784 httpOnly:
1785 type: boolean
1786 maxAge:
1787 type: integer
1788 format: int32
1789 name:
1790 type: string
1791 path:
1792 type: string
1793 secure:
1794 type: boolean
1795 value:
1796 type: string
1797 version:
1798 type: integer
1799 format: int32
1800 date:
1801 type: string
1802 format: date-time
1803 entity:
1804 type: object
1805 entityTag:
1806 type: object
1807 properties:
1808 value:
1809 type: string
1810 weak:
1811 type: boolean
1812 headers:
1813 type: object
1814 additionalProperties:
1815 type: array
1816 items:
1817 type: object
1818 language:
1819 type: object
1820 properties:
1821 country:
1822 type: string
1823 displayCountry:
1824 type: string
1825 displayLanguage:
1826 type: string
1827 displayName:
1828 type: string
1829 displayScript:
1830 type: string
1831 displayVariant:
1832 type: string
1833 extensionKeys:
1834 type: array
1835 items:
1836 type: string
1837 uniqueItems: true
1838 iso3Country:
1839 type: string
1840 iso3Language:
1841 type: string
1842 language:
1843 type: string
1844 script:
1845 type: string
1846 unicodeLocaleAttributes:
1847 type: array
1848 items:
1849 type: string
1850 uniqueItems: true
1851 unicodeLocaleKeys:
1852 type: array
1853 items:
1854 type: string
1855 uniqueItems: true
1856 variant:
1857 type: string
1858 lastModified:
1859 type: string
1860 format: date-time
1861 length:
1862 type: integer
1863 format: int32
1864 links:
1865 type: array
1866 items:
1867 type: object
1868 properties:
1869 params:
1870 type: object
1871 additionalProperties:
1872 type: string
1873 rel:
1874 type: string
1875 rels:
1876 type: array
1877 items:
1878 type: string
1879 title:
1880 type: string
1881 type:
1882 type: string
1883 uri:
1884 type: string
1885 format: uri
1886 uriBuilder:
1887 type: object
1888 uniqueItems: true
1889 location:
1890 type: string
1891 format: uri
1892 mediaType:
1893 type: object
1894 properties:
1895 parameters:
1896 type: object
1897 additionalProperties:
1898 type: string
1899 subtype:
1900 type: string
1901 type:
1902 type: string
1903 wildcardSubtype:
1904 type: boolean
1905 wildcardType:
1906 type: boolean
1907 metadata:
1908 type: object
1909 additionalProperties:
1910 type: array
1911 items:
1912 type: object
1913 status:
1914 type: integer
1915 format: int32
1916 statusInfo:
1917 type: object
1918 properties:
1919 family:
1920 type: string
1921 enum:
1922 - INFORMATIONAL
1923 - SUCCESSFUL
1924 - REDIRECTION
1925 - CLIENT_ERROR
1926 - SERVER_ERROR
1927 - OTHER
1928 reasonPhrase:
1929 type: string
1930 statusCode:
1931 type: integer
1932 format: int32
1933 stringHeaders:
1934 type: object
1935 additionalProperties:
1936 type: array
1937 items:
1938 type: string
1939 servers:
1940 - url: /sdc2/rest
1941 variables: {}
1942 summary: Returns all data types from all models
1943 tags:
1944 - SDCE-2 APIs
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]1945 /v1/catalog/gab/searchFor:
1946 post:
1947 description: Search json paths inside the yaml
1948 operationId: searchFor
1949 requestBody:
1950 content:
1951 application/json:
1952 schema:
1953 $ref: '#/components/schemas/GenericArtifactQueryInfo'
1954 description: Generic Artifact search model
1955 required: true
1956 responses:
1957 "200":
1958 description: Returned yaml entries
1959 "400":
1960 description: Invalid content / Missing content
1961 default:
1962 content:
1963 application/json:
1964 schema:
1965 type: array
1966 items:
1967 type: object
1968 properties:
1969 allowedMethods:
1970 type: array
1971 items:
1972 type: string
1973 uniqueItems: true
1974 cookies:
1975 type: object
1976 additionalProperties:
1977 type: object
1978 properties:
1979 comment:
1980 type: string
1981 domain:
1982 type: string
1983 expiry:
1984 type: string
1985 format: date-time
1986 httpOnly:
1987 type: boolean
1988 maxAge:
1989 type: integer
1990 format: int32
1991 name:
1992 type: string
1993 path:
1994 type: string
1995 secure:
1996 type: boolean
1997 value:
1998 type: string
1999 version:
2000 type: integer
2001 format: int32
2002 date:
2003 type: string
2004 format: date-time
2005 entity:
2006 type: object
2007 entityTag:
2008 type: object
2009 properties:
2010 value:
2011 type: string
2012 weak:
2013 type: boolean
2014 headers:
2015 type: object
2016 additionalProperties:
2017 type: array
2018 items:
2019 type: object
2020 language:
2021 type: object
2022 properties:
2023 country:
2024 type: string
2025 displayCountry:
2026 type: string
2027 displayLanguage:
2028 type: string
2029 displayName:
2030 type: string
2031 displayScript:
2032 type: string
2033 displayVariant:
2034 type: string
2035 extensionKeys:
2036 type: array
2037 items:
2038 type: string
2039 uniqueItems: true
2040 iso3Country:
2041 type: string
2042 iso3Language:
2043 type: string
2044 language:
2045 type: string
2046 script:
2047 type: string
2048 unicodeLocaleAttributes:
2049 type: array
2050 items:
2051 type: string
2052 uniqueItems: true
2053 unicodeLocaleKeys:
2054 type: array
2055 items:
2056 type: string
2057 uniqueItems: true
2058 variant:
2059 type: string
2060 lastModified:
2061 type: string
2062 format: date-time
2063 length:
2064 type: integer
2065 format: int32
2066 links:
2067 type: array
2068 items:
2069 type: object
2070 properties:
2071 params:
2072 type: object
2073 additionalProperties:
2074 type: string
2075 rel:
2076 type: string
2077 rels:
2078 type: array
2079 items:
2080 type: string
2081 title:
2082 type: string
2083 type:
2084 type: string
2085 uri:
2086 type: string
2087 format: uri
2088 uriBuilder:
2089 type: object
2090 uniqueItems: true
2091 location:
2092 type: string
2093 format: uri
2094 mediaType:
2095 type: object
2096 properties:
2097 parameters:
2098 type: object
2099 additionalProperties:
2100 type: string
2101 subtype:
2102 type: string
2103 type:
2104 type: string
2105 wildcardSubtype:
2106 type: boolean
2107 wildcardType:
2108 type: boolean
2109 metadata:
2110 type: object
2111 additionalProperties:
2112 type: array
2113 items:
2114 type: object
2115 status:
2116 type: integer
2117 format: int32
2118 statusInfo:
2119 type: object
2120 properties:
2121 family:
2122 type: string
2123 enum:
2124 - INFORMATIONAL
2125 - SUCCESSFUL
2126 - REDIRECTION
2127 - CLIENT_ERROR
2128 - SERVER_ERROR
2129 - OTHER
2130 reasonPhrase:
2131 type: string
2132 statusCode:
2133 type: integer
2134 format: int32
2135 stringHeaders:
2136 type: object
2137 additionalProperties:
2138 type: array
2139 items:
2140 type: string
2141 servers:
2142 - url: /sdc2/rest
2143 variables: {}
2144 summary: Returns found entries of json paths
2145 tags:
2146 - SDCE-2 APIs
2147 /v1/catalog/groupTypes:
2148 get:
2149 description: 'Get group types '
2150 operationId: getGroupTypes
2151 parameters:
2152 - in: header
2153 name: USER_ID
2154 schema:
2155 type: string
2156 - description: An optional parameter to indicate the type of the container from
2157 where this call is executed
2158 in: query
2159 name: internalComponentType
2160 schema:
2161 type: string
2162 - in: query
2163 name: componentModel
2164 schema:
2165 type: string
2166 responses:
2167 "200":
2168 description: group types found
2169 "400":
2170 description: "field name invalid type/length, characters; mandatory field\
2171 \ is absent, already exists (name)"
2172 "403":
2173 description: Restricted operation
2174 "500":
2175 description: Internal Error
2176 default:
2177 content:
2178 application/json:
2179 schema:
2180 type: array
2181 items:
2182 $ref: '#/components/schemas/GroupTypeDefinition'
2183 servers:
2184 - url: /sdc2/rest
2185 variables: {}
2186 summary: Returns group types
2187 tags:
2188 - SDCE-2 APIs
2189 /v1/catalog/handleException:
2190 get:
2191 description: Handle exception
2192 operationId: sendError
2193 responses:
2194 "500":
2195 content:
2196 application/json:
2197 schema:
2198 type: object
2199 properties:
2200 allowedMethods:
2201 type: array
2202 items:
2203 type: string
2204 uniqueItems: true
2205 cookies:
2206 type: object
2207 additionalProperties:
2208 type: object
2209 properties:
2210 comment:
2211 type: string
2212 domain:
2213 type: string
2214 expiry:
2215 type: string
2216 format: date-time
2217 httpOnly:
2218 type: boolean
2219 maxAge:
2220 type: integer
2221 format: int32
2222 name:
2223 type: string
2224 path:
2225 type: string
2226 secure:
2227 type: boolean
2228 value:
2229 type: string
2230 version:
2231 type: integer
2232 format: int32
2233 date:
2234 type: string
2235 format: date-time
2236 entity:
2237 type: object
2238 entityTag:
2239 type: object
2240 properties:
2241 value:
2242 type: string
2243 weak:
2244 type: boolean
2245 headers:
2246 type: object
2247 additionalProperties:
2248 type: array
2249 items:
2250 type: object
2251 language:
2252 type: object
2253 properties:
2254 country:
2255 type: string
2256 displayCountry:
2257 type: string
2258 displayLanguage:
2259 type: string
2260 displayName:
2261 type: string
2262 displayScript:
2263 type: string
2264 displayVariant:
2265 type: string
2266 extensionKeys:
2267 type: array
2268 items:
2269 type: string
2270 uniqueItems: true
2271 iso3Country:
2272 type: string
2273 iso3Language:
2274 type: string
2275 language:
2276 type: string
2277 script:
2278 type: string
2279 unicodeLocaleAttributes:
2280 type: array
2281 items:
2282 type: string
2283 uniqueItems: true
2284 unicodeLocaleKeys:
2285 type: array
2286 items:
2287 type: string
2288 uniqueItems: true
2289 variant:
2290 type: string
2291 lastModified:
2292 type: string
2293 format: date-time
2294 length:
2295 type: integer
2296 format: int32
2297 links:
2298 type: array
2299 items:
2300 type: object
2301 properties:
2302 params:
2303 type: object
2304 additionalProperties:
2305 type: string
2306 rel:
2307 type: string
2308 rels:
2309 type: array
2310 items:
2311 type: string
2312 title:
2313 type: string
2314 type:
2315 type: string
2316 uri:
2317 type: string
2318 format: uri
2319 uriBuilder:
2320 type: object
2321 uniqueItems: true
2322 location:
2323 type: string
2324 format: uri
2325 mediaType:
2326 type: object
2327 properties:
2328 parameters:
2329 type: object
2330 additionalProperties:
2331 type: string
2332 subtype:
2333 type: string
2334 type:
2335 type: string
2336 wildcardSubtype:
2337 type: boolean
2338 wildcardType:
2339 type: boolean
2340 metadata:
2341 type: object
2342 additionalProperties:
2343 type: array
2344 items:
2345 type: object
2346 status:
2347 type: integer
2348 format: int32
2349 statusInfo:
2350 type: object
2351 properties:
2352 family:
2353 type: string
2354 enum:
2355 - INFORMATIONAL
2356 - SUCCESSFUL
2357 - REDIRECTION
2358 - CLIENT_ERROR
2359 - SERVER_ERROR
2360 - OTHER
2361 reasonPhrase:
2362 type: string
2363 statusCode:
2364 type: integer
2365 format: int32
2366 stringHeaders:
2367 type: object
2368 additionalProperties:
2369 type: array
2370 items:
2371 type: string
2372 description: Internal Error
2373 servers:
2374 - url: /sdc2/rest
2375 variables: {}
2376 tags:
2377 - SDCE-2 APIs
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]2378 /v1/catalog/interface-types/{interfaceTypeId}:
2379 delete:
2380 operationId: deleteInterfaceType
2381 parameters:
2382 - description: The interface type id
2383 in: path
2384 name: interfaceTypeId
2385 required: true
2386 schema:
2387 type: string
2388 responses:
2389 default:
2390 content:
2391 '*/*': {}
2392 description: default response
2393 servers:
2394 - url: /sdc2/rest
2395 variables: {}
2396 tags:
2397 - SDCE-2 APIs
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]2398 /v1/catalog/interfaceLifecycleTypes:
2399 get:
2400 description: Get interface lifecycle types
2401 operationId: getInterfaceLifecycleTypes
2402 parameters:
2403 - in: header
2404 name: USER_ID
2405 schema:
2406 type: string
2407 - description: model
2408 in: query
2409 name: model
2410 schema:
2411 type: string
2412 responses:
2413 "200":
2414 description: Interface lifecycle types
2415 "400":
2416 description: Invalid content / Missing content
2417 "403":
2418 description: Restricted operation
2419 "404":
2420 description: Interface lifecycle types not found
2421 default:
2422 content:
2423 application/json:
2424 schema:
2425 type: array
2426 items:
2427 type: object
2428 properties:
2429 allowedMethods:
2430 type: array
2431 items:
2432 type: string
2433 uniqueItems: true
2434 cookies:
2435 type: object
2436 additionalProperties:
2437 type: object
2438 properties:
2439 comment:
2440 type: string
2441 domain:
2442 type: string
2443 expiry:
2444 type: string
2445 format: date-time
2446 httpOnly:
2447 type: boolean
2448 maxAge:
2449 type: integer
2450 format: int32
2451 name:
2452 type: string
2453 path:
2454 type: string
2455 secure:
2456 type: boolean
2457 value:
2458 type: string
2459 version:
2460 type: integer
2461 format: int32
2462 date:
2463 type: string
2464 format: date-time
2465 entity:
2466 type: object
2467 entityTag:
2468 type: object
2469 properties:
2470 value:
2471 type: string
2472 weak:
2473 type: boolean
2474 headers:
2475 type: object
2476 additionalProperties:
2477 type: array
2478 items:
2479 type: object
2480 language:
2481 type: object
2482 properties:
2483 country:
2484 type: string
2485 displayCountry:
2486 type: string
2487 displayLanguage:
2488 type: string
2489 displayName:
2490 type: string
2491 displayScript:
2492 type: string
2493 displayVariant:
2494 type: string
2495 extensionKeys:
2496 type: array
2497 items:
2498 type: string
2499 uniqueItems: true
2500 iso3Country:
2501 type: string
2502 iso3Language:
2503 type: string
2504 language:
2505 type: string
2506 script:
2507 type: string
2508 unicodeLocaleAttributes:
2509 type: array
2510 items:
2511 type: string
2512 uniqueItems: true
2513 unicodeLocaleKeys:
2514 type: array
2515 items:
2516 type: string
2517 uniqueItems: true
2518 variant:
2519 type: string
2520 lastModified:
2521 type: string
2522 format: date-time
2523 length:
2524 type: integer
2525 format: int32
2526 links:
2527 type: array
2528 items:
2529 type: object
2530 properties:
2531 params:
2532 type: object
2533 additionalProperties:
2534 type: string
2535 rel:
2536 type: string
2537 rels:
2538 type: array
2539 items:
2540 type: string
2541 title:
2542 type: string
2543 type:
2544 type: string
2545 uri:
2546 type: string
2547 format: uri
2548 uriBuilder:
2549 type: object
2550 uniqueItems: true
2551 location:
2552 type: string
2553 format: uri
2554 mediaType:
2555 type: object
2556 properties:
2557 parameters:
2558 type: object
2559 additionalProperties:
2560 type: string
2561 subtype:
2562 type: string
2563 type:
2564 type: string
2565 wildcardSubtype:
2566 type: boolean
2567 wildcardType:
2568 type: boolean
2569 metadata:
2570 type: object
2571 additionalProperties:
2572 type: array
2573 items:
2574 type: object
2575 status:
2576 type: integer
2577 format: int32
2578 statusInfo:
2579 type: object
2580 properties:
2581 family:
2582 type: string
2583 enum:
2584 - INFORMATIONAL
2585 - SUCCESSFUL
2586 - REDIRECTION
2587 - CLIENT_ERROR
2588 - SERVER_ERROR
2589 - OTHER
2590 reasonPhrase:
2591 type: string
2592 statusCode:
2593 type: integer
2594 format: int32
2595 stringHeaders:
2596 type: object
2597 additionalProperties:
2598 type: array
2599 items:
2600 type: string
2601 servers:
2602 - url: /sdc2/rest
2603 variables: {}
2604 summary: Returns interface lifecycle types
2605 tags:
2606 - SDCE-2 APIs
2607 /v1/catalog/lock:
2608 post:
2609 description: Toggle disable locking
2610 operationId: toggleDisableLocking
2611 parameters:
2612 - in: header
2613 name: USER_ID
2614 schema:
2615 type: string
2616 requestBody:
2617 content:
2618 application/json:
2619 schema:
2620 type: boolean
2621 description: Disable Locking
2622 responses:
2623 "200":
2624 description: Disable locking successfully updated
2625 "500":
2626 description: Update disable locking failed
2627 default:
2628 content:
2629 application/json:
2630 schema:
2631 type: object
2632 properties:
2633 allowedMethods:
2634 type: array
2635 items:
2636 type: string
2637 uniqueItems: true
2638 cookies:
2639 type: object
2640 additionalProperties:
2641 type: object
2642 properties:
2643 comment:
2644 type: string
2645 domain:
2646 type: string
2647 expiry:
2648 type: string
2649 format: date-time
2650 httpOnly:
2651 type: boolean
2652 maxAge:
2653 type: integer
2654 format: int32
2655 name:
2656 type: string
2657 path:
2658 type: string
2659 secure:
2660 type: boolean
2661 value:
2662 type: string
2663 version:
2664 type: integer
2665 format: int32
2666 date:
2667 type: string
2668 format: date-time
2669 entity:
2670 type: object
2671 entityTag:
2672 type: object
2673 properties:
2674 value:
2675 type: string
2676 weak:
2677 type: boolean
2678 headers:
2679 type: object
2680 additionalProperties:
2681 type: array
2682 items:
2683 type: object
2684 language:
2685 type: object
2686 properties:
2687 country:
2688 type: string
2689 displayCountry:
2690 type: string
2691 displayLanguage:
2692 type: string
2693 displayName:
2694 type: string
2695 displayScript:
2696 type: string
2697 displayVariant:
2698 type: string
2699 extensionKeys:
2700 type: array
2701 items:
2702 type: string
2703 uniqueItems: true
2704 iso3Country:
2705 type: string
2706 iso3Language:
2707 type: string
2708 language:
2709 type: string
2710 script:
2711 type: string
2712 unicodeLocaleAttributes:
2713 type: array
2714 items:
2715 type: string
2716 uniqueItems: true
2717 unicodeLocaleKeys:
2718 type: array
2719 items:
2720 type: string
2721 uniqueItems: true
2722 variant:
2723 type: string
2724 lastModified:
2725 type: string
2726 format: date-time
2727 length:
2728 type: integer
2729 format: int32
2730 links:
2731 type: array
2732 items:
2733 type: object
2734 properties:
2735 params:
2736 type: object
2737 additionalProperties:
2738 type: string
2739 rel:
2740 type: string
2741 rels:
2742 type: array
2743 items:
2744 type: string
2745 title:
2746 type: string
2747 type:
2748 type: string
2749 uri:
2750 type: string
2751 format: uri
2752 uriBuilder:
2753 type: object
2754 uniqueItems: true
2755 location:
2756 type: string
2757 format: uri
2758 mediaType:
2759 type: object
2760 properties:
2761 parameters:
2762 type: object
2763 additionalProperties:
2764 type: string
2765 subtype:
2766 type: string
2767 type:
2768 type: string
2769 wildcardSubtype:
2770 type: boolean
2771 wildcardType:
2772 type: boolean
2773 metadata:
2774 type: object
2775 additionalProperties:
2776 type: array
2777 items:
2778 type: object
2779 status:
2780 type: integer
2781 format: int32
2782 statusInfo:
2783 type: object
2784 properties:
2785 family:
2786 type: string
2787 enum:
2788 - INFORMATIONAL
2789 - SUCCESSFUL
2790 - REDIRECTION
2791 - CLIENT_ERROR
2792 - SERVER_ERROR
2793 - OTHER
2794 reasonPhrase:
2795 type: string
2796 statusCode:
2797 type: integer
2798 format: int32
2799 stringHeaders:
2800 type: object
2801 additionalProperties:
2802 type: array
2803 items:
2804 type: string
2805 servers:
2806 - url: /sdc2/rest
2807 variables: {}
2808 tags:
2809 - SDCE-2 APIs
2810 /v1/catalog/model:
2811 get:
2812 description: List all the existing TOSCA models
2813 operationId: listModels
2814 parameters:
2815 - in: header
2816 name: USER_ID
2817 schema:
2818 type: string
2819 - in: query
2820 name: modelType
2821 schema:
2822 type: string
2823 responses:
2824 "200":
2825 description: Listing successful
2826 "403":
2827 description: Restricted operation
2828 default:
2829 content:
2830 application/json:
2831 schema:
2832 type: array
2833 items:
2834 $ref: '#/components/schemas/Model'
2835 servers:
2836 - url: /sdc2/rest
2837 variables: {}
2838 summary: List TOSCA models
2839 tags:
2840 - SDCE-2 APIs
2841 post:
2842 description: "Create a TOSCA model, along with its imports files"
2843 operationId: createModel
2844 parameters:
2845 - in: header
2846 name: USER_ID
2847 schema:
2848 type: string
2849 requestBody:
2850 content:
2851 multipart/form-data:
2852 schema:
2853 type: object
2854 properties:
2855 model:
2856 $ref: '#/components/schemas/ModelCreateRequest'
2857 modelImportsZip:
2858 type: object
2859 description: the model TOSCA imports zipped
2860 required:
2861 - model
2862 - modelImportsZip
2863 responses:
2864 "201":
2865 description: Model created
2866 "400":
2867 description: Invalid content / Missing content
2868 "403":
2869 description: Restricted operation
2870 "409":
2871 description: Model already exists
2872 default:
2873 content:
2874 application/json:
2875 schema:
2876 type: array
2877 items:
2878 type: object
2879 properties:
2880 allowedMethods:
2881 type: array
2882 items:
2883 type: string
2884 uniqueItems: true
2885 cookies:
2886 type: object
2887 additionalProperties:
2888 type: object
2889 properties:
2890 comment:
2891 type: string
2892 domain:
2893 type: string
2894 expiry:
2895 type: string
2896 format: date-time
2897 httpOnly:
2898 type: boolean
2899 maxAge:
2900 type: integer
2901 format: int32
2902 name:
2903 type: string
2904 path:
2905 type: string
2906 secure:
2907 type: boolean
2908 value:
2909 type: string
2910 version:
2911 type: integer
2912 format: int32
2913 date:
2914 type: string
2915 format: date-time
2916 entity:
2917 type: object
2918 entityTag:
2919 type: object
2920 properties:
2921 value:
2922 type: string
2923 weak:
2924 type: boolean
2925 headers:
2926 type: object
2927 additionalProperties:
2928 type: array
2929 items:
2930 type: object
2931 language:
2932 type: object
2933 properties:
2934 country:
2935 type: string
2936 displayCountry:
2937 type: string
2938 displayLanguage:
2939 type: string
2940 displayName:
2941 type: string
2942 displayScript:
2943 type: string
2944 displayVariant:
2945 type: string
2946 extensionKeys:
2947 type: array
2948 items:
2949 type: string
2950 uniqueItems: true
2951 iso3Country:
2952 type: string
2953 iso3Language:
2954 type: string
2955 language:
2956 type: string
2957 script:
2958 type: string
2959 unicodeLocaleAttributes:
2960 type: array
2961 items:
2962 type: string
2963 uniqueItems: true
2964 unicodeLocaleKeys:
2965 type: array
2966 items:
2967 type: string
2968 uniqueItems: true
2969 variant:
2970 type: string
2971 lastModified:
2972 type: string
2973 format: date-time
2974 length:
2975 type: integer
2976 format: int32
2977 links:
2978 type: array
2979 items:
2980 type: object
2981 properties:
2982 params:
2983 type: object
2984 additionalProperties:
2985 type: string
2986 rel:
2987 type: string
2988 rels:
2989 type: array
2990 items:
2991 type: string
2992 title:
2993 type: string
2994 type:
2995 type: string
2996 uri:
2997 type: string
2998 format: uri
2999 uriBuilder:
3000 type: object
3001 uniqueItems: true
3002 location:
3003 type: string
3004 format: uri
3005 mediaType:
3006 type: object
3007 properties:
3008 parameters:
3009 type: object
3010 additionalProperties:
3011 type: string
3012 subtype:
3013 type: string
3014 type:
3015 type: string
3016 wildcardSubtype:
3017 type: boolean
3018 wildcardType:
3019 type: boolean
3020 metadata:
3021 type: object
3022 additionalProperties:
3023 type: array
3024 items:
3025 type: object
3026 status:
3027 type: integer
3028 format: int32
3029 statusInfo:
3030 type: object
3031 properties:
3032 family:
3033 type: string
3034 enum:
3035 - INFORMATIONAL
3036 - SUCCESSFUL
3037 - REDIRECTION
3038 - CLIENT_ERROR
3039 - SERVER_ERROR
3040 - OTHER
3041 reasonPhrase:
3042 type: string
3043 statusCode:
3044 type: integer
3045 format: int32
3046 stringHeaders:
3047 type: object
3048 additionalProperties:
3049 type: array
3050 items:
3051 type: string
3052 servers:
3053 - url: /sdc2/rest
3054 variables: {}
3055 summary: Create a TOSCA model
3056 tags:
3057 - SDCE-2 APIs
3058 /v1/catalog/model/imports:
3059 put:
3060 description: Update a model TOSCA imports
3061 operationId: updateModelImports
3062 parameters:
3063 - in: header
3064 name: USER_ID
3065 schema:
3066 type: string
3067 requestBody:
3068 content:
3069 multipart/form-data:
3070 schema:
3071 type: object
3072 properties:
3073 modelImportsZip:
3074 type: object
3075 description: the model TOSCA imports zipped
3076 modelName:
3077 type: string
3078 description: model to be created
3079 required:
3080 - modelImportsZip
3081 - modelName
3082 responses:
3083 "204":
3084 description: Model imports updated
3085 "400":
3086 description: Invalid content / Missing content
3087 "403":
3088 description: Restricted operation
3089 "404":
3090 description: Model not found
3091 default:
3092 content:
3093 application/json:
3094 schema:
3095 type: array
3096 items:
3097 type: object
3098 properties:
3099 allowedMethods:
3100 type: array
3101 items:
3102 type: string
3103 uniqueItems: true
3104 cookies:
3105 type: object
3106 additionalProperties:
3107 type: object
3108 properties:
3109 comment:
3110 type: string
3111 domain:
3112 type: string
3113 expiry:
3114 type: string
3115 format: date-time
3116 httpOnly:
3117 type: boolean
3118 maxAge:
3119 type: integer
3120 format: int32
3121 name:
3122 type: string
3123 path:
3124 type: string
3125 secure:
3126 type: boolean
3127 value:
3128 type: string
3129 version:
3130 type: integer
3131 format: int32
3132 date:
3133 type: string
3134 format: date-time
3135 entity:
3136 type: object
3137 entityTag:
3138 type: object
3139 properties:
3140 value:
3141 type: string
3142 weak:
3143 type: boolean
3144 headers:
3145 type: object
3146 additionalProperties:
3147 type: array
3148 items:
3149 type: object
3150 language:
3151 type: object
3152 properties:
3153 country:
3154 type: string
3155 displayCountry:
3156 type: string
3157 displayLanguage:
3158 type: string
3159 displayName:
3160 type: string
3161 displayScript:
3162 type: string
3163 displayVariant:
3164 type: string
3165 extensionKeys:
3166 type: array
3167 items:
3168 type: string
3169 uniqueItems: true
3170 iso3Country:
3171 type: string
3172 iso3Language:
3173 type: string
3174 language:
3175 type: string
3176 script:
3177 type: string
3178 unicodeLocaleAttributes:
3179 type: array
3180 items:
3181 type: string
3182 uniqueItems: true
3183 unicodeLocaleKeys:
3184 type: array
3185 items:
3186 type: string
3187 uniqueItems: true
3188 variant:
3189 type: string
3190 lastModified:
3191 type: string
3192 format: date-time
3193 length:
3194 type: integer
3195 format: int32
3196 links:
3197 type: array
3198 items:
3199 type: object
3200 properties:
3201 params:
3202 type: object
3203 additionalProperties:
3204 type: string
3205 rel:
3206 type: string
3207 rels:
3208 type: array
3209 items:
3210 type: string
3211 title:
3212 type: string
3213 type:
3214 type: string
3215 uri:
3216 type: string
3217 format: uri
3218 uriBuilder:
3219 type: object
3220 uniqueItems: true
3221 location:
3222 type: string
3223 format: uri
3224 mediaType:
3225 type: object
3226 properties:
3227 parameters:
3228 type: object
3229 additionalProperties:
3230 type: string
3231 subtype:
3232 type: string
3233 type:
3234 type: string
3235 wildcardSubtype:
3236 type: boolean
3237 wildcardType:
3238 type: boolean
3239 metadata:
3240 type: object
3241 additionalProperties:
3242 type: array
3243 items:
3244 type: object
3245 status:
3246 type: integer
3247 format: int32
3248 statusInfo:
3249 type: object
3250 properties:
3251 family:
3252 type: string
3253 enum:
3254 - INFORMATIONAL
3255 - SUCCESSFUL
3256 - REDIRECTION
3257 - CLIENT_ERROR
3258 - SERVER_ERROR
3259 - OTHER
3260 reasonPhrase:
3261 type: string
3262 statusCode:
3263 type: integer
3264 format: int32
3265 stringHeaders:
3266 type: object
3267 additionalProperties:
3268 type: array
3269 items:
3270 type: string
3271 servers:
3272 - url: /sdc2/rest
3273 variables: {}
3274 summary: Update a model TOSCA imports
3275 tags:
3276 - SDCE-2 APIs
3277 /v1/catalog/nodeTypes:
3278 get:
3279 description: Get node types
3280 operationId: getAllNodeTypesServlet
3281 parameters:
3282 - in: header
3283 name: USER_ID
3284 schema:
3285 type: string
3286 - description: model
3287 in: query
3288 name: model
3289 schema:
3290 type: string
3291 responses:
3292 "200":
3293 description: nodeTypes
3294 "400":
3295 description: Invalid content / Missing content
3296 "403":
3297 description: Restricted operation
3298 "404":
3299 description: Node types not found
3300 default:
3301 content:
3302 application/json:
3303 schema:
3304 type: array
3305 items:
3306 type: object
3307 properties:
3308 allowedMethods:
3309 type: array
3310 items:
3311 type: string
3312 uniqueItems: true
3313 cookies:
3314 type: object
3315 additionalProperties:
3316 type: object
3317 properties:
3318 comment:
3319 type: string
3320 domain:
3321 type: string
3322 expiry:
3323 type: string
3324 format: date-time
3325 httpOnly:
3326 type: boolean
3327 maxAge:
3328 type: integer
3329 format: int32
3330 name:
3331 type: string
3332 path:
3333 type: string
3334 secure:
3335 type: boolean
3336 value:
3337 type: string
3338 version:
3339 type: integer
3340 format: int32
3341 date:
3342 type: string
3343 format: date-time
3344 entity:
3345 type: object
3346 entityTag:
3347 type: object
3348 properties:
3349 value:
3350 type: string
3351 weak:
3352 type: boolean
3353 headers:
3354 type: object
3355 additionalProperties:
3356 type: array
3357 items:
3358 type: object
3359 language:
3360 type: object
3361 properties:
3362 country:
3363 type: string
3364 displayCountry:
3365 type: string
3366 displayLanguage:
3367 type: string
3368 displayName:
3369 type: string
3370 displayScript:
3371 type: string
3372 displayVariant:
3373 type: string
3374 extensionKeys:
3375 type: array
3376 items:
3377 type: string
3378 uniqueItems: true
3379 iso3Country:
3380 type: string
3381 iso3Language:
3382 type: string
3383 language:
3384 type: string
3385 script:
3386 type: string
3387 unicodeLocaleAttributes:
3388 type: array
3389 items:
3390 type: string
3391 uniqueItems: true
3392 unicodeLocaleKeys:
3393 type: array
3394 items:
3395 type: string
3396 uniqueItems: true
3397 variant:
3398 type: string
3399 lastModified:
3400 type: string
3401 format: date-time
3402 length:
3403 type: integer
3404 format: int32
3405 links:
3406 type: array
3407 items:
3408 type: object
3409 properties:
3410 params:
3411 type: object
3412 additionalProperties:
3413 type: string
3414 rel:
3415 type: string
3416 rels:
3417 type: array
3418 items:
3419 type: string
3420 title:
3421 type: string
3422 type:
3423 type: string
3424 uri:
3425 type: string
3426 format: uri
3427 uriBuilder:
3428 type: object
3429 uniqueItems: true
3430 location:
3431 type: string
3432 format: uri
3433 mediaType:
3434 type: object
3435 properties:
3436 parameters:
3437 type: object
3438 additionalProperties:
3439 type: string
3440 subtype:
3441 type: string
3442 type:
3443 type: string
3444 wildcardSubtype:
3445 type: boolean
3446 wildcardType:
3447 type: boolean
3448 metadata:
3449 type: object
3450 additionalProperties:
3451 type: array
3452 items:
3453 type: object
3454 status:
3455 type: integer
3456 format: int32
3457 statusInfo:
3458 type: object
3459 properties:
3460 family:
3461 type: string
3462 enum:
3463 - INFORMATIONAL
3464 - SUCCESSFUL
3465 - REDIRECTION
3466 - CLIENT_ERROR
3467 - SERVER_ERROR
3468 - OTHER
3469 reasonPhrase:
3470 type: string
3471 statusCode:
3472 type: integer
3473 format: int32
3474 stringHeaders:
3475 type: object
3476 additionalProperties:
3477 type: array
3478 items:
3479 type: string
3480 servers:
3481 - url: /sdc2/rest
3482 variables: {}
3483 summary: Returns node types
3484 tags:
3485 - SDCE-2 APIs
3486 /v1/catalog/notif/vsp/archived:
3487 post:
3488 description: Notify about an archived VSP. All VFs with relation to the given
3489 CSAR IDs will be martked as vspArchived=true
3490 operationId: onVspArchived
3491 parameters:
3492 - in: header
3493 name: USER_ID
3494 schema:
3495 type: string
3496 requestBody:
3497 content:
3498 application/json:
3499 schema:
3500 type: array
3501 items:
3502 type: string
3503 responses:
3504 "200":
3505 description: Success
3506 "400":
3507 description: Bad request
3508 "403":
3509 description: Restricted operation
3510 "500":
3511 description: Internal Error. A list of the failed CSAR IDs may be returned.
3512 servers:
3513 - url: /sdc2/rest
3514 variables: {}
3515 tags:
3516 - SDCE-2 APIs
3517 /v1/catalog/notif/vsp/restored:
3518 post:
3519 description: Notify about a restored VSP. All VFs with relation to the given
3520 CSAR IDs will be martked as vspArchived=false
3521 operationId: onVspRestored
3522 parameters:
3523 - in: header
3524 name: USER_ID
3525 schema:
3526 type: string
3527 requestBody:
3528 content:
3529 application/json:
3530 schema:
3531 type: array
3532 items:
3533 type: string
3534 responses:
3535 "200":
3536 description: Success
3537 "400":
3538 description: Bad request
3539 "403":
3540 description: Restricted operation
3541 "500":
3542 description: Internal Error. A list of the failed CSAR IDs may be returned.
3543 servers:
3544 - url: /sdc2/rest
3545 variables: {}
3546 tags:
3547 - SDCE-2 APIs
3548 /v1/catalog/policyTypes:
3549 get:
3550 description: 'Get policy types '
3551 operationId: getPolicyTypes
3552 parameters:
3553 - description: An optional parameter to indicate the type of the container from
3554 where this call is executed
3555 in: query
3556 name: internalComponentType
3557 schema:
3558 type: string
3559 - in: query
3560 name: componentModel
3561 schema:
3562 type: string
3563 - description: The user id
3564 in: header
3565 name: USER_ID
3566 required: true
3567 schema:
3568 type: string
3569 responses:
3570 "200":
3571 description: policy types found
3572 "403":
3573 description: Restricted operation
3574 "500":
3575 description: The GET request failed due to internal SDC problem.
3576 default:
3577 content:
3578 application/json:
3579 schema:
3580 type: array
3581 items:
3582 $ref: '#/components/schemas/PolicyTypeDefinition'
3583 servers:
3584 - url: /sdc2/rest
3585 variables: {}
3586 summary: Returns policy types
3587 tags:
3588 - SDCE-2 APIs
3589 /v1/catalog/relationshipTypes:
3590 get:
3591 description: Get relationship types
3592 operationId: getAllRelationshipTypesServlet
3593 parameters:
3594 - in: header
3595 name: USER_ID
3596 schema:
3597 type: string
3598 - description: model
3599 in: query
3600 name: model
3601 schema:
3602 type: string
3603 responses:
3604 "200":
3605 description: relationshipTypes
3606 "400":
3607 description: Invalid content / Missing content
3608 "403":
3609 description: Restricted operation
3610 "404":
3611 description: Relationship types not found
3612 default:
3613 content:
3614 application/json:
3615 schema:
3616 type: array
3617 items:
3618 type: object
3619 properties:
3620 allowedMethods:
3621 type: array
3622 items:
3623 type: string
3624 uniqueItems: true
3625 cookies:
3626 type: object
3627 additionalProperties:
3628 type: object
3629 properties:
3630 comment:
3631 type: string
3632 domain:
3633 type: string
3634 expiry:
3635 type: string
3636 format: date-time
3637 httpOnly:
3638 type: boolean
3639 maxAge:
3640 type: integer
3641 format: int32
3642 name:
3643 type: string
3644 path:
3645 type: string
3646 secure:
3647 type: boolean
3648 value:
3649 type: string
3650 version:
3651 type: integer
3652 format: int32
3653 date:
3654 type: string
3655 format: date-time
3656 entity:
3657 type: object
3658 entityTag:
3659 type: object
3660 properties:
3661 value:
3662 type: string
3663 weak:
3664 type: boolean
3665 headers:
3666 type: object
3667 additionalProperties:
3668 type: array
3669 items:
3670 type: object
3671 language:
3672 type: object
3673 properties:
3674 country:
3675 type: string
3676 displayCountry:
3677 type: string
3678 displayLanguage:
3679 type: string
3680 displayName:
3681 type: string
3682 displayScript:
3683 type: string
3684 displayVariant:
3685 type: string
3686 extensionKeys:
3687 type: array
3688 items:
3689 type: string
3690 uniqueItems: true
3691 iso3Country:
3692 type: string
3693 iso3Language:
3694 type: string
3695 language:
3696 type: string
3697 script:
3698 type: string
3699 unicodeLocaleAttributes:
3700 type: array
3701 items:
3702 type: string
3703 uniqueItems: true
3704 unicodeLocaleKeys:
3705 type: array
3706 items:
3707 type: string
3708 uniqueItems: true
3709 variant:
3710 type: string
3711 lastModified:
3712 type: string
3713 format: date-time
3714 length:
3715 type: integer
3716 format: int32
3717 links:
3718 type: array
3719 items:
3720 type: object
3721 properties:
3722 params:
3723 type: object
3724 additionalProperties:
3725 type: string
3726 rel:
3727 type: string
3728 rels:
3729 type: array
3730 items:
3731 type: string
3732 title:
3733 type: string
3734 type:
3735 type: string
3736 uri:
3737 type: string
3738 format: uri
3739 uriBuilder:
3740 type: object
3741 uniqueItems: true
3742 location:
3743 type: string
3744 format: uri
3745 mediaType:
3746 type: object
3747 properties:
3748 parameters:
3749 type: object
3750 additionalProperties:
3751 type: string
3752 subtype:
3753 type: string
3754 type:
3755 type: string
3756 wildcardSubtype:
3757 type: boolean
3758 wildcardType:
3759 type: boolean
3760 metadata:
3761 type: object
3762 additionalProperties:
3763 type: array
3764 items:
3765 type: object
3766 status:
3767 type: integer
3768 format: int32
3769 statusInfo:
3770 type: object
3771 properties:
3772 family:
3773 type: string
3774 enum:
3775 - INFORMATIONAL
3776 - SUCCESSFUL
3777 - REDIRECTION
3778 - CLIENT_ERROR
3779 - SERVER_ERROR
3780 - OTHER
3781 reasonPhrase:
3782 type: string
3783 statusCode:
3784 type: integer
3785 format: int32
3786 stringHeaders:
3787 type: object
3788 additionalProperties:
3789 type: array
3790 items:
3791 type: string
3792 servers:
3793 - url: /sdc2/rest
3794 variables: {}
3795 summary: Returns relationship types
3796 tags:
3797 - SDCE-2 APIs
3798 /v1/catalog/resources:
3799 post:
3800 description: Create Resource
3801 operationId: createResource
3802 parameters:
3803 - in: header
3804 name: USER_ID
3805 schema:
3806 type: string
3807 requestBody:
3808 content:
3809 application/json:
3810 schema:
3811 type: string
3812 description: Resource object to be created
3813 required: true
3814 responses:
3815 "201":
3816 description: Resource created
3817 "400":
3818 description: Invalid content / Missing content
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]3819 "401":
3820 description: Unauthorized Tenant
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]3821 "403":
3822 description: Restricted operation
3823 "409":
3824 description: Resource already exist
3825 default:
3826 content:
3827 application/json:
3828 schema:
3829 type: array
3830 items:
3831 $ref: '#/components/schemas/Resource'
3832 servers:
3833 - url: /sdc2/rest
3834 variables: {}
3835 summary: Returns created resource
3836 tags:
3837 - SDCE-2 APIs
3838 /v1/catalog/resources/certified/abstract:
3839 get:
3840 operationId: getCertifiedAbstractResources
3841 parameters:
3842 - in: header
3843 name: USER_ID
3844 schema:
3845 type: string
3846 responses:
3847 default:
3848 content:
3849 application/json: {}
3850 description: default response
3851 servers:
3852 - url: /sdc2/rest
3853 variables: {}
3854 tags:
3855 - SDCE-2 APIs
3856 /v1/catalog/resources/certified/notabstract:
3857 get:
3858 operationId: getCertifiedNotAbstractResources
3859 parameters:
3860 - in: header
3861 name: USER_ID
3862 schema:
3863 type: string
3864 responses:
3865 default:
3866 content:
3867 application/json: {}
3868 description: default response
3869 servers:
3870 - url: /sdc2/rest
3871 variables: {}
3872 tags:
3873 - SDCE-2 APIs
3874 /v1/catalog/resources/csar/{csaruuid}:
3875 get:
3876 description: Create Resource
3877 operationId: getResourceFromCsar
3878 parameters:
3879 - in: header
3880 name: USER_ID
3881 schema:
3882 type: string
3883 - in: path
3884 name: csaruuid
3885 required: true
3886 schema:
3887 type: string
3888 responses:
3889 "201":
3890 description: Resource retrieced
3891 "400":
3892 description: Invalid content / Missing content
3893 "403":
3894 description: Restricted operation
3895 default:
3896 content:
3897 application/json:
3898 schema:
3899 type: array
3900 items:
3901 $ref: '#/components/schemas/Resource'
3902 servers:
3903 - url: /sdc2/rest
3904 variables: {}
3905 summary: Returns resource created from csar uuid
3906 tags:
3907 - SDCE-2 APIs
3908 /v1/catalog/resources/importReplaceResource:
3909 post:
3910 description: Import Resource
3911 operationId: importReplaceResource
3912 parameters:
3913 - description: The user id
3914 in: header
3915 name: USER_ID
3916 required: true
3917 schema:
3918 type: string
3919 - description: X-ECOMP-RequestID header
3920 in: header
3921 name: X-ECOMP-RequestID
3922 schema:
3923 type: string
3924 - description: X-ECOMP-InstanceID header
3925 in: header
3926 name: X-ECOMP-InstanceID
3927 required: true
3928 schema:
3929 type: string
3930 - description: Determines the format of the body of the response
3931 in: header
3932 name: Accept
3933 schema:
3934 type: string
3935 - description: The username and password
3936 in: header
3937 name: Authorization
3938 required: true
3939 schema:
3940 type: string
3941 requestBody:
3942 content:
3943 '*/*':
3944 schema:
3945 type: object
3946 properties:
3947 resourceZip:
3948 $ref: '#/components/schemas/FormDataContentDisposition'
3949 resourceZipMetadata:
3950 type: string
3951 description: resourceMetadata
3952 responses:
3953 "201":
3954 description: Resource created
3955 "400":
3956 description: Invalid content / Missing content
3957 "403":
3958 description: Restricted operation
3959 "409":
3960 description: Resource already exist
3961 servers:
3962 - url: /sdc2/rest
3963 variables: {}
3964 summary: Returns imported resource
3965 tags:
3966 - SDCE-2 APIs
3967 /v1/catalog/resources/resourceName/{resourceName}/resourceVersion/{resourceVersion}:
3968 get:
3969 description: Retrieve Resource by name and version
3970 operationId: getResourceByNameAndVersion
3971 parameters:
3972 - in: path
3973 name: resourceName
3974 required: true
3975 schema:
3976 type: string
3977 - in: path
3978 name: resourceVersion
3979 required: true
3980 schema:
3981 type: string
3982 - in: header
3983 name: USER_ID
3984 schema:
3985 type: string
3986 responses:
3987 "200":
3988 description: Resource found
3989 "403":
3990 description: Restricted operation
3991 "404":
3992 description: Resource not found
3993 default:
3994 content:
3995 application/json:
3996 schema:
3997 type: array
3998 items:
3999 $ref: '#/components/schemas/Resource'
4000 servers:
4001 - url: /sdc2/rest
4002 variables: {}
4003 summary: Returns resource according to resourceId
4004 tags:
4005 - SDCE-2 APIs
4006 /v1/catalog/resources/validate-name/{resourceName}:
4007 get:
4008 description: validate resource name
4009 operationId: validateResourceName
4010 parameters:
4011 - in: path
4012 name: resourceName
4013 required: true
4014 schema:
4015 type: string
4016 - in: query
4017 name: subtype
4018 schema:
4019 type: string
4020 - in: header
4021 name: USER_ID
4022 schema:
4023 type: string
4024 responses:
4025 "200":
4026 description: Resource found
4027 "403":
4028 description: Restricted operation
4029 default:
4030 content:
4031 application/json:
4032 schema:
4033 type: array
4034 items:
4035 $ref: '#/components/schemas/Resource'
4036 servers:
4037 - url: /sdc2/rest
4038 variables: {}
4039 summary: 'checks if the chosen resource name is available '
4040 tags:
4041 - SDCE-2 APIs
4042 /v1/catalog/resources/{componentId}/archive:
4043 post:
4044 description: Archive Resource
4045 operationId: archiveResources
4046 parameters:
4047 - in: path
4048 name: componentId
4049 required: true
4050 schema:
4051 type: string
4052 - in: header
4053 name: USER_ID
4054 schema:
4055 type: string
4056 responses:
4057 "200":
4058 description: Archive successful
4059 "400":
4060 description: Bad request
4061 "403":
4062 description: Restricted operation
4063 "404":
4064 description: Resource not found
4065 "500":
4066 description: Internal Error
4067 default:
4068 content:
4069 application/json:
4070 schema:
4071 type: array
4072 items:
4073 type: string
4074 servers:
4075 - url: /sdc2/rest
4076 variables: {}
4077 summary: Marks a resource as archived. Can be restored with restore action
4078 tags:
4079 - SDCE-2 APIs
4080 /v1/catalog/resources/{componentId}/interfaceOperation:
4081 put:
4082 description: Update Interface Operation
4083 operationId: updateResourceInterfaceOperation
4084 parameters:
4085 - description: Component Id
4086 in: path
4087 name: componentId
4088 required: true
4089 schema:
4090 type: string
4091 - in: header
4092 name: USER_ID
4093 schema:
4094 type: string
4095 responses:
4096 "201":
4097 description: Update Interface Operation
4098 "400":
4099 description: Invalid content / Missing content
4100 "403":
4101 description: Restricted operation
4102 default:
4103 content:
4104 application/json:
4105 schema:
4106 type: array
4107 items:
4108 type: object
4109 properties:
4110 allowedMethods:
4111 type: array
4112 items:
4113 type: string
4114 uniqueItems: true
4115 cookies:
4116 type: object
4117 additionalProperties:
4118 type: object
4119 properties:
4120 comment:
4121 type: string
4122 domain:
4123 type: string
4124 expiry:
4125 type: string
4126 format: date-time
4127 httpOnly:
4128 type: boolean
4129 maxAge:
4130 type: integer
4131 format: int32
4132 name:
4133 type: string
4134 path:
4135 type: string
4136 secure:
4137 type: boolean
4138 value:
4139 type: string
4140 version:
4141 type: integer
4142 format: int32
4143 date:
4144 type: string
4145 format: date-time
4146 entity:
4147 type: object
4148 entityTag:
4149 type: object
4150 properties:
4151 value:
4152 type: string
4153 weak:
4154 type: boolean
4155 headers:
4156 type: object
4157 additionalProperties:
4158 type: array
4159 items:
4160 type: object
4161 language:
4162 type: object
4163 properties:
4164 country:
4165 type: string
4166 displayCountry:
4167 type: string
4168 displayLanguage:
4169 type: string
4170 displayName:
4171 type: string
4172 displayScript:
4173 type: string
4174 displayVariant:
4175 type: string
4176 extensionKeys:
4177 type: array
4178 items:
4179 type: string
4180 uniqueItems: true
4181 iso3Country:
4182 type: string
4183 iso3Language:
4184 type: string
4185 language:
4186 type: string
4187 script:
4188 type: string
4189 unicodeLocaleAttributes:
4190 type: array
4191 items:
4192 type: string
4193 uniqueItems: true
4194 unicodeLocaleKeys:
4195 type: array
4196 items:
4197 type: string
4198 uniqueItems: true
4199 variant:
4200 type: string
4201 lastModified:
4202 type: string
4203 format: date-time
4204 length:
4205 type: integer
4206 format: int32
4207 links:
4208 type: array
4209 items:
4210 type: object
4211 properties:
4212 params:
4213 type: object
4214 additionalProperties:
4215 type: string
4216 rel:
4217 type: string
4218 rels:
4219 type: array
4220 items:
4221 type: string
4222 title:
4223 type: string
4224 type:
4225 type: string
4226 uri:
4227 type: string
4228 format: uri
4229 uriBuilder:
4230 type: object
4231 uniqueItems: true
4232 location:
4233 type: string
4234 format: uri
4235 mediaType:
4236 type: object
4237 properties:
4238 parameters:
4239 type: object
4240 additionalProperties:
4241 type: string
4242 subtype:
4243 type: string
4244 type:
4245 type: string
4246 wildcardSubtype:
4247 type: boolean
4248 wildcardType:
4249 type: boolean
4250 metadata:
4251 type: object
4252 additionalProperties:
4253 type: array
4254 items:
4255 type: object
4256 status:
4257 type: integer
4258 format: int32
4259 statusInfo:
4260 type: object
4261 properties:
4262 family:
4263 type: string
4264 enum:
4265 - INFORMATIONAL
4266 - SUCCESSFUL
4267 - REDIRECTION
4268 - CLIENT_ERROR
4269 - SERVER_ERROR
4270 - OTHER
4271 reasonPhrase:
4272 type: string
4273 statusCode:
4274 type: integer
4275 format: int32
4276 stringHeaders:
4277 type: object
4278 additionalProperties:
4279 type: array
4280 items:
4281 type: string
4282 servers:
4283 - url: /sdc2/rest
4284 variables: {}
4285 summary: Update Interface Operation on ComponentInstance
4286 tags:
4287 - SDCE-2 APIs
4288 /v1/catalog/resources/{componentId}/restore:
4289 post:
4290 description: Restore Resource
4291 operationId: restoreResource
4292 parameters:
4293 - in: path
4294 name: componentId
4295 required: true
4296 schema:
4297 type: string
4298 - in: header
4299 name: USER_ID
4300 schema:
4301 type: string
4302 responses:
4303 "200":
4304 description: Restore successful
4305 "400":
4306 description: Bad request
4307 "403":
4308 description: Restricted operation
4309 "404":
4310 description: Resource not found
4311 "500":
4312 description: Internal Error
4313 default:
4314 content:
4315 application/json:
4316 schema:
4317 type: array
4318 items:
4319 type: string
4320 servers:
4321 - url: /sdc2/rest
4322 variables: {}
4323 summary: Restores a resource from archive.
4324 tags:
4325 - SDCE-2 APIs
4326 /v1/catalog/resources/{resourceId}:
4327 delete:
4328 operationId: deleteResource
4329 parameters:
4330 - in: path
4331 name: resourceId
4332 required: true
4333 schema:
4334 type: string
4335 - description: "Optional parameter to determine the delete action: DELETE, which\
4336 \ will permanently delete the Resource from the system or MARK_AS_DELETE,\
4337 \ which will logically mark the Resource as deleted. Default action is to\
4338 \ MARK_AS_DELETE"
4339 in: query
4340 name: deleteAction
4341 schema:
4342 type: string
4343 enum:
4344 - MARK_AS_DELETE
4345 - DELETE
4346 responses:
4347 default:
4348 content:
4349 '*/*': {}
4350 description: default response
4351 servers:
4352 - url: /sdc2/rest
4353 variables: {}
4354 tags:
4355 - SDCE-2 APIs
4356 get:
4357 description: Retrieve Resource
4358 operationId: getResourceById
4359 parameters:
4360 - in: path
4361 name: resourceId
4362 required: true
4363 schema:
4364 type: string
4365 - in: header
4366 name: USER_ID
4367 schema:
4368 type: string
4369 responses:
4370 "200":
4371 description: Resource found
4372 "403":
4373 description: Restricted operation
4374 "404":
4375 description: Resource not found
4376 default:
4377 content:
4378 application/json:
4379 schema:
4380 type: array
4381 items:
4382 $ref: '#/components/schemas/Resource'
4383 servers:
4384 - url: /sdc2/rest
4385 variables: {}
4386 summary: Returns resource according to resourceId
4387 tags:
4388 - SDCE-2 APIs
4389 put:
4390 description: Update Resource
4391 operationId: updateResource
4392 parameters:
4393 - in: header
4394 name: USER_ID
4395 schema:
4396 type: string
4397 - in: path
4398 name: resourceId
4399 required: true
4400 schema:
4401 type: string
4402 requestBody:
4403 content:
4404 application/json:
4405 schema:
4406 type: string
4407 description: Resource object to be updated
4408 required: true
4409 responses:
4410 "200":
4411 description: Resource updated
4412 "400":
4413 description: Invalid content / Missing content
4414 "403":
4415 description: Restricted operation
4416 "409":
4417 description: Resource already exist
4418 default:
4419 content:
4420 application/json:
4421 schema:
4422 type: array
4423 items:
4424 $ref: '#/components/schemas/Resource'
4425 servers:
4426 - url: /sdc2/rest
4427 variables: {}
4428 summary: Returns updated resource
4429 tags:
4430 - SDCE-2 APIs
4431 /v1/catalog/resources/{resourceId}/additionalinfo:
4432 get:
4433 description: Get all Additional Information under resource
4434 operationId: getAllResourceAdditionalInformationLabel
4435 parameters:
4436 - description: resource id to update with new property
4437 in: path
4438 name: resourceId
4439 required: true
4440 schema:
4441 type: string
4442 - in: header
4443 name: USER_ID
4444 schema:
4445 type: string
4446 responses:
4447 "200":
4448 description: list of additional information
4449 "400":
4450 description: Invalid content / Missing content
4451 "403":
4452 description: Restricted operation
4453 "409":
4454 description: Additional information key already exist
4455 default:
4456 content:
4457 application/json:
4458 schema:
4459 type: array
4460 items:
4461 type: object
4462 properties:
4463 allowedMethods:
4464 type: array
4465 items:
4466 type: string
4467 uniqueItems: true
4468 cookies:
4469 type: object
4470 additionalProperties:
4471 type: object
4472 properties:
4473 comment:
4474 type: string
4475 domain:
4476 type: string
4477 expiry:
4478 type: string
4479 format: date-time
4480 httpOnly:
4481 type: boolean
4482 maxAge:
4483 type: integer
4484 format: int32
4485 name:
4486 type: string
4487 path:
4488 type: string
4489 secure:
4490 type: boolean
4491 value:
4492 type: string
4493 version:
4494 type: integer
4495 format: int32
4496 date:
4497 type: string
4498 format: date-time
4499 entity:
4500 type: object
4501 entityTag:
4502 type: object
4503 properties:
4504 value:
4505 type: string
4506 weak:
4507 type: boolean
4508 headers:
4509 type: object
4510 additionalProperties:
4511 type: array
4512 items:
4513 type: object
4514 language:
4515 type: object
4516 properties:
4517 country:
4518 type: string
4519 displayCountry:
4520 type: string
4521 displayLanguage:
4522 type: string
4523 displayName:
4524 type: string
4525 displayScript:
4526 type: string
4527 displayVariant:
4528 type: string
4529 extensionKeys:
4530 type: array
4531 items:
4532 type: string
4533 uniqueItems: true
4534 iso3Country:
4535 type: string
4536 iso3Language:
4537 type: string
4538 language:
4539 type: string
4540 script:
4541 type: string
4542 unicodeLocaleAttributes:
4543 type: array
4544 items:
4545 type: string
4546 uniqueItems: true
4547 unicodeLocaleKeys:
4548 type: array
4549 items:
4550 type: string
4551 uniqueItems: true
4552 variant:
4553 type: string
4554 lastModified:
4555 type: string
4556 format: date-time
4557 length:
4558 type: integer
4559 format: int32
4560 links:
4561 type: array
4562 items:
4563 type: object
4564 properties:
4565 params:
4566 type: object
4567 additionalProperties:
4568 type: string
4569 rel:
4570 type: string
4571 rels:
4572 type: array
4573 items:
4574 type: string
4575 title:
4576 type: string
4577 type:
4578 type: string
4579 uri:
4580 type: string
4581 format: uri
4582 uriBuilder:
4583 type: object
4584 uniqueItems: true
4585 location:
4586 type: string
4587 format: uri
4588 mediaType:
4589 type: object
4590 properties:
4591 parameters:
4592 type: object
4593 additionalProperties:
4594 type: string
4595 subtype:
4596 type: string
4597 type:
4598 type: string
4599 wildcardSubtype:
4600 type: boolean
4601 wildcardType:
4602 type: boolean
4603 metadata:
4604 type: object
4605 additionalProperties:
4606 type: array
4607 items:
4608 type: object
4609 status:
4610 type: integer
4611 format: int32
4612 statusInfo:
4613 type: object
4614 properties:
4615 family:
4616 type: string
4617 enum:
4618 - INFORMATIONAL
4619 - SUCCESSFUL
4620 - REDIRECTION
4621 - CLIENT_ERROR
4622 - SERVER_ERROR
4623 - OTHER
4624 reasonPhrase:
4625 type: string
4626 statusCode:
4627 type: integer
4628 format: int32
4629 stringHeaders:
4630 type: object
4631 additionalProperties:
4632 type: array
4633 items:
4634 type: string
4635 servers:
4636 - url: /sdc2/rest
4637 variables: {}
4638 summary: Returns Additional Inforamtion property
4639 tags:
4640 - SDCE-2 APIs
4641 post:
4642 description: Create Additional Information Label and Value
4643 operationId: createResourceAdditionalInformationLabel
4644 parameters:
4645 - description: resource id to update with new property
4646 in: path
4647 name: resourceId
4648 required: true
4649 schema:
4650 type: string
4651 - in: header
4652 name: USER_ID
4653 schema:
4654 type: string
4655 requestBody:
4656 content:
4657 application/json:
4658 schema:
4659 type: string
4660 description: Additional information key value to be created
4661 required: true
4662 responses:
4663 "201":
4664 description: Additional information created
4665 "400":
4666 description: Invalid content / Missing content
4667 "403":
4668 description: Restricted operation
4669 "409":
4670 description: Additional information key already exist
4671 default:
4672 content:
4673 application/json:
4674 schema:
4675 type: array
4676 items:
4677 type: object
4678 properties:
4679 allowedMethods:
4680 type: array
4681 items:
4682 type: string
4683 uniqueItems: true
4684 cookies:
4685 type: object
4686 additionalProperties:
4687 type: object
4688 properties:
4689 comment:
4690 type: string
4691 domain:
4692 type: string
4693 expiry:
4694 type: string
4695 format: date-time
4696 httpOnly:
4697 type: boolean
4698 maxAge:
4699 type: integer
4700 format: int32
4701 name:
4702 type: string
4703 path:
4704 type: string
4705 secure:
4706 type: boolean
4707 value:
4708 type: string
4709 version:
4710 type: integer
4711 format: int32
4712 date:
4713 type: string
4714 format: date-time
4715 entity:
4716 type: object
4717 entityTag:
4718 type: object
4719 properties:
4720 value:
4721 type: string
4722 weak:
4723 type: boolean
4724 headers:
4725 type: object
4726 additionalProperties:
4727 type: array
4728 items:
4729 type: object
4730 language:
4731 type: object
4732 properties:
4733 country:
4734 type: string
4735 displayCountry:
4736 type: string
4737 displayLanguage:
4738 type: string
4739 displayName:
4740 type: string
4741 displayScript:
4742 type: string
4743 displayVariant:
4744 type: string
4745 extensionKeys:
4746 type: array
4747 items:
4748 type: string
4749 uniqueItems: true
4750 iso3Country:
4751 type: string
4752 iso3Language:
4753 type: string
4754 language:
4755 type: string
4756 script:
4757 type: string
4758 unicodeLocaleAttributes:
4759 type: array
4760 items:
4761 type: string
4762 uniqueItems: true
4763 unicodeLocaleKeys:
4764 type: array
4765 items:
4766 type: string
4767 uniqueItems: true
4768 variant:
4769 type: string
4770 lastModified:
4771 type: string
4772 format: date-time
4773 length:
4774 type: integer
4775 format: int32
4776 links:
4777 type: array
4778 items:
4779 type: object
4780 properties:
4781 params:
4782 type: object
4783 additionalProperties:
4784 type: string
4785 rel:
4786 type: string
4787 rels:
4788 type: array
4789 items:
4790 type: string
4791 title:
4792 type: string
4793 type:
4794 type: string
4795 uri:
4796 type: string
4797 format: uri
4798 uriBuilder:
4799 type: object
4800 uniqueItems: true
4801 location:
4802 type: string
4803 format: uri
4804 mediaType:
4805 type: object
4806 properties:
4807 parameters:
4808 type: object
4809 additionalProperties:
4810 type: string
4811 subtype:
4812 type: string
4813 type:
4814 type: string
4815 wildcardSubtype:
4816 type: boolean
4817 wildcardType:
4818 type: boolean
4819 metadata:
4820 type: object
4821 additionalProperties:
4822 type: array
4823 items:
4824 type: object
4825 status:
4826 type: integer
4827 format: int32
4828 statusInfo:
4829 type: object
4830 properties:
4831 family:
4832 type: string
4833 enum:
4834 - INFORMATIONAL
4835 - SUCCESSFUL
4836 - REDIRECTION
4837 - CLIENT_ERROR
4838 - SERVER_ERROR
4839 - OTHER
4840 reasonPhrase:
4841 type: string
4842 statusCode:
4843 type: integer
4844 format: int32
4845 stringHeaders:
4846 type: object
4847 additionalProperties:
4848 type: array
4849 items:
4850 type: string
4851 servers:
4852 - url: /sdc2/rest
4853 variables: {}
4854 summary: Returns created Additional Inforamtion property
4855 tags:
4856 - SDCE-2 APIs
4857 /v1/catalog/resources/{resourceId}/additionalinfo/{labelId}:
4858 delete:
4859 description: Create Additional Information Label and Value
4860 operationId: updateResourceAdditionalInformationLabel
4861 parameters:
4862 - description: resource id to update with new property
4863 in: path
4864 name: resourceId
4865 required: true
4866 schema:
4867 type: string
4868 - description: label id
4869 in: path
4870 name: labelId
4871 required: true
4872 schema:
4873 type: string
4874 - in: header
4875 name: USER_ID
4876 schema:
4877 type: string
4878 responses:
4879 "200":
4880 description: Additional information deleted
4881 "400":
4882 description: Invalid content / Missing content
4883 "403":
4884 description: Restricted operation
4885 "409":
4886 description: Additional information key already exist
4887 default:
4888 content:
4889 application/json:
4890 schema:
4891 type: array
4892 items:
4893 type: object
4894 properties:
4895 allowedMethods:
4896 type: array
4897 items:
4898 type: string
4899 uniqueItems: true
4900 cookies:
4901 type: object
4902 additionalProperties:
4903 type: object
4904 properties:
4905 comment:
4906 type: string
4907 domain:
4908 type: string
4909 expiry:
4910 type: string
4911 format: date-time
4912 httpOnly:
4913 type: boolean
4914 maxAge:
4915 type: integer
4916 format: int32
4917 name:
4918 type: string
4919 path:
4920 type: string
4921 secure:
4922 type: boolean
4923 value:
4924 type: string
4925 version:
4926 type: integer
4927 format: int32
4928 date:
4929 type: string
4930 format: date-time
4931 entity:
4932 type: object
4933 entityTag:
4934 type: object
4935 properties:
4936 value:
4937 type: string
4938 weak:
4939 type: boolean
4940 headers:
4941 type: object
4942 additionalProperties:
4943 type: array
4944 items:
4945 type: object
4946 language:
4947 type: object
4948 properties:
4949 country:
4950 type: string
4951 displayCountry:
4952 type: string
4953 displayLanguage:
4954 type: string
4955 displayName:
4956 type: string
4957 displayScript:
4958 type: string
4959 displayVariant:
4960 type: string
4961 extensionKeys:
4962 type: array
4963 items:
4964 type: string
4965 uniqueItems: true
4966 iso3Country:
4967 type: string
4968 iso3Language:
4969 type: string
4970 language:
4971 type: string
4972 script:
4973 type: string
4974 unicodeLocaleAttributes:
4975 type: array
4976 items:
4977 type: string
4978 uniqueItems: true
4979 unicodeLocaleKeys:
4980 type: array
4981 items:
4982 type: string
4983 uniqueItems: true
4984 variant:
4985 type: string
4986 lastModified:
4987 type: string
4988 format: date-time
4989 length:
4990 type: integer
4991 format: int32
4992 links:
4993 type: array
4994 items:
4995 type: object
4996 properties:
4997 params:
4998 type: object
4999 additionalProperties:
5000 type: string
5001 rel:
5002 type: string
5003 rels:
5004 type: array
5005 items:
5006 type: string
5007 title:
5008 type: string
5009 type:
5010 type: string
5011 uri:
5012 type: string
5013 format: uri
5014 uriBuilder:
5015 type: object
5016 uniqueItems: true
5017 location:
5018 type: string
5019 format: uri
5020 mediaType:
5021 type: object
5022 properties:
5023 parameters:
5024 type: object
5025 additionalProperties:
5026 type: string
5027 subtype:
5028 type: string
5029 type:
5030 type: string
5031 wildcardSubtype:
5032 type: boolean
5033 wildcardType:
5034 type: boolean
5035 metadata:
5036 type: object
5037 additionalProperties:
5038 type: array
5039 items:
5040 type: object
5041 status:
5042 type: integer
5043 format: int32
5044 statusInfo:
5045 type: object
5046 properties:
5047 family:
5048 type: string
5049 enum:
5050 - INFORMATIONAL
5051 - SUCCESSFUL
5052 - REDIRECTION
5053 - CLIENT_ERROR
5054 - SERVER_ERROR
5055 - OTHER
5056 reasonPhrase:
5057 type: string
5058 statusCode:
5059 type: integer
5060 format: int32
5061 stringHeaders:
5062 type: object
5063 additionalProperties:
5064 type: array
5065 items:
5066 type: string
5067 servers:
5068 - url: /sdc2/rest
5069 variables: {}
5070 summary: Returns deleted Additional Inforamtion property
5071 tags:
5072 - SDCE-2 APIs
5073 get:
5074 description: Get Additional Information by id
5075 operationId: getResourceAdditionalInformationLabel
5076 parameters:
5077 - description: resource id to update with new property
5078 in: path
5079 name: resourceId
5080 required: true
5081 schema:
5082 type: string
5083 - description: label id
5084 in: path
5085 name: labelId
5086 required: true
5087 schema:
5088 type: string
5089 - in: header
5090 name: USER_ID
5091 schema:
5092 type: string
5093 responses:
5094 "200":
5095 description: fetched additional information
5096 "400":
5097 description: Invalid content / Missing content
5098 "403":
5099 description: Restricted operation
5100 "409":
5101 description: Additional information key already exist
5102 default:
5103 content:
5104 application/json:
5105 schema:
5106 type: array
5107 items:
5108 type: object
5109 properties:
5110 allowedMethods:
5111 type: array
5112 items:
5113 type: string
5114 uniqueItems: true
5115 cookies:
5116 type: object
5117 additionalProperties:
5118 type: object
5119 properties:
5120 comment:
5121 type: string
5122 domain:
5123 type: string
5124 expiry:
5125 type: string
5126 format: date-time
5127 httpOnly:
5128 type: boolean
5129 maxAge:
5130 type: integer
5131 format: int32
5132 name:
5133 type: string
5134 path:
5135 type: string
5136 secure:
5137 type: boolean
5138 value:
5139 type: string
5140 version:
5141 type: integer
5142 format: int32
5143 date:
5144 type: string
5145 format: date-time
5146 entity:
5147 type: object
5148 entityTag:
5149 type: object
5150 properties:
5151 value:
5152 type: string
5153 weak:
5154 type: boolean
5155 headers:
5156 type: object
5157 additionalProperties:
5158 type: array
5159 items:
5160 type: object
5161 language:
5162 type: object
5163 properties:
5164 country:
5165 type: string
5166 displayCountry:
5167 type: string
5168 displayLanguage:
5169 type: string
5170 displayName:
5171 type: string
5172 displayScript:
5173 type: string
5174 displayVariant:
5175 type: string
5176 extensionKeys:
5177 type: array
5178 items:
5179 type: string
5180 uniqueItems: true
5181 iso3Country:
5182 type: string
5183 iso3Language:
5184 type: string
5185 language:
5186 type: string
5187 script:
5188 type: string
5189 unicodeLocaleAttributes:
5190 type: array
5191 items:
5192 type: string
5193 uniqueItems: true
5194 unicodeLocaleKeys:
5195 type: array
5196 items:
5197 type: string
5198 uniqueItems: true
5199 variant:
5200 type: string
5201 lastModified:
5202 type: string
5203 format: date-time
5204 length:
5205 type: integer
5206 format: int32
5207 links:
5208 type: array
5209 items:
5210 type: object
5211 properties:
5212 params:
5213 type: object
5214 additionalProperties:
5215 type: string
5216 rel:
5217 type: string
5218 rels:
5219 type: array
5220 items:
5221 type: string
5222 title:
5223 type: string
5224 type:
5225 type: string
5226 uri:
5227 type: string
5228 format: uri
5229 uriBuilder:
5230 type: object
5231 uniqueItems: true
5232 location:
5233 type: string
5234 format: uri
5235 mediaType:
5236 type: object
5237 properties:
5238 parameters:
5239 type: object
5240 additionalProperties:
5241 type: string
5242 subtype:
5243 type: string
5244 type:
5245 type: string
5246 wildcardSubtype:
5247 type: boolean
5248 wildcardType:
5249 type: boolean
5250 metadata:
5251 type: object
5252 additionalProperties:
5253 type: array
5254 items:
5255 type: object
5256 status:
5257 type: integer
5258 format: int32
5259 statusInfo:
5260 type: object
5261 properties:
5262 family:
5263 type: string
5264 enum:
5265 - INFORMATIONAL
5266 - SUCCESSFUL
5267 - REDIRECTION
5268 - CLIENT_ERROR
5269 - SERVER_ERROR
5270 - OTHER
5271 reasonPhrase:
5272 type: string
5273 statusCode:
5274 type: integer
5275 format: int32
5276 stringHeaders:
5277 type: object
5278 additionalProperties:
5279 type: array
5280 items:
5281 type: string
5282 servers:
5283 - url: /sdc2/rest
5284 variables: {}
5285 summary: Returns Additional Inforamtion property
5286 tags:
5287 - SDCE-2 APIs
5288 put:
5289 description: Update Additional Information Label and Value
5290 operationId: updateResourceAdditionalInformationLabel_1
5291 parameters:
5292 - description: resource id to update with new property
5293 in: path
5294 name: resourceId
5295 required: true
5296 schema:
5297 type: string
5298 - description: label id
5299 in: path
5300 name: labelId
5301 required: true
5302 schema:
5303 type: string
5304 - in: header
5305 name: USER_ID
5306 schema:
5307 type: string
5308 requestBody:
5309 content:
5310 application/json:
5311 schema:
5312 type: string
5313 description: Additional information key value to be created
5314 required: true
5315 responses:
5316 "200":
5317 description: Additional information updated
5318 "400":
5319 description: Invalid content / Missing content
5320 "403":
5321 description: Restricted operation
5322 "409":
5323 description: Additional information key already exist
5324 default:
5325 content:
5326 application/json:
5327 schema:
5328 type: array
5329 items:
5330 type: object
5331 properties:
5332 allowedMethods:
5333 type: array
5334 items:
5335 type: string
5336 uniqueItems: true
5337 cookies:
5338 type: object
5339 additionalProperties:
5340 type: object
5341 properties:
5342 comment:
5343 type: string
5344 domain:
5345 type: string
5346 expiry:
5347 type: string
5348 format: date-time
5349 httpOnly:
5350 type: boolean
5351 maxAge:
5352 type: integer
5353 format: int32
5354 name:
5355 type: string
5356 path:
5357 type: string
5358 secure:
5359 type: boolean
5360 value:
5361 type: string
5362 version:
5363 type: integer
5364 format: int32
5365 date:
5366 type: string
5367 format: date-time
5368 entity:
5369 type: object
5370 entityTag:
5371 type: object
5372 properties:
5373 value:
5374 type: string
5375 weak:
5376 type: boolean
5377 headers:
5378 type: object
5379 additionalProperties:
5380 type: array
5381 items:
5382 type: object
5383 language:
5384 type: object
5385 properties:
5386 country:
5387 type: string
5388 displayCountry:
5389 type: string
5390 displayLanguage:
5391 type: string
5392 displayName:
5393 type: string
5394 displayScript:
5395 type: string
5396 displayVariant:
5397 type: string
5398 extensionKeys:
5399 type: array
5400 items:
5401 type: string
5402 uniqueItems: true
5403 iso3Country:
5404 type: string
5405 iso3Language:
5406 type: string
5407 language:
5408 type: string
5409 script:
5410 type: string
5411 unicodeLocaleAttributes:
5412 type: array
5413 items:
5414 type: string
5415 uniqueItems: true
5416 unicodeLocaleKeys:
5417 type: array
5418 items:
5419 type: string
5420 uniqueItems: true
5421 variant:
5422 type: string
5423 lastModified:
5424 type: string
5425 format: date-time
5426 length:
5427 type: integer
5428 format: int32
5429 links:
5430 type: array
5431 items:
5432 type: object
5433 properties:
5434 params:
5435 type: object
5436 additionalProperties:
5437 type: string
5438 rel:
5439 type: string
5440 rels:
5441 type: array
5442 items:
5443 type: string
5444 title:
5445 type: string
5446 type:
5447 type: string
5448 uri:
5449 type: string
5450 format: uri
5451 uriBuilder:
5452 type: object
5453 uniqueItems: true
5454 location:
5455 type: string
5456 format: uri
5457 mediaType:
5458 type: object
5459 properties:
5460 parameters:
5461 type: object
5462 additionalProperties:
5463 type: string
5464 subtype:
5465 type: string
5466 type:
5467 type: string
5468 wildcardSubtype:
5469 type: boolean
5470 wildcardType:
5471 type: boolean
5472 metadata:
5473 type: object
5474 additionalProperties:
5475 type: array
5476 items:
5477 type: object
5478 status:
5479 type: integer
5480 format: int32
5481 statusInfo:
5482 type: object
5483 properties:
5484 family:
5485 type: string
5486 enum:
5487 - INFORMATIONAL
5488 - SUCCESSFUL
5489 - REDIRECTION
5490 - CLIENT_ERROR
5491 - SERVER_ERROR
5492 - OTHER
5493 reasonPhrase:
5494 type: string
5495 statusCode:
5496 type: integer
5497 format: int32
5498 stringHeaders:
5499 type: object
5500 additionalProperties:
5501 type: array
5502 items:
5503 type: string
5504 servers:
5505 - url: /sdc2/rest
5506 variables: {}
5507 summary: Returns updated Additional Inforamtion property
5508 tags:
5509 - SDCE-2 APIs
5510 /v1/catalog/resources/{resourceId}/artifacts:
5511 post:
5512 description: Create Artifact
5513 operationId: loadArtifact
5514 parameters:
5515 - in: path
5516 name: resourceId
5517 required: true
5518 schema:
5519 type: string
5520 requestBody:
5521 content:
5522 application/json:
5523 schema:
5524 type: string
5525 description: json describe the artifact
5526 required: true
5527 responses:
5528 "201":
5529 description: Resource created
5530 "400":
5531 description: Invalid content / Missing content
5532 "403":
5533 description: Restricted operation
5534 "409":
5535 description: Artifact already exist
5536 default:
5537 content:
5538 application/json:
5539 schema:
5540 type: array
5541 items:
5542 type: object
5543 properties:
5544 allowedMethods:
5545 type: array
5546 items:
5547 type: string
5548 uniqueItems: true
5549 cookies:
5550 type: object
5551 additionalProperties:
5552 type: object
5553 properties:
5554 comment:
5555 type: string
5556 domain:
5557 type: string
5558 expiry:
5559 type: string
5560 format: date-time
5561 httpOnly:
5562 type: boolean
5563 maxAge:
5564 type: integer
5565 format: int32
5566 name:
5567 type: string
5568 path:
5569 type: string
5570 secure:
5571 type: boolean
5572 value:
5573 type: string
5574 version:
5575 type: integer
5576 format: int32
5577 date:
5578 type: string
5579 format: date-time
5580 entity:
5581 type: object
5582 entityTag:
5583 type: object
5584 properties:
5585 value:
5586 type: string
5587 weak:
5588 type: boolean
5589 headers:
5590 type: object
5591 additionalProperties:
5592 type: array
5593 items:
5594 type: object
5595 language:
5596 type: object
5597 properties:
5598 country:
5599 type: string
5600 displayCountry:
5601 type: string
5602 displayLanguage:
5603 type: string
5604 displayName:
5605 type: string
5606 displayScript:
5607 type: string
5608 displayVariant:
5609 type: string
5610 extensionKeys:
5611 type: array
5612 items:
5613 type: string
5614 uniqueItems: true
5615 iso3Country:
5616 type: string
5617 iso3Language:
5618 type: string
5619 language:
5620 type: string
5621 script:
5622 type: string
5623 unicodeLocaleAttributes:
5624 type: array
5625 items:
5626 type: string
5627 uniqueItems: true
5628 unicodeLocaleKeys:
5629 type: array
5630 items:
5631 type: string
5632 uniqueItems: true
5633 variant:
5634 type: string
5635 lastModified:
5636 type: string
5637 format: date-time
5638 length:
5639 type: integer
5640 format: int32
5641 links:
5642 type: array
5643 items:
5644 type: object
5645 properties:
5646 params:
5647 type: object
5648 additionalProperties:
5649 type: string
5650 rel:
5651 type: string
5652 rels:
5653 type: array
5654 items:
5655 type: string
5656 title:
5657 type: string
5658 type:
5659 type: string
5660 uri:
5661 type: string
5662 format: uri
5663 uriBuilder:
5664 type: object
5665 uniqueItems: true
5666 location:
5667 type: string
5668 format: uri
5669 mediaType:
5670 type: object
5671 properties:
5672 parameters:
5673 type: object
5674 additionalProperties:
5675 type: string
5676 subtype:
5677 type: string
5678 type:
5679 type: string
5680 wildcardSubtype:
5681 type: boolean
5682 wildcardType:
5683 type: boolean
5684 metadata:
5685 type: object
5686 additionalProperties:
5687 type: array
5688 items:
5689 type: object
5690 status:
5691 type: integer
5692 format: int32
5693 statusInfo:
5694 type: object
5695 properties:
5696 family:
5697 type: string
5698 enum:
5699 - INFORMATIONAL
5700 - SUCCESSFUL
5701 - REDIRECTION
5702 - CLIENT_ERROR
5703 - SERVER_ERROR
5704 - OTHER
5705 reasonPhrase:
5706 type: string
5707 statusCode:
5708 type: integer
5709 format: int32
5710 stringHeaders:
5711 type: object
5712 additionalProperties:
5713 type: array
5714 items:
5715 type: string
5716 servers:
5717 - url: /sdc2/rest
5718 variables: {}
5719 summary: Returns created ArtifactDefinition
5720 tags:
5721 - SDCE-2 APIs
5722 /v1/catalog/resources/{resourceId}/artifacts/{artifactId}:
5723 delete:
5724 description: Delete Artifact
5725 operationId: deleteArtifact
5726 parameters:
5727 - in: path
5728 name: resourceId
5729 required: true
5730 schema:
5731 type: string
5732 - in: path
5733 name: artifactId
5734 required: true
5735 schema:
5736 type: string
5737 responses:
5738 "201":
5739 description: Resource created
5740 "400":
5741 description: Invalid content / Missing content
5742 "403":
5743 description: Restricted operation
5744 default:
5745 content:
5746 application/json:
5747 schema:
5748 type: array
5749 items:
5750 type: object
5751 properties:
5752 allowedMethods:
5753 type: array
5754 items:
5755 type: string
5756 uniqueItems: true
5757 cookies:
5758 type: object
5759 additionalProperties:
5760 type: object
5761 properties:
5762 comment:
5763 type: string
5764 domain:
5765 type: string
5766 expiry:
5767 type: string
5768 format: date-time
5769 httpOnly:
5770 type: boolean
5771 maxAge:
5772 type: integer
5773 format: int32
5774 name:
5775 type: string
5776 path:
5777 type: string
5778 secure:
5779 type: boolean
5780 value:
5781 type: string
5782 version:
5783 type: integer
5784 format: int32
5785 date:
5786 type: string
5787 format: date-time
5788 entity:
5789 type: object
5790 entityTag:
5791 type: object
5792 properties:
5793 value:
5794 type: string
5795 weak:
5796 type: boolean
5797 headers:
5798 type: object
5799 additionalProperties:
5800 type: array
5801 items:
5802 type: object
5803 language:
5804 type: object
5805 properties:
5806 country:
5807 type: string
5808 displayCountry:
5809 type: string
5810 displayLanguage:
5811 type: string
5812 displayName:
5813 type: string
5814 displayScript:
5815 type: string
5816 displayVariant:
5817 type: string
5818 extensionKeys:
5819 type: array
5820 items:
5821 type: string
5822 uniqueItems: true
5823 iso3Country:
5824 type: string
5825 iso3Language:
5826 type: string
5827 language:
5828 type: string
5829 script:
5830 type: string
5831 unicodeLocaleAttributes:
5832 type: array
5833 items:
5834 type: string
5835 uniqueItems: true
5836 unicodeLocaleKeys:
5837 type: array
5838 items:
5839 type: string
5840 uniqueItems: true
5841 variant:
5842 type: string
5843 lastModified:
5844 type: string
5845 format: date-time
5846 length:
5847 type: integer
5848 format: int32
5849 links:
5850 type: array
5851 items:
5852 type: object
5853 properties:
5854 params:
5855 type: object
5856 additionalProperties:
5857 type: string
5858 rel:
5859 type: string
5860 rels:
5861 type: array
5862 items:
5863 type: string
5864 title:
5865 type: string
5866 type:
5867 type: string
5868 uri:
5869 type: string
5870 format: uri
5871 uriBuilder:
5872 type: object
5873 uniqueItems: true
5874 location:
5875 type: string
5876 format: uri
5877 mediaType:
5878 type: object
5879 properties:
5880 parameters:
5881 type: object
5882 additionalProperties:
5883 type: string
5884 subtype:
5885 type: string
5886 type:
5887 type: string
5888 wildcardSubtype:
5889 type: boolean
5890 wildcardType:
5891 type: boolean
5892 metadata:
5893 type: object
5894 additionalProperties:
5895 type: array
5896 items:
5897 type: object
5898 status:
5899 type: integer
5900 format: int32
5901 statusInfo:
5902 type: object
5903 properties:
5904 family:
5905 type: string
5906 enum:
5907 - INFORMATIONAL
5908 - SUCCESSFUL
5909 - REDIRECTION
5910 - CLIENT_ERROR
5911 - SERVER_ERROR
5912 - OTHER
5913 reasonPhrase:
5914 type: string
5915 statusCode:
5916 type: integer
5917 format: int32
5918 stringHeaders:
5919 type: object
5920 additionalProperties:
5921 type: array
5922 items:
5923 type: string
5924 servers:
5925 - url: /sdc2/rest
5926 variables: {}
5927 summary: Returns delete artifact
5928 tags:
5929 - SDCE-2 APIs
5930 get:
5931 description: Download resource Artifact in Base64
5932 operationId: downloadResourceArtifactBase64
5933 parameters:
5934 - in: path
5935 name: resourceId
5936 required: true
5937 schema:
5938 type: string
5939 - in: path
5940 name: artifactId
5941 required: true
5942 schema:
5943 type: string
5944 responses:
5945 "200":
5946 description: Resource artifact downloaded
5947 "404":
5948 description: Resource/Artifact not found
5949 default:
5950 content:
5951 application/json:
5952 schema:
5953 type: array
5954 items:
5955 type: object
5956 properties:
5957 allowedMethods:
5958 type: array
5959 items:
5960 type: string
5961 uniqueItems: true
5962 cookies:
5963 type: object
5964 additionalProperties:
5965 type: object
5966 properties:
5967 comment:
5968 type: string
5969 domain:
5970 type: string
5971 expiry:
5972 type: string
5973 format: date-time
5974 httpOnly:
5975 type: boolean
5976 maxAge:
5977 type: integer
5978 format: int32
5979 name:
5980 type: string
5981 path:
5982 type: string
5983 secure:
5984 type: boolean
5985 value:
5986 type: string
5987 version:
5988 type: integer
5989 format: int32
5990 date:
5991 type: string
5992 format: date-time
5993 entity:
5994 type: object
5995 entityTag:
5996 type: object
5997 properties:
5998 value:
5999 type: string
6000 weak:
6001 type: boolean
6002 headers:
6003 type: object
6004 additionalProperties:
6005 type: array
6006 items:
6007 type: object
6008 language:
6009 type: object
6010 properties:
6011 country:
6012 type: string
6013 displayCountry:
6014 type: string
6015 displayLanguage:
6016 type: string
6017 displayName:
6018 type: string
6019 displayScript:
6020 type: string
6021 displayVariant:
6022 type: string
6023 extensionKeys:
6024 type: array
6025 items:
6026 type: string
6027 uniqueItems: true
6028 iso3Country:
6029 type: string
6030 iso3Language:
6031 type: string
6032 language:
6033 type: string
6034 script:
6035 type: string
6036 unicodeLocaleAttributes:
6037 type: array
6038 items:
6039 type: string
6040 uniqueItems: true
6041 unicodeLocaleKeys:
6042 type: array
6043 items:
6044 type: string
6045 uniqueItems: true
6046 variant:
6047 type: string
6048 lastModified:
6049 type: string
6050 format: date-time
6051 length:
6052 type: integer
6053 format: int32
6054 links:
6055 type: array
6056 items:
6057 type: object
6058 properties:
6059 params:
6060 type: object
6061 additionalProperties:
6062 type: string
6063 rel:
6064 type: string
6065 rels:
6066 type: array
6067 items:
6068 type: string
6069 title:
6070 type: string
6071 type:
6072 type: string
6073 uri:
6074 type: string
6075 format: uri
6076 uriBuilder:
6077 type: object
6078 uniqueItems: true
6079 location:
6080 type: string
6081 format: uri
6082 mediaType:
6083 type: object
6084 properties:
6085 parameters:
6086 type: object
6087 additionalProperties:
6088 type: string
6089 subtype:
6090 type: string
6091 type:
6092 type: string
6093 wildcardSubtype:
6094 type: boolean
6095 wildcardType:
6096 type: boolean
6097 metadata:
6098 type: object
6099 additionalProperties:
6100 type: array
6101 items:
6102 type: object
6103 status:
6104 type: integer
6105 format: int32
6106 statusInfo:
6107 type: object
6108 properties:
6109 family:
6110 type: string
6111 enum:
6112 - INFORMATIONAL
6113 - SUCCESSFUL
6114 - REDIRECTION
6115 - CLIENT_ERROR
6116 - SERVER_ERROR
6117 - OTHER
6118 reasonPhrase:
6119 type: string
6120 statusCode:
6121 type: integer
6122 format: int32
6123 stringHeaders:
6124 type: object
6125 additionalProperties:
6126 type: array
6127 items:
6128 type: string
6129 servers:
6130 - url: /sdc2/rest
6131 variables: {}
6132 summary: Returns downloaded artifact
6133 tags:
6134 - SDCE-2 APIs
6135 post:
6136 description: Update Artifact
6137 operationId: updateArtifact
6138 parameters:
6139 - in: path
6140 name: resourceId
6141 required: true
6142 schema:
6143 type: string
6144 - in: path
6145 name: artifactId
6146 required: true
6147 schema:
6148 type: string
6149 requestBody:
6150 content:
6151 application/json:
6152 schema:
6153 type: string
6154 description: json describe the artifact
6155 required: true
6156 responses:
6157 "201":
6158 description: Resource created
6159 "400":
6160 description: Invalid content / Missing content
6161 "403":
6162 description: Restricted operation
6163 default:
6164 content:
6165 application/json:
6166 schema:
6167 type: array
6168 items:
6169 type: object
6170 properties:
6171 allowedMethods:
6172 type: array
6173 items:
6174 type: string
6175 uniqueItems: true
6176 cookies:
6177 type: object
6178 additionalProperties:
6179 type: object
6180 properties:
6181 comment:
6182 type: string
6183 domain:
6184 type: string
6185 expiry:
6186 type: string
6187 format: date-time
6188 httpOnly:
6189 type: boolean
6190 maxAge:
6191 type: integer
6192 format: int32
6193 name:
6194 type: string
6195 path:
6196 type: string
6197 secure:
6198 type: boolean
6199 value:
6200 type: string
6201 version:
6202 type: integer
6203 format: int32
6204 date:
6205 type: string
6206 format: date-time
6207 entity:
6208 type: object
6209 entityTag:
6210 type: object
6211 properties:
6212 value:
6213 type: string
6214 weak:
6215 type: boolean
6216 headers:
6217 type: object
6218 additionalProperties:
6219 type: array
6220 items:
6221 type: object
6222 language:
6223 type: object
6224 properties:
6225 country:
6226 type: string
6227 displayCountry:
6228 type: string
6229 displayLanguage:
6230 type: string
6231 displayName:
6232 type: string
6233 displayScript:
6234 type: string
6235 displayVariant:
6236 type: string
6237 extensionKeys:
6238 type: array
6239 items:
6240 type: string
6241 uniqueItems: true
6242 iso3Country:
6243 type: string
6244 iso3Language:
6245 type: string
6246 language:
6247 type: string
6248 script:
6249 type: string
6250 unicodeLocaleAttributes:
6251 type: array
6252 items:
6253 type: string
6254 uniqueItems: true
6255 unicodeLocaleKeys:
6256 type: array
6257 items:
6258 type: string
6259 uniqueItems: true
6260 variant:
6261 type: string
6262 lastModified:
6263 type: string
6264 format: date-time
6265 length:
6266 type: integer
6267 format: int32
6268 links:
6269 type: array
6270 items:
6271 type: object
6272 properties:
6273 params:
6274 type: object
6275 additionalProperties:
6276 type: string
6277 rel:
6278 type: string
6279 rels:
6280 type: array
6281 items:
6282 type: string
6283 title:
6284 type: string
6285 type:
6286 type: string
6287 uri:
6288 type: string
6289 format: uri
6290 uriBuilder:
6291 type: object
6292 uniqueItems: true
6293 location:
6294 type: string
6295 format: uri
6296 mediaType:
6297 type: object
6298 properties:
6299 parameters:
6300 type: object
6301 additionalProperties:
6302 type: string
6303 subtype:
6304 type: string
6305 type:
6306 type: string
6307 wildcardSubtype:
6308 type: boolean
6309 wildcardType:
6310 type: boolean
6311 metadata:
6312 type: object
6313 additionalProperties:
6314 type: array
6315 items:
6316 type: object
6317 status:
6318 type: integer
6319 format: int32
6320 statusInfo:
6321 type: object
6322 properties:
6323 family:
6324 type: string
6325 enum:
6326 - INFORMATIONAL
6327 - SUCCESSFUL
6328 - REDIRECTION
6329 - CLIENT_ERROR
6330 - SERVER_ERROR
6331 - OTHER
6332 reasonPhrase:
6333 type: string
6334 statusCode:
6335 type: integer
6336 format: int32
6337 stringHeaders:
6338 type: object
6339 additionalProperties:
6340 type: array
6341 items:
6342 type: string
6343 servers:
6344 - url: /sdc2/rest
6345 variables: {}
6346 summary: Returns updated artifact
6347 tags:
6348 - SDCE-2 APIs
6349 /v1/catalog/resources/{resourceId}/attributes:
6350 get:
6351 description: Get Resource Attribute
6352 operationId: getAttributeListInResource
6353 parameters:
6354 - description: resource id of attribute
6355 in: path
6356 name: resourceId
6357 required: true
6358 schema:
6359 type: string
6360 - in: header
6361 name: USER_ID
6362 schema:
6363 type: string
6364 responses:
6365 "200":
6366 description: attribute
6367 "400":
6368 description: Invalid content / Missing content
6369 "403":
6370 description: Restricted operation
6371 "404":
6372 description: Resource attribute not found
6373 default:
6374 content:
6375 application/json:
6376 schema:
6377 type: array
6378 items:
6379 type: object
6380 properties:
6381 allowedMethods:
6382 type: array
6383 items:
6384 type: string
6385 uniqueItems: true
6386 cookies:
6387 type: object
6388 additionalProperties:
6389 type: object
6390 properties:
6391 comment:
6392 type: string
6393 domain:
6394 type: string
6395 expiry:
6396 type: string
6397 format: date-time
6398 httpOnly:
6399 type: boolean
6400 maxAge:
6401 type: integer
6402 format: int32
6403 name:
6404 type: string
6405 path:
6406 type: string
6407 secure:
6408 type: boolean
6409 value:
6410 type: string
6411 version:
6412 type: integer
6413 format: int32
6414 date:
6415 type: string
6416 format: date-time
6417 entity:
6418 type: object
6419 entityTag:
6420 type: object
6421 properties:
6422 value:
6423 type: string
6424 weak:
6425 type: boolean
6426 headers:
6427 type: object
6428 additionalProperties:
6429 type: array
6430 items:
6431 type: object
6432 language:
6433 type: object
6434 properties:
6435 country:
6436 type: string
6437 displayCountry:
6438 type: string
6439 displayLanguage:
6440 type: string
6441 displayName:
6442 type: string
6443 displayScript:
6444 type: string
6445 displayVariant:
6446 type: string
6447 extensionKeys:
6448 type: array
6449 items:
6450 type: string
6451 uniqueItems: true
6452 iso3Country:
6453 type: string
6454 iso3Language:
6455 type: string
6456 language:
6457 type: string
6458 script:
6459 type: string
6460 unicodeLocaleAttributes:
6461 type: array
6462 items:
6463 type: string
6464 uniqueItems: true
6465 unicodeLocaleKeys:
6466 type: array
6467 items:
6468 type: string
6469 uniqueItems: true
6470 variant:
6471 type: string
6472 lastModified:
6473 type: string
6474 format: date-time
6475 length:
6476 type: integer
6477 format: int32
6478 links:
6479 type: array
6480 items:
6481 type: object
6482 properties:
6483 params:
6484 type: object
6485 additionalProperties:
6486 type: string
6487 rel:
6488 type: string
6489 rels:
6490 type: array
6491 items:
6492 type: string
6493 title:
6494 type: string
6495 type:
6496 type: string
6497 uri:
6498 type: string
6499 format: uri
6500 uriBuilder:
6501 type: object
6502 uniqueItems: true
6503 location:
6504 type: string
6505 format: uri
6506 mediaType:
6507 type: object
6508 properties:
6509 parameters:
6510 type: object
6511 additionalProperties:
6512 type: string
6513 subtype:
6514 type: string
6515 type:
6516 type: string
6517 wildcardSubtype:
6518 type: boolean
6519 wildcardType:
6520 type: boolean
6521 metadata:
6522 type: object
6523 additionalProperties:
6524 type: array
6525 items:
6526 type: object
6527 status:
6528 type: integer
6529 format: int32
6530 statusInfo:
6531 type: object
6532 properties:
6533 family:
6534 type: string
6535 enum:
6536 - INFORMATIONAL
6537 - SUCCESSFUL
6538 - REDIRECTION
6539 - CLIENT_ERROR
6540 - SERVER_ERROR
6541 - OTHER
6542 reasonPhrase:
6543 type: string
6544 statusCode:
6545 type: integer
6546 format: int32
6547 stringHeaders:
6548 type: object
6549 additionalProperties:
6550 type: array
6551 items:
6552 type: string
6553 servers:
6554 - url: /sdc2/rest
6555 variables: {}
6556 summary: Returns attribute list of resource
6557 tags:
6558 - SDCE-2 APIs
6559 post:
6560 description: Create Resource Attribute
6561 operationId: createAttribute
6562 parameters:
6563 - description: resource id to update with new attribute
6564 in: path
6565 name: resourceId
6566 required: true
6567 schema:
6568 type: string
6569 - in: header
6570 name: USER_ID
6571 schema:
6572 type: string
6573 requestBody:
6574 content:
6575 application/json:
6576 schema:
6577 type: string
6578 description: Resource attribute to be created
6579 required: true
6580 responses:
6581 "201":
6582 description: Resource property created
6583 "400":
6584 description: Invalid content / Missing content
6585 "403":
6586 description: Restricted operation
6587 "409":
6588 description: Resource attribute already exist
6589 default:
6590 content:
6591 application/json:
6592 schema:
6593 type: array
6594 items:
6595 type: object
6596 properties:
6597 allowedMethods:
6598 type: array
6599 items:
6600 type: string
6601 uniqueItems: true
6602 cookies:
6603 type: object
6604 additionalProperties:
6605 type: object
6606 properties:
6607 comment:
6608 type: string
6609 domain:
6610 type: string
6611 expiry:
6612 type: string
6613 format: date-time
6614 httpOnly:
6615 type: boolean
6616 maxAge:
6617 type: integer
6618 format: int32
6619 name:
6620 type: string
6621 path:
6622 type: string
6623 secure:
6624 type: boolean
6625 value:
6626 type: string
6627 version:
6628 type: integer
6629 format: int32
6630 date:
6631 type: string
6632 format: date-time
6633 entity:
6634 type: object
6635 entityTag:
6636 type: object
6637 properties:
6638 value:
6639 type: string
6640 weak:
6641 type: boolean
6642 headers:
6643 type: object
6644 additionalProperties:
6645 type: array
6646 items:
6647 type: object
6648 language:
6649 type: object
6650 properties:
6651 country:
6652 type: string
6653 displayCountry:
6654 type: string
6655 displayLanguage:
6656 type: string
6657 displayName:
6658 type: string
6659 displayScript:
6660 type: string
6661 displayVariant:
6662 type: string
6663 extensionKeys:
6664 type: array
6665 items:
6666 type: string
6667 uniqueItems: true
6668 iso3Country:
6669 type: string
6670 iso3Language:
6671 type: string
6672 language:
6673 type: string
6674 script:
6675 type: string
6676 unicodeLocaleAttributes:
6677 type: array
6678 items:
6679 type: string
6680 uniqueItems: true
6681 unicodeLocaleKeys:
6682 type: array
6683 items:
6684 type: string
6685 uniqueItems: true
6686 variant:
6687 type: string
6688 lastModified:
6689 type: string
6690 format: date-time
6691 length:
6692 type: integer
6693 format: int32
6694 links:
6695 type: array
6696 items:
6697 type: object
6698 properties:
6699 params:
6700 type: object
6701 additionalProperties:
6702 type: string
6703 rel:
6704 type: string
6705 rels:
6706 type: array
6707 items:
6708 type: string
6709 title:
6710 type: string
6711 type:
6712 type: string
6713 uri:
6714 type: string
6715 format: uri
6716 uriBuilder:
6717 type: object
6718 uniqueItems: true
6719 location:
6720 type: string
6721 format: uri
6722 mediaType:
6723 type: object
6724 properties:
6725 parameters:
6726 type: object
6727 additionalProperties:
6728 type: string
6729 subtype:
6730 type: string
6731 type:
6732 type: string
6733 wildcardSubtype:
6734 type: boolean
6735 wildcardType:
6736 type: boolean
6737 metadata:
6738 type: object
6739 additionalProperties:
6740 type: array
6741 items:
6742 type: object
6743 status:
6744 type: integer
6745 format: int32
6746 statusInfo:
6747 type: object
6748 properties:
6749 family:
6750 type: string
6751 enum:
6752 - INFORMATIONAL
6753 - SUCCESSFUL
6754 - REDIRECTION
6755 - CLIENT_ERROR
6756 - SERVER_ERROR
6757 - OTHER
6758 reasonPhrase:
6759 type: string
6760 statusCode:
6761 type: integer
6762 format: int32
6763 stringHeaders:
6764 type: object
6765 additionalProperties:
6766 type: array
6767 items:
6768 type: string
6769 servers:
6770 - url: /sdc2/rest
6771 variables: {}
6772 summary: Returns created resource attribute
6773 tags:
6774 - SDCE-2 APIs
6775 /v1/catalog/resources/{resourceId}/attributes/{attributeId}:
6776 delete:
6777 description: Create Resource Attribute
6778 operationId: deleteAttribute
6779 parameters:
6780 - description: resource id of attribute
6781 in: path
6782 name: resourceId
6783 required: true
6784 schema:
6785 type: string
6786 - description: Attribute id to delete
6787 in: path
6788 name: attributeId
6789 required: true
6790 schema:
6791 type: string
6792 - in: header
6793 name: USER_ID
6794 schema:
6795 type: string
6796 responses:
6797 "204":
6798 description: deleted attribute
6799 "400":
6800 description: Invalid content / Missing content
6801 "403":
6802 description: Restricted operation
6803 "404":
6804 description: Resource property not found
6805 default:
6806 content:
6807 application/json:
6808 schema:
6809 type: array
6810 items:
6811 type: object
6812 properties:
6813 allowedMethods:
6814 type: array
6815 items:
6816 type: string
6817 uniqueItems: true
6818 cookies:
6819 type: object
6820 additionalProperties:
6821 type: object
6822 properties:
6823 comment:
6824 type: string
6825 domain:
6826 type: string
6827 expiry:
6828 type: string
6829 format: date-time
6830 httpOnly:
6831 type: boolean
6832 maxAge:
6833 type: integer
6834 format: int32
6835 name:
6836 type: string
6837 path:
6838 type: string
6839 secure:
6840 type: boolean
6841 value:
6842 type: string
6843 version:
6844 type: integer
6845 format: int32
6846 date:
6847 type: string
6848 format: date-time
6849 entity:
6850 type: object
6851 entityTag:
6852 type: object
6853 properties:
6854 value:
6855 type: string
6856 weak:
6857 type: boolean
6858 headers:
6859 type: object
6860 additionalProperties:
6861 type: array
6862 items:
6863 type: object
6864 language:
6865 type: object
6866 properties:
6867 country:
6868 type: string
6869 displayCountry:
6870 type: string
6871 displayLanguage:
6872 type: string
6873 displayName:
6874 type: string
6875 displayScript:
6876 type: string
6877 displayVariant:
6878 type: string
6879 extensionKeys:
6880 type: array
6881 items:
6882 type: string
6883 uniqueItems: true
6884 iso3Country:
6885 type: string
6886 iso3Language:
6887 type: string
6888 language:
6889 type: string
6890 script:
6891 type: string
6892 unicodeLocaleAttributes:
6893 type: array
6894 items:
6895 type: string
6896 uniqueItems: true
6897 unicodeLocaleKeys:
6898 type: array
6899 items:
6900 type: string
6901 uniqueItems: true
6902 variant:
6903 type: string
6904 lastModified:
6905 type: string
6906 format: date-time
6907 length:
6908 type: integer
6909 format: int32
6910 links:
6911 type: array
6912 items:
6913 type: object
6914 properties:
6915 params:
6916 type: object
6917 additionalProperties:
6918 type: string
6919 rel:
6920 type: string
6921 rels:
6922 type: array
6923 items:
6924 type: string
6925 title:
6926 type: string
6927 type:
6928 type: string
6929 uri:
6930 type: string
6931 format: uri
6932 uriBuilder:
6933 type: object
6934 uniqueItems: true
6935 location:
6936 type: string
6937 format: uri
6938 mediaType:
6939 type: object
6940 properties:
6941 parameters:
6942 type: object
6943 additionalProperties:
6944 type: string
6945 subtype:
6946 type: string
6947 type:
6948 type: string
6949 wildcardSubtype:
6950 type: boolean
6951 wildcardType:
6952 type: boolean
6953 metadata:
6954 type: object
6955 additionalProperties:
6956 type: array
6957 items:
6958 type: object
6959 status:
6960 type: integer
6961 format: int32
6962 statusInfo:
6963 type: object
6964 properties:
6965 family:
6966 type: string
6967 enum:
6968 - INFORMATIONAL
6969 - SUCCESSFUL
6970 - REDIRECTION
6971 - CLIENT_ERROR
6972 - SERVER_ERROR
6973 - OTHER
6974 reasonPhrase:
6975 type: string
6976 statusCode:
6977 type: integer
6978 format: int32
6979 stringHeaders:
6980 type: object
6981 additionalProperties:
6982 type: array
6983 items:
6984 type: string
6985 servers:
6986 - url: /sdc2/rest
6987 variables: {}
6988 summary: Returns deleted attribute
6989 tags:
6990 - SDCE-2 APIs
6991 put:
6992 description: Update Resource Attribute
6993 operationId: updateAttribute
6994 parameters:
6995 - description: resource id to update with new attribute
6996 in: path
6997 name: resourceId
6998 required: true
6999 schema:
7000 type: string
7001 - description: attribute id to update
7002 in: path
7003 name: attributeId
7004 required: true
7005 schema:
7006 type: string
7007 - in: header
7008 name: USER_ID
7009 schema:
7010 type: string
7011 requestBody:
7012 content:
7013 application/json:
7014 schema:
7015 type: string
7016 description: Resource attribute to update
7017 required: true
7018 responses:
7019 "200":
7020 description: Resource attribute updated
7021 "400":
7022 description: Invalid content / Missing content
7023 "403":
7024 description: Restricted operation
7025 default:
7026 content:
7027 application/json:
7028 schema:
7029 type: array
7030 items:
7031 type: object
7032 properties:
7033 allowedMethods:
7034 type: array
7035 items:
7036 type: string
7037 uniqueItems: true
7038 cookies:
7039 type: object
7040 additionalProperties:
7041 type: object
7042 properties:
7043 comment:
7044 type: string
7045 domain:
7046 type: string
7047 expiry:
7048 type: string
7049 format: date-time
7050 httpOnly:
7051 type: boolean
7052 maxAge:
7053 type: integer
7054 format: int32
7055 name:
7056 type: string
7057 path:
7058 type: string
7059 secure:
7060 type: boolean
7061 value:
7062 type: string
7063 version:
7064 type: integer
7065 format: int32
7066 date:
7067 type: string
7068 format: date-time
7069 entity:
7070 type: object
7071 entityTag:
7072 type: object
7073 properties:
7074 value:
7075 type: string
7076 weak:
7077 type: boolean
7078 headers:
7079 type: object
7080 additionalProperties:
7081 type: array
7082 items:
7083 type: object
7084 language:
7085 type: object
7086 properties:
7087 country:
7088 type: string
7089 displayCountry:
7090 type: string
7091 displayLanguage:
7092 type: string
7093 displayName:
7094 type: string
7095 displayScript:
7096 type: string
7097 displayVariant:
7098 type: string
7099 extensionKeys:
7100 type: array
7101 items:
7102 type: string
7103 uniqueItems: true
7104 iso3Country:
7105 type: string
7106 iso3Language:
7107 type: string
7108 language:
7109 type: string
7110 script:
7111 type: string
7112 unicodeLocaleAttributes:
7113 type: array
7114 items:
7115 type: string
7116 uniqueItems: true
7117 unicodeLocaleKeys:
7118 type: array
7119 items:
7120 type: string
7121 uniqueItems: true
7122 variant:
7123 type: string
7124 lastModified:
7125 type: string
7126 format: date-time
7127 length:
7128 type: integer
7129 format: int32
7130 links:
7131 type: array
7132 items:
7133 type: object
7134 properties:
7135 params:
7136 type: object
7137 additionalProperties:
7138 type: string
7139 rel:
7140 type: string
7141 rels:
7142 type: array
7143 items:
7144 type: string
7145 title:
7146 type: string
7147 type:
7148 type: string
7149 uri:
7150 type: string
7151 format: uri
7152 uriBuilder:
7153 type: object
7154 uniqueItems: true
7155 location:
7156 type: string
7157 format: uri
7158 mediaType:
7159 type: object
7160 properties:
7161 parameters:
7162 type: object
7163 additionalProperties:
7164 type: string
7165 subtype:
7166 type: string
7167 type:
7168 type: string
7169 wildcardSubtype:
7170 type: boolean
7171 wildcardType:
7172 type: boolean
7173 metadata:
7174 type: object
7175 additionalProperties:
7176 type: array
7177 items:
7178 type: object
7179 status:
7180 type: integer
7181 format: int32
7182 statusInfo:
7183 type: object
7184 properties:
7185 family:
7186 type: string
7187 enum:
7188 - INFORMATIONAL
7189 - SUCCESSFUL
7190 - REDIRECTION
7191 - CLIENT_ERROR
7192 - SERVER_ERROR
7193 - OTHER
7194 reasonPhrase:
7195 type: string
7196 statusCode:
7197 type: integer
7198 format: int32
7199 stringHeaders:
7200 type: object
7201 additionalProperties:
7202 type: array
7203 items:
7204 type: string
7205 servers:
7206 - url: /sdc2/rest
7207 variables: {}
7208 summary: Returns updated attribute
7209 tags:
7210 - SDCE-2 APIs
7211 /v1/catalog/resources/{resourceId}/capabilities:
7212 post:
7213 description: Create Capabilities on resource
7214 operationId: createCapabilitiesOnResource
7215 parameters:
7216 - description: Resource Id
7217 in: path
7218 name: resourceId
7219 required: true
7220 schema:
7221 type: string
7222 - in: header
7223 name: USER_ID
7224 schema:
7225 type: string
7226 requestBody:
7227 content:
7228 application/json:
7229 schema:
7230 type: string
7231 description: Capability to create
7232 required: true
7233 responses:
7234 "201":
7235 description: Create Capabilities
7236 "400":
7237 description: Invalid content / Missing content
7238 "403":
7239 description: Restricted operation
7240 "409":
7241 description: Capability already exist
7242 default:
7243 content:
7244 application/json:
7245 schema:
7246 type: array
7247 items:
7248 type: object
7249 properties:
7250 allowedMethods:
7251 type: array
7252 items:
7253 type: string
7254 uniqueItems: true
7255 cookies:
7256 type: object
7257 additionalProperties:
7258 type: object
7259 properties:
7260 comment:
7261 type: string
7262 domain:
7263 type: string
7264 expiry:
7265 type: string
7266 format: date-time
7267 httpOnly:
7268 type: boolean
7269 maxAge:
7270 type: integer
7271 format: int32
7272 name:
7273 type: string
7274 path:
7275 type: string
7276 secure:
7277 type: boolean
7278 value:
7279 type: string
7280 version:
7281 type: integer
7282 format: int32
7283 date:
7284 type: string
7285 format: date-time
7286 entity:
7287 type: object
7288 entityTag:
7289 type: object
7290 properties:
7291 value:
7292 type: string
7293 weak:
7294 type: boolean
7295 headers:
7296 type: object
7297 additionalProperties:
7298 type: array
7299 items:
7300 type: object
7301 language:
7302 type: object
7303 properties:
7304 country:
7305 type: string
7306 displayCountry:
7307 type: string
7308 displayLanguage:
7309 type: string
7310 displayName:
7311 type: string
7312 displayScript:
7313 type: string
7314 displayVariant:
7315 type: string
7316 extensionKeys:
7317 type: array
7318 items:
7319 type: string
7320 uniqueItems: true
7321 iso3Country:
7322 type: string
7323 iso3Language:
7324 type: string
7325 language:
7326 type: string
7327 script:
7328 type: string
7329 unicodeLocaleAttributes:
7330 type: array
7331 items:
7332 type: string
7333 uniqueItems: true
7334 unicodeLocaleKeys:
7335 type: array
7336 items:
7337 type: string
7338 uniqueItems: true
7339 variant:
7340 type: string
7341 lastModified:
7342 type: string
7343 format: date-time
7344 length:
7345 type: integer
7346 format: int32
7347 links:
7348 type: array
7349 items:
7350 type: object
7351 properties:
7352 params:
7353 type: object
7354 additionalProperties:
7355 type: string
7356 rel:
7357 type: string
7358 rels:
7359 type: array
7360 items:
7361 type: string
7362 title:
7363 type: string
7364 type:
7365 type: string
7366 uri:
7367 type: string
7368 format: uri
7369 uriBuilder:
7370 type: object
7371 uniqueItems: true
7372 location:
7373 type: string
7374 format: uri
7375 mediaType:
7376 type: object
7377 properties:
7378 parameters:
7379 type: object
7380 additionalProperties:
7381 type: string
7382 subtype:
7383 type: string
7384 type:
7385 type: string
7386 wildcardSubtype:
7387 type: boolean
7388 wildcardType:
7389 type: boolean
7390 metadata:
7391 type: object
7392 additionalProperties:
7393 type: array
7394 items:
7395 type: object
7396 status:
7397 type: integer
7398 format: int32
7399 statusInfo:
7400 type: object
7401 properties:
7402 family:
7403 type: string
7404 enum:
7405 - INFORMATIONAL
7406 - SUCCESSFUL
7407 - REDIRECTION
7408 - CLIENT_ERROR
7409 - SERVER_ERROR
7410 - OTHER
7411 reasonPhrase:
7412 type: string
7413 statusCode:
7414 type: integer
7415 format: int32
7416 stringHeaders:
7417 type: object
7418 additionalProperties:
7419 type: array
7420 items:
7421 type: string
7422 servers:
7423 - url: /sdc2/rest
7424 variables: {}
7425 summary: Create Capabilities on resource
7426 tags:
7427 - SDCE-2 APIs
7428 put:
7429 description: Update Capabilities on resource
7430 operationId: updateCapabilitiesOnResource
7431 parameters:
7432 - description: Component Id
7433 in: path
7434 name: resourceId
7435 required: true
7436 schema:
7437 type: string
7438 - in: header
7439 name: USER_ID
7440 schema:
7441 type: string
7442 requestBody:
7443 content:
7444 application/json:
7445 schema:
7446 type: string
7447 description: Capabilities to update
7448 required: true
7449 responses:
7450 "201":
7451 description: Update Capabilities
7452 "400":
7453 description: Invalid content / Missing content
7454 "403":
7455 description: Restricted operation
7456 default:
7457 content:
7458 application/json:
7459 schema:
7460 type: array
7461 items:
7462 $ref: '#/components/schemas/CapabilityDefinition'
7463 servers:
7464 - url: /sdc2/rest
7465 variables: {}
7466 summary: Update Capabilities on resource
7467 tags:
7468 - SDCE-2 APIs
7469 /v1/catalog/resources/{resourceId}/capabilities/{capabilityId}:
7470 delete:
7471 description: Delete capability from resource
7472 operationId: deleteCapabilityOnResource
7473 parameters:
7474 - description: capability Id
7475 in: path
7476 name: capabilityId
7477 required: true
7478 schema:
7479 type: string
7480 - description: Resource Id
7481 in: path
7482 name: resourceId
7483 required: true
7484 schema:
7485 type: string
7486 - in: header
7487 name: USER_ID
7488 schema:
7489 type: string
7490 responses:
7491 "201":
7492 description: Delete capability
7493 "400":
7494 description: Invalid content / Missing content
7495 "403":
7496 description: Restricted operation
7497 default:
7498 content:
7499 application/json:
7500 schema:
7501 type: array
7502 items:
7503 $ref: '#/components/schemas/CapabilityDefinition'
7504 servers:
7505 - url: /sdc2/rest
7506 variables: {}
7507 summary: Delete capability from resource
7508 tags:
7509 - SDCE-2 APIs
7510 get:
7511 description: Get Capability from resource
7512 operationId: getCapabilityOnResource
7513 parameters:
7514 - description: Resource Id
7515 in: path
7516 name: resourceId
7517 required: true
7518 schema:
7519 type: string
7520 - description: Capability Id
7521 in: path
7522 name: capabilityId
7523 required: true
7524 schema:
7525 type: string
7526 - in: header
7527 name: USER_ID
7528 schema:
7529 type: string
7530 responses:
7531 "201":
7532 description: GET Capability
7533 "400":
7534 description: Invalid content / Missing content
7535 "403":
7536 description: Restricted operation
7537 default:
7538 content:
7539 application/json:
7540 schema:
7541 type: array
7542 items:
7543 $ref: '#/components/schemas/CapabilityDefinition'
7544 servers:
7545 - url: /sdc2/rest
7546 variables: {}
7547 summary: GET Capability from resource
7548 tags:
7549 - SDCE-2 APIs
7550 /v1/catalog/resources/{resourceId}/interfaceOperations:
7551 post:
7552 description: Create Interface Operations on Resource
7553 operationId: createInterfaceOperationsOnResource
7554 parameters:
7555 - description: Resource Id
7556 in: path
7557 name: resourceId
7558 required: true
7559 schema:
7560 type: string
7561 - in: header
7562 name: USER_ID
7563 schema:
7564 type: string
7565 requestBody:
7566 content:
7567 application/json:
7568 schema:
7569 type: string
7570 description: Interface Operations to create
7571 required: true
7572 responses:
7573 "201":
7574 description: Create Interface Operations on Resource
7575 "400":
7576 description: Invalid content / Missing content
7577 "403":
7578 description: Restricted operation
7579 "404":
7580 description: Resource not found
7581 "409":
7582 description: Interface Operation already exist
7583 default:
7584 content:
7585 application/json:
7586 schema:
7587 type: array
7588 items:
7589 $ref: '#/components/schemas/InterfaceDefinition'
7590 servers:
7591 - url: /sdc2/rest
7592 variables: {}
7593 summary: Create Interface Operations on Resource
7594 tags:
7595 - SDCE-2 APIs
7596 put:
7597 description: Update Interface Operations on Resource
7598 operationId: updateInterfaceOperationsOnResource
7599 parameters:
7600 - description: Resource Id
7601 in: path
7602 name: resourceId
7603 required: true
7604 schema:
7605 type: string
7606 - in: header
7607 name: USER_ID
7608 schema:
7609 type: string
7610 requestBody:
7611 content:
7612 application/json:
7613 schema:
7614 type: string
7615 description: Interface Operations to update
7616 required: true
7617 responses:
7618 "201":
7619 description: Update Interface Operations on Resource
7620 "400":
7621 description: Invalid content / Missing content
7622 "403":
7623 description: Restricted operation
7624 "404":
7625 description: Resource not found
7626 default:
7627 content:
7628 application/json:
7629 schema:
7630 type: array
7631 items:
7632 $ref: '#/components/schemas/InterfaceDefinition'
7633 servers:
7634 - url: /sdc2/rest
7635 variables: {}
7636 summary: Update Interface Operations on Resource
7637 tags:
7638 - SDCE-2 APIs
7639 /v1/catalog/resources/{resourceId}/interfaces/{interfaceId}/operations/{operationId}:
7640 delete:
7641 description: Delete Interface Operation from Resource
7642 operationId: deleteInterfaceOperationsFromResource
7643 parameters:
7644 - description: Resource Id
7645 in: path
7646 name: resourceId
7647 required: true
7648 schema:
7649 type: string
7650 - description: Interface Id
7651 in: path
7652 name: interfaceId
7653 required: true
7654 schema:
7655 type: string
7656 - description: Operation Id
7657 in: path
7658 name: operationId
7659 required: true
7660 schema:
7661 type: string
7662 - in: header
7663 name: USER_ID
7664 schema:
7665 type: string
7666 responses:
7667 "201":
7668 description: Delete Interface Operation from Resource
7669 "400":
7670 description: Invalid content / Missing content
7671 "403":
7672 description: Restricted operation
7673 "404":
7674 description: Resource not found
7675 default:
7676 content:
7677 application/json:
7678 schema:
7679 type: array
7680 items:
7681 $ref: '#/components/schemas/InterfaceDefinition'
7682 servers:
7683 - url: /sdc2/rest
7684 variables: {}
7685 summary: Delete Interface Operation from Resource
7686 tags:
7687 - SDCE-2 APIs
7688 get:
7689 description: Get Interface Operation from Resource
7690 operationId: getInterfaceOperationsFromResource
7691 parameters:
7692 - description: Resource Id
7693 in: path
7694 name: resourceId
7695 required: true
7696 schema:
7697 type: string
7698 - description: Interface Id
7699 in: path
7700 name: interfaceId
7701 required: true
7702 schema:
7703 type: string
7704 - description: Operation Id
7705 in: path
7706 name: operationId
7707 required: true
7708 schema:
7709 type: string
7710 - in: header
7711 name: USER_ID
7712 schema:
7713 type: string
7714 responses:
7715 "201":
7716 description: Delete Interface Operation from Resource
7717 "400":
7718 description: Invalid content / Missing content
7719 "403":
7720 description: Restricted operation
7721 "404":
7722 description: Resource not found
7723 default:
7724 content:
7725 application/json:
7726 schema:
7727 type: array
7728 items:
7729 $ref: '#/components/schemas/InterfaceDefinition'
7730 servers:
7731 - url: /sdc2/rest
7732 variables: {}
7733 summary: GET Interface Operation from Resource
7734 tags:
7735 - SDCE-2 APIs
7736 /v1/catalog/resources/{resourceId}/metadata:
7737 put:
7738 description: Update Resource Metadata
7739 operationId: updateResourceMetadata
7740 parameters:
7741 - in: path
7742 name: resourceId
7743 required: true
7744 schema:
7745 type: string
7746 - in: header
7747 name: USER_ID
7748 schema:
7749 type: string
7750 requestBody:
7751 content:
7752 application/json:
7753 schema:
7754 type: string
7755 description: Resource metadata to be updated
7756 required: true
7757 responses:
7758 "200":
7759 description: Resource metadata updated
7760 "400":
7761 description: Invalid content
7762 "403":
7763 description: Restricted operation
7764 default:
7765 content:
7766 application/json:
7767 schema:
7768 type: array
7769 items:
7770 $ref: '#/components/schemas/Resource'
7771 servers:
7772 - url: /sdc2/rest
7773 variables: {}
7774 summary: Returns updated resource metadata
7775 tags:
7776 - SDCE-2 APIs
7777 /v1/catalog/resources/{resourceId}/properties:
7778 get:
7779 description: Get Resource Property
7780 operationId: getPropertyListInResource
7781 parameters:
7782 - description: resource id of property
7783 in: path
7784 name: resourceId
7785 required: true
7786 schema:
7787 type: string
7788 - in: header
7789 name: USER_ID
7790 schema:
7791 type: string
7792 responses:
7793 "200":
7794 description: property
7795 "400":
7796 description: Invalid content / Missing content
7797 "403":
7798 description: Restricted operation
7799 "404":
7800 description: Resource property not found
7801 default:
7802 content:
7803 application/json:
7804 schema:
7805 type: array
7806 items:
7807 type: object
7808 properties:
7809 allowedMethods:
7810 type: array
7811 items:
7812 type: string
7813 uniqueItems: true
7814 cookies:
7815 type: object
7816 additionalProperties:
7817 type: object
7818 properties:
7819 comment:
7820 type: string
7821 domain:
7822 type: string
7823 expiry:
7824 type: string
7825 format: date-time
7826 httpOnly:
7827 type: boolean
7828 maxAge:
7829 type: integer
7830 format: int32
7831 name:
7832 type: string
7833 path:
7834 type: string
7835 secure:
7836 type: boolean
7837 value:
7838 type: string
7839 version:
7840 type: integer
7841 format: int32
7842 date:
7843 type: string
7844 format: date-time
7845 entity:
7846 type: object
7847 entityTag:
7848 type: object
7849 properties:
7850 value:
7851 type: string
7852 weak:
7853 type: boolean
7854 headers:
7855 type: object
7856 additionalProperties:
7857 type: array
7858 items:
7859 type: object
7860 language:
7861 type: object
7862 properties:
7863 country:
7864 type: string
7865 displayCountry:
7866 type: string
7867 displayLanguage:
7868 type: string
7869 displayName:
7870 type: string
7871 displayScript:
7872 type: string
7873 displayVariant:
7874 type: string
7875 extensionKeys:
7876 type: array
7877 items:
7878 type: string
7879 uniqueItems: true
7880 iso3Country:
7881 type: string
7882 iso3Language:
7883 type: string
7884 language:
7885 type: string
7886 script:
7887 type: string
7888 unicodeLocaleAttributes:
7889 type: array
7890 items:
7891 type: string
7892 uniqueItems: true
7893 unicodeLocaleKeys:
7894 type: array
7895 items:
7896 type: string
7897 uniqueItems: true
7898 variant:
7899 type: string
7900 lastModified:
7901 type: string
7902 format: date-time
7903 length:
7904 type: integer
7905 format: int32
7906 links:
7907 type: array
7908 items:
7909 type: object
7910 properties:
7911 params:
7912 type: object
7913 additionalProperties:
7914 type: string
7915 rel:
7916 type: string
7917 rels:
7918 type: array
7919 items:
7920 type: string
7921 title:
7922 type: string
7923 type:
7924 type: string
7925 uri:
7926 type: string
7927 format: uri
7928 uriBuilder:
7929 type: object
7930 uniqueItems: true
7931 location:
7932 type: string
7933 format: uri
7934 mediaType:
7935 type: object
7936 properties:
7937 parameters:
7938 type: object
7939 additionalProperties:
7940 type: string
7941 subtype:
7942 type: string
7943 type:
7944 type: string
7945 wildcardSubtype:
7946 type: boolean
7947 wildcardType:
7948 type: boolean
7949 metadata:
7950 type: object
7951 additionalProperties:
7952 type: array
7953 items:
7954 type: object
7955 status:
7956 type: integer
7957 format: int32
7958 statusInfo:
7959 type: object
7960 properties:
7961 family:
7962 type: string
7963 enum:
7964 - INFORMATIONAL
7965 - SUCCESSFUL
7966 - REDIRECTION
7967 - CLIENT_ERROR
7968 - SERVER_ERROR
7969 - OTHER
7970 reasonPhrase:
7971 type: string
7972 statusCode:
7973 type: integer
7974 format: int32
7975 stringHeaders:
7976 type: object
7977 additionalProperties:
7978 type: array
7979 items:
7980 type: string
7981 servers:
7982 - url: /sdc2/rest
7983 variables: {}
7984 summary: Returns property list of resource
7985 tags:
7986 - SDCE-2 APIs
7987 post:
7988 description: Create Resource Property
7989 operationId: createPropertyInResource
7990 parameters:
7991 - description: Resource id to update with new property
7992 in: path
7993 name: resourceId
7994 required: true
7995 schema:
7996 type: string
7997 - in: header
7998 name: USER_ID
7999 schema:
8000 type: string
8001 requestBody:
8002 content:
8003 application/json:
8004 schema:
8005 type: string
8006 description: Resource property to be created
8007 required: true
8008 responses:
8009 "201":
8010 description: Resource property created
8011 "400":
8012 description: Invalid content / Missing content
8013 "403":
8014 description: Restricted operation
8015 "409":
8016 description: Resource property already exist
8017 default:
8018 content:
8019 application/json:
8020 schema:
8021 type: array
8022 items:
8023 type: object
8024 properties:
8025 allowedMethods:
8026 type: array
8027 items:
8028 type: string
8029 uniqueItems: true
8030 cookies:
8031 type: object
8032 additionalProperties:
8033 type: object
8034 properties:
8035 comment:
8036 type: string
8037 domain:
8038 type: string
8039 expiry:
8040 type: string
8041 format: date-time
8042 httpOnly:
8043 type: boolean
8044 maxAge:
8045 type: integer
8046 format: int32
8047 name:
8048 type: string
8049 path:
8050 type: string
8051 secure:
8052 type: boolean
8053 value:
8054 type: string
8055 version:
8056 type: integer
8057 format: int32
8058 date:
8059 type: string
8060 format: date-time
8061 entity:
8062 type: object
8063 entityTag:
8064 type: object
8065 properties:
8066 value:
8067 type: string
8068 weak:
8069 type: boolean
8070 headers:
8071 type: object
8072 additionalProperties:
8073 type: array
8074 items:
8075 type: object
8076 language:
8077 type: object
8078 properties:
8079 country:
8080 type: string
8081 displayCountry:
8082 type: string
8083 displayLanguage:
8084 type: string
8085 displayName:
8086 type: string
8087 displayScript:
8088 type: string
8089 displayVariant:
8090 type: string
8091 extensionKeys:
8092 type: array
8093 items:
8094 type: string
8095 uniqueItems: true
8096 iso3Country:
8097 type: string
8098 iso3Language:
8099 type: string
8100 language:
8101 type: string
8102 script:
8103 type: string
8104 unicodeLocaleAttributes:
8105 type: array
8106 items:
8107 type: string
8108 uniqueItems: true
8109 unicodeLocaleKeys:
8110 type: array
8111 items:
8112 type: string
8113 uniqueItems: true
8114 variant:
8115 type: string
8116 lastModified:
8117 type: string
8118 format: date-time
8119 length:
8120 type: integer
8121 format: int32
8122 links:
8123 type: array
8124 items:
8125 type: object
8126 properties:
8127 params:
8128 type: object
8129 additionalProperties:
8130 type: string
8131 rel:
8132 type: string
8133 rels:
8134 type: array
8135 items:
8136 type: string
8137 title:
8138 type: string
8139 type:
8140 type: string
8141 uri:
8142 type: string
8143 format: uri
8144 uriBuilder:
8145 type: object
8146 uniqueItems: true
8147 location:
8148 type: string
8149 format: uri
8150 mediaType:
8151 type: object
8152 properties:
8153 parameters:
8154 type: object
8155 additionalProperties:
8156 type: string
8157 subtype:
8158 type: string
8159 type:
8160 type: string
8161 wildcardSubtype:
8162 type: boolean
8163 wildcardType:
8164 type: boolean
8165 metadata:
8166 type: object
8167 additionalProperties:
8168 type: array
8169 items:
8170 type: object
8171 status:
8172 type: integer
8173 format: int32
8174 statusInfo:
8175 type: object
8176 properties:
8177 family:
8178 type: string
8179 enum:
8180 - INFORMATIONAL
8181 - SUCCESSFUL
8182 - REDIRECTION
8183 - CLIENT_ERROR
8184 - SERVER_ERROR
8185 - OTHER
8186 reasonPhrase:
8187 type: string
8188 statusCode:
8189 type: integer
8190 format: int32
8191 stringHeaders:
8192 type: object
8193 additionalProperties:
8194 type: array
8195 items:
8196 type: string
8197 servers:
8198 - url: /sdc2/rest
8199 variables: {}
8200 summary: Returns created service property
8201 tags:
8202 - SDCE-2 APIs
8203 put:
8204 description: Update Resource Property
8205 operationId: updatePropertyInResource
8206 parameters:
8207 - description: resource id to update with new property
8208 in: path
8209 name: resourceId
8210 required: true
8211 schema:
8212 type: string
8213 - in: header
8214 name: USER_ID
8215 schema:
8216 type: string
8217 requestBody:
8218 content:
8219 application/json:
8220 schema:
8221 type: string
8222 description: Resource property to update
8223 required: true
8224 responses:
8225 "200":
8226 description: Resource property updated
8227 "400":
8228 description: Invalid content / Missing content
8229 "403":
8230 description: Restricted operation
8231 default:
8232 content:
8233 application/json:
8234 schema:
8235 type: array
8236 items:
8237 type: object
8238 properties:
8239 allowedMethods:
8240 type: array
8241 items:
8242 type: string
8243 uniqueItems: true
8244 cookies:
8245 type: object
8246 additionalProperties:
8247 type: object
8248 properties:
8249 comment:
8250 type: string
8251 domain:
8252 type: string
8253 expiry:
8254 type: string
8255 format: date-time
8256 httpOnly:
8257 type: boolean
8258 maxAge:
8259 type: integer
8260 format: int32
8261 name:
8262 type: string
8263 path:
8264 type: string
8265 secure:
8266 type: boolean
8267 value:
8268 type: string
8269 version:
8270 type: integer
8271 format: int32
8272 date:
8273 type: string
8274 format: date-time
8275 entity:
8276 type: object
8277 entityTag:
8278 type: object
8279 properties:
8280 value:
8281 type: string
8282 weak:
8283 type: boolean
8284 headers:
8285 type: object
8286 additionalProperties:
8287 type: array
8288 items:
8289 type: object
8290 language:
8291 type: object
8292 properties:
8293 country:
8294 type: string
8295 displayCountry:
8296 type: string
8297 displayLanguage:
8298 type: string
8299 displayName:
8300 type: string
8301 displayScript:
8302 type: string
8303 displayVariant:
8304 type: string
8305 extensionKeys:
8306 type: array
8307 items:
8308 type: string
8309 uniqueItems: true
8310 iso3Country:
8311 type: string
8312 iso3Language:
8313 type: string
8314 language:
8315 type: string
8316 script:
8317 type: string
8318 unicodeLocaleAttributes:
8319 type: array
8320 items:
8321 type: string
8322 uniqueItems: true
8323 unicodeLocaleKeys:
8324 type: array
8325 items:
8326 type: string
8327 uniqueItems: true
8328 variant:
8329 type: string
8330 lastModified:
8331 type: string
8332 format: date-time
8333 length:
8334 type: integer
8335 format: int32
8336 links:
8337 type: array
8338 items:
8339 type: object
8340 properties:
8341 params:
8342 type: object
8343 additionalProperties:
8344 type: string
8345 rel:
8346 type: string
8347 rels:
8348 type: array
8349 items:
8350 type: string
8351 title:
8352 type: string
8353 type:
8354 type: string
8355 uri:
8356 type: string
8357 format: uri
8358 uriBuilder:
8359 type: object
8360 uniqueItems: true
8361 location:
8362 type: string
8363 format: uri
8364 mediaType:
8365 type: object
8366 properties:
8367 parameters:
8368 type: object
8369 additionalProperties:
8370 type: string
8371 subtype:
8372 type: string
8373 type:
8374 type: string
8375 wildcardSubtype:
8376 type: boolean
8377 wildcardType:
8378 type: boolean
8379 metadata:
8380 type: object
8381 additionalProperties:
8382 type: array
8383 items:
8384 type: object
8385 status:
8386 type: integer
8387 format: int32
8388 statusInfo:
8389 type: object
8390 properties:
8391 family:
8392 type: string
8393 enum:
8394 - INFORMATIONAL
8395 - SUCCESSFUL
8396 - REDIRECTION
8397 - CLIENT_ERROR
8398 - SERVER_ERROR
8399 - OTHER
8400 reasonPhrase:
8401 type: string
8402 statusCode:
8403 type: integer
8404 format: int32
8405 stringHeaders:
8406 type: object
8407 additionalProperties:
8408 type: array
8409 items:
8410 type: string
8411 servers:
8412 - url: /sdc2/rest
8413 variables: {}
8414 summary: Returns updated property
8415 tags:
8416 - SDCE-2 APIs
8417 /v1/catalog/resources/{resourceId}/properties/{propertyId}:
8418 delete:
8419 description: Delete Resource Property
8420 operationId: deletePropertyInResource
8421 parameters:
8422 - description: resource id of property
8423 in: path
8424 name: resourceId
8425 required: true
8426 schema:
8427 type: string
8428 - description: Property id to delete
8429 in: path
8430 name: propertyId
8431 required: true
8432 schema:
8433 type: string
8434 - in: header
8435 name: USER_ID
8436 schema:
8437 type: string
8438 responses:
8439 "204":
8440 description: deleted property
8441 "400":
8442 description: Invalid content / Missing content
8443 "403":
8444 description: Restricted operation
8445 "404":
8446 description: Resource property not found
8447 default:
8448 content:
8449 application/json:
8450 schema:
8451 type: array
8452 items:
8453 type: object
8454 properties:
8455 allowedMethods:
8456 type: array
8457 items:
8458 type: string
8459 uniqueItems: true
8460 cookies:
8461 type: object
8462 additionalProperties:
8463 type: object
8464 properties:
8465 comment:
8466 type: string
8467 domain:
8468 type: string
8469 expiry:
8470 type: string
8471 format: date-time
8472 httpOnly:
8473 type: boolean
8474 maxAge:
8475 type: integer
8476 format: int32
8477 name:
8478 type: string
8479 path:
8480 type: string
8481 secure:
8482 type: boolean
8483 value:
8484 type: string
8485 version:
8486 type: integer
8487 format: int32
8488 date:
8489 type: string
8490 format: date-time
8491 entity:
8492 type: object
8493 entityTag:
8494 type: object
8495 properties:
8496 value:
8497 type: string
8498 weak:
8499 type: boolean
8500 headers:
8501 type: object
8502 additionalProperties:
8503 type: array
8504 items:
8505 type: object
8506 language:
8507 type: object
8508 properties:
8509 country:
8510 type: string
8511 displayCountry:
8512 type: string
8513 displayLanguage:
8514 type: string
8515 displayName:
8516 type: string
8517 displayScript:
8518 type: string
8519 displayVariant:
8520 type: string
8521 extensionKeys:
8522 type: array
8523 items:
8524 type: string
8525 uniqueItems: true
8526 iso3Country:
8527 type: string
8528 iso3Language:
8529 type: string
8530 language:
8531 type: string
8532 script:
8533 type: string
8534 unicodeLocaleAttributes:
8535 type: array
8536 items:
8537 type: string
8538 uniqueItems: true
8539 unicodeLocaleKeys:
8540 type: array
8541 items:
8542 type: string
8543 uniqueItems: true
8544 variant:
8545 type: string
8546 lastModified:
8547 type: string
8548 format: date-time
8549 length:
8550 type: integer
8551 format: int32
8552 links:
8553 type: array
8554 items:
8555 type: object
8556 properties:
8557 params:
8558 type: object
8559 additionalProperties:
8560 type: string
8561 rel:
8562 type: string
8563 rels:
8564 type: array
8565 items:
8566 type: string
8567 title:
8568 type: string
8569 type:
8570 type: string
8571 uri:
8572 type: string
8573 format: uri
8574 uriBuilder:
8575 type: object
8576 uniqueItems: true
8577 location:
8578 type: string
8579 format: uri
8580 mediaType:
8581 type: object
8582 properties:
8583 parameters:
8584 type: object
8585 additionalProperties:
8586 type: string
8587 subtype:
8588 type: string
8589 type:
8590 type: string
8591 wildcardSubtype:
8592 type: boolean
8593 wildcardType:
8594 type: boolean
8595 metadata:
8596 type: object
8597 additionalProperties:
8598 type: array
8599 items:
8600 type: object
8601 status:
8602 type: integer
8603 format: int32
8604 statusInfo:
8605 type: object
8606 properties:
8607 family:
8608 type: string
8609 enum:
8610 - INFORMATIONAL
8611 - SUCCESSFUL
8612 - REDIRECTION
8613 - CLIENT_ERROR
8614 - SERVER_ERROR
8615 - OTHER
8616 reasonPhrase:
8617 type: string
8618 statusCode:
8619 type: integer
8620 format: int32
8621 stringHeaders:
8622 type: object
8623 additionalProperties:
8624 type: array
8625 items:
8626 type: string
8627 servers:
8628 - url: /sdc2/rest
8629 variables: {}
8630 summary: Returns deleted property
8631 tags:
8632 - SDCE-2 APIs
8633 get:
8634 description: Get Resource Property
8635 operationId: getPropertyInResource
8636 parameters:
8637 - description: resource id of property
8638 in: path
8639 name: resourceId
8640 required: true
8641 schema:
8642 type: string
8643 - description: property id to get
8644 in: path
8645 name: propertyId
8646 required: true
8647 schema:
8648 type: string
8649 - in: header
8650 name: USER_ID
8651 schema:
8652 type: string
8653 responses:
8654 "200":
8655 description: property
8656 "400":
8657 description: Invalid content / Missing content
8658 "403":
8659 description: Restricted operation
8660 "404":
8661 description: Resource property not found
8662 default:
8663 content:
8664 application/json:
8665 schema:
8666 type: array
8667 items:
8668 type: object
8669 properties:
8670 allowedMethods:
8671 type: array
8672 items:
8673 type: string
8674 uniqueItems: true
8675 cookies:
8676 type: object
8677 additionalProperties:
8678 type: object
8679 properties:
8680 comment:
8681 type: string
8682 domain:
8683 type: string
8684 expiry:
8685 type: string
8686 format: date-time
8687 httpOnly:
8688 type: boolean
8689 maxAge:
8690 type: integer
8691 format: int32
8692 name:
8693 type: string
8694 path:
8695 type: string
8696 secure:
8697 type: boolean
8698 value:
8699 type: string
8700 version:
8701 type: integer
8702 format: int32
8703 date:
8704 type: string
8705 format: date-time
8706 entity:
8707 type: object
8708 entityTag:
8709 type: object
8710 properties:
8711 value:
8712 type: string
8713 weak:
8714 type: boolean
8715 headers:
8716 type: object
8717 additionalProperties:
8718 type: array
8719 items:
8720 type: object
8721 language:
8722 type: object
8723 properties:
8724 country:
8725 type: string
8726 displayCountry:
8727 type: string
8728 displayLanguage:
8729 type: string
8730 displayName:
8731 type: string
8732 displayScript:
8733 type: string
8734 displayVariant:
8735 type: string
8736 extensionKeys:
8737 type: array
8738 items:
8739 type: string
8740 uniqueItems: true
8741 iso3Country:
8742 type: string
8743 iso3Language:
8744 type: string
8745 language:
8746 type: string
8747 script:
8748 type: string
8749 unicodeLocaleAttributes:
8750 type: array
8751 items:
8752 type: string
8753 uniqueItems: true
8754 unicodeLocaleKeys:
8755 type: array
8756 items:
8757 type: string
8758 uniqueItems: true
8759 variant:
8760 type: string
8761 lastModified:
8762 type: string
8763 format: date-time
8764 length:
8765 type: integer
8766 format: int32
8767 links:
8768 type: array
8769 items:
8770 type: object
8771 properties:
8772 params:
8773 type: object
8774 additionalProperties:
8775 type: string
8776 rel:
8777 type: string
8778 rels:
8779 type: array
8780 items:
8781 type: string
8782 title:
8783 type: string
8784 type:
8785 type: string
8786 uri:
8787 type: string
8788 format: uri
8789 uriBuilder:
8790 type: object
8791 uniqueItems: true
8792 location:
8793 type: string
8794 format: uri
8795 mediaType:
8796 type: object
8797 properties:
8798 parameters:
8799 type: object
8800 additionalProperties:
8801 type: string
8802 subtype:
8803 type: string
8804 type:
8805 type: string
8806 wildcardSubtype:
8807 type: boolean
8808 wildcardType:
8809 type: boolean
8810 metadata:
8811 type: object
8812 additionalProperties:
8813 type: array
8814 items:
8815 type: object
8816 status:
8817 type: integer
8818 format: int32
8819 statusInfo:
8820 type: object
8821 properties:
8822 family:
8823 type: string
8824 enum:
8825 - INFORMATIONAL
8826 - SUCCESSFUL
8827 - REDIRECTION
8828 - CLIENT_ERROR
8829 - SERVER_ERROR
8830 - OTHER
8831 reasonPhrase:
8832 type: string
8833 statusCode:
8834 type: integer
8835 format: int32
8836 stringHeaders:
8837 type: object
8838 additionalProperties:
8839 type: array
8840 items:
8841 type: string
8842 servers:
8843 - url: /sdc2/rest
8844 variables: {}
8845 summary: Returns property of resource
8846 tags:
8847 - SDCE-2 APIs
8848 /v1/catalog/resources/{resourceId}/requirements:
8849 post:
8850 description: Create requirements on resource
8851 operationId: createRequirementsOnResource
8852 parameters:
8853 - description: Resource Id
8854 in: path
8855 name: resourceId
8856 required: true
8857 schema:
8858 type: string
8859 - in: header
8860 name: USER_ID
8861 schema:
8862 type: string
8863 requestBody:
8864 content:
8865 application/json:
8866 schema:
8867 type: string
8868 description: Requirement to create
8869 required: true
8870 responses:
8871 "201":
8872 description: Create requirements
8873 "400":
8874 description: Invalid content / Missing content
8875 "403":
8876 description: Restricted operation
8877 "409":
8878 description: requirement already exist
8879 default:
8880 content:
8881 application/json:
8882 schema:
8883 type: array
8884 items:
8885 type: object
8886 properties:
8887 allowedMethods:
8888 type: array
8889 items:
8890 type: string
8891 uniqueItems: true
8892 cookies:
8893 type: object
8894 additionalProperties:
8895 type: object
8896 properties:
8897 comment:
8898 type: string
8899 domain:
8900 type: string
8901 expiry:
8902 type: string
8903 format: date-time
8904 httpOnly:
8905 type: boolean
8906 maxAge:
8907 type: integer
8908 format: int32
8909 name:
8910 type: string
8911 path:
8912 type: string
8913 secure:
8914 type: boolean
8915 value:
8916 type: string
8917 version:
8918 type: integer
8919 format: int32
8920 date:
8921 type: string
8922 format: date-time
8923 entity:
8924 type: object
8925 entityTag:
8926 type: object
8927 properties:
8928 value:
8929 type: string
8930 weak:
8931 type: boolean
8932 headers:
8933 type: object
8934 additionalProperties:
8935 type: array
8936 items:
8937 type: object
8938 language:
8939 type: object
8940 properties:
8941 country:
8942 type: string
8943 displayCountry:
8944 type: string
8945 displayLanguage:
8946 type: string
8947 displayName:
8948 type: string
8949 displayScript:
8950 type: string
8951 displayVariant:
8952 type: string
8953 extensionKeys:
8954 type: array
8955 items:
8956 type: string
8957 uniqueItems: true
8958 iso3Country:
8959 type: string
8960 iso3Language:
8961 type: string
8962 language:
8963 type: string
8964 script:
8965 type: string
8966 unicodeLocaleAttributes:
8967 type: array
8968 items:
8969 type: string
8970 uniqueItems: true
8971 unicodeLocaleKeys:
8972 type: array
8973 items:
8974 type: string
8975 uniqueItems: true
8976 variant:
8977 type: string
8978 lastModified:
8979 type: string
8980 format: date-time
8981 length:
8982 type: integer
8983 format: int32
8984 links:
8985 type: array
8986 items:
8987 type: object
8988 properties:
8989 params:
8990 type: object
8991 additionalProperties:
8992 type: string
8993 rel:
8994 type: string
8995 rels:
8996 type: array
8997 items:
8998 type: string
8999 title:
9000 type: string
9001 type:
9002 type: string
9003 uri:
9004 type: string
9005 format: uri
9006 uriBuilder:
9007 type: object
9008 uniqueItems: true
9009 location:
9010 type: string
9011 format: uri
9012 mediaType:
9013 type: object
9014 properties:
9015 parameters:
9016 type: object
9017 additionalProperties:
9018 type: string
9019 subtype:
9020 type: string
9021 type:
9022 type: string
9023 wildcardSubtype:
9024 type: boolean
9025 wildcardType:
9026 type: boolean
9027 metadata:
9028 type: object
9029 additionalProperties:
9030 type: array
9031 items:
9032 type: object
9033 status:
9034 type: integer
9035 format: int32
9036 statusInfo:
9037 type: object
9038 properties:
9039 family:
9040 type: string
9041 enum:
9042 - INFORMATIONAL
9043 - SUCCESSFUL
9044 - REDIRECTION
9045 - CLIENT_ERROR
9046 - SERVER_ERROR
9047 - OTHER
9048 reasonPhrase:
9049 type: string
9050 statusCode:
9051 type: integer
9052 format: int32
9053 stringHeaders:
9054 type: object
9055 additionalProperties:
9056 type: array
9057 items:
9058 type: string
9059 servers:
9060 - url: /sdc2/rest
9061 variables: {}
9062 summary: Create requirements on resource
9063 tags:
9064 - SDCE-2 APIs
9065 put:
9066 description: Update Requirements on resource
9067 operationId: updateRequirementsOnResource
9068 parameters:
9069 - description: Component Id
9070 in: path
9071 name: resourceId
9072 required: true
9073 schema:
9074 type: string
9075 - in: header
9076 name: USER_ID
9077 schema:
9078 type: string
9079 requestBody:
9080 content:
9081 application/json:
9082 schema:
9083 type: string
9084 description: Requirements to update
9085 required: true
9086 responses:
9087 "201":
9088 description: Update Requirements
9089 "400":
9090 description: Invalid content / Missing content
9091 "403":
9092 description: Restricted operation
9093 default:
9094 content:
9095 application/json:
9096 schema:
9097 type: array
9098 items:
9099 $ref: '#/components/schemas/RequirementDefinition'
9100 servers:
9101 - url: /sdc2/rest
9102 variables: {}
9103 summary: Update Requirements on resource
9104 tags:
9105 - SDCE-2 APIs
9106 /v1/catalog/resources/{resourceId}/requirements/{requirementId}:
9107 delete:
9108 description: Delete requirements from resource
9109 operationId: deleteRequirementsFromResource
9110 parameters:
9111 - description: Resource Id
9112 in: path
9113 name: resourceId
9114 required: true
9115 schema:
9116 type: string
9117 - description: requirement Id
9118 in: path
9119 name: requirementId
9120 required: true
9121 schema:
9122 type: string
9123 - in: header
9124 name: USER_ID
9125 schema:
9126 type: string
9127 responses:
9128 "201":
9129 description: Delete requirement
9130 "400":
9131 description: Invalid content / Missing content
9132 "403":
9133 description: Restricted operation
9134 default:
9135 content:
9136 application/json:
9137 schema:
9138 type: array
9139 items:
9140 $ref: '#/components/schemas/RequirementDefinition'
9141 servers:
9142 - url: /sdc2/rest
9143 variables: {}
9144 summary: Delete requirements from resource
9145 tags:
9146 - SDCE-2 APIs
9147 get:
9148 description: Get Requirement from resource
9149 operationId: getRequirementsFromResource
9150 parameters:
9151 - description: Resource Id
9152 in: path
9153 name: resourceId
9154 required: true
9155 schema:
9156 type: string
9157 - description: Requirement Id
9158 in: path
9159 name: requirementId
9160 required: true
9161 schema:
9162 type: string
9163 - in: header
9164 name: USER_ID
9165 schema:
9166 type: string
9167 responses:
9168 "201":
9169 description: GET requirement
9170 "400":
9171 description: Invalid content / Missing content
9172 "403":
9173 description: Restricted operation
9174 default:
9175 content:
9176 application/json:
9177 schema:
9178 type: array
9179 items:
9180 $ref: '#/components/schemas/RequirementDefinition'
9181 servers:
9182 - url: /sdc2/rest
9183 variables: {}
9184 summary: GET Requirement from resource
9185 tags:
9186 - SDCE-2 APIs
9187 /v1/catalog/resources/{resourceId}/{interfaceType}/{operation}/artifacts:
9188 post:
9189 description: Create Artifact and Attach to interface
9190 operationId: loadArtifactToInterface
9191 parameters:
9192 - in: path
9193 name: resourceId
9194 required: true
9195 schema:
9196 type: string
9197 - in: path
9198 name: interfaceType
9199 required: true
9200 schema:
9201 type: string
9202 - in: path
9203 name: operation
9204 required: true
9205 schema:
9206 type: string
9207 - in: header
9208 name: USER_ID
9209 schema:
9210 type: string
9211 - in: header
9212 name: Content-MD5
9213 schema:
9214 type: string
9215 requestBody:
9216 content:
9217 application/json:
9218 schema:
9219 type: string
9220 description: json describe the artifact
9221 required: true
9222 responses:
9223 "201":
9224 description: Resource created
9225 "400":
9226 description: Invalid content / Missing content
9227 "403":
9228 description: Restricted operation
9229 "409":
9230 description: Artifact already exist
9231 default:
9232 content:
9233 application/json:
9234 schema:
9235 type: array
9236 items:
9237 type: object
9238 properties:
9239 allowedMethods:
9240 type: array
9241 items:
9242 type: string
9243 uniqueItems: true
9244 cookies:
9245 type: object
9246 additionalProperties:
9247 type: object
9248 properties:
9249 comment:
9250 type: string
9251 domain:
9252 type: string
9253 expiry:
9254 type: string
9255 format: date-time
9256 httpOnly:
9257 type: boolean
9258 maxAge:
9259 type: integer
9260 format: int32
9261 name:
9262 type: string
9263 path:
9264 type: string
9265 secure:
9266 type: boolean
9267 value:
9268 type: string
9269 version:
9270 type: integer
9271 format: int32
9272 date:
9273 type: string
9274 format: date-time
9275 entity:
9276 type: object
9277 entityTag:
9278 type: object
9279 properties:
9280 value:
9281 type: string
9282 weak:
9283 type: boolean
9284 headers:
9285 type: object
9286 additionalProperties:
9287 type: array
9288 items:
9289 type: object
9290 language:
9291 type: object
9292 properties:
9293 country:
9294 type: string
9295 displayCountry:
9296 type: string
9297 displayLanguage:
9298 type: string
9299 displayName:
9300 type: string
9301 displayScript:
9302 type: string
9303 displayVariant:
9304 type: string
9305 extensionKeys:
9306 type: array
9307 items:
9308 type: string
9309 uniqueItems: true
9310 iso3Country:
9311 type: string
9312 iso3Language:
9313 type: string
9314 language:
9315 type: string
9316 script:
9317 type: string
9318 unicodeLocaleAttributes:
9319 type: array
9320 items:
9321 type: string
9322 uniqueItems: true
9323 unicodeLocaleKeys:
9324 type: array
9325 items:
9326 type: string
9327 uniqueItems: true
9328 variant:
9329 type: string
9330 lastModified:
9331 type: string
9332 format: date-time
9333 length:
9334 type: integer
9335 format: int32
9336 links:
9337 type: array
9338 items:
9339 type: object
9340 properties:
9341 params:
9342 type: object
9343 additionalProperties:
9344 type: string
9345 rel:
9346 type: string
9347 rels:
9348 type: array
9349 items:
9350 type: string
9351 title:
9352 type: string
9353 type:
9354 type: string
9355 uri:
9356 type: string
9357 format: uri
9358 uriBuilder:
9359 type: object
9360 uniqueItems: true
9361 location:
9362 type: string
9363 format: uri
9364 mediaType:
9365 type: object
9366 properties:
9367 parameters:
9368 type: object
9369 additionalProperties:
9370 type: string
9371 subtype:
9372 type: string
9373 type:
9374 type: string
9375 wildcardSubtype:
9376 type: boolean
9377 wildcardType:
9378 type: boolean
9379 metadata:
9380 type: object
9381 additionalProperties:
9382 type: array
9383 items:
9384 type: object
9385 status:
9386 type: integer
9387 format: int32
9388 statusInfo:
9389 type: object
9390 properties:
9391 family:
9392 type: string
9393 enum:
9394 - INFORMATIONAL
9395 - SUCCESSFUL
9396 - REDIRECTION
9397 - CLIENT_ERROR
9398 - SERVER_ERROR
9399 - OTHER
9400 reasonPhrase:
9401 type: string
9402 statusCode:
9403 type: integer
9404 format: int32
9405 stringHeaders:
9406 type: object
9407 additionalProperties:
9408 type: array
9409 items:
9410 type: string
9411 servers:
9412 - url: /sdc2/rest
9413 variables: {}
9414 summary: Returns created resource
9415 tags:
9416 - SDCE-2 APIs
9417 /v1/catalog/resources/{resourceId}/{interfaceType}/{operation}/artifacts/{artifactId}:
9418 delete:
9419 description: delete Artifact from interface
9420 operationId: deleteArtifactToInterface
9421 parameters:
9422 - in: path
9423 name: resourceId
9424 required: true
9425 schema:
9426 type: string
9427 - in: path
9428 name: interfaceType
9429 required: true
9430 schema:
9431 type: string
9432 - in: path
9433 name: operation
9434 required: true
9435 schema:
9436 type: string
9437 - in: path
9438 name: artifactId
9439 required: true
9440 schema:
9441 type: string
9442 responses:
9443 "201":
9444 description: delete artifact under interface deleted
9445 "400":
9446 description: Invalid content / Missing content
9447 "403":
9448 description: Restricted operation
9449 "409":
9450 description: Artifact already exist
9451 default:
9452 content:
9453 application/json:
9454 schema:
9455 type: array
9456 items:
9457 type: object
9458 properties:
9459 allowedMethods:
9460 type: array
9461 items:
9462 type: string
9463 uniqueItems: true
9464 cookies:
9465 type: object
9466 additionalProperties:
9467 type: object
9468 properties:
9469 comment:
9470 type: string
9471 domain:
9472 type: string
9473 expiry:
9474 type: string
9475 format: date-time
9476 httpOnly:
9477 type: boolean
9478 maxAge:
9479 type: integer
9480 format: int32
9481 name:
9482 type: string
9483 path:
9484 type: string
9485 secure:
9486 type: boolean
9487 value:
9488 type: string
9489 version:
9490 type: integer
9491 format: int32
9492 date:
9493 type: string
9494 format: date-time
9495 entity:
9496 type: object
9497 entityTag:
9498 type: object
9499 properties:
9500 value:
9501 type: string
9502 weak:
9503 type: boolean
9504 headers:
9505 type: object
9506 additionalProperties:
9507 type: array
9508 items:
9509 type: object
9510 language:
9511 type: object
9512 properties:
9513 country:
9514 type: string
9515 displayCountry:
9516 type: string
9517 displayLanguage:
9518 type: string
9519 displayName:
9520 type: string
9521 displayScript:
9522 type: string
9523 displayVariant:
9524 type: string
9525 extensionKeys:
9526 type: array
9527 items:
9528 type: string
9529 uniqueItems: true
9530 iso3Country:
9531 type: string
9532 iso3Language:
9533 type: string
9534 language:
9535 type: string
9536 script:
9537 type: string
9538 unicodeLocaleAttributes:
9539 type: array
9540 items:
9541 type: string
9542 uniqueItems: true
9543 unicodeLocaleKeys:
9544 type: array
9545 items:
9546 type: string
9547 uniqueItems: true
9548 variant:
9549 type: string
9550 lastModified:
9551 type: string
9552 format: date-time
9553 length:
9554 type: integer
9555 format: int32
9556 links:
9557 type: array
9558 items:
9559 type: object
9560 properties:
9561 params:
9562 type: object
9563 additionalProperties:
9564 type: string
9565 rel:
9566 type: string
9567 rels:
9568 type: array
9569 items:
9570 type: string
9571 title:
9572 type: string
9573 type:
9574 type: string
9575 uri:
9576 type: string
9577 format: uri
9578 uriBuilder:
9579 type: object
9580 uniqueItems: true
9581 location:
9582 type: string
9583 format: uri
9584 mediaType:
9585 type: object
9586 properties:
9587 parameters:
9588 type: object
9589 additionalProperties:
9590 type: string
9591 subtype:
9592 type: string
9593 type:
9594 type: string
9595 wildcardSubtype:
9596 type: boolean
9597 wildcardType:
9598 type: boolean
9599 metadata:
9600 type: object
9601 additionalProperties:
9602 type: array
9603 items:
9604 type: object
9605 status:
9606 type: integer
9607 format: int32
9608 statusInfo:
9609 type: object
9610 properties:
9611 family:
9612 type: string
9613 enum:
9614 - INFORMATIONAL
9615 - SUCCESSFUL
9616 - REDIRECTION
9617 - CLIENT_ERROR
9618 - SERVER_ERROR
9619 - OTHER
9620 reasonPhrase:
9621 type: string
9622 statusCode:
9623 type: integer
9624 format: int32
9625 stringHeaders:
9626 type: object
9627 additionalProperties:
9628 type: array
9629 items:
9630 type: string
9631 servers:
9632 - url: /sdc2/rest
9633 variables: {}
9634 summary: delete matching artifact from interface
9635 tags:
9636 - SDCE-2 APIs
9637 post:
9638 description: update Artifact Attach to interface
9639 operationId: updateArtifactToInterface
9640 parameters:
9641 - in: path
9642 name: resourceId
9643 required: true
9644 schema:
9645 type: string
9646 - in: path
9647 name: interfaceType
9648 required: true
9649 schema:
9650 type: string
9651 - in: path
9652 name: operation
9653 required: true
9654 schema:
9655 type: string
9656 - in: path
9657 name: artifactId
9658 required: true
9659 schema:
9660 type: string
9661 - in: header
9662 name: USER_ID
9663 schema:
9664 type: string
9665 - in: header
9666 name: Content-MD5
9667 schema:
9668 type: string
9669 requestBody:
9670 content:
9671 application/json:
9672 schema:
9673 type: string
9674 description: json describe the artifact
9675 required: true
9676 responses:
9677 "201":
9678 description: delete artifact under interface deleted
9679 "400":
9680 description: Invalid content / Missing content
9681 "403":
9682 description: Restricted operation
9683 "409":
9684 description: Artifact already exist
9685 default:
9686 content:
9687 application/json:
9688 schema:
9689 type: array
9690 items:
9691 type: object
9692 properties:
9693 allowedMethods:
9694 type: array
9695 items:
9696 type: string
9697 uniqueItems: true
9698 cookies:
9699 type: object
9700 additionalProperties:
9701 type: object
9702 properties:
9703 comment:
9704 type: string
9705 domain:
9706 type: string
9707 expiry:
9708 type: string
9709 format: date-time
9710 httpOnly:
9711 type: boolean
9712 maxAge:
9713 type: integer
9714 format: int32
9715 name:
9716 type: string
9717 path:
9718 type: string
9719 secure:
9720 type: boolean
9721 value:
9722 type: string
9723 version:
9724 type: integer
9725 format: int32
9726 date:
9727 type: string
9728 format: date-time
9729 entity:
9730 type: object
9731 entityTag:
9732 type: object
9733 properties:
9734 value:
9735 type: string
9736 weak:
9737 type: boolean
9738 headers:
9739 type: object
9740 additionalProperties:
9741 type: array
9742 items:
9743 type: object
9744 language:
9745 type: object
9746 properties:
9747 country:
9748 type: string
9749 displayCountry:
9750 type: string
9751 displayLanguage:
9752 type: string
9753 displayName:
9754 type: string
9755 displayScript:
9756 type: string
9757 displayVariant:
9758 type: string
9759 extensionKeys:
9760 type: array
9761 items:
9762 type: string
9763 uniqueItems: true
9764 iso3Country:
9765 type: string
9766 iso3Language:
9767 type: string
9768 language:
9769 type: string
9770 script:
9771 type: string
9772 unicodeLocaleAttributes:
9773 type: array
9774 items:
9775 type: string
9776 uniqueItems: true
9777 unicodeLocaleKeys:
9778 type: array
9779 items:
9780 type: string
9781 uniqueItems: true
9782 variant:
9783 type: string
9784 lastModified:
9785 type: string
9786 format: date-time
9787 length:
9788 type: integer
9789 format: int32
9790 links:
9791 type: array
9792 items:
9793 type: object
9794 properties:
9795 params:
9796 type: object
9797 additionalProperties:
9798 type: string
9799 rel:
9800 type: string
9801 rels:
9802 type: array
9803 items:
9804 type: string
9805 title:
9806 type: string
9807 type:
9808 type: string
9809 uri:
9810 type: string
9811 format: uri
9812 uriBuilder:
9813 type: object
9814 uniqueItems: true
9815 location:
9816 type: string
9817 format: uri
9818 mediaType:
9819 type: object
9820 properties:
9821 parameters:
9822 type: object
9823 additionalProperties:
9824 type: string
9825 subtype:
9826 type: string
9827 type:
9828 type: string
9829 wildcardSubtype:
9830 type: boolean
9831 wildcardType:
9832 type: boolean
9833 metadata:
9834 type: object
9835 additionalProperties:
9836 type: array
9837 items:
9838 type: object
9839 status:
9840 type: integer
9841 format: int32
9842 statusInfo:
9843 type: object
9844 properties:
9845 family:
9846 type: string
9847 enum:
9848 - INFORMATIONAL
9849 - SUCCESSFUL
9850 - REDIRECTION
9851 - CLIENT_ERROR
9852 - SERVER_ERROR
9853 - OTHER
9854 reasonPhrase:
9855 type: string
9856 statusCode:
9857 type: integer
9858 format: int32
9859 stringHeaders:
9860 type: object
9861 additionalProperties:
9862 type: array
9863 items:
9864 type: string
9865 servers:
9866 - url: /sdc2/rest
9867 variables: {}
9868 summary: updates artifact by interface
9869 tags:
9870 - SDCE-2 APIs
9871 /v1/catalog/resources/{resourceName}/{version}:
9872 delete:
9873 description: Delete Resource By Name And Version
9874 operationId: deleteResourceByNameAndVersion
9875 parameters:
9876 - in: path
9877 name: resourceName
9878 required: true
9879 schema:
9880 type: string
9881 - in: path
9882 name: version
9883 required: true
9884 schema:
9885 type: string
9886 responses:
9887 "204":
9888 description: Resource deleted
9889 "400":
9890 description: Invalid content / Missing content
9891 "403":
9892 description: Restricted operation
9893 "404":
9894 description: Resource not found
9895 default:
9896 content:
9897 '*/*':
9898 schema:
9899 type: array
9900 items:
9901 $ref: '#/components/schemas/Resource'
9902 servers:
9903 - url: /sdc2/rest
9904 variables: {}
9905 summary: Returns no content
9906 tags:
9907 - SDCE-2 APIs
9908 /v1/catalog/services:
9909 post:
9910 description: Create Service
9911 operationId: createService
9912 parameters:
9913 - in: header
9914 name: USER_ID
9915 schema:
9916 type: string
9917 requestBody:
9918 content:
9919 application/json:
9920 schema:
9921 type: string
9922 description: Service object to be created
9923 required: true
9924 responses:
9925 "201":
9926 description: Service created
9927 "400":
9928 description: Invalid content / Missing content
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]9929 "401":
9930 description: Unauthorized Tenant
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]9931 "403":
9932 description: Restricted operation
9933 "409":
9934 description: Service already exist
9935 default:
9936 content:
9937 application/json:
9938 schema:
9939 type: array
9940 items:
9941 $ref: '#/components/schemas/Service'
9942 servers:
9943 - url: /sdc2/rest
9944 variables: {}
9945 summary: Returns created service
9946 tags:
9947 - SDCE-2 APIs
9948 /v1/catalog/services/distribution/{did}:
9949 get:
9950 description: Retrieve Distributions
9951 operationId: getListOfDistributionStatuses
9952 parameters:
9953 - in: path
9954 name: did
9955 required: true
9956 schema:
9957 type: string
9958 - in: header
9959 name: USER_ID
9960 schema:
9961 type: string
9962 responses:
9963 "200":
9964 description: Service found
9965 "403":
9966 description: Restricted operation
9967 "404":
9968 description: Status not found
9969 default:
9970 content:
9971 application/json:
9972 schema:
9973 type: array
9974 items:
9975 $ref: '#/components/schemas/DistributionStatusListResponse'
9976 servers:
9977 - url: /sdc2/rest
9978 variables: {}
9979 summary: Return the list of distribution status objects
9980 tags:
9981 - SDCE-5 APIs
9982 /v1/catalog/services/importService:
9983 post:
9984 description: Import Service
9985 operationId: importNsService
9986 parameters:
9987 - in: header
9988 name: USER_ID
9989 schema:
9990 type: string
9991 requestBody:
9992 content:
9993 application/json:
9994 schema:
9995 type: string
9996 description: Service object to be imported
9997 required: true
9998 responses:
9999 "201":
10000 description: Service created
10001 "400":
10002 description: Invalid content / Missing content
10003 "403":
10004 description: Restricted operation
10005 "409":
10006 description: Service already exist
10007 servers:
10008 - url: /sdc2/rest
10009 variables: {}
10010 summary: Returns imported service
10011 tags:
10012 - SDCE-2 APIs
10013 /v1/catalog/services/replaceVNF:
10014 post:
10015 description: Replace new VNF based on the existing VNF
10016 operationId: replaceVNF
10017 parameters:
10018 - description: The user id
10019 in: header
10020 name: USER_ID
10021 required: true
10022 schema:
10023 type: string
10024 - description: X-ECOMP-RequestID header
10025 in: header
10026 name: X-ECOMP-RequestID
10027 schema:
10028 type: string
10029 - description: X-ECOMP-InstanceID header
10030 in: header
10031 name: X-ECOMP-InstanceID
10032 required: true
10033 schema:
10034 type: string
10035 - description: Determines the format of the body of the response
10036 in: header
10037 name: Accept
10038 schema:
10039 type: string
10040 - description: The username and password
10041 in: header
10042 name: Authorization
10043 required: true
10044 schema:
10045 type: string
10046 requestBody:
10047 content:
10048 '*/*':
10049 schema:
10050 type: string
10051 description: Resource object to be created
10052 required: true
10053 responses:
10054 "200":
10055 content:
10056 '*/*':
10057 schema:
10058 type: array
10059 items:
10060 $ref: '#/components/schemas/ReplaceVNFInfo'
10061 description: ECOMP component is authenticated and list of Catalog Assets
10062 Metadata is returned
10063 "400":
10064 description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001
10065 "401":
10066 description: ECOMP component should authenticate itself and to re-send again HTTP request with
10067 its Basic Authentication credentials - POL5002
10068 "403":
10069 description: ECOMP component is not authorized - POL5003
10070 "404":
10071 description: "Error: Requested '%1' (uuid) resource was not found - SVC4063"
10072 "405":
10073 description: "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST\
10074 \ will be rejected) - POL4050"
10075 "409":
10076 description: Service already exist
10077 "500":
10078 description: The GET request failed either due to internal SDC problem.
10079 ECOMP Component should continue the attempts to get the needed information
10080 - POL5000
10081 servers:
10082 - url: /sdc2/rest
10083 variables: {}
10084 summary: Return whether the replace VNF is successful
10085 tags:
10086 - SDCE-2 APIs
10087 /v1/catalog/services/serviceName/{serviceName}/serviceVersion/{serviceVersion}:
10088 get:
10089 description: Retrieve Service
10090 operationId: getServiceByNameAndVersion
10091 parameters:
10092 - in: path
10093 name: serviceName
10094 required: true
10095 schema:
10096 type: string
10097 - in: path
10098 name: serviceVersion
10099 required: true
10100 schema:
10101 type: string
10102 - in: header
10103 name: USER_ID
10104 schema:
10105 type: string
10106 responses:
10107 "200":
10108 description: Service found
10109 "403":
10110 description: Restricted operation
10111 "404":
10112 description: Service not found
10113 default:
10114 content:
10115 application/json:
10116 schema:
10117 type: array
10118 items:
10119 $ref: '#/components/schemas/Service'
10120 servers:
10121 - url: /sdc2/rest
10122 variables: {}
10123 summary: Returns service according to name and version
10124 tags:
10125 - SDCE-2 APIs
10126 /v1/catalog/services/serviceUUID/{uuid}/importReplaceService:
10127 post:
10128 description: Import Service
10129 operationId: importReplaceService
10130 parameters:
10131 - description: The user id
10132 in: header
10133 name: USER_ID
10134 required: true
10135 schema:
10136 type: string
10137 - description: X-ECOMP-RequestID header
10138 in: header
10139 name: X-ECOMP-RequestID
10140 schema:
10141 type: string
10142 - description: X-ECOMP-InstanceID header
10143 in: header
10144 name: X-ECOMP-InstanceID
10145 required: true
10146 schema:
10147 type: string
10148 - description: Determines the format of the body of the response
10149 in: header
10150 name: Accept
10151 schema:
10152 type: string
10153 - description: The username and password
10154 in: header
10155 name: Authorization
10156 required: true
10157 schema:
10158 type: string
10159 - description: The requested asset uuid
10160 in: path
10161 name: uuid
10162 required: true
10163 schema:
10164 type: string
10165 requestBody:
10166 content:
10167 '*/*':
10168 schema:
10169 type: object
10170 properties:
10171 serviceZip:
10172 $ref: '#/components/schemas/FormDataContentDisposition'
10173 serviceZipMetadata:
10174 type: string
10175 description: serviceMetadata
10176 responses:
10177 "201":
10178 description: Service created
10179 "400":
10180 description: Invalid content / Missing content
10181 "403":
10182 description: Restricted operation
10183 "409":
10184 description: Service already exist
10185 servers:
10186 - url: /sdc2/rest
10187 variables: {}
10188 summary: Returns imported service
10189 tags:
10190 - SDCE-2 APIs
10191 /v1/catalog/services/validate-name/{serviceName}:
10192 get:
10193 description: validate service name
10194 operationId: validateServiceName
10195 parameters:
10196 - in: path
10197 name: serviceName
10198 required: true
10199 schema:
10200 type: string
10201 - in: header
10202 name: USER_ID
10203 schema:
10204 type: string
10205 responses:
10206 "200":
10207 description: Service found
10208 "403":
10209 description: Restricted operation
10210 default:
10211 content:
10212 application/json:
10213 schema:
10214 type: array
10215 items:
10216 type: object
10217 properties:
10218 allowedMethods:
10219 type: array
10220 items:
10221 type: string
10222 uniqueItems: true
10223 cookies:
10224 type: object
10225 additionalProperties:
10226 type: object
10227 properties:
10228 comment:
10229 type: string
10230 domain:
10231 type: string
10232 expiry:
10233 type: string
10234 format: date-time
10235 httpOnly:
10236 type: boolean
10237 maxAge:
10238 type: integer
10239 format: int32
10240 name:
10241 type: string
10242 path:
10243 type: string
10244 secure:
10245 type: boolean
10246 value:
10247 type: string
10248 version:
10249 type: integer
10250 format: int32
10251 date:
10252 type: string
10253 format: date-time
10254 entity:
10255 type: object
10256 entityTag:
10257 type: object
10258 properties:
10259 value:
10260 type: string
10261 weak:
10262 type: boolean
10263 headers:
10264 type: object
10265 additionalProperties:
10266 type: array
10267 items:
10268 type: object
10269 language:
10270 type: object
10271 properties:
10272 country:
10273 type: string
10274 displayCountry:
10275 type: string
10276 displayLanguage:
10277 type: string
10278 displayName:
10279 type: string
10280 displayScript:
10281 type: string
10282 displayVariant:
10283 type: string
10284 extensionKeys:
10285 type: array
10286 items:
10287 type: string
10288 uniqueItems: true
10289 iso3Country:
10290 type: string
10291 iso3Language:
10292 type: string
10293 language:
10294 type: string
10295 script:
10296 type: string
10297 unicodeLocaleAttributes:
10298 type: array
10299 items:
10300 type: string
10301 uniqueItems: true
10302 unicodeLocaleKeys:
10303 type: array
10304 items:
10305 type: string
10306 uniqueItems: true
10307 variant:
10308 type: string
10309 lastModified:
10310 type: string
10311 format: date-time
10312 length:
10313 type: integer
10314 format: int32
10315 links:
10316 type: array
10317 items:
10318 type: object
10319 properties:
10320 params:
10321 type: object
10322 additionalProperties:
10323 type: string
10324 rel:
10325 type: string
10326 rels:
10327 type: array
10328 items:
10329 type: string
10330 title:
10331 type: string
10332 type:
10333 type: string
10334 uri:
10335 type: string
10336 format: uri
10337 uriBuilder:
10338 type: object
10339 uniqueItems: true
10340 location:
10341 type: string
10342 format: uri
10343 mediaType:
10344 type: object
10345 properties:
10346 parameters:
10347 type: object
10348 additionalProperties:
10349 type: string
10350 subtype:
10351 type: string
10352 type:
10353 type: string
10354 wildcardSubtype:
10355 type: boolean
10356 wildcardType:
10357 type: boolean
10358 metadata:
10359 type: object
10360 additionalProperties:
10361 type: array
10362 items:
10363 type: object
10364 status:
10365 type: integer
10366 format: int32
10367 statusInfo:
10368 type: object
10369 properties:
10370 family:
10371 type: string
10372 enum:
10373 - INFORMATIONAL
10374 - SUCCESSFUL
10375 - REDIRECTION
10376 - CLIENT_ERROR
10377 - SERVER_ERROR
10378 - OTHER
10379 reasonPhrase:
10380 type: string
10381 statusCode:
10382 type: integer
10383 format: int32
10384 stringHeaders:
10385 type: object
10386 additionalProperties:
10387 type: array
10388 items:
10389 type: string
10390 servers:
10391 - url: /sdc2/rest
10392 variables: {}
10393 summary: 'checks if the chosen service name is available '
10394 tags:
10395 - SDCE-2 APIs
10396 /v1/catalog/services/{componentId}/archive:
10397 post:
10398 description: Archive Service
10399 operationId: archiveService
10400 parameters:
10401 - in: path
10402 name: componentId
10403 required: true
10404 schema:
10405 type: string
10406 - in: header
10407 name: USER_ID
10408 schema:
10409 type: string
10410 responses:
10411 "200":
10412 description: Archive successful
10413 "400":
10414 description: Bad request
10415 "403":
10416 description: Restricted operation
10417 "404":
10418 description: Service not found
10419 "500":
10420 description: Internal Error
10421 default:
10422 content:
10423 application/json:
10424 schema:
10425 type: array
10426 items:
10427 type: string
10428 servers:
10429 - url: /sdc2/rest
10430 variables: {}
10431 summary: Marks a service as archived. Can be restored with restore action
10432 tags:
10433 - SDCE-2 APIs
10434 /v1/catalog/services/{componentId}/copyComponentInstance/{componentInstanceId}:
10435 post:
10436 description: Copy Component Instance
10437 operationId: copyComponentInstance
10438 parameters:
10439 - description: service unique id in pasted canvas
10440 in: path
10441 name: componentId
10442 required: true
10443 schema:
10444 type: string
10445 - in: path
10446 name: componentInstanceId
10447 required: true
10448 schema:
10449 type: string
10450 requestBody:
10451 content:
10452 application/json:
10453 schema:
10454 type: string
10455 description: Data for copying
10456 required: true
10457 responses:
10458 "201":
10459 description: Copy and Paste Success
10460 "400":
10461 description: Invalid Content / Missing content
10462 "403":
10463 description: Restricted Operation
10464 default:
10465 content:
10466 application/json:
10467 schema:
10468 type: array
10469 items:
10470 $ref: '#/components/schemas/Service'
10471 servers:
10472 - url: /sdc2/rest
10473 variables: {}
10474 summary: Returns updated service information
10475 tags:
10476 - SDCE-2 APIs
10477 /v1/catalog/services/{componentId}/restore:
10478 post:
10479 description: Restore Service
10480 operationId: restoreService
10481 parameters:
10482 - in: path
10483 name: componentId
10484 required: true
10485 schema:
10486 type: string
10487 - in: header
10488 name: USER_ID
10489 schema:
10490 type: string
10491 responses:
10492 "200":
10493 description: Restore successful
10494 "400":
10495 description: Bad request
10496 "403":
10497 description: Restricted operation
10498 "404":
10499 description: Service not found
10500 "500":
10501 description: Internal Error
10502 default:
10503 content:
10504 application/json:
10505 schema:
10506 type: array
10507 items:
10508 type: string
10509 servers:
10510 - url: /sdc2/rest
10511 variables: {}
10512 summary: Restores a service from archive.
10513 tags:
10514 - SDCE-2 APIs
10515 /v1/catalog/services/{serviceId}:
10516 delete:
10517 description: Delete Service
10518 operationId: deleteService
10519 parameters:
10520 - in: path
10521 name: serviceId
10522 required: true
10523 schema:
10524 type: string
10525 - description: "Optional parameter to determine the delete action: DELETE, which\
10526 \ will permanently delete theService from the system or MARK_AS_DELETE,\
10527 \ which will logically mark the service as deleted. Default action is to\
10528 \ MARK_AS_DELETE"
10529 in: query
10530 name: deleteAction
10531 schema:
10532 type: string
10533 enum:
10534 - DELETE
10535 - MARK_AS_DELETE
10536 responses:
10537 "204":
10538 description: Service deleted
10539 "400":
10540 description: Invalid content / Missing content
10541 "403":
10542 description: Restricted operation
10543 "404":
10544 description: Service not found
10545 default:
10546 content:
10547 '*/*':
10548 schema:
10549 type: array
10550 items:
10551 $ref: '#/components/schemas/Service'
10552 servers:
10553 - url: /sdc2/rest
10554 variables: {}
10555 summary: Return no content
10556 tags:
10557 - SDCE-2 APIs
10558 get:
10559 description: Retrieve Service
10560 operationId: getServiceById_1
10561 parameters:
10562 - in: path
10563 name: serviceId
10564 required: true
10565 schema:
10566 type: string
10567 - in: header
10568 name: USER_ID
10569 schema:
10570 type: string
10571 responses:
10572 "200":
10573 description: Service found
10574 "403":
10575 description: Restricted operation
10576 "404":
10577 description: Service not found
10578 default:
10579 content:
10580 application/json:
10581 schema:
10582 type: array
10583 items:
10584 $ref: '#/components/schemas/Service'
10585 servers:
10586 - url: /sdc2/rest
10587 variables: {}
10588 summary: Returns service according to serviceId
10589 tags:
10590 - SDCE-2 APIs
10591 /v1/catalog/services/{serviceId}/additionalinfo:
10592 get:
10593 description: Get all Additional Information under service
10594 operationId: getAllServiceAdditionalInformationLabel
10595 parameters:
10596 - description: service id to update with new property
10597 in: path
10598 name: serviceId
10599 required: true
10600 schema:
10601 type: string
10602 - in: header
10603 name: USER_ID
10604 schema:
10605 type: string
10606 responses:
10607 "200":
10608 description: list of additional information
10609 "400":
10610 description: Invalid content / Missing content
10611 "403":
10612 description: Restricted operation
10613 "409":
10614 description: Additional information key already exist
10615 default:
10616 content:
10617 application/json:
10618 schema:
10619 type: array
10620 items:
10621 type: object
10622 properties:
10623 allowedMethods:
10624 type: array
10625 items:
10626 type: string
10627 uniqueItems: true
10628 cookies:
10629 type: object
10630 additionalProperties:
10631 type: object
10632 properties:
10633 comment:
10634 type: string
10635 domain:
10636 type: string
10637 expiry:
10638 type: string
10639 format: date-time
10640 httpOnly:
10641 type: boolean
10642 maxAge:
10643 type: integer
10644 format: int32
10645 name:
10646 type: string
10647 path:
10648 type: string
10649 secure:
10650 type: boolean
10651 value:
10652 type: string
10653 version:
10654 type: integer
10655 format: int32
10656 date:
10657 type: string
10658 format: date-time
10659 entity:
10660 type: object
10661 entityTag:
10662 type: object
10663 properties:
10664 value:
10665 type: string
10666 weak:
10667 type: boolean
10668 headers:
10669 type: object
10670 additionalProperties:
10671 type: array
10672 items:
10673 type: object
10674 language:
10675 type: object
10676 properties:
10677 country:
10678 type: string
10679 displayCountry:
10680 type: string
10681 displayLanguage:
10682 type: string
10683 displayName:
10684 type: string
10685 displayScript:
10686 type: string
10687 displayVariant:
10688 type: string
10689 extensionKeys:
10690 type: array
10691 items:
10692 type: string
10693 uniqueItems: true
10694 iso3Country:
10695 type: string
10696 iso3Language:
10697 type: string
10698 language:
10699 type: string
10700 script:
10701 type: string
10702 unicodeLocaleAttributes:
10703 type: array
10704 items:
10705 type: string
10706 uniqueItems: true
10707 unicodeLocaleKeys:
10708 type: array
10709 items:
10710 type: string
10711 uniqueItems: true
10712 variant:
10713 type: string
10714 lastModified:
10715 type: string
10716 format: date-time
10717 length:
10718 type: integer
10719 format: int32
10720 links:
10721 type: array
10722 items:
10723 type: object
10724 properties:
10725 params:
10726 type: object
10727 additionalProperties:
10728 type: string
10729 rel:
10730 type: string
10731 rels:
10732 type: array
10733 items:
10734 type: string
10735 title:
10736 type: string
10737 type:
10738 type: string
10739 uri:
10740 type: string
10741 format: uri
10742 uriBuilder:
10743 type: object
10744 uniqueItems: true
10745 location:
10746 type: string
10747 format: uri
10748 mediaType:
10749 type: object
10750 properties:
10751 parameters:
10752 type: object
10753 additionalProperties:
10754 type: string
10755 subtype:
10756 type: string
10757 type:
10758 type: string
10759 wildcardSubtype:
10760 type: boolean
10761 wildcardType:
10762 type: boolean
10763 metadata:
10764 type: object
10765 additionalProperties:
10766 type: array
10767 items:
10768 type: object
10769 status:
10770 type: integer
10771 format: int32
10772 statusInfo:
10773 type: object
10774 properties:
10775 family:
10776 type: string
10777 enum:
10778 - INFORMATIONAL
10779 - SUCCESSFUL
10780 - REDIRECTION
10781 - CLIENT_ERROR
10782 - SERVER_ERROR
10783 - OTHER
10784 reasonPhrase:
10785 type: string
10786 statusCode:
10787 type: integer
10788 format: int32
10789 stringHeaders:
10790 type: object
10791 additionalProperties:
10792 type: array
10793 items:
10794 type: string
10795 servers:
10796 - url: /sdc2/rest
10797 variables: {}
10798 summary: Returns Additional Inforamtion property
10799 tags:
10800 - SDCE-2 APIs
10801 post:
10802 description: Create Additional Information Label and Value
10803 operationId: createServiceAdditionalInformationLabel
10804 parameters:
10805 - description: service id to update with new property
10806 in: path
10807 name: serviceId
10808 required: true
10809 schema:
10810 type: string
10811 - in: header
10812 name: USER_ID
10813 schema:
10814 type: string
10815 requestBody:
10816 content:
10817 application/json:
10818 schema:
10819 type: string
10820 description: Additional information key value to be created
10821 required: true
10822 responses:
10823 "201":
10824 description: Additional information created
10825 "400":
10826 description: Invalid content / Missing content
10827 "403":
10828 description: Restricted operation
10829 "409":
10830 description: Additional information key already exist
10831 default:
10832 content:
10833 application/json:
10834 schema:
10835 type: array
10836 items:
10837 type: object
10838 properties:
10839 allowedMethods:
10840 type: array
10841 items:
10842 type: string
10843 uniqueItems: true
10844 cookies:
10845 type: object
10846 additionalProperties:
10847 type: object
10848 properties:
10849 comment:
10850 type: string
10851 domain:
10852 type: string
10853 expiry:
10854 type: string
10855 format: date-time
10856 httpOnly:
10857 type: boolean
10858 maxAge:
10859 type: integer
10860 format: int32
10861 name:
10862 type: string
10863 path:
10864 type: string
10865 secure:
10866 type: boolean
10867 value:
10868 type: string
10869 version:
10870 type: integer
10871 format: int32
10872 date:
10873 type: string
10874 format: date-time
10875 entity:
10876 type: object
10877 entityTag:
10878 type: object
10879 properties:
10880 value:
10881 type: string
10882 weak:
10883 type: boolean
10884 headers:
10885 type: object
10886 additionalProperties:
10887 type: array
10888 items:
10889 type: object
10890 language:
10891 type: object
10892 properties:
10893 country:
10894 type: string
10895 displayCountry:
10896 type: string
10897 displayLanguage:
10898 type: string
10899 displayName:
10900 type: string
10901 displayScript:
10902 type: string
10903 displayVariant:
10904 type: string
10905 extensionKeys:
10906 type: array
10907 items:
10908 type: string
10909 uniqueItems: true
10910 iso3Country:
10911 type: string
10912 iso3Language:
10913 type: string
10914 language:
10915 type: string
10916 script:
10917 type: string
10918 unicodeLocaleAttributes:
10919 type: array
10920 items:
10921 type: string
10922 uniqueItems: true
10923 unicodeLocaleKeys:
10924 type: array
10925 items:
10926 type: string
10927 uniqueItems: true
10928 variant:
10929 type: string
10930 lastModified:
10931 type: string
10932 format: date-time
10933 length:
10934 type: integer
10935 format: int32
10936 links:
10937 type: array
10938 items:
10939 type: object
10940 properties:
10941 params:
10942 type: object
10943 additionalProperties:
10944 type: string
10945 rel:
10946 type: string
10947 rels:
10948 type: array
10949 items:
10950 type: string
10951 title:
10952 type: string
10953 type:
10954 type: string
10955 uri:
10956 type: string
10957 format: uri
10958 uriBuilder:
10959 type: object
10960 uniqueItems: true
10961 location:
10962 type: string
10963 format: uri
10964 mediaType:
10965 type: object
10966 properties:
10967 parameters:
10968 type: object
10969 additionalProperties:
10970 type: string
10971 subtype:
10972 type: string
10973 type:
10974 type: string
10975 wildcardSubtype:
10976 type: boolean
10977 wildcardType:
10978 type: boolean
10979 metadata:
10980 type: object
10981 additionalProperties:
10982 type: array
10983 items:
10984 type: object
10985 status:
10986 type: integer
10987 format: int32
10988 statusInfo:
10989 type: object
10990 properties:
10991 family:
10992 type: string
10993 enum:
10994 - INFORMATIONAL
10995 - SUCCESSFUL
10996 - REDIRECTION
10997 - CLIENT_ERROR
10998 - SERVER_ERROR
10999 - OTHER
11000 reasonPhrase:
11001 type: string
11002 statusCode:
11003 type: integer
11004 format: int32
11005 stringHeaders:
11006 type: object
11007 additionalProperties:
11008 type: array
11009 items:
11010 type: string
11011 servers:
11012 - url: /sdc2/rest
11013 variables: {}
11014 summary: Returns created Additional Inforamtion property
11015 tags:
11016 - SDCE-2 APIs
11017 /v1/catalog/services/{serviceId}/additionalinfo/{labelId}:
11018 delete:
11019 description: Create Additional Information Label and Value
11020 operationId: deleteServiceAdditionalInformationLabel
11021 parameters:
11022 - description: service id to update with new property
11023 in: path
11024 name: serviceId
11025 required: true
11026 schema:
11027 type: string
11028 - description: label id
11029 in: path
11030 name: labelId
11031 required: true
11032 schema:
11033 type: string
11034 - in: header
11035 name: USER_ID
11036 schema:
11037 type: string
11038 responses:
11039 "200":
11040 description: Additional information deleted
11041 "400":
11042 description: Invalid content / Missing content
11043 "403":
11044 description: Restricted operation
11045 "409":
11046 description: Additional information key already exist
11047 default:
11048 content:
11049 application/json:
11050 schema:
11051 type: array
11052 items:
11053 type: object
11054 properties:
11055 allowedMethods:
11056 type: array
11057 items:
11058 type: string
11059 uniqueItems: true
11060 cookies:
11061 type: object
11062 additionalProperties:
11063 type: object
11064 properties:
11065 comment:
11066 type: string
11067 domain:
11068 type: string
11069 expiry:
11070 type: string
11071 format: date-time
11072 httpOnly:
11073 type: boolean
11074 maxAge:
11075 type: integer
11076 format: int32
11077 name:
11078 type: string
11079 path:
11080 type: string
11081 secure:
11082 type: boolean
11083 value:
11084 type: string
11085 version:
11086 type: integer
11087 format: int32
11088 date:
11089 type: string
11090 format: date-time
11091 entity:
11092 type: object
11093 entityTag:
11094 type: object
11095 properties:
11096 value:
11097 type: string
11098 weak:
11099 type: boolean
11100 headers:
11101 type: object
11102 additionalProperties:
11103 type: array
11104 items:
11105 type: object
11106 language:
11107 type: object
11108 properties:
11109 country:
11110 type: string
11111 displayCountry:
11112 type: string
11113 displayLanguage:
11114 type: string
11115 displayName:
11116 type: string
11117 displayScript:
11118 type: string
11119 displayVariant:
11120 type: string
11121 extensionKeys:
11122 type: array
11123 items:
11124 type: string
11125 uniqueItems: true
11126 iso3Country:
11127 type: string
11128 iso3Language:
11129 type: string
11130 language:
11131 type: string
11132 script:
11133 type: string
11134 unicodeLocaleAttributes:
11135 type: array
11136 items:
11137 type: string
11138 uniqueItems: true
11139 unicodeLocaleKeys:
11140 type: array
11141 items:
11142 type: string
11143 uniqueItems: true
11144 variant:
11145 type: string
11146 lastModified:
11147 type: string
11148 format: date-time
11149 length:
11150 type: integer
11151 format: int32
11152 links:
11153 type: array
11154 items:
11155 type: object
11156 properties:
11157 params:
11158 type: object
11159 additionalProperties:
11160 type: string
11161 rel:
11162 type: string
11163 rels:
11164 type: array
11165 items:
11166 type: string
11167 title:
11168 type: string
11169 type:
11170 type: string
11171 uri:
11172 type: string
11173 format: uri
11174 uriBuilder:
11175 type: object
11176 uniqueItems: true
11177 location:
11178 type: string
11179 format: uri
11180 mediaType:
11181 type: object
11182 properties:
11183 parameters:
11184 type: object
11185 additionalProperties:
11186 type: string
11187 subtype:
11188 type: string
11189 type:
11190 type: string
11191 wildcardSubtype:
11192 type: boolean
11193 wildcardType:
11194 type: boolean
11195 metadata:
11196 type: object
11197 additionalProperties:
11198 type: array
11199 items:
11200 type: object
11201 status:
11202 type: integer
11203 format: int32
11204 statusInfo:
11205 type: object
11206 properties:
11207 family:
11208 type: string
11209 enum:
11210 - INFORMATIONAL
11211 - SUCCESSFUL
11212 - REDIRECTION
11213 - CLIENT_ERROR
11214 - SERVER_ERROR
11215 - OTHER
11216 reasonPhrase:
11217 type: string
11218 statusCode:
11219 type: integer
11220 format: int32
11221 stringHeaders:
11222 type: object
11223 additionalProperties:
11224 type: array
11225 items:
11226 type: string
11227 servers:
11228 - url: /sdc2/rest
11229 variables: {}
11230 summary: Returns deleted Additional Inforamtion property
11231 tags:
11232 - SDCE-2 APIs
11233 get:
11234 description: Get Additional Information by id
11235 operationId: getServiceAdditionalInformationLabel
11236 parameters:
11237 - description: service id to update with new property
11238 in: path
11239 name: serviceId
11240 required: true
11241 schema:
11242 type: string
11243 - description: label id
11244 in: path
11245 name: labelId
11246 required: true
11247 schema:
11248 type: string
11249 - in: header
11250 name: USER_ID
11251 schema:
11252 type: string
11253 responses:
11254 "200":
11255 description: fetched additional information
11256 "400":
11257 description: Invalid content / Missing content
11258 "403":
11259 description: Restricted operation
11260 "409":
11261 description: Additional information key already exist
11262 default:
11263 content:
11264 application/json:
11265 schema:
11266 type: array
11267 items:
11268 type: object
11269 properties:
11270 allowedMethods:
11271 type: array
11272 items:
11273 type: string
11274 uniqueItems: true
11275 cookies:
11276 type: object
11277 additionalProperties:
11278 type: object
11279 properties:
11280 comment:
11281 type: string
11282 domain:
11283 type: string
11284 expiry:
11285 type: string
11286 format: date-time
11287 httpOnly:
11288 type: boolean
11289 maxAge:
11290 type: integer
11291 format: int32
11292 name:
11293 type: string
11294 path:
11295 type: string
11296 secure:
11297 type: boolean
11298 value:
11299 type: string
11300 version:
11301 type: integer
11302 format: int32
11303 date:
11304 type: string
11305 format: date-time
11306 entity:
11307 type: object
11308 entityTag:
11309 type: object
11310 properties:
11311 value:
11312 type: string
11313 weak:
11314 type: boolean
11315 headers:
11316 type: object
11317 additionalProperties:
11318 type: array
11319 items:
11320 type: object
11321 language:
11322 type: object
11323 properties:
11324 country:
11325 type: string
11326 displayCountry:
11327 type: string
11328 displayLanguage:
11329 type: string
11330 displayName:
11331 type: string
11332 displayScript:
11333 type: string
11334 displayVariant:
11335 type: string
11336 extensionKeys:
11337 type: array
11338 items:
11339 type: string
11340 uniqueItems: true
11341 iso3Country:
11342 type: string
11343 iso3Language:
11344 type: string
11345 language:
11346 type: string
11347 script:
11348 type: string
11349 unicodeLocaleAttributes:
11350 type: array
11351 items:
11352 type: string
11353 uniqueItems: true
11354 unicodeLocaleKeys:
11355 type: array
11356 items:
11357 type: string
11358 uniqueItems: true
11359 variant:
11360 type: string
11361 lastModified:
11362 type: string
11363 format: date-time
11364 length:
11365 type: integer
11366 format: int32
11367 links:
11368 type: array
11369 items:
11370 type: object
11371 properties:
11372 params:
11373 type: object
11374 additionalProperties:
11375 type: string
11376 rel:
11377 type: string
11378 rels:
11379 type: array
11380 items:
11381 type: string
11382 title:
11383 type: string
11384 type:
11385 type: string
11386 uri:
11387 type: string
11388 format: uri
11389 uriBuilder:
11390 type: object
11391 uniqueItems: true
11392 location:
11393 type: string
11394 format: uri
11395 mediaType:
11396 type: object
11397 properties:
11398 parameters:
11399 type: object
11400 additionalProperties:
11401 type: string
11402 subtype:
11403 type: string
11404 type:
11405 type: string
11406 wildcardSubtype:
11407 type: boolean
11408 wildcardType:
11409 type: boolean
11410 metadata:
11411 type: object
11412 additionalProperties:
11413 type: array
11414 items:
11415 type: object
11416 status:
11417 type: integer
11418 format: int32
11419 statusInfo:
11420 type: object
11421 properties:
11422 family:
11423 type: string
11424 enum:
11425 - INFORMATIONAL
11426 - SUCCESSFUL
11427 - REDIRECTION
11428 - CLIENT_ERROR
11429 - SERVER_ERROR
11430 - OTHER
11431 reasonPhrase:
11432 type: string
11433 statusCode:
11434 type: integer
11435 format: int32
11436 stringHeaders:
11437 type: object
11438 additionalProperties:
11439 type: array
11440 items:
11441 type: string
11442 servers:
11443 - url: /sdc2/rest
11444 variables: {}
11445 summary: Returns Additional Inforamtion property
11446 tags:
11447 - SDCE-2 APIs
11448 put:
11449 description: Update Additional Information Label and Value
11450 operationId: updateServiceAdditionalInformationLabel
11451 parameters:
11452 - description: service id to update with new property
11453 in: path
11454 name: serviceId
11455 required: true
11456 schema:
11457 type: string
11458 - description: label id
11459 in: path
11460 name: labelId
11461 required: true
11462 schema:
11463 type: string
11464 - in: header
11465 name: USER_ID
11466 schema:
11467 type: string
11468 requestBody:
11469 content:
11470 application/json:
11471 schema:
11472 type: string
11473 description: Additional information key value to be created
11474 required: true
11475 responses:
11476 "200":
11477 description: Additional information updated
11478 "400":
11479 description: Invalid content / Missing content
11480 "403":
11481 description: Restricted operation
11482 "409":
11483 description: Additional information key already exist
11484 default:
11485 content:
11486 application/json:
11487 schema:
11488 type: array
11489 items:
11490 type: object
11491 properties:
11492 allowedMethods:
11493 type: array
11494 items:
11495 type: string
11496 uniqueItems: true
11497 cookies:
11498 type: object
11499 additionalProperties:
11500 type: object
11501 properties:
11502 comment:
11503 type: string
11504 domain:
11505 type: string
11506 expiry:
11507 type: string
11508 format: date-time
11509 httpOnly:
11510 type: boolean
11511 maxAge:
11512 type: integer
11513 format: int32
11514 name:
11515 type: string
11516 path:
11517 type: string
11518 secure:
11519 type: boolean
11520 value:
11521 type: string
11522 version:
11523 type: integer
11524 format: int32
11525 date:
11526 type: string
11527 format: date-time
11528 entity:
11529 type: object
11530 entityTag:
11531 type: object
11532 properties:
11533 value:
11534 type: string
11535 weak:
11536 type: boolean
11537 headers:
11538 type: object
11539 additionalProperties:
11540 type: array
11541 items:
11542 type: object
11543 language:
11544 type: object
11545 properties:
11546 country:
11547 type: string
11548 displayCountry:
11549 type: string
11550 displayLanguage:
11551 type: string
11552 displayName:
11553 type: string
11554 displayScript:
11555 type: string
11556 displayVariant:
11557 type: string
11558 extensionKeys:
11559 type: array
11560 items:
11561 type: string
11562 uniqueItems: true
11563 iso3Country:
11564 type: string
11565 iso3Language:
11566 type: string
11567 language:
11568 type: string
11569 script:
11570 type: string
11571 unicodeLocaleAttributes:
11572 type: array
11573 items:
11574 type: string
11575 uniqueItems: true
11576 unicodeLocaleKeys:
11577 type: array
11578 items:
11579 type: string
11580 uniqueItems: true
11581 variant:
11582 type: string
11583 lastModified:
11584 type: string
11585 format: date-time
11586 length:
11587 type: integer
11588 format: int32
11589 links:
11590 type: array
11591 items:
11592 type: object
11593 properties:
11594 params:
11595 type: object
11596 additionalProperties:
11597 type: string
11598 rel:
11599 type: string
11600 rels:
11601 type: array
11602 items:
11603 type: string
11604 title:
11605 type: string
11606 type:
11607 type: string
11608 uri:
11609 type: string
11610 format: uri
11611 uriBuilder:
11612 type: object
11613 uniqueItems: true
11614 location:
11615 type: string
11616 format: uri
11617 mediaType:
11618 type: object
11619 properties:
11620 parameters:
11621 type: object
11622 additionalProperties:
11623 type: string
11624 subtype:
11625 type: string
11626 type:
11627 type: string
11628 wildcardSubtype:
11629 type: boolean
11630 wildcardType:
11631 type: boolean
11632 metadata:
11633 type: object
11634 additionalProperties:
11635 type: array
11636 items:
11637 type: object
11638 status:
11639 type: integer
11640 format: int32
11641 statusInfo:
11642 type: object
11643 properties:
11644 family:
11645 type: string
11646 enum:
11647 - INFORMATIONAL
11648 - SUCCESSFUL
11649 - REDIRECTION
11650 - CLIENT_ERROR
11651 - SERVER_ERROR
11652 - OTHER
11653 reasonPhrase:
11654 type: string
11655 statusCode:
11656 type: integer
11657 format: int32
11658 stringHeaders:
11659 type: object
11660 additionalProperties:
11661 type: array
11662 items:
11663 type: string
11664 servers:
11665 - url: /sdc2/rest
11666 variables: {}
11667 summary: Returns updated Additional Inforamtion property
11668 tags:
11669 - SDCE-2 APIs
11670 /v1/catalog/services/{serviceId}/artifacts:
11671 post:
11672 description: Create Artifact
11673 operationId: loadInformationArtifact
11674 parameters:
11675 - in: path
11676 name: serviceId
11677 required: true
11678 schema:
11679 type: string
11680 requestBody:
11681 content:
11682 application/json:
11683 schema:
11684 type: string
11685 description: json describe the artifact
11686 required: true
11687 responses:
11688 "201":
11689 description: Resource created
11690 "400":
11691 description: Invalid content / Missing content
11692 "403":
11693 description: Restricted operation
11694 "409":
11695 description: Artifact already exist
11696 default:
11697 content:
11698 application/json:
11699 schema:
11700 type: array
11701 items:
11702 type: object
11703 properties:
11704 allowedMethods:
11705 type: array
11706 items:
11707 type: string
11708 uniqueItems: true
11709 cookies:
11710 type: object
11711 additionalProperties:
11712 type: object
11713 properties:
11714 comment:
11715 type: string
11716 domain:
11717 type: string
11718 expiry:
11719 type: string
11720 format: date-time
11721 httpOnly:
11722 type: boolean
11723 maxAge:
11724 type: integer
11725 format: int32
11726 name:
11727 type: string
11728 path:
11729 type: string
11730 secure:
11731 type: boolean
11732 value:
11733 type: string
11734 version:
11735 type: integer
11736 format: int32
11737 date:
11738 type: string
11739 format: date-time
11740 entity:
11741 type: object
11742 entityTag:
11743 type: object
11744 properties:
11745 value:
11746 type: string
11747 weak:
11748 type: boolean
11749 headers:
11750 type: object
11751 additionalProperties:
11752 type: array
11753 items:
11754 type: object
11755 language:
11756 type: object
11757 properties:
11758 country:
11759 type: string
11760 displayCountry:
11761 type: string
11762 displayLanguage:
11763 type: string
11764 displayName:
11765 type: string
11766 displayScript:
11767 type: string
11768 displayVariant:
11769 type: string
11770 extensionKeys:
11771 type: array
11772 items:
11773 type: string
11774 uniqueItems: true
11775 iso3Country:
11776 type: string
11777 iso3Language:
11778 type: string
11779 language:
11780 type: string
11781 script:
11782 type: string
11783 unicodeLocaleAttributes:
11784 type: array
11785 items:
11786 type: string
11787 uniqueItems: true
11788 unicodeLocaleKeys:
11789 type: array
11790 items:
11791 type: string
11792 uniqueItems: true
11793 variant:
11794 type: string
11795 lastModified:
11796 type: string
11797 format: date-time
11798 length:
11799 type: integer
11800 format: int32
11801 links:
11802 type: array
11803 items:
11804 type: object
11805 properties:
11806 params:
11807 type: object
11808 additionalProperties:
11809 type: string
11810 rel:
11811 type: string
11812 rels:
11813 type: array
11814 items:
11815 type: string
11816 title:
11817 type: string
11818 type:
11819 type: string
11820 uri:
11821 type: string
11822 format: uri
11823 uriBuilder:
11824 type: object
11825 uniqueItems: true
11826 location:
11827 type: string
11828 format: uri
11829 mediaType:
11830 type: object
11831 properties:
11832 parameters:
11833 type: object
11834 additionalProperties:
11835 type: string
11836 subtype:
11837 type: string
11838 type:
11839 type: string
11840 wildcardSubtype:
11841 type: boolean
11842 wildcardType:
11843 type: boolean
11844 metadata:
11845 type: object
11846 additionalProperties:
11847 type: array
11848 items:
11849 type: object
11850 status:
11851 type: integer
11852 format: int32
11853 statusInfo:
11854 type: object
11855 properties:
11856 family:
11857 type: string
11858 enum:
11859 - INFORMATIONAL
11860 - SUCCESSFUL
11861 - REDIRECTION
11862 - CLIENT_ERROR
11863 - SERVER_ERROR
11864 - OTHER
11865 reasonPhrase:
11866 type: string
11867 statusCode:
11868 type: integer
11869 format: int32
11870 stringHeaders:
11871 type: object
11872 additionalProperties:
11873 type: array
11874 items:
11875 type: string
11876 servers:
11877 - url: /sdc2/rest
11878 variables: {}
11879 summary: Returns created ArtifactDefinition
11880 tags:
11881 - SDCE-2 APIs
11882 /v1/catalog/services/{serviceId}/artifacts/api/{artifactId}:
11883 delete:
11884 description: Delete Api Artifact
11885 operationId: deleteApiArtifact
11886 parameters:
11887 - in: path
11888 name: serviceId
11889 required: true
11890 schema:
11891 type: string
11892 - in: path
11893 name: artifactId
11894 required: true
11895 schema:
11896 type: string
11897 - in: header
11898 name: USER_ID
11899 schema:
11900 type: string
11901 - in: header
11902 name: Content-MD5
11903 schema:
11904 type: string
11905 responses:
11906 "204":
11907 description: Api Artifact deleted
11908 "403":
11909 description: Restricted operation
11910 default:
11911 content:
11912 application/json:
11913 schema:
11914 type: array
11915 items:
11916 type: object
11917 properties:
11918 allowedMethods:
11919 type: array
11920 items:
11921 type: string
11922 uniqueItems: true
11923 cookies:
11924 type: object
11925 additionalProperties:
11926 type: object
11927 properties:
11928 comment:
11929 type: string
11930 domain:
11931 type: string
11932 expiry:
11933 type: string
11934 format: date-time
11935 httpOnly:
11936 type: boolean
11937 maxAge:
11938 type: integer
11939 format: int32
11940 name:
11941 type: string
11942 path:
11943 type: string
11944 secure:
11945 type: boolean
11946 value:
11947 type: string
11948 version:
11949 type: integer
11950 format: int32
11951 date:
11952 type: string
11953 format: date-time
11954 entity:
11955 type: object
11956 entityTag:
11957 type: object
11958 properties:
11959 value:
11960 type: string
11961 weak:
11962 type: boolean
11963 headers:
11964 type: object
11965 additionalProperties:
11966 type: array
11967 items:
11968 type: object
11969 language:
11970 type: object
11971 properties:
11972 country:
11973 type: string
11974 displayCountry:
11975 type: string
11976 displayLanguage:
11977 type: string
11978 displayName:
11979 type: string
11980 displayScript:
11981 type: string
11982 displayVariant:
11983 type: string
11984 extensionKeys:
11985 type: array
11986 items:
11987 type: string
11988 uniqueItems: true
11989 iso3Country:
11990 type: string
11991 iso3Language:
11992 type: string
11993 language:
11994 type: string
11995 script:
11996 type: string
11997 unicodeLocaleAttributes:
11998 type: array
11999 items:
12000 type: string
12001 uniqueItems: true
12002 unicodeLocaleKeys:
12003 type: array
12004 items:
12005 type: string
12006 uniqueItems: true
12007 variant:
12008 type: string
12009 lastModified:
12010 type: string
12011 format: date-time
12012 length:
12013 type: integer
12014 format: int32
12015 links:
12016 type: array
12017 items:
12018 type: object
12019 properties:
12020 params:
12021 type: object
12022 additionalProperties:
12023 type: string
12024 rel:
12025 type: string
12026 rels:
12027 type: array
12028 items:
12029 type: string
12030 title:
12031 type: string
12032 type:
12033 type: string
12034 uri:
12035 type: string
12036 format: uri
12037 uriBuilder:
12038 type: object
12039 uniqueItems: true
12040 location:
12041 type: string
12042 format: uri
12043 mediaType:
12044 type: object
12045 properties:
12046 parameters:
12047 type: object
12048 additionalProperties:
12049 type: string
12050 subtype:
12051 type: string
12052 type:
12053 type: string
12054 wildcardSubtype:
12055 type: boolean
12056 wildcardType:
12057 type: boolean
12058 metadata:
12059 type: object
12060 additionalProperties:
12061 type: array
12062 items:
12063 type: object
12064 status:
12065 type: integer
12066 format: int32
12067 statusInfo:
12068 type: object
12069 properties:
12070 family:
12071 type: string
12072 enum:
12073 - INFORMATIONAL
12074 - SUCCESSFUL
12075 - REDIRECTION
12076 - CLIENT_ERROR
12077 - SERVER_ERROR
12078 - OTHER
12079 reasonPhrase:
12080 type: string
12081 statusCode:
12082 type: integer
12083 format: int32
12084 stringHeaders:
12085 type: object
12086 additionalProperties:
12087 type: array
12088 items:
12089 type: string
12090 servers:
12091 - url: /sdc2/rest
12092 variables: {}
12093 summary: Returns Deleted ArtifactDefinition
12094 tags:
12095 - SDCE-2 APIs
12096 post:
12097 description: Update Api Artifact
12098 operationId: updateApiArtifact
12099 parameters:
12100 - in: path
12101 name: serviceId
12102 required: true
12103 schema:
12104 type: string
12105 - in: path
12106 name: artifactId
12107 required: true
12108 schema:
12109 type: string
12110 - in: header
12111 name: USER_ID
12112 schema:
12113 type: string
12114 - in: header
12115 name: Content-MD5
12116 schema:
12117 type: string
12118 requestBody:
12119 content:
12120 application/json:
12121 schema:
12122 type: string
12123 description: json describe the artifact
12124 required: true
12125 responses:
12126 "200":
12127 description: Api Artifact Updated
12128 "400":
12129 description: Invalid content / Missing content
12130 "403":
12131 description: Restricted operation
12132 default:
12133 content:
12134 application/json:
12135 schema:
12136 type: array
12137 items:
12138 type: object
12139 properties:
12140 allowedMethods:
12141 type: array
12142 items:
12143 type: string
12144 uniqueItems: true
12145 cookies:
12146 type: object
12147 additionalProperties:
12148 type: object
12149 properties:
12150 comment:
12151 type: string
12152 domain:
12153 type: string
12154 expiry:
12155 type: string
12156 format: date-time
12157 httpOnly:
12158 type: boolean
12159 maxAge:
12160 type: integer
12161 format: int32
12162 name:
12163 type: string
12164 path:
12165 type: string
12166 secure:
12167 type: boolean
12168 value:
12169 type: string
12170 version:
12171 type: integer
12172 format: int32
12173 date:
12174 type: string
12175 format: date-time
12176 entity:
12177 type: object
12178 entityTag:
12179 type: object
12180 properties:
12181 value:
12182 type: string
12183 weak:
12184 type: boolean
12185 headers:
12186 type: object
12187 additionalProperties:
12188 type: array
12189 items:
12190 type: object
12191 language:
12192 type: object
12193 properties:
12194 country:
12195 type: string
12196 displayCountry:
12197 type: string
12198 displayLanguage:
12199 type: string
12200 displayName:
12201 type: string
12202 displayScript:
12203 type: string
12204 displayVariant:
12205 type: string
12206 extensionKeys:
12207 type: array
12208 items:
12209 type: string
12210 uniqueItems: true
12211 iso3Country:
12212 type: string
12213 iso3Language:
12214 type: string
12215 language:
12216 type: string
12217 script:
12218 type: string
12219 unicodeLocaleAttributes:
12220 type: array
12221 items:
12222 type: string
12223 uniqueItems: true
12224 unicodeLocaleKeys:
12225 type: array
12226 items:
12227 type: string
12228 uniqueItems: true
12229 variant:
12230 type: string
12231 lastModified:
12232 type: string
12233 format: date-time
12234 length:
12235 type: integer
12236 format: int32
12237 links:
12238 type: array
12239 items:
12240 type: object
12241 properties:
12242 params:
12243 type: object
12244 additionalProperties:
12245 type: string
12246 rel:
12247 type: string
12248 rels:
12249 type: array
12250 items:
12251 type: string
12252 title:
12253 type: string
12254 type:
12255 type: string
12256 uri:
12257 type: string
12258 format: uri
12259 uriBuilder:
12260 type: object
12261 uniqueItems: true
12262 location:
12263 type: string
12264 format: uri
12265 mediaType:
12266 type: object
12267 properties:
12268 parameters:
12269 type: object
12270 additionalProperties:
12271 type: string
12272 subtype:
12273 type: string
12274 type:
12275 type: string
12276 wildcardSubtype:
12277 type: boolean
12278 wildcardType:
12279 type: boolean
12280 metadata:
12281 type: object
12282 additionalProperties:
12283 type: array
12284 items:
12285 type: object
12286 status:
12287 type: integer
12288 format: int32
12289 statusInfo:
12290 type: object
12291 properties:
12292 family:
12293 type: string
12294 enum:
12295 - INFORMATIONAL
12296 - SUCCESSFUL
12297 - REDIRECTION
12298 - CLIENT_ERROR
12299 - SERVER_ERROR
12300 - OTHER
12301 reasonPhrase:
12302 type: string
12303 statusCode:
12304 type: integer
12305 format: int32
12306 stringHeaders:
12307 type: object
12308 additionalProperties:
12309 type: array
12310 items:
12311 type: string
12312 servers:
12313 - url: /sdc2/rest
12314 variables: {}
12315 summary: Returns created ArtifactDefinition
12316 tags:
12317 - SDCE-2 APIs
12318 /v1/catalog/services/{serviceId}/artifacts/{artifactId}:
12319 delete:
12320 description: Delete Artifact
12321 operationId: deleteInformationalArtifact
12322 parameters:
12323 - in: path
12324 name: serviceId
12325 required: true
12326 schema:
12327 type: string
12328 - in: path
12329 name: artifactId
12330 required: true
12331 schema:
12332 type: string
12333 responses:
12334 "201":
12335 description: Service artifact deleted
12336 "400":
12337 description: Invalid content / Missing content
12338 "403":
12339 description: Restricted operation
12340 default:
12341 content:
12342 application/json:
12343 schema:
12344 type: array
12345 items:
12346 type: object
12347 properties:
12348 allowedMethods:
12349 type: array
12350 items:
12351 type: string
12352 uniqueItems: true
12353 cookies:
12354 type: object
12355 additionalProperties:
12356 type: object
12357 properties:
12358 comment:
12359 type: string
12360 domain:
12361 type: string
12362 expiry:
12363 type: string
12364 format: date-time
12365 httpOnly:
12366 type: boolean
12367 maxAge:
12368 type: integer
12369 format: int32
12370 name:
12371 type: string
12372 path:
12373 type: string
12374 secure:
12375 type: boolean
12376 value:
12377 type: string
12378 version:
12379 type: integer
12380 format: int32
12381 date:
12382 type: string
12383 format: date-time
12384 entity:
12385 type: object
12386 entityTag:
12387 type: object
12388 properties:
12389 value:
12390 type: string
12391 weak:
12392 type: boolean
12393 headers:
12394 type: object
12395 additionalProperties:
12396 type: array
12397 items:
12398 type: object
12399 language:
12400 type: object
12401 properties:
12402 country:
12403 type: string
12404 displayCountry:
12405 type: string
12406 displayLanguage:
12407 type: string
12408 displayName:
12409 type: string
12410 displayScript:
12411 type: string
12412 displayVariant:
12413 type: string
12414 extensionKeys:
12415 type: array
12416 items:
12417 type: string
12418 uniqueItems: true
12419 iso3Country:
12420 type: string
12421 iso3Language:
12422 type: string
12423 language:
12424 type: string
12425 script:
12426 type: string
12427 unicodeLocaleAttributes:
12428 type: array
12429 items:
12430 type: string
12431 uniqueItems: true
12432 unicodeLocaleKeys:
12433 type: array
12434 items:
12435 type: string
12436 uniqueItems: true
12437 variant:
12438 type: string
12439 lastModified:
12440 type: string
12441 format: date-time
12442 length:
12443 type: integer
12444 format: int32
12445 links:
12446 type: array
12447 items:
12448 type: object
12449 properties:
12450 params:
12451 type: object
12452 additionalProperties:
12453 type: string
12454 rel:
12455 type: string
12456 rels:
12457 type: array
12458 items:
12459 type: string
12460 title:
12461 type: string
12462 type:
12463 type: string
12464 uri:
12465 type: string
12466 format: uri
12467 uriBuilder:
12468 type: object
12469 uniqueItems: true
12470 location:
12471 type: string
12472 format: uri
12473 mediaType:
12474 type: object
12475 properties:
12476 parameters:
12477 type: object
12478 additionalProperties:
12479 type: string
12480 subtype:
12481 type: string
12482 type:
12483 type: string
12484 wildcardSubtype:
12485 type: boolean
12486 wildcardType:
12487 type: boolean
12488 metadata:
12489 type: object
12490 additionalProperties:
12491 type: array
12492 items:
12493 type: object
12494 status:
12495 type: integer
12496 format: int32
12497 statusInfo:
12498 type: object
12499 properties:
12500 family:
12501 type: string
12502 enum:
12503 - INFORMATIONAL
12504 - SUCCESSFUL
12505 - REDIRECTION
12506 - CLIENT_ERROR
12507 - SERVER_ERROR
12508 - OTHER
12509 reasonPhrase:
12510 type: string
12511 statusCode:
12512 type: integer
12513 format: int32
12514 stringHeaders:
12515 type: object
12516 additionalProperties:
12517 type: array
12518 items:
12519 type: string
12520 servers:
12521 - url: /sdc2/rest
12522 variables: {}
12523 summary: Returns delete artifact
12524 tags:
12525 - SDCE-2 APIs
12526 get:
12527 description: Download service Artifact in Base64
12528 operationId: downloadServiceArtifactBase64
12529 parameters:
12530 - in: path
12531 name: serviceId
12532 required: true
12533 schema:
12534 type: string
12535 - in: path
12536 name: artifactId
12537 required: true
12538 schema:
12539 type: string
12540 responses:
12541 "200":
12542 description: Service artifact downloaded
12543 "404":
12544 description: Service/Artifact not found
12545 default:
12546 content:
12547 application/json:
12548 schema:
12549 type: array
12550 items:
12551 type: object
12552 properties:
12553 allowedMethods:
12554 type: array
12555 items:
12556 type: string
12557 uniqueItems: true
12558 cookies:
12559 type: object
12560 additionalProperties:
12561 type: object
12562 properties:
12563 comment:
12564 type: string
12565 domain:
12566 type: string
12567 expiry:
12568 type: string
12569 format: date-time
12570 httpOnly:
12571 type: boolean
12572 maxAge:
12573 type: integer
12574 format: int32
12575 name:
12576 type: string
12577 path:
12578 type: string
12579 secure:
12580 type: boolean
12581 value:
12582 type: string
12583 version:
12584 type: integer
12585 format: int32
12586 date:
12587 type: string
12588 format: date-time
12589 entity:
12590 type: object
12591 entityTag:
12592 type: object
12593 properties:
12594 value:
12595 type: string
12596 weak:
12597 type: boolean
12598 headers:
12599 type: object
12600 additionalProperties:
12601 type: array
12602 items:
12603 type: object
12604 language:
12605 type: object
12606 properties:
12607 country:
12608 type: string
12609 displayCountry:
12610 type: string
12611 displayLanguage:
12612 type: string
12613 displayName:
12614 type: string
12615 displayScript:
12616 type: string
12617 displayVariant:
12618 type: string
12619 extensionKeys:
12620 type: array
12621 items:
12622 type: string
12623 uniqueItems: true
12624 iso3Country:
12625 type: string
12626 iso3Language:
12627 type: string
12628 language:
12629 type: string
12630 script:
12631 type: string
12632 unicodeLocaleAttributes:
12633 type: array
12634 items:
12635 type: string
12636 uniqueItems: true
12637 unicodeLocaleKeys:
12638 type: array
12639 items:
12640 type: string
12641 uniqueItems: true
12642 variant:
12643 type: string
12644 lastModified:
12645 type: string
12646 format: date-time
12647 length:
12648 type: integer
12649 format: int32
12650 links:
12651 type: array
12652 items:
12653 type: object
12654 properties:
12655 params:
12656 type: object
12657 additionalProperties:
12658 type: string
12659 rel:
12660 type: string
12661 rels:
12662 type: array
12663 items:
12664 type: string
12665 title:
12666 type: string
12667 type:
12668 type: string
12669 uri:
12670 type: string
12671 format: uri
12672 uriBuilder:
12673 type: object
12674 uniqueItems: true
12675 location:
12676 type: string
12677 format: uri
12678 mediaType:
12679 type: object
12680 properties:
12681 parameters:
12682 type: object
12683 additionalProperties:
12684 type: string
12685 subtype:
12686 type: string
12687 type:
12688 type: string
12689 wildcardSubtype:
12690 type: boolean
12691 wildcardType:
12692 type: boolean
12693 metadata:
12694 type: object
12695 additionalProperties:
12696 type: array
12697 items:
12698 type: object
12699 status:
12700 type: integer
12701 format: int32
12702 statusInfo:
12703 type: object
12704 properties:
12705 family:
12706 type: string
12707 enum:
12708 - INFORMATIONAL
12709 - SUCCESSFUL
12710 - REDIRECTION
12711 - CLIENT_ERROR
12712 - SERVER_ERROR
12713 - OTHER
12714 reasonPhrase:
12715 type: string
12716 statusCode:
12717 type: integer
12718 format: int32
12719 stringHeaders:
12720 type: object
12721 additionalProperties:
12722 type: array
12723 items:
12724 type: string
12725 servers:
12726 - url: /sdc2/rest
12727 variables: {}
12728 summary: Returns downloaded artifact
12729 tags:
12730 - SDCE-2 APIs
12731 post:
12732 description: Update Artifact
12733 operationId: updateInformationArtifact
12734 parameters:
12735 - in: path
12736 name: serviceId
12737 required: true
12738 schema:
12739 type: string
12740 - in: path
12741 name: artifactId
12742 required: true
12743 schema:
12744 type: string
12745 requestBody:
12746 content:
12747 application/json:
12748 schema:
12749 type: string
12750 description: json describe the artifact
12751 required: true
12752 responses:
12753 "201":
12754 description: Service artifact created
12755 "400":
12756 description: Invalid content / Missing content
12757 "403":
12758 description: Restricted operation
12759 default:
12760 content:
12761 application/json:
12762 schema:
12763 type: array
12764 items:
12765 type: object
12766 properties:
12767 allowedMethods:
12768 type: array
12769 items:
12770 type: string
12771 uniqueItems: true
12772 cookies:
12773 type: object
12774 additionalProperties:
12775 type: object
12776 properties:
12777 comment:
12778 type: string
12779 domain:
12780 type: string
12781 expiry:
12782 type: string
12783 format: date-time
12784 httpOnly:
12785 type: boolean
12786 maxAge:
12787 type: integer
12788 format: int32
12789 name:
12790 type: string
12791 path:
12792 type: string
12793 secure:
12794 type: boolean
12795 value:
12796 type: string
12797 version:
12798 type: integer
12799 format: int32
12800 date:
12801 type: string
12802 format: date-time
12803 entity:
12804 type: object
12805 entityTag:
12806 type: object
12807 properties:
12808 value:
12809 type: string
12810 weak:
12811 type: boolean
12812 headers:
12813 type: object
12814 additionalProperties:
12815 type: array
12816 items:
12817 type: object
12818 language:
12819 type: object
12820 properties:
12821 country:
12822 type: string
12823 displayCountry:
12824 type: string
12825 displayLanguage:
12826 type: string
12827 displayName:
12828 type: string
12829 displayScript:
12830 type: string
12831 displayVariant:
12832 type: string
12833 extensionKeys:
12834 type: array
12835 items:
12836 type: string
12837 uniqueItems: true
12838 iso3Country:
12839 type: string
12840 iso3Language:
12841 type: string
12842 language:
12843 type: string
12844 script:
12845 type: string
12846 unicodeLocaleAttributes:
12847 type: array
12848 items:
12849 type: string
12850 uniqueItems: true
12851 unicodeLocaleKeys:
12852 type: array
12853 items:
12854 type: string
12855 uniqueItems: true
12856 variant:
12857 type: string
12858 lastModified:
12859 type: string
12860 format: date-time
12861 length:
12862 type: integer
12863 format: int32
12864 links:
12865 type: array
12866 items:
12867 type: object
12868 properties:
12869 params:
12870 type: object
12871 additionalProperties:
12872 type: string
12873 rel:
12874 type: string
12875 rels:
12876 type: array
12877 items:
12878 type: string
12879 title:
12880 type: string
12881 type:
12882 type: string
12883 uri:
12884 type: string
12885 format: uri
12886 uriBuilder:
12887 type: object
12888 uniqueItems: true
12889 location:
12890 type: string
12891 format: uri
12892 mediaType:
12893 type: object
12894 properties:
12895 parameters:
12896 type: object
12897 additionalProperties:
12898 type: string
12899 subtype:
12900 type: string
12901 type:
12902 type: string
12903 wildcardSubtype:
12904 type: boolean
12905 wildcardType:
12906 type: boolean
12907 metadata:
12908 type: object
12909 additionalProperties:
12910 type: array
12911 items:
12912 type: object
12913 status:
12914 type: integer
12915 format: int32
12916 statusInfo:
12917 type: object
12918 properties:
12919 family:
12920 type: string
12921 enum:
12922 - INFORMATIONAL
12923 - SUCCESSFUL
12924 - REDIRECTION
12925 - CLIENT_ERROR
12926 - SERVER_ERROR
12927 - OTHER
12928 reasonPhrase:
12929 type: string
12930 statusCode:
12931 type: integer
12932 format: int32
12933 stringHeaders:
12934 type: object
12935 additionalProperties:
12936 type: array
12937 items:
12938 type: string
12939 servers:
12940 - url: /sdc2/rest
12941 variables: {}
12942 summary: Returns updated artifact
12943 tags:
12944 - SDCE-2 APIs
12945 /v1/catalog/services/{serviceId}/attributes:
12946 get:
12947 description: Get Service Attribute
12948 operationId: getAttributeListInService
12949 parameters:
12950 - description: service id of attribute
12951 in: path
12952 name: serviceId
12953 required: true
12954 schema:
12955 type: string
12956 - in: header
12957 name: USER_ID
12958 schema:
12959 type: string
12960 responses:
12961 "200":
12962 description: attribute
12963 "400":
12964 description: Invalid content / Missing content
12965 "403":
12966 description: Restricted operation
12967 "404":
12968 description: Service attribute not found
12969 default:
12970 content:
12971 application/json:
12972 schema:
12973 type: array
12974 items:
12975 type: object
12976 properties:
12977 allowedMethods:
12978 type: array
12979 items:
12980 type: string
12981 uniqueItems: true
12982 cookies:
12983 type: object
12984 additionalProperties:
12985 type: object
12986 properties:
12987 comment:
12988 type: string
12989 domain:
12990 type: string
12991 expiry:
12992 type: string
12993 format: date-time
12994 httpOnly:
12995 type: boolean
12996 maxAge:
12997 type: integer
12998 format: int32
12999 name:
13000 type: string
13001 path:
13002 type: string
13003 secure:
13004 type: boolean
13005 value:
13006 type: string
13007 version:
13008 type: integer
13009 format: int32
13010 date:
13011 type: string
13012 format: date-time
13013 entity:
13014 type: object
13015 entityTag:
13016 type: object
13017 properties:
13018 value:
13019 type: string
13020 weak:
13021 type: boolean
13022 headers:
13023 type: object
13024 additionalProperties:
13025 type: array
13026 items:
13027 type: object
13028 language:
13029 type: object
13030 properties:
13031 country:
13032 type: string
13033 displayCountry:
13034 type: string
13035 displayLanguage:
13036 type: string
13037 displayName:
13038 type: string
13039 displayScript:
13040 type: string
13041 displayVariant:
13042 type: string
13043 extensionKeys:
13044 type: array
13045 items:
13046 type: string
13047 uniqueItems: true
13048 iso3Country:
13049 type: string
13050 iso3Language:
13051 type: string
13052 language:
13053 type: string
13054 script:
13055 type: string
13056 unicodeLocaleAttributes:
13057 type: array
13058 items:
13059 type: string
13060 uniqueItems: true
13061 unicodeLocaleKeys:
13062 type: array
13063 items:
13064 type: string
13065 uniqueItems: true
13066 variant:
13067 type: string
13068 lastModified:
13069 type: string
13070 format: date-time
13071 length:
13072 type: integer
13073 format: int32
13074 links:
13075 type: array
13076 items:
13077 type: object
13078 properties:
13079 params:
13080 type: object
13081 additionalProperties:
13082 type: string
13083 rel:
13084 type: string
13085 rels:
13086 type: array
13087 items:
13088 type: string
13089 title:
13090 type: string
13091 type:
13092 type: string
13093 uri:
13094 type: string
13095 format: uri
13096 uriBuilder:
13097 type: object
13098 uniqueItems: true
13099 location:
13100 type: string
13101 format: uri
13102 mediaType:
13103 type: object
13104 properties:
13105 parameters:
13106 type: object
13107 additionalProperties:
13108 type: string
13109 subtype:
13110 type: string
13111 type:
13112 type: string
13113 wildcardSubtype:
13114 type: boolean
13115 wildcardType:
13116 type: boolean
13117 metadata:
13118 type: object
13119 additionalProperties:
13120 type: array
13121 items:
13122 type: object
13123 status:
13124 type: integer
13125 format: int32
13126 statusInfo:
13127 type: object
13128 properties:
13129 family:
13130 type: string
13131 enum:
13132 - INFORMATIONAL
13133 - SUCCESSFUL
13134 - REDIRECTION
13135 - CLIENT_ERROR
13136 - SERVER_ERROR
13137 - OTHER
13138 reasonPhrase:
13139 type: string
13140 statusCode:
13141 type: integer
13142 format: int32
13143 stringHeaders:
13144 type: object
13145 additionalProperties:
13146 type: array
13147 items:
13148 type: string
13149 servers:
13150 - url: /sdc2/rest
13151 variables: {}
13152 summary: Returns attribute list of service
13153 tags:
13154 - SDCE-2 APIs
13155 /v1/catalog/services/{serviceId}/capabilities:
13156 post:
13157 description: Create Capabilities on service
13158 operationId: createCapabilitiesOnService
13159 parameters:
13160 - description: Service Id
13161 in: path
13162 name: serviceId
13163 required: true
13164 schema:
13165 type: string
13166 - in: header
13167 name: USER_ID
13168 schema:
13169 type: string
13170 requestBody:
13171 content:
13172 application/json:
13173 schema:
13174 type: string
13175 description: Capability to create
13176 required: true
13177 responses:
13178 "201":
13179 description: Create Capabilities
13180 "400":
13181 description: Invalid content / Missing content
13182 "403":
13183 description: Restricted operation
13184 "409":
13185 description: Capability already exist
13186 default:
13187 content:
13188 application/json:
13189 schema:
13190 type: array
13191 items:
13192 type: object
13193 properties:
13194 allowedMethods:
13195 type: array
13196 items:
13197 type: string
13198 uniqueItems: true
13199 cookies:
13200 type: object
13201 additionalProperties:
13202 type: object
13203 properties:
13204 comment:
13205 type: string
13206 domain:
13207 type: string
13208 expiry:
13209 type: string
13210 format: date-time
13211 httpOnly:
13212 type: boolean
13213 maxAge:
13214 type: integer
13215 format: int32
13216 name:
13217 type: string
13218 path:
13219 type: string
13220 secure:
13221 type: boolean
13222 value:
13223 type: string
13224 version:
13225 type: integer
13226 format: int32
13227 date:
13228 type: string
13229 format: date-time
13230 entity:
13231 type: object
13232 entityTag:
13233 type: object
13234 properties:
13235 value:
13236 type: string
13237 weak:
13238 type: boolean
13239 headers:
13240 type: object
13241 additionalProperties:
13242 type: array
13243 items:
13244 type: object
13245 language:
13246 type: object
13247 properties:
13248 country:
13249 type: string
13250 displayCountry:
13251 type: string
13252 displayLanguage:
13253 type: string
13254 displayName:
13255 type: string
13256 displayScript:
13257 type: string
13258 displayVariant:
13259 type: string
13260 extensionKeys:
13261 type: array
13262 items:
13263 type: string
13264 uniqueItems: true
13265 iso3Country:
13266 type: string
13267 iso3Language:
13268 type: string
13269 language:
13270 type: string
13271 script:
13272 type: string
13273 unicodeLocaleAttributes:
13274 type: array
13275 items:
13276 type: string
13277 uniqueItems: true
13278 unicodeLocaleKeys:
13279 type: array
13280 items:
13281 type: string
13282 uniqueItems: true
13283 variant:
13284 type: string
13285 lastModified:
13286 type: string
13287 format: date-time
13288 length:
13289 type: integer
13290 format: int32
13291 links:
13292 type: array
13293 items:
13294 type: object
13295 properties:
13296 params:
13297 type: object
13298 additionalProperties:
13299 type: string
13300 rel:
13301 type: string
13302 rels:
13303 type: array
13304 items:
13305 type: string
13306 title:
13307 type: string
13308 type:
13309 type: string
13310 uri:
13311 type: string
13312 format: uri
13313 uriBuilder:
13314 type: object
13315 uniqueItems: true
13316 location:
13317 type: string
13318 format: uri
13319 mediaType:
13320 type: object
13321 properties:
13322 parameters:
13323 type: object
13324 additionalProperties:
13325 type: string
13326 subtype:
13327 type: string
13328 type:
13329 type: string
13330 wildcardSubtype:
13331 type: boolean
13332 wildcardType:
13333 type: boolean
13334 metadata:
13335 type: object
13336 additionalProperties:
13337 type: array
13338 items:
13339 type: object
13340 status:
13341 type: integer
13342 format: int32
13343 statusInfo:
13344 type: object
13345 properties:
13346 family:
13347 type: string
13348 enum:
13349 - INFORMATIONAL
13350 - SUCCESSFUL
13351 - REDIRECTION
13352 - CLIENT_ERROR
13353 - SERVER_ERROR
13354 - OTHER
13355 reasonPhrase:
13356 type: string
13357 statusCode:
13358 type: integer
13359 format: int32
13360 stringHeaders:
13361 type: object
13362 additionalProperties:
13363 type: array
13364 items:
13365 type: string
13366 servers:
13367 - url: /sdc2/rest
13368 variables: {}
13369 summary: Create Capabilities on service
13370 tags:
13371 - SDCE-2 APIs
13372 put:
13373 description: Update Capabilities on service
13374 operationId: updateCapabilitiesOnService
13375 parameters:
13376 - description: Component Id
13377 in: path
13378 name: serviceId
13379 required: true
13380 schema:
13381 type: string
13382 - in: header
13383 name: USER_ID
13384 schema:
13385 type: string
13386 requestBody:
13387 content:
13388 application/json:
13389 schema:
13390 type: string
13391 description: Capabilities to update
13392 required: true
13393 responses:
13394 "201":
13395 description: Update Capabilities
13396 "400":
13397 description: Invalid content / Missing content
13398 "403":
13399 description: Restricted operation
13400 default:
13401 content:
13402 application/json:
13403 schema:
13404 type: array
13405 items:
13406 $ref: '#/components/schemas/CapabilityDefinition'
13407 servers:
13408 - url: /sdc2/rest
13409 variables: {}
13410 summary: Update Capabilities on service
13411 tags:
13412 - SDCE-2 APIs
13413 /v1/catalog/services/{serviceId}/capabilities/{capabilityId}:
13414 delete:
13415 description: Delete capability from service
13416 operationId: deleteCapabilityOnService
13417 parameters:
13418 - description: capability Id
13419 in: path
13420 name: capabilityId
13421 required: true
13422 schema:
13423 type: string
13424 - description: Service Id
13425 in: path
13426 name: serviceId
13427 required: true
13428 schema:
13429 type: string
13430 - in: header
13431 name: USER_ID
13432 schema:
13433 type: string
13434 responses:
13435 "201":
13436 description: Delete capability
13437 "400":
13438 description: Invalid content / Missing content
13439 "403":
13440 description: Restricted operation
13441 default:
13442 content:
13443 application/json:
13444 schema:
13445 type: array
13446 items:
13447 $ref: '#/components/schemas/CapabilityDefinition'
13448 servers:
13449 - url: /sdc2/rest
13450 variables: {}
13451 summary: Delete capability from service
13452 tags:
13453 - SDCE-2 APIs
13454 get:
13455 description: Get Capability from service
13456 operationId: getCapabilityOnService
13457 parameters:
13458 - description: Service Id
13459 in: path
13460 name: serviceId
13461 required: true
13462 schema:
13463 type: string
13464 - description: Capability Id
13465 in: path
13466 name: capabilityId
13467 required: true
13468 schema:
13469 type: string
13470 - in: header
13471 name: USER_ID
13472 schema:
13473 type: string
13474 responses:
13475 "201":
13476 description: GET Capability
13477 "400":
13478 description: Invalid content / Missing content
13479 "403":
13480 description: Restricted operation
13481 default:
13482 content:
13483 application/json:
13484 schema:
13485 type: array
13486 items:
13487 $ref: '#/components/schemas/CapabilityDefinition'
13488 servers:
13489 - url: /sdc2/rest
13490 variables: {}
13491 summary: GET Capability from service
13492 tags:
13493 - SDCE-2 APIs
13494 /v1/catalog/services/{serviceId}/consumption/{serviceInstanceId}:
13495 post:
13496 description: Service consumption on operation
13497 operationId: addInputToServiceOperation
13498 parameters:
13499 - in: path
13500 name: serviceId
13501 required: true
13502 schema:
13503 type: string
13504 - in: path
13505 name: serviceInstanceId
13506 required: true
13507 schema:
13508 type: string
13509 - in: header
13510 name: USER_ID
13511 schema:
13512 type: string
13513 requestBody:
13514 content:
13515 application/json:
13516 schema:
13517 type: string
13518 description: Service Consumption Data
13519 required: true
13520 responses:
13521 "201":
13522 description: Service property created
13523 "400":
13524 description: Invalid content / Missing content
13525 "403":
13526 description: Restricted operation
13527 "409":
13528 description: Service property already exist
13529 default:
13530 content:
13531 application/json:
13532 schema:
13533 type: array
13534 items:
13535 type: object
13536 properties:
13537 allowedMethods:
13538 type: array
13539 items:
13540 type: string
13541 uniqueItems: true
13542 cookies:
13543 type: object
13544 additionalProperties:
13545 type: object
13546 properties:
13547 comment:
13548 type: string
13549 domain:
13550 type: string
13551 expiry:
13552 type: string
13553 format: date-time
13554 httpOnly:
13555 type: boolean
13556 maxAge:
13557 type: integer
13558 format: int32
13559 name:
13560 type: string
13561 path:
13562 type: string
13563 secure:
13564 type: boolean
13565 value:
13566 type: string
13567 version:
13568 type: integer
13569 format: int32
13570 date:
13571 type: string
13572 format: date-time
13573 entity:
13574 type: object
13575 entityTag:
13576 type: object
13577 properties:
13578 value:
13579 type: string
13580 weak:
13581 type: boolean
13582 headers:
13583 type: object
13584 additionalProperties:
13585 type: array
13586 items:
13587 type: object
13588 language:
13589 type: object
13590 properties:
13591 country:
13592 type: string
13593 displayCountry:
13594 type: string
13595 displayLanguage:
13596 type: string
13597 displayName:
13598 type: string
13599 displayScript:
13600 type: string
13601 displayVariant:
13602 type: string
13603 extensionKeys:
13604 type: array
13605 items:
13606 type: string
13607 uniqueItems: true
13608 iso3Country:
13609 type: string
13610 iso3Language:
13611 type: string
13612 language:
13613 type: string
13614 script:
13615 type: string
13616 unicodeLocaleAttributes:
13617 type: array
13618 items:
13619 type: string
13620 uniqueItems: true
13621 unicodeLocaleKeys:
13622 type: array
13623 items:
13624 type: string
13625 uniqueItems: true
13626 variant:
13627 type: string
13628 lastModified:
13629 type: string
13630 format: date-time
13631 length:
13632 type: integer
13633 format: int32
13634 links:
13635 type: array
13636 items:
13637 type: object
13638 properties:
13639 params:
13640 type: object
13641 additionalProperties:
13642 type: string
13643 rel:
13644 type: string
13645 rels:
13646 type: array
13647 items:
13648 type: string
13649 title:
13650 type: string
13651 type:
13652 type: string
13653 uri:
13654 type: string
13655 format: uri
13656 uriBuilder:
13657 type: object
13658 uniqueItems: true
13659 location:
13660 type: string
13661 format: uri
13662 mediaType:
13663 type: object
13664 properties:
13665 parameters:
13666 type: object
13667 additionalProperties:
13668 type: string
13669 subtype:
13670 type: string
13671 type:
13672 type: string
13673 wildcardSubtype:
13674 type: boolean
13675 wildcardType:
13676 type: boolean
13677 metadata:
13678 type: object
13679 additionalProperties:
13680 type: array
13681 items:
13682 type: object
13683 status:
13684 type: integer
13685 format: int32
13686 statusInfo:
13687 type: object
13688 properties:
13689 family:
13690 type: string
13691 enum:
13692 - INFORMATIONAL
13693 - SUCCESSFUL
13694 - REDIRECTION
13695 - CLIENT_ERROR
13696 - SERVER_ERROR
13697 - OTHER
13698 reasonPhrase:
13699 type: string
13700 statusCode:
13701 type: integer
13702 format: int32
13703 stringHeaders:
13704 type: object
13705 additionalProperties:
13706 type: array
13707 items:
13708 type: string
13709 servers:
13710 - url: /sdc2/rest
13711 variables: {}
13712 summary: Returns consumption data
13713 tags:
13714 - SDCE-2 APIs
13715 /v1/catalog/services/{serviceId}/consumption/{serviceInstanceId}/interfaces/{interfaceId}/operations/{operationId}/inputs:
13716 get:
13717 operationId: getInputsListOfOperation
13718 parameters:
13719 - in: path
13720 name: serviceId
13721 required: true
13722 schema:
13723 type: string
13724 - in: path
13725 name: serviceInstanceId
13726 required: true
13727 schema:
13728 type: string
13729 - in: path
13730 name: interfaceId
13731 required: true
13732 schema:
13733 type: string
13734 - in: path
13735 name: operationId
13736 required: true
13737 schema:
13738 type: string
13739 - in: header
13740 name: USER_ID
13741 schema:
13742 type: string
13743 responses:
13744 default:
13745 content:
13746 application/json: {}
13747 description: default response
13748 servers:
13749 - url: /sdc2/rest
13750 variables: {}
13751 tags:
13752 - SDCE-2 APIs
13753 /v1/catalog/services/{serviceId}/distribution/{did}/markDeployed:
13754 post:
13755 description: Mark distribution as deployed
13756 operationId: markDistributionAsDeployed
13757 parameters:
13758 - in: path
13759 name: serviceId
13760 required: true
13761 schema:
13762 type: string
13763 - in: path
13764 name: did
13765 required: true
13766 schema:
13767 type: string
13768 - in: header
13769 name: USER_ID
13770 schema:
13771 type: string
13772 responses:
13773 "200":
13774 description: Service was marked as deployed
13775 "400":
13776 description: Invalid content / Missing content
13777 "403":
13778 description: Service is not available
13779 "404":
13780 description: Requested service was not found
13781 "409":
13782 description: Restricted operation
13783 "500":
13784 description: Internal Server Error. Please try again later.
13785 servers:
13786 - url: /sdc2/rest
13787 variables: {}
13788 summary: relevant audit record will be created
13789 tags:
13790 - SDCE-5 APIs
13791 /v1/catalog/services/{serviceId}/distribution/{env}/activate:
13792 post:
13793 description: Activate distribution
13794 operationId: activateDistribution
13795 parameters:
13796 - in: path
13797 name: serviceId
13798 required: true
13799 schema:
13800 type: string
13801 - in: path
13802 name: env
13803 required: true
13804 schema:
13805 type: string
13806 - in: header
13807 name: USER_ID
13808 schema:
13809 type: string
13810 responses:
13811 "200":
13812 description: OK
13813 "404":
13814 description: Requested service was not found
13815 "409":
13816 description: Service cannot be distributed due to missing deployment artifacts
13817 "500":
13818 description: Internal Server Error. Please try again later.
13819 servers:
13820 - url: /sdc2/rest
13821 variables: {}
13822 summary: activate distribution
13823 tags:
13824 - SDCE-5 APIs
13825 /v1/catalog/services/{serviceId}/interfaceOperations:
13826 post:
13827 description: Create Interface Operations on Service
13828 operationId: createInterfaceOperationsOnService
13829 parameters:
13830 - description: Service Id
13831 in: path
13832 name: serviceId
13833 required: true
13834 schema:
13835 type: string
13836 - in: header
13837 name: USER_ID
13838 schema:
13839 type: string
13840 requestBody:
13841 content:
13842 application/json:
13843 schema:
13844 type: string
13845 description: Interface Operations to create
13846 required: true
13847 responses:
13848 "201":
13849 description: Create Interface Operations on Service
13850 "400":
13851 description: Invalid content / Missing content
13852 "403":
13853 description: Restricted operation
13854 "404":
13855 description: Service not found
13856 "409":
13857 description: Interface Operation already exist
13858 default:
13859 content:
13860 application/json:
13861 schema:
13862 type: array
13863 items:
13864 $ref: '#/components/schemas/InterfaceDefinition'
13865 servers:
13866 - url: /sdc2/rest
13867 variables: {}
13868 summary: Create Interface Operations on Service
13869 tags:
13870 - SDCE-2 APIs
13871 put:
13872 description: Update Interface Operations on Service
13873 operationId: updateInterfaceOperationsOnService
13874 parameters:
13875 - description: Service Id
13876 in: path
13877 name: serviceId
13878 required: true
13879 schema:
13880 type: string
13881 - in: header
13882 name: USER_ID
13883 schema:
13884 type: string
13885 requestBody:
13886 content:
13887 application/json:
13888 schema:
13889 type: string
13890 description: Interface Operations to update
13891 required: true
13892 responses:
13893 "201":
13894 description: Update Interface Operations on Service
13895 "400":
13896 description: Invalid content / Missing content
13897 "403":
13898 description: Restricted operation
13899 "404":
13900 description: Service not found
13901 default:
13902 content:
13903 application/json:
13904 schema:
13905 type: array
13906 items:
13907 $ref: '#/components/schemas/InterfaceDefinition'
13908 servers:
13909 - url: /sdc2/rest
13910 variables: {}
13911 summary: Update Interface Operations on Service
13912 tags:
13913 - SDCE-2 APIs
13914 /v1/catalog/services/{serviceId}/interfaces/{interfaceId}/operations/{operationId}:
13915 delete:
13916 description: Delete Interface Operation from Service
13917 operationId: deleteInterfaceOperationsFromService
13918 parameters:
13919 - description: Service Id
13920 in: path
13921 name: serviceId
13922 required: true
13923 schema:
13924 type: string
13925 - description: Interface Id
13926 in: path
13927 name: interfaceId
13928 required: true
13929 schema:
13930 type: string
13931 - description: Operation Id
13932 in: path
13933 name: operationId
13934 required: true
13935 schema:
13936 type: string
13937 - in: header
13938 name: USER_ID
13939 schema:
13940 type: string
13941 responses:
13942 "201":
13943 description: Delete Interface Operation from Service
13944 "400":
13945 description: Invalid content / Missing content
13946 "403":
13947 description: Restricted operation
13948 "404":
13949 description: Service not found
13950 default:
13951 content:
13952 application/json:
13953 schema:
13954 type: array
13955 items:
13956 $ref: '#/components/schemas/InterfaceDefinition'
13957 servers:
13958 - url: /sdc2/rest
13959 variables: {}
13960 summary: Delete Interface Operation from Service
13961 tags:
13962 - SDCE-2 APIs
13963 get:
13964 description: Get Interface Operation from Service
13965 operationId: getInterfaceOperationsFromService
13966 parameters:
13967 - description: Service Id
13968 in: path
13969 name: serviceId
13970 required: true
13971 schema:
13972 type: string
13973 - description: Interface Id
13974 in: path
13975 name: interfaceId
13976 required: true
13977 schema:
13978 type: string
13979 - description: Operation Id
13980 in: path
13981 name: operationId
13982 required: true
13983 schema:
13984 type: string
13985 - in: header
13986 name: USER_ID
13987 schema:
13988 type: string
13989 responses:
13990 "201":
13991 description: Get Interface Operation from Service
13992 "400":
13993 description: Invalid content / Missing content
13994 "403":
13995 description: Restricted operation
13996 "404":
13997 description: Service not found
13998 default:
13999 content:
14000 application/json:
14001 schema:
14002 type: array
14003 items:
14004 $ref: '#/components/schemas/InterfaceDefinition'
14005 servers:
14006 - url: /sdc2/rest
14007 variables: {}
14008 summary: GET Interface Operation from Service
14009 tags:
14010 - SDCE-2 APIs
14011 /v1/catalog/services/{serviceId}/linksMap:
14012 get:
14013 description: Retrieve Service component relations map
14014 operationId: getServiceComponentRelationMap
14015 parameters:
14016 - in: path
14017 name: serviceId
14018 required: true
14019 schema:
14020 type: string
14021 - in: header
14022 name: USER_ID
14023 schema:
14024 type: string
14025 responses:
14026 "200":
14027 description: Service found
14028 "403":
14029 description: Restricted operation
14030 "404":
14031 description: Service not found
14032 default:
14033 content:
14034 application/json:
14035 schema:
14036 type: array
14037 items:
14038 $ref: '#/components/schemas/ServiceRelations'
14039 servers:
14040 - url: /sdc2/rest
14041 variables: {}
14042 summary: Returns service components relations
14043 tags:
14044 - SDCE-2 APIs
14045 /v1/catalog/services/{serviceId}/metadata:
14046 put:
14047 description: Update Service Metadata
14048 operationId: updateServiceMetadata
14049 parameters:
14050 - in: path
14051 name: serviceId
14052 required: true
14053 schema:
14054 type: string
14055 - in: header
14056 name: USER_ID
14057 schema:
14058 type: string
14059 requestBody:
14060 content:
14061 application/json:
14062 schema:
14063 type: string
14064 description: Service object to be Updated
14065 required: true
14066 responses:
14067 "200":
14068 description: Service Updated
14069 "400":
14070 description: Invalid content / Missing content
14071 "403":
14072 description: Restricted operation
14073 default:
14074 content:
14075 application/json:
14076 schema:
14077 type: array
14078 items:
14079 $ref: '#/components/schemas/Service'
14080 servers:
14081 - url: /sdc2/rest
14082 variables: {}
14083 summary: Returns updated service
14084 tags:
14085 - SDCE-2 APIs
14086 /v1/catalog/services/{serviceId}/paths:
14087 post:
14088 description: Create Forwarding Path
14089 operationId: createForwardingPath
14090 parameters:
14091 - description: Service Id
14092 in: path
14093 name: serviceId
14094 required: true
14095 schema:
14096 type: string
14097 - in: header
14098 name: USER_ID
14099 schema:
14100 type: string
14101 requestBody:
14102 content:
14103 application/json:
14104 schema:
14105 type: string
14106 description: Forwarding Path to create
14107 required: true
14108 responses:
14109 "201":
14110 description: Create Forwarding Path
14111 "400":
14112 description: Invalid content / Missing content
14113 "403":
14114 description: Restricted operation
14115 "409":
14116 description: Forwarding Path already exist
14117 default:
14118 content:
14119 application/json:
14120 schema:
14121 type: array
14122 items:
14123 $ref: '#/components/schemas/Service'
14124 servers:
14125 - url: /sdc2/rest
14126 variables: {}
14127 summary: Create Forwarding Path
14128 tags:
14129 - SDCE-2 APIs
14130 put:
14131 description: Update Forwarding Path
14132 operationId: updateForwardingPath
14133 parameters:
14134 - description: Service Id
14135 in: path
14136 name: serviceId
14137 required: true
14138 schema:
14139 type: string
14140 - in: header
14141 name: USER_ID
14142 schema:
14143 type: string
14144 requestBody:
14145 content:
14146 application/json:
14147 schema:
14148 type: string
14149 description: Update Path to create
14150 required: true
14151 responses:
14152 "201":
14153 description: Update Forwarding Path
14154 "400":
14155 description: Invalid content / Missing content
14156 "403":
14157 description: Restricted operation
14158 "409":
14159 description: Forwarding Path already exist
14160 default:
14161 content:
14162 application/json:
14163 schema:
14164 type: array
14165 items:
14166 $ref: '#/components/schemas/Service'
14167 servers:
14168 - url: /sdc2/rest
14169 variables: {}
14170 summary: Update Forwarding Path
14171 tags:
14172 - SDCE-2 APIs
14173 /v1/catalog/services/{serviceId}/paths/{forwardingPathId}:
14174 delete:
14175 description: Delete Forwarding Path
14176 operationId: deleteForwardingPath
14177 parameters:
14178 - description: Forwarding Path Id
14179 in: path
14180 name: forwardingPathId
14181 required: true
14182 schema:
14183 type: string
14184 - description: Service Id
14185 in: path
14186 name: serviceId
14187 required: true
14188 schema:
14189 type: string
14190 - in: header
14191 name: USER_ID
14192 schema:
14193 type: string
14194 responses:
14195 "201":
14196 description: Delete Forwarding Path
14197 "400":
14198 description: Invalid content / Missing content
14199 "403":
14200 description: Restricted operation
14201 "409":
14202 description: Forwarding Path already exist
14203 default:
14204 content:
14205 application/json:
14206 schema:
14207 type: array
14208 items:
14209 $ref: '#/components/schemas/Service'
14210 servers:
14211 - url: /sdc2/rest
14212 variables: {}
14213 summary: Delete Forwarding Path
14214 tags:
14215 - SDCE-2 APIs
14216 get:
14217 description: Get Forwarding Path
14218 operationId: getForwardingPath
14219 parameters:
14220 - description: Service Id
14221 in: path
14222 name: serviceId
14223 required: true
14224 schema:
14225 type: string
14226 - description: Forwarding Path Id
14227 in: path
14228 name: forwardingPathId
14229 required: true
14230 schema:
14231 type: string
14232 - in: header
14233 name: USER_ID
14234 schema:
14235 type: string
14236 requestBody:
14237 content:
14238 application/json:
14239 schema:
14240 type: string
14241 description: Forwarding Path to create
14242 required: true
14243 responses:
14244 "201":
14245 description: Get Forwarding Path
14246 "400":
14247 description: Invalid content / Missing content
14248 "403":
14249 description: Restricted operation
14250 "409":
14251 description: Forwarding Path already exist
14252 default:
14253 content:
14254 application/json:
14255 schema:
14256 type: array
14257 items:
14258 $ref: '#/components/schemas/ForwardingPathDataDefinition'
14259 servers:
14260 - url: /sdc2/rest
14261 variables: {}
14262 summary: GET Forwarding Path
14263 tags:
14264 - SDCE-2 APIs
14265 /v1/catalog/services/{serviceId}/properties:
14266 get:
14267 description: Get Service Property
14268 operationId: getPropertyListInService
14269 parameters:
14270 - description: service id of property
14271 in: path
14272 name: serviceId
14273 required: true
14274 schema:
14275 type: string
14276 - in: header
14277 name: USER_ID
14278 schema:
14279 type: string
14280 responses:
14281 "200":
14282 description: property
14283 "400":
14284 description: Invalid content / Missing content
14285 "403":
14286 description: Restricted operation
14287 "404":
14288 description: Service property not found
14289 default:
14290 content:
14291 application/json:
14292 schema:
14293 type: array
14294 items:
14295 type: object
14296 properties:
14297 allowedMethods:
14298 type: array
14299 items:
14300 type: string
14301 uniqueItems: true
14302 cookies:
14303 type: object
14304 additionalProperties:
14305 type: object
14306 properties:
14307 comment:
14308 type: string
14309 domain:
14310 type: string
14311 expiry:
14312 type: string
14313 format: date-time
14314 httpOnly:
14315 type: boolean
14316 maxAge:
14317 type: integer
14318 format: int32
14319 name:
14320 type: string
14321 path:
14322 type: string
14323 secure:
14324 type: boolean
14325 value:
14326 type: string
14327 version:
14328 type: integer
14329 format: int32
14330 date:
14331 type: string
14332 format: date-time
14333 entity:
14334 type: object
14335 entityTag:
14336 type: object
14337 properties:
14338 value:
14339 type: string
14340 weak:
14341 type: boolean
14342 headers:
14343 type: object
14344 additionalProperties:
14345 type: array
14346 items:
14347 type: object
14348 language:
14349 type: object
14350 properties:
14351 country:
14352 type: string
14353 displayCountry:
14354 type: string
14355 displayLanguage:
14356 type: string
14357 displayName:
14358 type: string
14359 displayScript:
14360 type: string
14361 displayVariant:
14362 type: string
14363 extensionKeys:
14364 type: array
14365 items:
14366 type: string
14367 uniqueItems: true
14368 iso3Country:
14369 type: string
14370 iso3Language:
14371 type: string
14372 language:
14373 type: string
14374 script:
14375 type: string
14376 unicodeLocaleAttributes:
14377 type: array
14378 items:
14379 type: string
14380 uniqueItems: true
14381 unicodeLocaleKeys:
14382 type: array
14383 items:
14384 type: string
14385 uniqueItems: true
14386 variant:
14387 type: string
14388 lastModified:
14389 type: string
14390 format: date-time
14391 length:
14392 type: integer
14393 format: int32
14394 links:
14395 type: array
14396 items:
14397 type: object
14398 properties:
14399 params:
14400 type: object
14401 additionalProperties:
14402 type: string
14403 rel:
14404 type: string
14405 rels:
14406 type: array
14407 items:
14408 type: string
14409 title:
14410 type: string
14411 type:
14412 type: string
14413 uri:
14414 type: string
14415 format: uri
14416 uriBuilder:
14417 type: object
14418 uniqueItems: true
14419 location:
14420 type: string
14421 format: uri
14422 mediaType:
14423 type: object
14424 properties:
14425 parameters:
14426 type: object
14427 additionalProperties:
14428 type: string
14429 subtype:
14430 type: string
14431 type:
14432 type: string
14433 wildcardSubtype:
14434 type: boolean
14435 wildcardType:
14436 type: boolean
14437 metadata:
14438 type: object
14439 additionalProperties:
14440 type: array
14441 items:
14442 type: object
14443 status:
14444 type: integer
14445 format: int32
14446 statusInfo:
14447 type: object
14448 properties:
14449 family:
14450 type: string
14451 enum:
14452 - INFORMATIONAL
14453 - SUCCESSFUL
14454 - REDIRECTION
14455 - CLIENT_ERROR
14456 - SERVER_ERROR
14457 - OTHER
14458 reasonPhrase:
14459 type: string
14460 statusCode:
14461 type: integer
14462 format: int32
14463 stringHeaders:
14464 type: object
14465 additionalProperties:
14466 type: array
14467 items:
14468 type: string
14469 servers:
14470 - url: /sdc2/rest
14471 variables: {}
14472 summary: Returns property list of service
14473 tags:
14474 - SDCE-2 APIs
14475 post:
14476 description: Create Service Property
14477 operationId: createPropertyInService
14478 parameters:
14479 - description: service id to update with new property
14480 in: path
14481 name: serviceId
14482 required: true
14483 schema:
14484 type: string
14485 - in: header
14486 name: USER_ID
14487 schema:
14488 type: string
14489 requestBody:
14490 content:
14491 application/json:
14492 schema:
14493 type: string
14494 description: Service property to be created
14495 required: true
14496 responses:
14497 "201":
14498 description: Service property created
14499 "400":
14500 description: Invalid content / Missing content
14501 "403":
14502 description: Restricted operation
14503 "409":
14504 description: Service property already exist
14505 default:
14506 content:
14507 application/json:
14508 schema:
14509 type: array
14510 items:
14511 type: object
14512 properties:
14513 allowedMethods:
14514 type: array
14515 items:
14516 type: string
14517 uniqueItems: true
14518 cookies:
14519 type: object
14520 additionalProperties:
14521 type: object
14522 properties:
14523 comment:
14524 type: string
14525 domain:
14526 type: string
14527 expiry:
14528 type: string
14529 format: date-time
14530 httpOnly:
14531 type: boolean
14532 maxAge:
14533 type: integer
14534 format: int32
14535 name:
14536 type: string
14537 path:
14538 type: string
14539 secure:
14540 type: boolean
14541 value:
14542 type: string
14543 version:
14544 type: integer
14545 format: int32
14546 date:
14547 type: string
14548 format: date-time
14549 entity:
14550 type: object
14551 entityTag:
14552 type: object
14553 properties:
14554 value:
14555 type: string
14556 weak:
14557 type: boolean
14558 headers:
14559 type: object
14560 additionalProperties:
14561 type: array
14562 items:
14563 type: object
14564 language:
14565 type: object
14566 properties:
14567 country:
14568 type: string
14569 displayCountry:
14570 type: string
14571 displayLanguage:
14572 type: string
14573 displayName:
14574 type: string
14575 displayScript:
14576 type: string
14577 displayVariant:
14578 type: string
14579 extensionKeys:
14580 type: array
14581 items:
14582 type: string
14583 uniqueItems: true
14584 iso3Country:
14585 type: string
14586 iso3Language:
14587 type: string
14588 language:
14589 type: string
14590 script:
14591 type: string
14592 unicodeLocaleAttributes:
14593 type: array
14594 items:
14595 type: string
14596 uniqueItems: true
14597 unicodeLocaleKeys:
14598 type: array
14599 items:
14600 type: string
14601 uniqueItems: true
14602 variant:
14603 type: string
14604 lastModified:
14605 type: string
14606 format: date-time
14607 length:
14608 type: integer
14609 format: int32
14610 links:
14611 type: array
14612 items:
14613 type: object
14614 properties:
14615 params:
14616 type: object
14617 additionalProperties:
14618 type: string
14619 rel:
14620 type: string
14621 rels:
14622 type: array
14623 items:
14624 type: string
14625 title:
14626 type: string
14627 type:
14628 type: string
14629 uri:
14630 type: string
14631 format: uri
14632 uriBuilder:
14633 type: object
14634 uniqueItems: true
14635 location:
14636 type: string
14637 format: uri
14638 mediaType:
14639 type: object
14640 properties:
14641 parameters:
14642 type: object
14643 additionalProperties:
14644 type: string
14645 subtype:
14646 type: string
14647 type:
14648 type: string
14649 wildcardSubtype:
14650 type: boolean
14651 wildcardType:
14652 type: boolean
14653 metadata:
14654 type: object
14655 additionalProperties:
14656 type: array
14657 items:
14658 type: object
14659 status:
14660 type: integer
14661 format: int32
14662 statusInfo:
14663 type: object
14664 properties:
14665 family:
14666 type: string
14667 enum:
14668 - INFORMATIONAL
14669 - SUCCESSFUL
14670 - REDIRECTION
14671 - CLIENT_ERROR
14672 - SERVER_ERROR
14673 - OTHER
14674 reasonPhrase:
14675 type: string
14676 statusCode:
14677 type: integer
14678 format: int32
14679 stringHeaders:
14680 type: object
14681 additionalProperties:
14682 type: array
14683 items:
14684 type: string
14685 servers:
14686 - url: /sdc2/rest
14687 variables: {}
14688 summary: Returns created service property
14689 tags:
14690 - SDCE-2 APIs
14691 put:
14692 description: Update Service Property
14693 operationId: updatePropertyInService
14694 parameters:
14695 - description: service id to update with new property
14696 in: path
14697 name: serviceId
14698 required: true
14699 schema:
14700 type: string
14701 - in: header
14702 name: USER_ID
14703 schema:
14704 type: string
14705 requestBody:
14706 content:
14707 application/json:
14708 schema:
14709 type: string
14710 description: Service property to update
14711 required: true
14712 responses:
14713 "200":
14714 description: Service property updated
14715 "400":
14716 description: Invalid content / Missing content
14717 "403":
14718 description: Restricted operation
14719 default:
14720 content:
14721 application/json:
14722 schema:
14723 type: array
14724 items:
14725 type: object
14726 properties:
14727 allowedMethods:
14728 type: array
14729 items:
14730 type: string
14731 uniqueItems: true
14732 cookies:
14733 type: object
14734 additionalProperties:
14735 type: object
14736 properties:
14737 comment:
14738 type: string
14739 domain:
14740 type: string
14741 expiry:
14742 type: string
14743 format: date-time
14744 httpOnly:
14745 type: boolean
14746 maxAge:
14747 type: integer
14748 format: int32
14749 name:
14750 type: string
14751 path:
14752 type: string
14753 secure:
14754 type: boolean
14755 value:
14756 type: string
14757 version:
14758 type: integer
14759 format: int32
14760 date:
14761 type: string
14762 format: date-time
14763 entity:
14764 type: object
14765 entityTag:
14766 type: object
14767 properties:
14768 value:
14769 type: string
14770 weak:
14771 type: boolean
14772 headers:
14773 type: object
14774 additionalProperties:
14775 type: array
14776 items:
14777 type: object
14778 language:
14779 type: object
14780 properties:
14781 country:
14782 type: string
14783 displayCountry:
14784 type: string
14785 displayLanguage:
14786 type: string
14787 displayName:
14788 type: string
14789 displayScript:
14790 type: string
14791 displayVariant:
14792 type: string
14793 extensionKeys:
14794 type: array
14795 items:
14796 type: string
14797 uniqueItems: true
14798 iso3Country:
14799 type: string
14800 iso3Language:
14801 type: string
14802 language:
14803 type: string
14804 script:
14805 type: string
14806 unicodeLocaleAttributes:
14807 type: array
14808 items:
14809 type: string
14810 uniqueItems: true
14811 unicodeLocaleKeys:
14812 type: array
14813 items:
14814 type: string
14815 uniqueItems: true
14816 variant:
14817 type: string
14818 lastModified:
14819 type: string
14820 format: date-time
14821 length:
14822 type: integer
14823 format: int32
14824 links:
14825 type: array
14826 items:
14827 type: object
14828 properties:
14829 params:
14830 type: object
14831 additionalProperties:
14832 type: string
14833 rel:
14834 type: string
14835 rels:
14836 type: array
14837 items:
14838 type: string
14839 title:
14840 type: string
14841 type:
14842 type: string
14843 uri:
14844 type: string
14845 format: uri
14846 uriBuilder:
14847 type: object
14848 uniqueItems: true
14849 location:
14850 type: string
14851 format: uri
14852 mediaType:
14853 type: object
14854 properties:
14855 parameters:
14856 type: object
14857 additionalProperties:
14858 type: string
14859 subtype:
14860 type: string
14861 type:
14862 type: string
14863 wildcardSubtype:
14864 type: boolean
14865 wildcardType:
14866 type: boolean
14867 metadata:
14868 type: object
14869 additionalProperties:
14870 type: array
14871 items:
14872 type: object
14873 status:
14874 type: integer
14875 format: int32
14876 statusInfo:
14877 type: object
14878 properties:
14879 family:
14880 type: string
14881 enum:
14882 - INFORMATIONAL
14883 - SUCCESSFUL
14884 - REDIRECTION
14885 - CLIENT_ERROR
14886 - SERVER_ERROR
14887 - OTHER
14888 reasonPhrase:
14889 type: string
14890 statusCode:
14891 type: integer
14892 format: int32
14893 stringHeaders:
14894 type: object
14895 additionalProperties:
14896 type: array
14897 items:
14898 type: string
14899 servers:
14900 - url: /sdc2/rest
14901 variables: {}
14902 summary: Returns updated property
14903 tags:
14904 - SDCE-2 APIs
14905 /v1/catalog/services/{serviceId}/properties/{propertyId}:
14906 delete:
14907 description: Delete Service Property
14908 operationId: deletePropertyInService
14909 parameters:
14910 - description: service id of property
14911 in: path
14912 name: serviceId
14913 required: true
14914 schema:
14915 type: string
14916 - description: Property id to delete
14917 in: path
14918 name: propertyId
14919 required: true
14920 schema:
14921 type: string
14922 - in: header
14923 name: USER_ID
14924 schema:
14925 type: string
14926 responses:
14927 "204":
14928 description: deleted property
14929 "400":
14930 description: Invalid content / Missing content
14931 "403":
14932 description: Restricted operation
14933 "404":
14934 description: Service property not found
14935 default:
14936 content:
14937 application/json:
14938 schema:
14939 type: array
14940 items:
14941 type: object
14942 properties:
14943 allowedMethods:
14944 type: array
14945 items:
14946 type: string
14947 uniqueItems: true
14948 cookies:
14949 type: object
14950 additionalProperties:
14951 type: object
14952 properties:
14953 comment:
14954 type: string
14955 domain:
14956 type: string
14957 expiry:
14958 type: string
14959 format: date-time
14960 httpOnly:
14961 type: boolean
14962 maxAge:
14963 type: integer
14964 format: int32
14965 name:
14966 type: string
14967 path:
14968 type: string
14969 secure:
14970 type: boolean
14971 value:
14972 type: string
14973 version:
14974 type: integer
14975 format: int32
14976 date:
14977 type: string
14978 format: date-time
14979 entity:
14980 type: object
14981 entityTag:
14982 type: object
14983 properties:
14984 value:
14985 type: string
14986 weak:
14987 type: boolean
14988 headers:
14989 type: object
14990 additionalProperties:
14991 type: array
14992 items:
14993 type: object
14994 language:
14995 type: object
14996 properties:
14997 country:
14998 type: string
14999 displayCountry:
15000 type: string
15001 displayLanguage:
15002 type: string
15003 displayName:
15004 type: string
15005 displayScript:
15006 type: string
15007 displayVariant:
15008 type: string
15009 extensionKeys:
15010 type: array
15011 items:
15012 type: string
15013 uniqueItems: true
15014 iso3Country:
15015 type: string
15016 iso3Language:
15017 type: string
15018 language:
15019 type: string
15020 script:
15021 type: string
15022 unicodeLocaleAttributes:
15023 type: array
15024 items:
15025 type: string
15026 uniqueItems: true
15027 unicodeLocaleKeys:
15028 type: array
15029 items:
15030 type: string
15031 uniqueItems: true
15032 variant:
15033 type: string
15034 lastModified:
15035 type: string
15036 format: date-time
15037 length:
15038 type: integer
15039 format: int32
15040 links:
15041 type: array
15042 items:
15043 type: object
15044 properties:
15045 params:
15046 type: object
15047 additionalProperties:
15048 type: string
15049 rel:
15050 type: string
15051 rels:
15052 type: array
15053 items:
15054 type: string
15055 title:
15056 type: string
15057 type:
15058 type: string
15059 uri:
15060 type: string
15061 format: uri
15062 uriBuilder:
15063 type: object
15064 uniqueItems: true
15065 location:
15066 type: string
15067 format: uri
15068 mediaType:
15069 type: object
15070 properties:
15071 parameters:
15072 type: object
15073 additionalProperties:
15074 type: string
15075 subtype:
15076 type: string
15077 type:
15078 type: string
15079 wildcardSubtype:
15080 type: boolean
15081 wildcardType:
15082 type: boolean
15083 metadata:
15084 type: object
15085 additionalProperties:
15086 type: array
15087 items:
15088 type: object
15089 status:
15090 type: integer
15091 format: int32
15092 statusInfo:
15093 type: object
15094 properties:
15095 family:
15096 type: string
15097 enum:
15098 - INFORMATIONAL
15099 - SUCCESSFUL
15100 - REDIRECTION
15101 - CLIENT_ERROR
15102 - SERVER_ERROR
15103 - OTHER
15104 reasonPhrase:
15105 type: string
15106 statusCode:
15107 type: integer
15108 format: int32
15109 stringHeaders:
15110 type: object
15111 additionalProperties:
15112 type: array
15113 items:
15114 type: string
15115 servers:
15116 - url: /sdc2/rest
15117 variables: {}
15118 summary: Returns deleted property
15119 tags:
15120 - SDCE-2 APIs
15121 get:
15122 description: Get Service Property
15123 operationId: getPropertyInService
15124 parameters:
15125 - description: service id of property
15126 in: path
15127 name: serviceId
15128 required: true
15129 schema:
15130 type: string
15131 - description: property id to get
15132 in: path
15133 name: propertyId
15134 required: true
15135 schema:
15136 type: string
15137 - in: header
15138 name: USER_ID
15139 schema:
15140 type: string
15141 responses:
15142 "200":
15143 description: property
15144 "400":
15145 description: Invalid content / Missing content
15146 "403":
15147 description: Restricted operation
15148 "404":
15149 description: Service property not found
15150 default:
15151 content:
15152 application/json:
15153 schema:
15154 type: array
15155 items:
15156 type: object
15157 properties:
15158 allowedMethods:
15159 type: array
15160 items:
15161 type: string
15162 uniqueItems: true
15163 cookies:
15164 type: object
15165 additionalProperties:
15166 type: object
15167 properties:
15168 comment:
15169 type: string
15170 domain:
15171 type: string
15172 expiry:
15173 type: string
15174 format: date-time
15175 httpOnly:
15176 type: boolean
15177 maxAge:
15178 type: integer
15179 format: int32
15180 name:
15181 type: string
15182 path:
15183 type: string
15184 secure:
15185 type: boolean
15186 value:
15187 type: string
15188 version:
15189 type: integer
15190 format: int32
15191 date:
15192 type: string
15193 format: date-time
15194 entity:
15195 type: object
15196 entityTag:
15197 type: object
15198 properties:
15199 value:
15200 type: string
15201 weak:
15202 type: boolean
15203 headers:
15204 type: object
15205 additionalProperties:
15206 type: array
15207 items:
15208 type: object
15209 language:
15210 type: object
15211 properties:
15212 country:
15213 type: string
15214 displayCountry:
15215 type: string
15216 displayLanguage:
15217 type: string
15218 displayName:
15219 type: string
15220 displayScript:
15221 type: string
15222 displayVariant:
15223 type: string
15224 extensionKeys:
15225 type: array
15226 items:
15227 type: string
15228 uniqueItems: true
15229 iso3Country:
15230 type: string
15231 iso3Language:
15232 type: string
15233 language:
15234 type: string
15235 script:
15236 type: string
15237 unicodeLocaleAttributes:
15238 type: array
15239 items:
15240 type: string
15241 uniqueItems: true
15242 unicodeLocaleKeys:
15243 type: array
15244 items:
15245 type: string
15246 uniqueItems: true
15247 variant:
15248 type: string
15249 lastModified:
15250 type: string
15251 format: date-time
15252 length:
15253 type: integer
15254 format: int32
15255 links:
15256 type: array
15257 items:
15258 type: object
15259 properties:
15260 params:
15261 type: object
15262 additionalProperties:
15263 type: string
15264 rel:
15265 type: string
15266 rels:
15267 type: array
15268 items:
15269 type: string
15270 title:
15271 type: string
15272 type:
15273 type: string
15274 uri:
15275 type: string
15276 format: uri
15277 uriBuilder:
15278 type: object
15279 uniqueItems: true
15280 location:
15281 type: string
15282 format: uri
15283 mediaType:
15284 type: object
15285 properties:
15286 parameters:
15287 type: object
15288 additionalProperties:
15289 type: string
15290 subtype:
15291 type: string
15292 type:
15293 type: string
15294 wildcardSubtype:
15295 type: boolean
15296 wildcardType:
15297 type: boolean
15298 metadata:
15299 type: object
15300 additionalProperties:
15301 type: array
15302 items:
15303 type: object
15304 status:
15305 type: integer
15306 format: int32
15307 statusInfo:
15308 type: object
15309 properties:
15310 family:
15311 type: string
15312 enum:
15313 - INFORMATIONAL
15314 - SUCCESSFUL
15315 - REDIRECTION
15316 - CLIENT_ERROR
15317 - SERVER_ERROR
15318 - OTHER
15319 reasonPhrase:
15320 type: string
15321 statusCode:
15322 type: integer
15323 format: int32
15324 stringHeaders:
15325 type: object
15326 additionalProperties:
15327 type: array
15328 items:
15329 type: string
15330 servers:
15331 - url: /sdc2/rest
15332 variables: {}
15333 summary: Returns property of service
15334 tags:
15335 - SDCE-2 APIs
15336 /v1/catalog/services/{serviceId}/requirements:
15337 post:
15338 description: Create requirements on service
15339 operationId: createRequirementsOnService
15340 parameters:
15341 - description: Service Id
15342 in: path
15343 name: serviceId
15344 required: true
15345 schema:
15346 type: string
15347 - in: header
15348 name: USER_ID
15349 schema:
15350 type: string
15351 requestBody:
15352 content:
15353 application/json:
15354 schema:
15355 type: string
15356 description: Requirements to create
15357 required: true
15358 responses:
15359 "201":
15360 description: Create Requirements
15361 "400":
15362 description: Invalid content / Missing content
15363 "403":
15364 description: Restricted operation
15365 "409":
15366 description: Requirement already exist
15367 default:
15368 content:
15369 application/json:
15370 schema:
15371 type: array
15372 items:
15373 type: object
15374 properties:
15375 allowedMethods:
15376 type: array
15377 items:
15378 type: string
15379 uniqueItems: true
15380 cookies:
15381 type: object
15382 additionalProperties:
15383 type: object
15384 properties:
15385 comment:
15386 type: string
15387 domain:
15388 type: string
15389 expiry:
15390 type: string
15391 format: date-time
15392 httpOnly:
15393 type: boolean
15394 maxAge:
15395 type: integer
15396 format: int32
15397 name:
15398 type: string
15399 path:
15400 type: string
15401 secure:
15402 type: boolean
15403 value:
15404 type: string
15405 version:
15406 type: integer
15407 format: int32
15408 date:
15409 type: string
15410 format: date-time
15411 entity:
15412 type: object
15413 entityTag:
15414 type: object
15415 properties:
15416 value:
15417 type: string
15418 weak:
15419 type: boolean
15420 headers:
15421 type: object
15422 additionalProperties:
15423 type: array
15424 items:
15425 type: object
15426 language:
15427 type: object
15428 properties:
15429 country:
15430 type: string
15431 displayCountry:
15432 type: string
15433 displayLanguage:
15434 type: string
15435 displayName:
15436 type: string
15437 displayScript:
15438 type: string
15439 displayVariant:
15440 type: string
15441 extensionKeys:
15442 type: array
15443 items:
15444 type: string
15445 uniqueItems: true
15446 iso3Country:
15447 type: string
15448 iso3Language:
15449 type: string
15450 language:
15451 type: string
15452 script:
15453 type: string
15454 unicodeLocaleAttributes:
15455 type: array
15456 items:
15457 type: string
15458 uniqueItems: true
15459 unicodeLocaleKeys:
15460 type: array
15461 items:
15462 type: string
15463 uniqueItems: true
15464 variant:
15465 type: string
15466 lastModified:
15467 type: string
15468 format: date-time
15469 length:
15470 type: integer
15471 format: int32
15472 links:
15473 type: array
15474 items:
15475 type: object
15476 properties:
15477 params:
15478 type: object
15479 additionalProperties:
15480 type: string
15481 rel:
15482 type: string
15483 rels:
15484 type: array
15485 items:
15486 type: string
15487 title:
15488 type: string
15489 type:
15490 type: string
15491 uri:
15492 type: string
15493 format: uri
15494 uriBuilder:
15495 type: object
15496 uniqueItems: true
15497 location:
15498 type: string
15499 format: uri
15500 mediaType:
15501 type: object
15502 properties:
15503 parameters:
15504 type: object
15505 additionalProperties:
15506 type: string
15507 subtype:
15508 type: string
15509 type:
15510 type: string
15511 wildcardSubtype:
15512 type: boolean
15513 wildcardType:
15514 type: boolean
15515 metadata:
15516 type: object
15517 additionalProperties:
15518 type: array
15519 items:
15520 type: object
15521 status:
15522 type: integer
15523 format: int32
15524 statusInfo:
15525 type: object
15526 properties:
15527 family:
15528 type: string
15529 enum:
15530 - INFORMATIONAL
15531 - SUCCESSFUL
15532 - REDIRECTION
15533 - CLIENT_ERROR
15534 - SERVER_ERROR
15535 - OTHER
15536 reasonPhrase:
15537 type: string
15538 statusCode:
15539 type: integer
15540 format: int32
15541 stringHeaders:
15542 type: object
15543 additionalProperties:
15544 type: array
15545 items:
15546 type: string
15547 servers:
15548 - url: /sdc2/rest
15549 variables: {}
15550 summary: Create requirements on service
15551 tags:
15552 - SDCE-2 APIs
15553 put:
15554 description: Update requirements on service
15555 operationId: updateRequirementsOnService
15556 parameters:
15557 - description: Component Id
15558 in: path
15559 name: serviceId
15560 required: true
15561 schema:
15562 type: string
15563 - in: header
15564 name: USER_ID
15565 schema:
15566 type: string
15567 requestBody:
15568 content:
15569 application/json:
15570 schema:
15571 type: string
15572 description: Requirements to update
15573 required: true
15574 responses:
15575 "201":
15576 description: Update requirements
15577 "400":
15578 description: Invalid content / Missing content
15579 "403":
15580 description: Restricted operation
15581 default:
15582 content:
15583 application/json:
15584 schema:
15585 type: array
15586 items:
15587 $ref: '#/components/schemas/RequirementDefinition'
15588 servers:
15589 - url: /sdc2/rest
15590 variables: {}
15591 summary: Update requirements on service
15592 tags:
15593 - SDCE-2 APIs
15594 /v1/catalog/services/{serviceId}/requirements/{requirementId}:
15595 delete:
15596 description: Delete requirement from service
15597 operationId: deleteRequirementsOnService
15598 parameters:
15599 - description: Service Id
15600 in: path
15601 name: serviceId
15602 required: true
15603 schema:
15604 type: string
15605 - description: Requirement Id
15606 in: path
15607 name: requirementId
15608 required: true
15609 schema:
15610 type: string
15611 - in: header
15612 name: USER_ID
15613 schema:
15614 type: string
15615 responses:
15616 "201":
15617 description: Delete Requirements
15618 "400":
15619 description: Invalid content / Missing content
15620 "403":
15621 description: Restricted operation
15622 default:
15623 content:
15624 application/json:
15625 schema:
15626 type: array
15627 items:
15628 $ref: '#/components/schemas/RequirementDefinition'
15629 servers:
15630 - url: /sdc2/rest
15631 variables: {}
15632 summary: Delete requirement from service
15633 tags:
15634 - SDCE-2 APIs
15635 get:
15636 description: Get requirement from service
15637 operationId: getRequirementsOnService
15638 parameters:
15639 - description: Service Id
15640 in: path
15641 name: serviceId
15642 required: true
15643 schema:
15644 type: string
15645 - description: Requirement Id
15646 in: path
15647 name: requirementId
15648 required: true
15649 schema:
15650 type: string
15651 - in: header
15652 name: USER_ID
15653 schema:
15654 type: string
15655 responses:
15656 "201":
15657 description: GET Requirements
15658 "400":
15659 description: Invalid content / Missing content
15660 "403":
15661 description: Restricted operation
15662 default:
15663 content:
15664 application/json:
15665 schema:
15666 type: array
15667 items:
15668 $ref: '#/components/schemas/RequirementDefinition'
15669 servers:
15670 - url: /sdc2/rest
15671 variables: {}
15672 summary: GET requirement from service
15673 tags:
15674 - SDCE-2 APIs
15675 /v1/catalog/services/{serviceId}/tempUrlToBeDeleted:
15676 post:
15677 operationId: tempUrlToBeDeleted
15678 parameters:
15679 - in: path
15680 name: serviceId
15681 required: true
15682 schema:
15683 type: string
15684 - in: header
15685 name: USER_ID
15686 schema:
15687 type: string
15688 responses:
15689 "200":
15690 description: OK
15691 "500":
15692 description: Internal Server Error. Please try again later.
15693 servers:
15694 - url: /sdc2/rest
15695 variables: {}
15696 tags:
15697 - SDCE-2 APIs
15698 /v1/catalog/services/{serviceName}/{version}:
15699 delete:
15700 description: Delete Service By Name And Version
15701 operationId: deleteServiceByNameAndVersion
15702 parameters:
15703 - in: path
15704 name: serviceName
15705 required: true
15706 schema:
15707 type: string
15708 - in: path
15709 name: version
15710 required: true
15711 schema:
15712 type: string
15713 responses:
15714 "204":
15715 description: Service deleted
15716 "400":
15717 description: Invalid content / Missing content
15718 "403":
15719 description: Restricted operation
15720 "404":
15721 description: Service not found
15722 default:
15723 content:
15724 '*/*':
15725 schema:
15726 type: array
15727 items:
15728 $ref: '#/components/schemas/Resource'
15729 servers:
15730 - url: /sdc2/rest
15731 variables: {}
15732 summary: Returns no content
15733 tags:
15734 - SDCE-2 APIs
15735 /v1/catalog/services/{serviceUUID}/distribution:
15736 get:
15737 description: Retrieve Distributions
15738 operationId: getServiceById
15739 parameters:
15740 - in: path
15741 name: serviceUUID
15742 required: true
15743 schema:
15744 type: string
15745 - in: header
15746 name: USER_ID
15747 schema:
15748 type: string
15749 responses:
15750 "200":
15751 description: Service found
15752 "403":
15753 description: Restricted operation
15754 "404":
15755 description: Service not found
15756 default:
15757 content:
15758 application/json:
15759 schema:
15760 type: array
15761 items:
15762 $ref: '#/components/schemas/DistributionStatusListResponse'
15763 servers:
15764 - url: /sdc2/rest
15765 variables: {}
15766 summary: Returns list bases on the information extracted from Auditing Records
15767 according to service uuid
15768 tags:
15769 - SDCE-5 APIs
15770 /v1/catalog/toggle:
15771 get:
15772 description: Get all Toggleable features
15773 operationId: getAllFeatures
15774 responses:
15775 "200":
15776 description: Success
15777 "400":
15778 description: Invalid content / Missing content
15779 "403":
15780 description: Restricted operation
15781 "404":
15782 description: Toggleable features not found
15783 default:
15784 content:
15785 application/json:
15786 schema:
15787 type: array
15788 items:
15789 type: object
15790 properties:
15791 allowedMethods:
15792 type: array
15793 items:
15794 type: string
15795 uniqueItems: true
15796 cookies:
15797 type: object
15798 additionalProperties:
15799 type: object
15800 properties:
15801 comment:
15802 type: string
15803 domain:
15804 type: string
15805 expiry:
15806 type: string
15807 format: date-time
15808 httpOnly:
15809 type: boolean
15810 maxAge:
15811 type: integer
15812 format: int32
15813 name:
15814 type: string
15815 path:
15816 type: string
15817 secure:
15818 type: boolean
15819 value:
15820 type: string
15821 version:
15822 type: integer
15823 format: int32
15824 date:
15825 type: string
15826 format: date-time
15827 entity:
15828 type: object
15829 entityTag:
15830 type: object
15831 properties:
15832 value:
15833 type: string
15834 weak:
15835 type: boolean
15836 headers:
15837 type: object
15838 additionalProperties:
15839 type: array
15840 items:
15841 type: object
15842 language:
15843 type: object
15844 properties:
15845 country:
15846 type: string
15847 displayCountry:
15848 type: string
15849 displayLanguage:
15850 type: string
15851 displayName:
15852 type: string
15853 displayScript:
15854 type: string
15855 displayVariant:
15856 type: string
15857 extensionKeys:
15858 type: array
15859 items:
15860 type: string
15861 uniqueItems: true
15862 iso3Country:
15863 type: string
15864 iso3Language:
15865 type: string
15866 language:
15867 type: string
15868 script:
15869 type: string
15870 unicodeLocaleAttributes:
15871 type: array
15872 items:
15873 type: string
15874 uniqueItems: true
15875 unicodeLocaleKeys:
15876 type: array
15877 items:
15878 type: string
15879 uniqueItems: true
15880 variant:
15881 type: string
15882 lastModified:
15883 type: string
15884 format: date-time
15885 length:
15886 type: integer
15887 format: int32
15888 links:
15889 type: array
15890 items:
15891 type: object
15892 properties:
15893 params:
15894 type: object
15895 additionalProperties:
15896 type: string
15897 rel:
15898 type: string
15899 rels:
15900 type: array
15901 items:
15902 type: string
15903 title:
15904 type: string
15905 type:
15906 type: string
15907 uri:
15908 type: string
15909 format: uri
15910 uriBuilder:
15911 type: object
15912 uniqueItems: true
15913 location:
15914 type: string
15915 format: uri
15916 mediaType:
15917 type: object
15918 properties:
15919 parameters:
15920 type: object
15921 additionalProperties:
15922 type: string
15923 subtype:
15924 type: string
15925 type:
15926 type: string
15927 wildcardSubtype:
15928 type: boolean
15929 wildcardType:
15930 type: boolean
15931 metadata:
15932 type: object
15933 additionalProperties:
15934 type: array
15935 items:
15936 type: object
15937 status:
15938 type: integer
15939 format: int32
15940 statusInfo:
15941 type: object
15942 properties:
15943 family:
15944 type: string
15945 enum:
15946 - INFORMATIONAL
15947 - SUCCESSFUL
15948 - REDIRECTION
15949 - CLIENT_ERROR
15950 - SERVER_ERROR
15951 - OTHER
15952 reasonPhrase:
15953 type: string
15954 statusCode:
15955 type: integer
15956 format: int32
15957 stringHeaders:
15958 type: object
15959 additionalProperties:
15960 type: array
15961 items:
15962 type: string
15963 servers:
15964 - url: /sdc2/rest
15965 variables: {}
15966 summary: Returns list of toggleable features
15967 tags:
15968 - SDCE-2 APIs
15969 /v1/catalog/toggle/state/{state}:
15970 put:
15971 description: Update all feature toggle state
15972 operationId: setAllFeatures
15973 parameters:
15974 - in: path
15975 name: state
15976 required: true
15977 schema:
15978 type: boolean
15979 responses:
15980 "200":
15981 description: Success
15982 "400":
15983 description: Invalid content / Missing content
15984 "403":
15985 description: Restricted operation
15986 "404":
15987 description: Toggleable features not found
15988 default:
15989 content:
15990 application/json:
15991 schema:
15992 type: array
15993 items:
15994 type: object
15995 properties:
15996 allowedMethods:
15997 type: array
15998 items:
15999 type: string
16000 uniqueItems: true
16001 cookies:
16002 type: object
16003 additionalProperties:
16004 type: object
16005 properties:
16006 comment:
16007 type: string
16008 domain:
16009 type: string
16010 expiry:
16011 type: string
16012 format: date-time
16013 httpOnly:
16014 type: boolean
16015 maxAge:
16016 type: integer
16017 format: int32
16018 name:
16019 type: string
16020 path:
16021 type: string
16022 secure:
16023 type: boolean
16024 value:
16025 type: string
16026 version:
16027 type: integer
16028 format: int32
16029 date:
16030 type: string
16031 format: date-time
16032 entity:
16033 type: object
16034 entityTag:
16035 type: object
16036 properties:
16037 value:
16038 type: string
16039 weak:
16040 type: boolean
16041 headers:
16042 type: object
16043 additionalProperties:
16044 type: array
16045 items:
16046 type: object
16047 language:
16048 type: object
16049 properties:
16050 country:
16051 type: string
16052 displayCountry:
16053 type: string
16054 displayLanguage:
16055 type: string
16056 displayName:
16057 type: string
16058 displayScript:
16059 type: string
16060 displayVariant:
16061 type: string
16062 extensionKeys:
16063 type: array
16064 items:
16065 type: string
16066 uniqueItems: true
16067 iso3Country:
16068 type: string
16069 iso3Language:
16070 type: string
16071 language:
16072 type: string
16073 script:
16074 type: string
16075 unicodeLocaleAttributes:
16076 type: array
16077 items:
16078 type: string
16079 uniqueItems: true
16080 unicodeLocaleKeys:
16081 type: array
16082 items:
16083 type: string
16084 uniqueItems: true
16085 variant:
16086 type: string
16087 lastModified:
16088 type: string
16089 format: date-time
16090 length:
16091 type: integer
16092 format: int32
16093 links:
16094 type: array
16095 items:
16096 type: object
16097 properties:
16098 params:
16099 type: object
16100 additionalProperties:
16101 type: string
16102 rel:
16103 type: string
16104 rels:
16105 type: array
16106 items:
16107 type: string
16108 title:
16109 type: string
16110 type:
16111 type: string
16112 uri:
16113 type: string
16114 format: uri
16115 uriBuilder:
16116 type: object
16117 uniqueItems: true
16118 location:
16119 type: string
16120 format: uri
16121 mediaType:
16122 type: object
16123 properties:
16124 parameters:
16125 type: object
16126 additionalProperties:
16127 type: string
16128 subtype:
16129 type: string
16130 type:
16131 type: string
16132 wildcardSubtype:
16133 type: boolean
16134 wildcardType:
16135 type: boolean
16136 metadata:
16137 type: object
16138 additionalProperties:
16139 type: array
16140 items:
16141 type: object
16142 status:
16143 type: integer
16144 format: int32
16145 statusInfo:
16146 type: object
16147 properties:
16148 family:
16149 type: string
16150 enum:
16151 - INFORMATIONAL
16152 - SUCCESSFUL
16153 - REDIRECTION
16154 - CLIENT_ERROR
16155 - SERVER_ERROR
16156 - OTHER
16157 reasonPhrase:
16158 type: string
16159 statusCode:
16160 type: integer
16161 format: int32
16162 stringHeaders:
16163 type: object
16164 additionalProperties:
16165 type: array
16166 items:
16167 type: string
16168 servers:
16169 - url: /sdc2/rest
16170 variables: {}
16171 summary: Update all feature status
16172 tags:
16173 - SDCE-2 APIs
16174 /v1/catalog/toggle/{featureName}/state:
16175 get:
16176 description: Get Toggleable feature state
16177 operationId: getToggleableFeature
16178 parameters:
16179 - in: path
16180 name: featureName
16181 required: true
16182 schema:
16183 type: string
16184 responses:
16185 "200":
16186 description: Success
16187 "400":
16188 description: Invalid content / Missing content
16189 "403":
16190 description: Restricted operation
16191 "404":
16192 description: Toggleable feature not found
16193 default:
16194 content:
16195 application/json:
16196 schema:
16197 type: array
16198 items:
16199 type: object
16200 properties:
16201 allowedMethods:
16202 type: array
16203 items:
16204 type: string
16205 uniqueItems: true
16206 cookies:
16207 type: object
16208 additionalProperties:
16209 type: object
16210 properties:
16211 comment:
16212 type: string
16213 domain:
16214 type: string
16215 expiry:
16216 type: string
16217 format: date-time
16218 httpOnly:
16219 type: boolean
16220 maxAge:
16221 type: integer
16222 format: int32
16223 name:
16224 type: string
16225 path:
16226 type: string
16227 secure:
16228 type: boolean
16229 value:
16230 type: string
16231 version:
16232 type: integer
16233 format: int32
16234 date:
16235 type: string
16236 format: date-time
16237 entity:
16238 type: object
16239 entityTag:
16240 type: object
16241 properties:
16242 value:
16243 type: string
16244 weak:
16245 type: boolean
16246 headers:
16247 type: object
16248 additionalProperties:
16249 type: array
16250 items:
16251 type: object
16252 language:
16253 type: object
16254 properties:
16255 country:
16256 type: string
16257 displayCountry:
16258 type: string
16259 displayLanguage:
16260 type: string
16261 displayName:
16262 type: string
16263 displayScript:
16264 type: string
16265 displayVariant:
16266 type: string
16267 extensionKeys:
16268 type: array
16269 items:
16270 type: string
16271 uniqueItems: true
16272 iso3Country:
16273 type: string
16274 iso3Language:
16275 type: string
16276 language:
16277 type: string
16278 script:
16279 type: string
16280 unicodeLocaleAttributes:
16281 type: array
16282 items:
16283 type: string
16284 uniqueItems: true
16285 unicodeLocaleKeys:
16286 type: array
16287 items:
16288 type: string
16289 uniqueItems: true
16290 variant:
16291 type: string
16292 lastModified:
16293 type: string
16294 format: date-time
16295 length:
16296 type: integer
16297 format: int32
16298 links:
16299 type: array
16300 items:
16301 type: object
16302 properties:
16303 params:
16304 type: object
16305 additionalProperties:
16306 type: string
16307 rel:
16308 type: string
16309 rels:
16310 type: array
16311 items:
16312 type: string
16313 title:
16314 type: string
16315 type:
16316 type: string
16317 uri:
16318 type: string
16319 format: uri
16320 uriBuilder:
16321 type: object
16322 uniqueItems: true
16323 location:
16324 type: string
16325 format: uri
16326 mediaType:
16327 type: object
16328 properties:
16329 parameters:
16330 type: object
16331 additionalProperties:
16332 type: string
16333 subtype:
16334 type: string
16335 type:
16336 type: string
16337 wildcardSubtype:
16338 type: boolean
16339 wildcardType:
16340 type: boolean
16341 metadata:
16342 type: object
16343 additionalProperties:
16344 type: array
16345 items:
16346 type: object
16347 status:
16348 type: integer
16349 format: int32
16350 statusInfo:
16351 type: object
16352 properties:
16353 family:
16354 type: string
16355 enum:
16356 - INFORMATIONAL
16357 - SUCCESSFUL
16358 - REDIRECTION
16359 - CLIENT_ERROR
16360 - SERVER_ERROR
16361 - OTHER
16362 reasonPhrase:
16363 type: string
16364 statusCode:
16365 type: integer
16366 format: int32
16367 stringHeaders:
16368 type: object
16369 additionalProperties:
16370 type: array
16371 items:
16372 type: string
16373 servers:
16374 - url: /sdc2/rest
16375 variables: {}
16376 summary: Returns one toggleable feature state
16377 tags:
16378 - SDCE-2 APIs
16379 /v1/catalog/toggle/{featureName}/state/{state}:
16380 put:
16381 description: Update feature toggle state
16382 operationId: updateFeatureState
16383 parameters:
16384 - in: path
16385 name: featureName
16386 required: true
16387 schema:
16388 type: string
16389 - in: path
16390 name: state
16391 required: true
16392 schema:
16393 type: boolean
16394 responses:
16395 "200":
16396 description: Success
16397 "400":
16398 description: Invalid content / Missing content
16399 "403":
16400 description: Restricted operation
16401 "404":
16402 description: Toggleable features not found
16403 default:
16404 content:
16405 application/json:
16406 schema:
16407 type: array
16408 items:
16409 type: object
16410 properties:
16411 allowedMethods:
16412 type: array
16413 items:
16414 type: string
16415 uniqueItems: true
16416 cookies:
16417 type: object
16418 additionalProperties:
16419 type: object
16420 properties:
16421 comment:
16422 type: string
16423 domain:
16424 type: string
16425 expiry:
16426 type: string
16427 format: date-time
16428 httpOnly:
16429 type: boolean
16430 maxAge:
16431 type: integer
16432 format: int32
16433 name:
16434 type: string
16435 path:
16436 type: string
16437 secure:
16438 type: boolean
16439 value:
16440 type: string
16441 version:
16442 type: integer
16443 format: int32
16444 date:
16445 type: string
16446 format: date-time
16447 entity:
16448 type: object
16449 entityTag:
16450 type: object
16451 properties:
16452 value:
16453 type: string
16454 weak:
16455 type: boolean
16456 headers:
16457 type: object
16458 additionalProperties:
16459 type: array
16460 items:
16461 type: object
16462 language:
16463 type: object
16464 properties:
16465 country:
16466 type: string
16467 displayCountry:
16468 type: string
16469 displayLanguage:
16470 type: string
16471 displayName:
16472 type: string
16473 displayScript:
16474 type: string
16475 displayVariant:
16476 type: string
16477 extensionKeys:
16478 type: array
16479 items:
16480 type: string
16481 uniqueItems: true
16482 iso3Country:
16483 type: string
16484 iso3Language:
16485 type: string
16486 language:
16487 type: string
16488 script:
16489 type: string
16490 unicodeLocaleAttributes:
16491 type: array
16492 items:
16493 type: string
16494 uniqueItems: true
16495 unicodeLocaleKeys:
16496 type: array
16497 items:
16498 type: string
16499 uniqueItems: true
16500 variant:
16501 type: string
16502 lastModified:
16503 type: string
16504 format: date-time
16505 length:
16506 type: integer
16507 format: int32
16508 links:
16509 type: array
16510 items:
16511 type: object
16512 properties:
16513 params:
16514 type: object
16515 additionalProperties:
16516 type: string
16517 rel:
16518 type: string
16519 rels:
16520 type: array
16521 items:
16522 type: string
16523 title:
16524 type: string
16525 type:
16526 type: string
16527 uri:
16528 type: string
16529 format: uri
16530 uriBuilder:
16531 type: object
16532 uniqueItems: true
16533 location:
16534 type: string
16535 format: uri
16536 mediaType:
16537 type: object
16538 properties:
16539 parameters:
16540 type: object
16541 additionalProperties:
16542 type: string
16543 subtype:
16544 type: string
16545 type:
16546 type: string
16547 wildcardSubtype:
16548 type: boolean
16549 wildcardType:
16550 type: boolean
16551 metadata:
16552 type: object
16553 additionalProperties:
16554 type: array
16555 items:
16556 type: object
16557 status:
16558 type: integer
16559 format: int32
16560 statusInfo:
16561 type: object
16562 properties:
16563 family:
16564 type: string
16565 enum:
16566 - INFORMATIONAL
16567 - SUCCESSFUL
16568 - REDIRECTION
16569 - CLIENT_ERROR
16570 - SERVER_ERROR
16571 - OTHER
16572 reasonPhrase:
16573 type: string
16574 statusCode:
16575 type: integer
16576 format: int32
16577 stringHeaders:
16578 type: object
16579 additionalProperties:
16580 type: array
16581 items:
16582 type: string
16583 servers:
16584 - url: /sdc2/rest
16585 variables: {}
16586 summary: Update feature status
16587 tags:
16588 - SDCE-2 APIs
16589 /v1/catalog/upload/resource/import:
16590 post:
16591 description: "Import node types from a TOSCA yaml, along with the types metadata"
16592 operationId: bulkImport
16593 parameters:
16594 - in: header
16595 name: USER_ID
16596 schema:
16597 type: string
16598 requestBody:
16599 content:
16600 multipart/form-data:
16601 schema:
16602 type: object
16603 properties:
16604 createNewVersion:
16605 type: boolean
16606 default: true
16607 description: The model name to associate the node types to
16608 nodeTypeMetadataJson:
16609 $ref: '#/components/schemas/NodeTypesMetadataList'
16610 nodeTypesYaml:
16611 type: object
16612 description: The node types TOSCA definition yaml
16613 required:
16614 - nodeTypeMetadataJson
16615 - nodeTypesYaml
16616 responses:
16617 "201":
16618 description: Resources created
16619 "400":
16620 description: Invalid content / Missing content
16621 "403":
16622 description: Restricted operation
16623 "409":
16624 description: One of the resources already exists
16625 default:
16626 content:
16627 application/json:
16628 schema:
16629 type: array
16630 items:
16631 type: object
16632 properties:
16633 allowedMethods:
16634 type: array
16635 items:
16636 type: string
16637 uniqueItems: true
16638 cookies:
16639 type: object
16640 additionalProperties:
16641 type: object
16642 properties:
16643 comment:
16644 type: string
16645 domain:
16646 type: string
16647 expiry:
16648 type: string
16649 format: date-time
16650 httpOnly:
16651 type: boolean
16652 maxAge:
16653 type: integer
16654 format: int32
16655 name:
16656 type: string
16657 path:
16658 type: string
16659 secure:
16660 type: boolean
16661 value:
16662 type: string
16663 version:
16664 type: integer
16665 format: int32
16666 date:
16667 type: string
16668 format: date-time
16669 entity:
16670 type: object
16671 entityTag:
16672 type: object
16673 properties:
16674 value:
16675 type: string
16676 weak:
16677 type: boolean
16678 headers:
16679 type: object
16680 additionalProperties:
16681 type: array
16682 items:
16683 type: object
16684 language:
16685 type: object
16686 properties:
16687 country:
16688 type: string
16689 displayCountry:
16690 type: string
16691 displayLanguage:
16692 type: string
16693 displayName:
16694 type: string
16695 displayScript:
16696 type: string
16697 displayVariant:
16698 type: string
16699 extensionKeys:
16700 type: array
16701 items:
16702 type: string
16703 uniqueItems: true
16704 iso3Country:
16705 type: string
16706 iso3Language:
16707 type: string
16708 language:
16709 type: string
16710 script:
16711 type: string
16712 unicodeLocaleAttributes:
16713 type: array
16714 items:
16715 type: string
16716 uniqueItems: true
16717 unicodeLocaleKeys:
16718 type: array
16719 items:
16720 type: string
16721 uniqueItems: true
16722 variant:
16723 type: string
16724 lastModified:
16725 type: string
16726 format: date-time
16727 length:
16728 type: integer
16729 format: int32
16730 links:
16731 type: array
16732 items:
16733 type: object
16734 properties:
16735 params:
16736 type: object
16737 additionalProperties:
16738 type: string
16739 rel:
16740 type: string
16741 rels:
16742 type: array
16743 items:
16744 type: string
16745 title:
16746 type: string
16747 type:
16748 type: string
16749 uri:
16750 type: string
16751 format: uri
16752 uriBuilder:
16753 type: object
16754 uniqueItems: true
16755 location:
16756 type: string
16757 format: uri
16758 mediaType:
16759 type: object
16760 properties:
16761 parameters:
16762 type: object
16763 additionalProperties:
16764 type: string
16765 subtype:
16766 type: string
16767 type:
16768 type: string
16769 wildcardSubtype:
16770 type: boolean
16771 wildcardType:
16772 type: boolean
16773 metadata:
16774 type: object
16775 additionalProperties:
16776 type: array
16777 items:
16778 type: object
16779 status:
16780 type: integer
16781 format: int32
16782 statusInfo:
16783 type: object
16784 properties:
16785 family:
16786 type: string
16787 enum:
16788 - INFORMATIONAL
16789 - SUCCESSFUL
16790 - REDIRECTION
16791 - CLIENT_ERROR
16792 - SERVER_ERROR
16793 - OTHER
16794 reasonPhrase:
16795 type: string
16796 statusCode:
16797 type: integer
16798 format: int32
16799 stringHeaders:
16800 type: object
16801 additionalProperties:
16802 type: array
16803 items:
16804 type: string
16805 servers:
16806 - url: /sdc2/rest
16807 variables: {}
16808 summary: Creates node types from a TOSCA yaml file
16809 tags:
16810 - SDCE-2 APIs
16811 /v1/catalog/upload/{resourceAuthority}:
16812 post:
16813 description: Create Resource from yaml
16814 operationId: uploadMultipart
16815 parameters:
16816 - description: "validValues: normative-resource / user-resource"
16817 in: path
16818 name: resourceAuthority
16819 required: true
16820 schema:
16821 type: string
16822 enum:
16823 - multipart
16824 - user-resource
16825 - user-resource-ui-import
16826 - in: header
16827 name: USER_ID
16828 schema:
16829 type: string
16830 - in: query
16831 name: createNewVersion
16832 schema:
16833 type: boolean
16834 default: true
16835 requestBody:
16836 content:
16837 multipart/form-data:
16838 schema:
16839 type: object
16840 properties:
16841 resourceMetadata:
16842 type: string
16843 description: resourceMetadata
16844 resourceZip:
16845 $ref: '#/components/schemas/FormDataContentDisposition'
16846 responses:
16847 "201":
16848 description: Resource created
16849 "400":
16850 description: Invalid content / Missing content
16851 "403":
16852 description: Restricted operation
16853 "409":
16854 description: Resource already exist
16855 default:
16856 content:
16857 application/json:
16858 schema:
16859 type: array
16860 items:
16861 type: object
16862 properties:
16863 allowedMethods:
16864 type: array
16865 items:
16866 type: string
16867 uniqueItems: true
16868 cookies:
16869 type: object
16870 additionalProperties:
16871 type: object
16872 properties:
16873 comment:
16874 type: string
16875 domain:
16876 type: string
16877 expiry:
16878 type: string
16879 format: date-time
16880 httpOnly:
16881 type: boolean
16882 maxAge:
16883 type: integer
16884 format: int32
16885 name:
16886 type: string
16887 path:
16888 type: string
16889 secure:
16890 type: boolean
16891 value:
16892 type: string
16893 version:
16894 type: integer
16895 format: int32
16896 date:
16897 type: string
16898 format: date-time
16899 entity:
16900 type: object
16901 entityTag:
16902 type: object
16903 properties:
16904 value:
16905 type: string
16906 weak:
16907 type: boolean
16908 headers:
16909 type: object
16910 additionalProperties:
16911 type: array
16912 items:
16913 type: object
16914 language:
16915 type: object
16916 properties:
16917 country:
16918 type: string
16919 displayCountry:
16920 type: string
16921 displayLanguage:
16922 type: string
16923 displayName:
16924 type: string
16925 displayScript:
16926 type: string
16927 displayVariant:
16928 type: string
16929 extensionKeys:
16930 type: array
16931 items:
16932 type: string
16933 uniqueItems: true
16934 iso3Country:
16935 type: string
16936 iso3Language:
16937 type: string
16938 language:
16939 type: string
16940 script:
16941 type: string
16942 unicodeLocaleAttributes:
16943 type: array
16944 items:
16945 type: string
16946 uniqueItems: true
16947 unicodeLocaleKeys:
16948 type: array
16949 items:
16950 type: string
16951 uniqueItems: true
16952 variant:
16953 type: string
16954 lastModified:
16955 type: string
16956 format: date-time
16957 length:
16958 type: integer
16959 format: int32
16960 links:
16961 type: array
16962 items:
16963 type: object
16964 properties:
16965 params:
16966 type: object
16967 additionalProperties:
16968 type: string
16969 rel:
16970 type: string
16971 rels:
16972 type: array
16973 items:
16974 type: string
16975 title:
16976 type: string
16977 type:
16978 type: string
16979 uri:
16980 type: string
16981 format: uri
16982 uriBuilder:
16983 type: object
16984 uniqueItems: true
16985 location:
16986 type: string
16987 format: uri
16988 mediaType:
16989 type: object
16990 properties:
16991 parameters:
16992 type: object
16993 additionalProperties:
16994 type: string
16995 subtype:
16996 type: string
16997 type:
16998 type: string
16999 wildcardSubtype:
17000 type: boolean
17001 wildcardType:
17002 type: boolean
17003 metadata:
17004 type: object
17005 additionalProperties:
17006 type: array
17007 items:
17008 type: object
17009 status:
17010 type: integer
17011 format: int32
17012 statusInfo:
17013 type: object
17014 properties:
17015 family:
17016 type: string
17017 enum:
17018 - INFORMATIONAL
17019 - SUCCESSFUL
17020 - REDIRECTION
17021 - CLIENT_ERROR
17022 - SERVER_ERROR
17023 - OTHER
17024 reasonPhrase:
17025 type: string
17026 statusCode:
17027 type: integer
17028 format: int32
17029 stringHeaders:
17030 type: object
17031 additionalProperties:
17032 type: array
17033 items:
17034 type: string
17035 servers:
17036 - url: /sdc2/rest
17037 variables: {}
17038 summary: Returns created resource
17039 tags:
17040 - SDCE-2 APIs
17041 /v1/catalog/uploadType/annotationtypes:
17042 post:
17043 description: Create AnnotationTypes from yaml
17044 operationId: uploadAnnotationTypes
17045 parameters:
17046 - in: header
17047 name: USER_ID
17048 schema:
17049 type: string
17050 requestBody:
17051 content:
17052 multipart/form-data:
17053 schema:
17054 type: object
17055 properties:
17056 annotationTypesZip:
17057 type: string
17058 format: binary
17059 description: FileInputStream
17060 responses:
17061 "201":
17062 description: annotation types created
17063 "400":
17064 description: Invalid content / Missing content
17065 "403":
17066 description: Restricted operation
17067 "409":
17068 description: annotation types already exist
17069 default:
17070 content:
17071 application/json:
17072 schema:
17073 type: array
17074 items:
17075 type: object
17076 properties:
17077 allowedMethods:
17078 type: array
17079 items:
17080 type: string
17081 uniqueItems: true
17082 cookies:
17083 type: object
17084 additionalProperties:
17085 type: object
17086 properties:
17087 comment:
17088 type: string
17089 domain:
17090 type: string
17091 expiry:
17092 type: string
17093 format: date-time
17094 httpOnly:
17095 type: boolean
17096 maxAge:
17097 type: integer
17098 format: int32
17099 name:
17100 type: string
17101 path:
17102 type: string
17103 secure:
17104 type: boolean
17105 value:
17106 type: string
17107 version:
17108 type: integer
17109 format: int32
17110 date:
17111 type: string
17112 format: date-time
17113 entity:
17114 type: object
17115 entityTag:
17116 type: object
17117 properties:
17118 value:
17119 type: string
17120 weak:
17121 type: boolean
17122 headers:
17123 type: object
17124 additionalProperties:
17125 type: array
17126 items:
17127 type: object
17128 language:
17129 type: object
17130 properties:
17131 country:
17132 type: string
17133 displayCountry:
17134 type: string
17135 displayLanguage:
17136 type: string
17137 displayName:
17138 type: string
17139 displayScript:
17140 type: string
17141 displayVariant:
17142 type: string
17143 extensionKeys:
17144 type: array
17145 items:
17146 type: string
17147 uniqueItems: true
17148 iso3Country:
17149 type: string
17150 iso3Language:
17151 type: string
17152 language:
17153 type: string
17154 script:
17155 type: string
17156 unicodeLocaleAttributes:
17157 type: array
17158 items:
17159 type: string
17160 uniqueItems: true
17161 unicodeLocaleKeys:
17162 type: array
17163 items:
17164 type: string
17165 uniqueItems: true
17166 variant:
17167 type: string
17168 lastModified:
17169 type: string
17170 format: date-time
17171 length:
17172 type: integer
17173 format: int32
17174 links:
17175 type: array
17176 items:
17177 type: object
17178 properties:
17179 params:
17180 type: object
17181 additionalProperties:
17182 type: string
17183 rel:
17184 type: string
17185 rels:
17186 type: array
17187 items:
17188 type: string
17189 title:
17190 type: string
17191 type:
17192 type: string
17193 uri:
17194 type: string
17195 format: uri
17196 uriBuilder:
17197 type: object
17198 uniqueItems: true
17199 location:
17200 type: string
17201 format: uri
17202 mediaType:
17203 type: object
17204 properties:
17205 parameters:
17206 type: object
17207 additionalProperties:
17208 type: string
17209 subtype:
17210 type: string
17211 type:
17212 type: string
17213 wildcardSubtype:
17214 type: boolean
17215 wildcardType:
17216 type: boolean
17217 metadata:
17218 type: object
17219 additionalProperties:
17220 type: array
17221 items:
17222 type: object
17223 status:
17224 type: integer
17225 format: int32
17226 statusInfo:
17227 type: object
17228 properties:
17229 family:
17230 type: string
17231 enum:
17232 - INFORMATIONAL
17233 - SUCCESSFUL
17234 - REDIRECTION
17235 - CLIENT_ERROR
17236 - SERVER_ERROR
17237 - OTHER
17238 reasonPhrase:
17239 type: string
17240 statusCode:
17241 type: integer
17242 format: int32
17243 stringHeaders:
17244 type: object
17245 additionalProperties:
17246 type: array
17247 items:
17248 type: string
17249 servers:
17250 - url: /sdc2/rest
17251 variables: {}
17252 summary: Returns created annotation types
17253 tags:
17254 - SDCE-2 APIs
17255 /v1/catalog/uploadType/artifactTypes:
17256 post:
17257 description: Create Tosca Artifact types from yaml
17258 operationId: uploadArtifactTypes
17259 parameters:
17260 - in: header
17261 name: USER_ID
17262 schema:
17263 type: string
17264 requestBody:
17265 content:
17266 multipart/form-data:
17267 schema:
17268 type: object
17269 properties:
17270 artifactsZip:
17271 type: string
17272 format: binary
17273 description: Zip file containing a yaml with the TOSCA artifact
17274 types definition
17275 includeToModelImport:
17276 type: boolean
17277 description: A flag to add types to the default imports
17278 model:
17279 type: string
17280 description: model name
17281 responses:
17282 "201":
17283 description: Tosca Artifact types created
17284 "400":
17285 description: Invalid content / Missing content
17286 "403":
17287 description: Restricted operation
17288 "409":
17289 description: Tosca Artifact Type already exist
17290 default:
17291 content:
17292 application/json:
17293 schema:
17294 type: array
17295 items:
17296 type: object
17297 properties:
17298 allowedMethods:
17299 type: array
17300 items:
17301 type: string
17302 uniqueItems: true
17303 cookies:
17304 type: object
17305 additionalProperties:
17306 type: object
17307 properties:
17308 comment:
17309 type: string
17310 domain:
17311 type: string
17312 expiry:
17313 type: string
17314 format: date-time
17315 httpOnly:
17316 type: boolean
17317 maxAge:
17318 type: integer
17319 format: int32
17320 name:
17321 type: string
17322 path:
17323 type: string
17324 secure:
17325 type: boolean
17326 value:
17327 type: string
17328 version:
17329 type: integer
17330 format: int32
17331 date:
17332 type: string
17333 format: date-time
17334 entity:
17335 type: object
17336 entityTag:
17337 type: object
17338 properties:
17339 value:
17340 type: string
17341 weak:
17342 type: boolean
17343 headers:
17344 type: object
17345 additionalProperties:
17346 type: array
17347 items:
17348 type: object
17349 language:
17350 type: object
17351 properties:
17352 country:
17353 type: string
17354 displayCountry:
17355 type: string
17356 displayLanguage:
17357 type: string
17358 displayName:
17359 type: string
17360 displayScript:
17361 type: string
17362 displayVariant:
17363 type: string
17364 extensionKeys:
17365 type: array
17366 items:
17367 type: string
17368 uniqueItems: true
17369 iso3Country:
17370 type: string
17371 iso3Language:
17372 type: string
17373 language:
17374 type: string
17375 script:
17376 type: string
17377 unicodeLocaleAttributes:
17378 type: array
17379 items:
17380 type: string
17381 uniqueItems: true
17382 unicodeLocaleKeys:
17383 type: array
17384 items:
17385 type: string
17386 uniqueItems: true
17387 variant:
17388 type: string
17389 lastModified:
17390 type: string
17391 format: date-time
17392 length:
17393 type: integer
17394 format: int32
17395 links:
17396 type: array
17397 items:
17398 type: object
17399 properties:
17400 params:
17401 type: object
17402 additionalProperties:
17403 type: string
17404 rel:
17405 type: string
17406 rels:
17407 type: array
17408 items:
17409 type: string
17410 title:
17411 type: string
17412 type:
17413 type: string
17414 uri:
17415 type: string
17416 format: uri
17417 uriBuilder:
17418 type: object
17419 uniqueItems: true
17420 location:
17421 type: string
17422 format: uri
17423 mediaType:
17424 type: object
17425 properties:
17426 parameters:
17427 type: object
17428 additionalProperties:
17429 type: string
17430 subtype:
17431 type: string
17432 type:
17433 type: string
17434 wildcardSubtype:
17435 type: boolean
17436 wildcardType:
17437 type: boolean
17438 metadata:
17439 type: object
17440 additionalProperties:
17441 type: array
17442 items:
17443 type: object
17444 status:
17445 type: integer
17446 format: int32
17447 statusInfo:
17448 type: object
17449 properties:
17450 family:
17451 type: string
17452 enum:
17453 - INFORMATIONAL
17454 - SUCCESSFUL
17455 - REDIRECTION
17456 - CLIENT_ERROR
17457 - SERVER_ERROR
17458 - OTHER
17459 reasonPhrase:
17460 type: string
17461 statusCode:
17462 type: integer
17463 format: int32
17464 stringHeaders:
17465 type: object
17466 additionalProperties:
17467 type: array
17468 items:
17469 type: string
17470 servers:
17471 - url: /sdc2/rest
17472 variables: {}
17473 summary: Returns created Tosca artifact types
17474 tags:
17475 - SDCE-2 APIs
17476 /v1/catalog/uploadType/capability:
17477 post:
17478 description: Create Capability Type from yaml
17479 operationId: uploadCapabilityType
17480 parameters:
17481 - in: header
17482 name: USER_ID
17483 schema:
17484 type: string
17485 requestBody:
17486 content:
17487 multipart/form-data:
17488 schema:
17489 type: object
17490 properties:
17491 capabilityTypeZip:
17492 type: string
17493 format: binary
17494 description: FileInputStream
17495 includeToModelImport:
17496 type: boolean
17497 description: includeToModelImport
17498 model:
17499 type: string
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]17500 description: model name
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]17501 responses:
17502 "201":
17503 description: Capability Type created
17504 "400":
17505 description: Invalid content / Missing content
17506 "403":
17507 description: Restricted operation
17508 "409":
17509 description: Capability Type already exist
17510 default:
17511 content:
17512 application/json:
17513 schema:
17514 type: array
17515 items:
17516 type: object
17517 properties:
17518 allowedMethods:
17519 type: array
17520 items:
17521 type: string
17522 uniqueItems: true
17523 cookies:
17524 type: object
17525 additionalProperties:
17526 type: object
17527 properties:
17528 comment:
17529 type: string
17530 domain:
17531 type: string
17532 expiry:
17533 type: string
17534 format: date-time
17535 httpOnly:
17536 type: boolean
17537 maxAge:
17538 type: integer
17539 format: int32
17540 name:
17541 type: string
17542 path:
17543 type: string
17544 secure:
17545 type: boolean
17546 value:
17547 type: string
17548 version:
17549 type: integer
17550 format: int32
17551 date:
17552 type: string
17553 format: date-time
17554 entity:
17555 type: object
17556 entityTag:
17557 type: object
17558 properties:
17559 value:
17560 type: string
17561 weak:
17562 type: boolean
17563 headers:
17564 type: object
17565 additionalProperties:
17566 type: array
17567 items:
17568 type: object
17569 language:
17570 type: object
17571 properties:
17572 country:
17573 type: string
17574 displayCountry:
17575 type: string
17576 displayLanguage:
17577 type: string
17578 displayName:
17579 type: string
17580 displayScript:
17581 type: string
17582 displayVariant:
17583 type: string
17584 extensionKeys:
17585 type: array
17586 items:
17587 type: string
17588 uniqueItems: true
17589 iso3Country:
17590 type: string
17591 iso3Language:
17592 type: string
17593 language:
17594 type: string
17595 script:
17596 type: string
17597 unicodeLocaleAttributes:
17598 type: array
17599 items:
17600 type: string
17601 uniqueItems: true
17602 unicodeLocaleKeys:
17603 type: array
17604 items:
17605 type: string
17606 uniqueItems: true
17607 variant:
17608 type: string
17609 lastModified:
17610 type: string
17611 format: date-time
17612 length:
17613 type: integer
17614 format: int32
17615 links:
17616 type: array
17617 items:
17618 type: object
17619 properties:
17620 params:
17621 type: object
17622 additionalProperties:
17623 type: string
17624 rel:
17625 type: string
17626 rels:
17627 type: array
17628 items:
17629 type: string
17630 title:
17631 type: string
17632 type:
17633 type: string
17634 uri:
17635 type: string
17636 format: uri
17637 uriBuilder:
17638 type: object
17639 uniqueItems: true
17640 location:
17641 type: string
17642 format: uri
17643 mediaType:
17644 type: object
17645 properties:
17646 parameters:
17647 type: object
17648 additionalProperties:
17649 type: string
17650 subtype:
17651 type: string
17652 type:
17653 type: string
17654 wildcardSubtype:
17655 type: boolean
17656 wildcardType:
17657 type: boolean
17658 metadata:
17659 type: object
17660 additionalProperties:
17661 type: array
17662 items:
17663 type: object
17664 status:
17665 type: integer
17666 format: int32
17667 statusInfo:
17668 type: object
17669 properties:
17670 family:
17671 type: string
17672 enum:
17673 - INFORMATIONAL
17674 - SUCCESSFUL
17675 - REDIRECTION
17676 - CLIENT_ERROR
17677 - SERVER_ERROR
17678 - OTHER
17679 reasonPhrase:
17680 type: string
17681 statusCode:
17682 type: integer
17683 format: int32
17684 stringHeaders:
17685 type: object
17686 additionalProperties:
17687 type: array
17688 items:
17689 type: string
17690 servers:
17691 - url: /sdc2/rest
17692 variables: {}
17693 summary: Returns created Capability Type
17694 tags:
17695 - SDCE-2 APIs
17696 /v1/catalog/uploadType/categories:
17697 post:
17698 description: Create Categories from yaml
17699 operationId: uploadCategories
17700 parameters:
17701 - in: header
17702 name: USER_ID
17703 schema:
17704 type: string
17705 requestBody:
17706 content:
17707 multipart/form-data:
17708 schema:
17709 type: object
17710 properties:
17711 categoriesZip:
17712 type: string
17713 format: binary
17714 description: FileInputStream
17715 responses:
17716 "201":
17717 description: Categories created
17718 "400":
17719 description: Invalid content / Missing content
17720 "403":
17721 description: Restricted operation
17722 "409":
17723 description: Category already exist
17724 default:
17725 content:
17726 application/json:
17727 schema:
17728 type: array
17729 items:
17730 type: object
17731 properties:
17732 allowedMethods:
17733 type: array
17734 items:
17735 type: string
17736 uniqueItems: true
17737 cookies:
17738 type: object
17739 additionalProperties:
17740 type: object
17741 properties:
17742 comment:
17743 type: string
17744 domain:
17745 type: string
17746 expiry:
17747 type: string
17748 format: date-time
17749 httpOnly:
17750 type: boolean
17751 maxAge:
17752 type: integer
17753 format: int32
17754 name:
17755 type: string
17756 path:
17757 type: string
17758 secure:
17759 type: boolean
17760 value:
17761 type: string
17762 version:
17763 type: integer
17764 format: int32
17765 date:
17766 type: string
17767 format: date-time
17768 entity:
17769 type: object
17770 entityTag:
17771 type: object
17772 properties:
17773 value:
17774 type: string
17775 weak:
17776 type: boolean
17777 headers:
17778 type: object
17779 additionalProperties:
17780 type: array
17781 items:
17782 type: object
17783 language:
17784 type: object
17785 properties:
17786 country:
17787 type: string
17788 displayCountry:
17789 type: string
17790 displayLanguage:
17791 type: string
17792 displayName:
17793 type: string
17794 displayScript:
17795 type: string
17796 displayVariant:
17797 type: string
17798 extensionKeys:
17799 type: array
17800 items:
17801 type: string
17802 uniqueItems: true
17803 iso3Country:
17804 type: string
17805 iso3Language:
17806 type: string
17807 language:
17808 type: string
17809 script:
17810 type: string
17811 unicodeLocaleAttributes:
17812 type: array
17813 items:
17814 type: string
17815 uniqueItems: true
17816 unicodeLocaleKeys:
17817 type: array
17818 items:
17819 type: string
17820 uniqueItems: true
17821 variant:
17822 type: string
17823 lastModified:
17824 type: string
17825 format: date-time
17826 length:
17827 type: integer
17828 format: int32
17829 links:
17830 type: array
17831 items:
17832 type: object
17833 properties:
17834 params:
17835 type: object
17836 additionalProperties:
17837 type: string
17838 rel:
17839 type: string
17840 rels:
17841 type: array
17842 items:
17843 type: string
17844 title:
17845 type: string
17846 type:
17847 type: string
17848 uri:
17849 type: string
17850 format: uri
17851 uriBuilder:
17852 type: object
17853 uniqueItems: true
17854 location:
17855 type: string
17856 format: uri
17857 mediaType:
17858 type: object
17859 properties:
17860 parameters:
17861 type: object
17862 additionalProperties:
17863 type: string
17864 subtype:
17865 type: string
17866 type:
17867 type: string
17868 wildcardSubtype:
17869 type: boolean
17870 wildcardType:
17871 type: boolean
17872 metadata:
17873 type: object
17874 additionalProperties:
17875 type: array
17876 items:
17877 type: object
17878 status:
17879 type: integer
17880 format: int32
17881 statusInfo:
17882 type: object
17883 properties:
17884 family:
17885 type: string
17886 enum:
17887 - INFORMATIONAL
17888 - SUCCESSFUL
17889 - REDIRECTION
17890 - CLIENT_ERROR
17891 - SERVER_ERROR
17892 - OTHER
17893 reasonPhrase:
17894 type: string
17895 statusCode:
17896 type: integer
17897 format: int32
17898 stringHeaders:
17899 type: object
17900 additionalProperties:
17901 type: array
17902 items:
17903 type: string
17904 servers:
17905 - url: /sdc2/rest
17906 variables: {}
17907 summary: Returns created categories
17908 tags:
17909 - SDCE-2 APIs
17910 /v1/catalog/uploadType/datatypes:
17911 post:
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]17912 description: Create Data Types from zip
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]17913 operationId: uploadDataTypes
17914 parameters:
17915 - in: header
17916 name: USER_ID
17917 schema:
17918 type: string
17919 requestBody:
17920 content:
17921 multipart/form-data:
17922 schema:
17923 type: object
17924 properties:
17925 dataTypesZip:
17926 type: string
17927 format: binary
17928 description: FileInputStream
17929 includeToModelImport:
17930 type: boolean
17931 description: includeToModelImport
17932 model:
17933 type: string
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]17934 description: model name
17935 responses:
17936 "201":
17937 description: Data types created
17938 "400":
17939 description: Invalid content / Missing content
17940 "403":
17941 description: Restricted operation
17942 "409":
17943 description: Data types already exist
17944 default:
17945 content:
17946 application/json:
17947 schema:
17948 type: array
17949 items:
17950 type: object
17951 properties:
17952 allowedMethods:
17953 type: array
17954 items:
17955 type: string
17956 uniqueItems: true
17957 cookies:
17958 type: object
17959 additionalProperties:
17960 type: object
17961 properties:
17962 comment:
17963 type: string
17964 domain:
17965 type: string
17966 expiry:
17967 type: string
17968 format: date-time
17969 httpOnly:
17970 type: boolean
17971 maxAge:
17972 type: integer
17973 format: int32
17974 name:
17975 type: string
17976 path:
17977 type: string
17978 secure:
17979 type: boolean
17980 value:
17981 type: string
17982 version:
17983 type: integer
17984 format: int32
17985 date:
17986 type: string
17987 format: date-time
17988 entity:
17989 type: object
17990 entityTag:
17991 type: object
17992 properties:
17993 value:
17994 type: string
17995 weak:
17996 type: boolean
17997 headers:
17998 type: object
17999 additionalProperties:
18000 type: array
18001 items:
18002 type: object
18003 language:
18004 type: object
18005 properties:
18006 country:
18007 type: string
18008 displayCountry:
18009 type: string
18010 displayLanguage:
18011 type: string
18012 displayName:
18013 type: string
18014 displayScript:
18015 type: string
18016 displayVariant:
18017 type: string
18018 extensionKeys:
18019 type: array
18020 items:
18021 type: string
18022 uniqueItems: true
18023 iso3Country:
18024 type: string
18025 iso3Language:
18026 type: string
18027 language:
18028 type: string
18029 script:
18030 type: string
18031 unicodeLocaleAttributes:
18032 type: array
18033 items:
18034 type: string
18035 uniqueItems: true
18036 unicodeLocaleKeys:
18037 type: array
18038 items:
18039 type: string
18040 uniqueItems: true
18041 variant:
18042 type: string
18043 lastModified:
18044 type: string
18045 format: date-time
18046 length:
18047 type: integer
18048 format: int32
18049 links:
18050 type: array
18051 items:
18052 type: object
18053 properties:
18054 params:
18055 type: object
18056 additionalProperties:
18057 type: string
18058 rel:
18059 type: string
18060 rels:
18061 type: array
18062 items:
18063 type: string
18064 title:
18065 type: string
18066 type:
18067 type: string
18068 uri:
18069 type: string
18070 format: uri
18071 uriBuilder:
18072 type: object
18073 uniqueItems: true
18074 location:
18075 type: string
18076 format: uri
18077 mediaType:
18078 type: object
18079 properties:
18080 parameters:
18081 type: object
18082 additionalProperties:
18083 type: string
18084 subtype:
18085 type: string
18086 type:
18087 type: string
18088 wildcardSubtype:
18089 type: boolean
18090 wildcardType:
18091 type: boolean
18092 metadata:
18093 type: object
18094 additionalProperties:
18095 type: array
18096 items:
18097 type: object
18098 status:
18099 type: integer
18100 format: int32
18101 statusInfo:
18102 type: object
18103 properties:
18104 family:
18105 type: string
18106 enum:
18107 - INFORMATIONAL
18108 - SUCCESSFUL
18109 - REDIRECTION
18110 - CLIENT_ERROR
18111 - SERVER_ERROR
18112 - OTHER
18113 reasonPhrase:
18114 type: string
18115 statusCode:
18116 type: integer
18117 format: int32
18118 stringHeaders:
18119 type: object
18120 additionalProperties:
18121 type: array
18122 items:
18123 type: string
18124 servers:
18125 - url: /sdc2/rest
18126 variables: {}
18127 summary: Returns created data types
18128 tags:
18129 - SDCE-2 APIs
18130 /v1/catalog/uploadType/datatypesyaml:
18131 post:
18132 description: Create Data Types from yaml
18133 operationId: uploadDataTypesYaml
18134 parameters:
18135 - in: header
18136 name: USER_ID
18137 schema:
18138 type: string
18139 requestBody:
18140 content:
18141 multipart/form-data:
18142 schema:
18143 type: object
18144 properties:
18145 dataTypesYaml:
18146 type: string
18147 format: binary
18148 description: FileInputStream
18149 includeToModelImport:
18150 type: boolean
18151 description: includeToModelImport
18152 model:
18153 type: string
18154 description: model name
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]18155 responses:
18156 "201":
18157 description: Data types created
18158 "400":
18159 description: Invalid content / Missing content
18160 "403":
18161 description: Restricted operation
18162 "409":
18163 description: Data types already exist
18164 default:
18165 content:
18166 application/json:
18167 schema:
18168 type: array
18169 items:
18170 type: object
18171 properties:
18172 allowedMethods:
18173 type: array
18174 items:
18175 type: string
18176 uniqueItems: true
18177 cookies:
18178 type: object
18179 additionalProperties:
18180 type: object
18181 properties:
18182 comment:
18183 type: string
18184 domain:
18185 type: string
18186 expiry:
18187 type: string
18188 format: date-time
18189 httpOnly:
18190 type: boolean
18191 maxAge:
18192 type: integer
18193 format: int32
18194 name:
18195 type: string
18196 path:
18197 type: string
18198 secure:
18199 type: boolean
18200 value:
18201 type: string
18202 version:
18203 type: integer
18204 format: int32
18205 date:
18206 type: string
18207 format: date-time
18208 entity:
18209 type: object
18210 entityTag:
18211 type: object
18212 properties:
18213 value:
18214 type: string
18215 weak:
18216 type: boolean
18217 headers:
18218 type: object
18219 additionalProperties:
18220 type: array
18221 items:
18222 type: object
18223 language:
18224 type: object
18225 properties:
18226 country:
18227 type: string
18228 displayCountry:
18229 type: string
18230 displayLanguage:
18231 type: string
18232 displayName:
18233 type: string
18234 displayScript:
18235 type: string
18236 displayVariant:
18237 type: string
18238 extensionKeys:
18239 type: array
18240 items:
18241 type: string
18242 uniqueItems: true
18243 iso3Country:
18244 type: string
18245 iso3Language:
18246 type: string
18247 language:
18248 type: string
18249 script:
18250 type: string
18251 unicodeLocaleAttributes:
18252 type: array
18253 items:
18254 type: string
18255 uniqueItems: true
18256 unicodeLocaleKeys:
18257 type: array
18258 items:
18259 type: string
18260 uniqueItems: true
18261 variant:
18262 type: string
18263 lastModified:
18264 type: string
18265 format: date-time
18266 length:
18267 type: integer
18268 format: int32
18269 links:
18270 type: array
18271 items:
18272 type: object
18273 properties:
18274 params:
18275 type: object
18276 additionalProperties:
18277 type: string
18278 rel:
18279 type: string
18280 rels:
18281 type: array
18282 items:
18283 type: string
18284 title:
18285 type: string
18286 type:
18287 type: string
18288 uri:
18289 type: string
18290 format: uri
18291 uriBuilder:
18292 type: object
18293 uniqueItems: true
18294 location:
18295 type: string
18296 format: uri
18297 mediaType:
18298 type: object
18299 properties:
18300 parameters:
18301 type: object
18302 additionalProperties:
18303 type: string
18304 subtype:
18305 type: string
18306 type:
18307 type: string
18308 wildcardSubtype:
18309 type: boolean
18310 wildcardType:
18311 type: boolean
18312 metadata:
18313 type: object
18314 additionalProperties:
18315 type: array
18316 items:
18317 type: object
18318 status:
18319 type: integer
18320 format: int32
18321 statusInfo:
18322 type: object
18323 properties:
18324 family:
18325 type: string
18326 enum:
18327 - INFORMATIONAL
18328 - SUCCESSFUL
18329 - REDIRECTION
18330 - CLIENT_ERROR
18331 - SERVER_ERROR
18332 - OTHER
18333 reasonPhrase:
18334 type: string
18335 statusCode:
18336 type: integer
18337 format: int32
18338 stringHeaders:
18339 type: object
18340 additionalProperties:
18341 type: array
18342 items:
18343 type: string
18344 servers:
18345 - url: /sdc2/rest
18346 variables: {}
18347 summary: Returns created data types
18348 tags:
18349 - SDCE-2 APIs
18350 /v1/catalog/uploadType/grouptypes:
18351 post:
18352 description: Create GroupTypes from yaml
18353 operationId: uploadGroupTypes
18354 parameters:
18355 - in: header
18356 name: USER_ID
18357 schema:
18358 type: string
18359 requestBody:
18360 content:
18361 multipart/form-data:
18362 schema:
18363 type: object
18364 properties:
18365 groupTypesZip:
18366 type: string
18367 format: binary
18368 description: FileInputStream
18369 includeToModelImport:
18370 type: boolean
18371 description: includeToModelImport
18372 model:
18373 type: string
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]18374 description: model name
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]18375 toscaTypeMetadata:
18376 type: string
18377 description: toscaTypeMetadata
18378 responses:
18379 "201":
18380 description: group types created
18381 "400":
18382 description: Invalid content / Missing content
18383 "403":
18384 description: Restricted operation
18385 "409":
18386 description: group types already exist
18387 default:
18388 content:
18389 application/json:
18390 schema:
18391 type: array
18392 items:
18393 type: object
18394 properties:
18395 allowedMethods:
18396 type: array
18397 items:
18398 type: string
18399 uniqueItems: true
18400 cookies:
18401 type: object
18402 additionalProperties:
18403 type: object
18404 properties:
18405 comment:
18406 type: string
18407 domain:
18408 type: string
18409 expiry:
18410 type: string
18411 format: date-time
18412 httpOnly:
18413 type: boolean
18414 maxAge:
18415 type: integer
18416 format: int32
18417 name:
18418 type: string
18419 path:
18420 type: string
18421 secure:
18422 type: boolean
18423 value:
18424 type: string
18425 version:
18426 type: integer
18427 format: int32
18428 date:
18429 type: string
18430 format: date-time
18431 entity:
18432 type: object
18433 entityTag:
18434 type: object
18435 properties:
18436 value:
18437 type: string
18438 weak:
18439 type: boolean
18440 headers:
18441 type: object
18442 additionalProperties:
18443 type: array
18444 items:
18445 type: object
18446 language:
18447 type: object
18448 properties:
18449 country:
18450 type: string
18451 displayCountry:
18452 type: string
18453 displayLanguage:
18454 type: string
18455 displayName:
18456 type: string
18457 displayScript:
18458 type: string
18459 displayVariant:
18460 type: string
18461 extensionKeys:
18462 type: array
18463 items:
18464 type: string
18465 uniqueItems: true
18466 iso3Country:
18467 type: string
18468 iso3Language:
18469 type: string
18470 language:
18471 type: string
18472 script:
18473 type: string
18474 unicodeLocaleAttributes:
18475 type: array
18476 items:
18477 type: string
18478 uniqueItems: true
18479 unicodeLocaleKeys:
18480 type: array
18481 items:
18482 type: string
18483 uniqueItems: true
18484 variant:
18485 type: string
18486 lastModified:
18487 type: string
18488 format: date-time
18489 length:
18490 type: integer
18491 format: int32
18492 links:
18493 type: array
18494 items:
18495 type: object
18496 properties:
18497 params:
18498 type: object
18499 additionalProperties:
18500 type: string
18501 rel:
18502 type: string
18503 rels:
18504 type: array
18505 items:
18506 type: string
18507 title:
18508 type: string
18509 type:
18510 type: string
18511 uri:
18512 type: string
18513 format: uri
18514 uriBuilder:
18515 type: object
18516 uniqueItems: true
18517 location:
18518 type: string
18519 format: uri
18520 mediaType:
18521 type: object
18522 properties:
18523 parameters:
18524 type: object
18525 additionalProperties:
18526 type: string
18527 subtype:
18528 type: string
18529 type:
18530 type: string
18531 wildcardSubtype:
18532 type: boolean
18533 wildcardType:
18534 type: boolean
18535 metadata:
18536 type: object
18537 additionalProperties:
18538 type: array
18539 items:
18540 type: object
18541 status:
18542 type: integer
18543 format: int32
18544 statusInfo:
18545 type: object
18546 properties:
18547 family:
18548 type: string
18549 enum:
18550 - INFORMATIONAL
18551 - SUCCESSFUL
18552 - REDIRECTION
18553 - CLIENT_ERROR
18554 - SERVER_ERROR
18555 - OTHER
18556 reasonPhrase:
18557 type: string
18558 statusCode:
18559 type: integer
18560 format: int32
18561 stringHeaders:
18562 type: object
18563 additionalProperties:
18564 type: array
18565 items:
18566 type: string
18567 servers:
18568 - url: /sdc2/rest
18569 variables: {}
18570 summary: Returns created group types
18571 tags:
18572 - SDCE-2 APIs
18573 /v1/catalog/uploadType/interfaceLifecycle:
18574 post:
18575 description: Create Interface Lyfecycle Type from yaml
18576 operationId: uploadInterfaceLifecycleType
18577 parameters:
18578 - in: header
18579 name: USER_ID
18580 schema:
18581 type: string
18582 requestBody:
18583 content:
18584 multipart/form-data:
18585 schema:
18586 type: object
18587 properties:
18588 includeToModelImport:
18589 type: boolean
18590 description: includeToModelImport
18591 interfaceLifecycleTypeZip:
18592 type: string
18593 format: binary
18594 description: FileInputStream
18595 model:
18596 type: string
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]18597 description: model name
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]18598 responses:
18599 "201":
18600 description: Interface Lifecycle Type created
18601 "400":
18602 description: Invalid content / Missing content
18603 "403":
18604 description: Restricted operation
18605 "409":
18606 description: Interface Lifecycle Type already exist
18607 default:
18608 content:
18609 application/json:
18610 schema:
18611 type: array
18612 items:
18613 type: object
18614 properties:
18615 allowedMethods:
18616 type: array
18617 items:
18618 type: string
18619 uniqueItems: true
18620 cookies:
18621 type: object
18622 additionalProperties:
18623 type: object
18624 properties:
18625 comment:
18626 type: string
18627 domain:
18628 type: string
18629 expiry:
18630 type: string
18631 format: date-time
18632 httpOnly:
18633 type: boolean
18634 maxAge:
18635 type: integer
18636 format: int32
18637 name:
18638 type: string
18639 path:
18640 type: string
18641 secure:
18642 type: boolean
18643 value:
18644 type: string
18645 version:
18646 type: integer
18647 format: int32
18648 date:
18649 type: string
18650 format: date-time
18651 entity:
18652 type: object
18653 entityTag:
18654 type: object
18655 properties:
18656 value:
18657 type: string
18658 weak:
18659 type: boolean
18660 headers:
18661 type: object
18662 additionalProperties:
18663 type: array
18664 items:
18665 type: object
18666 language:
18667 type: object
18668 properties:
18669 country:
18670 type: string
18671 displayCountry:
18672 type: string
18673 displayLanguage:
18674 type: string
18675 displayName:
18676 type: string
18677 displayScript:
18678 type: string
18679 displayVariant:
18680 type: string
18681 extensionKeys:
18682 type: array
18683 items:
18684 type: string
18685 uniqueItems: true
18686 iso3Country:
18687 type: string
18688 iso3Language:
18689 type: string
18690 language:
18691 type: string
18692 script:
18693 type: string
18694 unicodeLocaleAttributes:
18695 type: array
18696 items:
18697 type: string
18698 uniqueItems: true
18699 unicodeLocaleKeys:
18700 type: array
18701 items:
18702 type: string
18703 uniqueItems: true
18704 variant:
18705 type: string
18706 lastModified:
18707 type: string
18708 format: date-time
18709 length:
18710 type: integer
18711 format: int32
18712 links:
18713 type: array
18714 items:
18715 type: object
18716 properties:
18717 params:
18718 type: object
18719 additionalProperties:
18720 type: string
18721 rel:
18722 type: string
18723 rels:
18724 type: array
18725 items:
18726 type: string
18727 title:
18728 type: string
18729 type:
18730 type: string
18731 uri:
18732 type: string
18733 format: uri
18734 uriBuilder:
18735 type: object
18736 uniqueItems: true
18737 location:
18738 type: string
18739 format: uri
18740 mediaType:
18741 type: object
18742 properties:
18743 parameters:
18744 type: object
18745 additionalProperties:
18746 type: string
18747 subtype:
18748 type: string
18749 type:
18750 type: string
18751 wildcardSubtype:
18752 type: boolean
18753 wildcardType:
18754 type: boolean
18755 metadata:
18756 type: object
18757 additionalProperties:
18758 type: array
18759 items:
18760 type: object
18761 status:
18762 type: integer
18763 format: int32
18764 statusInfo:
18765 type: object
18766 properties:
18767 family:
18768 type: string
18769 enum:
18770 - INFORMATIONAL
18771 - SUCCESSFUL
18772 - REDIRECTION
18773 - CLIENT_ERROR
18774 - SERVER_ERROR
18775 - OTHER
18776 reasonPhrase:
18777 type: string
18778 statusCode:
18779 type: integer
18780 format: int32
18781 stringHeaders:
18782 type: object
18783 additionalProperties:
18784 type: array
18785 items:
18786 type: string
18787 servers:
18788 - url: /sdc2/rest
18789 variables: {}
18790 summary: Returns created Interface Lifecycle Type
18791 tags:
18792 - SDCE-2 APIs
18793 /v1/catalog/uploadType/policytypes:
18794 post:
18795 description: Create PolicyTypes from yaml
18796 operationId: uploadPolicyTypes
18797 parameters:
18798 - in: header
18799 name: USER_ID
18800 schema:
18801 type: string
18802 requestBody:
18803 content:
18804 multipart/form-data:
18805 schema:
18806 type: object
18807 properties:
18808 includeToModelImport:
18809 type: boolean
18810 description: includeToModelImport
18811 model:
18812 type: string
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]18813 description: model name
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]18814 policyTypesZip:
18815 type: string
18816 format: binary
18817 description: FileInputStream
18818 toscaTypeMetadata:
18819 type: string
18820 description: toscaTypeMetadata
18821 responses:
18822 "201":
18823 description: policy types created
18824 "400":
18825 description: Invalid content / Missing content
18826 "403":
18827 description: Restricted operation
18828 "409":
18829 description: policy types already exist
18830 default:
18831 content:
18832 application/json:
18833 schema:
18834 type: array
18835 items:
18836 type: object
18837 properties:
18838 allowedMethods:
18839 type: array
18840 items:
18841 type: string
18842 uniqueItems: true
18843 cookies:
18844 type: object
18845 additionalProperties:
18846 type: object
18847 properties:
18848 comment:
18849 type: string
18850 domain:
18851 type: string
18852 expiry:
18853 type: string
18854 format: date-time
18855 httpOnly:
18856 type: boolean
18857 maxAge:
18858 type: integer
18859 format: int32
18860 name:
18861 type: string
18862 path:
18863 type: string
18864 secure:
18865 type: boolean
18866 value:
18867 type: string
18868 version:
18869 type: integer
18870 format: int32
18871 date:
18872 type: string
18873 format: date-time
18874 entity:
18875 type: object
18876 entityTag:
18877 type: object
18878 properties:
18879 value:
18880 type: string
18881 weak:
18882 type: boolean
18883 headers:
18884 type: object
18885 additionalProperties:
18886 type: array
18887 items:
18888 type: object
18889 language:
18890 type: object
18891 properties:
18892 country:
18893 type: string
18894 displayCountry:
18895 type: string
18896 displayLanguage:
18897 type: string
18898 displayName:
18899 type: string
18900 displayScript:
18901 type: string
18902 displayVariant:
18903 type: string
18904 extensionKeys:
18905 type: array
18906 items:
18907 type: string
18908 uniqueItems: true
18909 iso3Country:
18910 type: string
18911 iso3Language:
18912 type: string
18913 language:
18914 type: string
18915 script:
18916 type: string
18917 unicodeLocaleAttributes:
18918 type: array
18919 items:
18920 type: string
18921 uniqueItems: true
18922 unicodeLocaleKeys:
18923 type: array
18924 items:
18925 type: string
18926 uniqueItems: true
18927 variant:
18928 type: string
18929 lastModified:
18930 type: string
18931 format: date-time
18932 length:
18933 type: integer
18934 format: int32
18935 links:
18936 type: array
18937 items:
18938 type: object
18939 properties:
18940 params:
18941 type: object
18942 additionalProperties:
18943 type: string
18944 rel:
18945 type: string
18946 rels:
18947 type: array
18948 items:
18949 type: string
18950 title:
18951 type: string
18952 type:
18953 type: string
18954 uri:
18955 type: string
18956 format: uri
18957 uriBuilder:
18958 type: object
18959 uniqueItems: true
18960 location:
18961 type: string
18962 format: uri
18963 mediaType:
18964 type: object
18965 properties:
18966 parameters:
18967 type: object
18968 additionalProperties:
18969 type: string
18970 subtype:
18971 type: string
18972 type:
18973 type: string
18974 wildcardSubtype:
18975 type: boolean
18976 wildcardType:
18977 type: boolean
18978 metadata:
18979 type: object
18980 additionalProperties:
18981 type: array
18982 items:
18983 type: object
18984 status:
18985 type: integer
18986 format: int32
18987 statusInfo:
18988 type: object
18989 properties:
18990 family:
18991 type: string
18992 enum:
18993 - INFORMATIONAL
18994 - SUCCESSFUL
18995 - REDIRECTION
18996 - CLIENT_ERROR
18997 - SERVER_ERROR
18998 - OTHER
18999 reasonPhrase:
19000 type: string
19001 statusCode:
19002 type: integer
19003 format: int32
19004 stringHeaders:
19005 type: object
19006 additionalProperties:
19007 type: array
19008 items:
19009 type: string
19010 servers:
19011 - url: /sdc2/rest
19012 variables: {}
19013 summary: Returns created policy types
19014 tags:
19015 - SDCE-2 APIs
19016 /v1/catalog/uploadType/relationship:
19017 post:
19018 description: Create Relationship Type from yaml
19019 operationId: uploadRelationshipType
19020 parameters:
19021 - in: header
19022 name: USER_ID
19023 schema:
19024 type: string
19025 requestBody:
19026 content:
19027 multipart/form-data:
19028 schema:
19029 type: object
19030 properties:
19031 includeToModelImport:
19032 type: boolean
19033 description: includeToModelImport
19034 model:
19035 type: string
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]19036 description: model name
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]19037 relationshipTypeZip:
19038 type: string
19039 format: binary
19040 description: FileInputStream
19041 responses:
19042 "201":
19043 description: Relationship Type created
19044 "400":
19045 description: Invalid content / Missing content
19046 "403":
19047 description: Restricted operation
19048 "409":
19049 description: Relationship Type already exist
19050 default:
19051 content:
19052 application/json:
19053 schema:
19054 type: array
19055 items:
19056 type: object
19057 properties:
19058 allowedMethods:
19059 type: array
19060 items:
19061 type: string
19062 uniqueItems: true
19063 cookies:
19064 type: object
19065 additionalProperties:
19066 type: object
19067 properties:
19068 comment:
19069 type: string
19070 domain:
19071 type: string
19072 expiry:
19073 type: string
19074 format: date-time
19075 httpOnly:
19076 type: boolean
19077 maxAge:
19078 type: integer
19079 format: int32
19080 name:
19081 type: string
19082 path:
19083 type: string
19084 secure:
19085 type: boolean
19086 value:
19087 type: string
19088 version:
19089 type: integer
19090 format: int32
19091 date:
19092 type: string
19093 format: date-time
19094 entity:
19095 type: object
19096 entityTag:
19097 type: object
19098 properties:
19099 value:
19100 type: string
19101 weak:
19102 type: boolean
19103 headers:
19104 type: object
19105 additionalProperties:
19106 type: array
19107 items:
19108 type: object
19109 language:
19110 type: object
19111 properties:
19112 country:
19113 type: string
19114 displayCountry:
19115 type: string
19116 displayLanguage:
19117 type: string
19118 displayName:
19119 type: string
19120 displayScript:
19121 type: string
19122 displayVariant:
19123 type: string
19124 extensionKeys:
19125 type: array
19126 items:
19127 type: string
19128 uniqueItems: true
19129 iso3Country:
19130 type: string
19131 iso3Language:
19132 type: string
19133 language:
19134 type: string
19135 script:
19136 type: string
19137 unicodeLocaleAttributes:
19138 type: array
19139 items:
19140 type: string
19141 uniqueItems: true
19142 unicodeLocaleKeys:
19143 type: array
19144 items:
19145 type: string
19146 uniqueItems: true
19147 variant:
19148 type: string
19149 lastModified:
19150 type: string
19151 format: date-time
19152 length:
19153 type: integer
19154 format: int32
19155 links:
19156 type: array
19157 items:
19158 type: object
19159 properties:
19160 params:
19161 type: object
19162 additionalProperties:
19163 type: string
19164 rel:
19165 type: string
19166 rels:
19167 type: array
19168 items:
19169 type: string
19170 title:
19171 type: string
19172 type:
19173 type: string
19174 uri:
19175 type: string
19176 format: uri
19177 uriBuilder:
19178 type: object
19179 uniqueItems: true
19180 location:
19181 type: string
19182 format: uri
19183 mediaType:
19184 type: object
19185 properties:
19186 parameters:
19187 type: object
19188 additionalProperties:
19189 type: string
19190 subtype:
19191 type: string
19192 type:
19193 type: string
19194 wildcardSubtype:
19195 type: boolean
19196 wildcardType:
19197 type: boolean
19198 metadata:
19199 type: object
19200 additionalProperties:
19201 type: array
19202 items:
19203 type: object
19204 status:
19205 type: integer
19206 format: int32
19207 statusInfo:
19208 type: object
19209 properties:
19210 family:
19211 type: string
19212 enum:
19213 - INFORMATIONAL
19214 - SUCCESSFUL
19215 - REDIRECTION
19216 - CLIENT_ERROR
19217 - SERVER_ERROR
19218 - OTHER
19219 reasonPhrase:
19220 type: string
19221 statusCode:
19222 type: integer
19223 format: int32
19224 stringHeaders:
19225 type: object
19226 additionalProperties:
19227 type: array
19228 items:
19229 type: string
19230 servers:
19231 - url: /sdc2/rest
19232 variables: {}
19233 summary: Returns created Relationship Type
19234 tags:
19235 - SDCE-2 APIs
19236 /v1/catalog/{assetType}/{uuid}/interfaces/{interfaceUUID}/operations/{operationUUID}/artifacts/{artifactUUID}:
19237 post:
19238 description: uploads of artifact to component operation workflow
19239 operationId: uploadInterfaceOperationArtifact
19240 parameters:
19241 - description: Asset type
19242 in: path
19243 name: assetType
19244 required: true
19245 schema:
19246 type: string
19247 - description: The uuid of the asset as published in the metadata
19248 in: path
19249 name: uuid
19250 required: true
19251 schema:
19252 type: string
19253 - description: The uuid of the interface
19254 in: path
19255 name: interfaceUUID
19256 required: true
19257 schema:
19258 type: string
19259 - description: The uuid of the operation
19260 in: path
19261 name: operationUUID
19262 required: true
19263 schema:
19264 type: string
19265 - description: The uuid of the artifact
19266 in: path
19267 name: artifactUUID
19268 required: true
19269 schema:
19270 type: string
19271 - in: header
19272 name: USER_ID
19273 schema:
19274 type: string
19275 - in: header
19276 name: Content-MD5
19277 schema:
19278 type: string
19279 responses:
19280 "200":
19281 content:
19282 application/json:
19283 schema:
19284 type: array
19285 items:
19286 $ref: '#/components/schemas/ArtifactDefinition'
19287 description: Artifact uploaded
19288 "400":
19289 description: Restricted Operation – the user provided does not have role
19290 of Designer or the asset is being used by another designer - SVC4301
19291 "404":
19292 description: Specified resource is not found - SVC4063
19293 servers:
19294 - url: /sdc2/rest
19295 variables: {}
19296 summary: uploads of artifact to component operation workflow
19297 tags:
19298 - SDCE-2 APIs
19299 /v1/catalog/{componentType}/latestversion/notabstract:
19300 get:
19301 description: Get Component Requirments And Capabilities
19302 operationId: getLatestVersionNotAbstractCheckoutComponents
19303 parameters:
19304 - in: path
19305 name: componentType
19306 required: true
19307 schema:
19308 type: string
19309 - in: query
19310 name: internalComponentType
19311 schema:
19312 type: string
19313 - in: query
19314 name: componentUids
19315 schema:
19316 type: array
19317 items:
19318 type: string
19319 - in: header
19320 name: USER_ID
19321 schema:
19322 type: string
19323 responses:
19324 "200":
19325 description: Component found
19326 "403":
19327 description: Restricted operation
19328 "404":
19329 description: Component not found
19330 default:
19331 content:
19332 application/json:
19333 schema:
19334 type: array
19335 items:
19336 $ref: '#/components/schemas/Resource'
19337 servers:
19338 - url: /sdc2/rest
19339 variables: {}
19340 summary: Returns Requirments And Capabilities according to componentId
19341 tags:
19342 - SDCE-2 APIs
19343 post:
19344 description: Get Component Requirments And Capabilities
19345 operationId: getLatestVersionNotAbstractCheckoutComponentsByBody
19346 parameters:
19347 - in: path
19348 name: componentType
19349 required: true
19350 schema:
19351 type: string
19352 - in: query
19353 name: internalComponentType
19354 schema:
19355 type: string
19356 - in: header
19357 name: USER_ID
19358 schema:
19359 type: string
19360 requestBody:
19361 content:
19362 application/json:
19363 schema:
19364 type: array
19365 items:
19366 type: string
19367 description: Consumer Object to be created
19368 required: true
19369 responses:
19370 "200":
19371 description: Component found
19372 "403":
19373 description: Restricted operation
19374 "404":
19375 description: Component not found
19376 default:
19377 content:
19378 application/json:
19379 schema:
19380 type: array
19381 items:
19382 $ref: '#/components/schemas/Resource'
19383 servers:
19384 - url: /sdc2/rest
19385 variables: {}
19386 summary: Returns Requirments And Capabilities according to componentId
19387 tags:
19388 - SDCE-2 APIs
19389 /v1/catalog/{componentType}/latestversion/notabstract/metadata:
19390 get:
19391 description: Get Component uid only
19392 operationId: getLatestVersionNotAbstractCheckoutComponentsIdesOnly
19393 parameters:
19394 - in: path
19395 name: componentType
19396 required: true
19397 schema:
19398 type: string
19399 - in: query
19400 name: internalComponentType
19401 schema:
19402 type: string
19403 - in: query
19404 name: componentModel
19405 schema:
19406 type: string
19407 - in: query
19408 name: includeNormativeExtensionModels
19409 schema:
19410 type: boolean
19411 - in: header
19412 name: USER_ID
19413 schema:
19414 type: string
19415 requestBody:
19416 content:
19417 application/json:
19418 schema:
19419 type: string
19420 description: uid list
19421 required: true
19422 responses:
19423 "200":
19424 description: Component found
19425 "403":
19426 description: Restricted operation
19427 "404":
19428 description: Component not found
19429 default:
19430 content:
19431 application/json:
19432 schema:
19433 type: array
19434 items:
19435 $ref: '#/components/schemas/Resource'
19436 servers:
19437 - url: /sdc2/rest
19438 variables: {}
19439 summary: Returns componentId
19440 tags:
19441 - SDCE-2 APIs
19442 /v1/catalog/{componentType}/{componentId}/automatedupgrade:
19443 post:
19444 description: Autometed upgrade
19445 operationId: autometedUpgrade
19446 parameters:
19447 - in: path
19448 name: componentType
19449 required: true
19450 schema:
19451 type: string
19452 - in: path
19453 name: componentId
19454 required: true
19455 schema:
19456 type: string
19457 - in: header
19458 name: USER_ID
19459 schema:
19460 type: string
19461 requestBody:
19462 content:
19463 application/json:
19464 schema:
19465 type: string
19466 description: json describes upgrade request
19467 required: true
19468 responses:
19469 "200":
19470 description: Component found
19471 "403":
19472 description: Restricted operation
19473 "404":
19474 description: Component not found
19475 default:
19476 content:
19477 application/json:
19478 schema:
19479 type: array
19480 items:
19481 type: object
19482 properties:
19483 allowedMethods:
19484 type: array
19485 items:
19486 type: string
19487 uniqueItems: true
19488 cookies:
19489 type: object
19490 additionalProperties:
19491 type: object
19492 properties:
19493 comment:
19494 type: string
19495 domain:
19496 type: string
19497 expiry:
19498 type: string
19499 format: date-time
19500 httpOnly:
19501 type: boolean
19502 maxAge:
19503 type: integer
19504 format: int32
19505 name:
19506 type: string
19507 path:
19508 type: string
19509 secure:
19510 type: boolean
19511 value:
19512 type: string
19513 version:
19514 type: integer
19515 format: int32
19516 date:
19517 type: string
19518 format: date-time
19519 entity:
19520 type: object
19521 entityTag:
19522 type: object
19523 properties:
19524 value:
19525 type: string
19526 weak:
19527 type: boolean
19528 headers:
19529 type: object
19530 additionalProperties:
19531 type: array
19532 items:
19533 type: object
19534 language:
19535 type: object
19536 properties:
19537 country:
19538 type: string
19539 displayCountry:
19540 type: string
19541 displayLanguage:
19542 type: string
19543 displayName:
19544 type: string
19545 displayScript:
19546 type: string
19547 displayVariant:
19548 type: string
19549 extensionKeys:
19550 type: array
19551 items:
19552 type: string
19553 uniqueItems: true
19554 iso3Country:
19555 type: string
19556 iso3Language:
19557 type: string
19558 language:
19559 type: string
19560 script:
19561 type: string
19562 unicodeLocaleAttributes:
19563 type: array
19564 items:
19565 type: string
19566 uniqueItems: true
19567 unicodeLocaleKeys:
19568 type: array
19569 items:
19570 type: string
19571 uniqueItems: true
19572 variant:
19573 type: string
19574 lastModified:
19575 type: string
19576 format: date-time
19577 length:
19578 type: integer
19579 format: int32
19580 links:
19581 type: array
19582 items:
19583 type: object
19584 properties:
19585 params:
19586 type: object
19587 additionalProperties:
19588 type: string
19589 rel:
19590 type: string
19591 rels:
19592 type: array
19593 items:
19594 type: string
19595 title:
19596 type: string
19597 type:
19598 type: string
19599 uri:
19600 type: string
19601 format: uri
19602 uriBuilder:
19603 type: object
19604 uniqueItems: true
19605 location:
19606 type: string
19607 format: uri
19608 mediaType:
19609 type: object
19610 properties:
19611 parameters:
19612 type: object
19613 additionalProperties:
19614 type: string
19615 subtype:
19616 type: string
19617 type:
19618 type: string
19619 wildcardSubtype:
19620 type: boolean
19621 wildcardType:
19622 type: boolean
19623 metadata:
19624 type: object
19625 additionalProperties:
19626 type: array
19627 items:
19628 type: object
19629 status:
19630 type: integer
19631 format: int32
19632 statusInfo:
19633 type: object
19634 properties:
19635 family:
19636 type: string
19637 enum:
19638 - INFORMATIONAL
19639 - SUCCESSFUL
19640 - REDIRECTION
19641 - CLIENT_ERROR
19642 - SERVER_ERROR
19643 - OTHER
19644 reasonPhrase:
19645 type: string
19646 statusCode:
19647 type: integer
19648 format: int32
19649 stringHeaders:
19650 type: object
19651 additionalProperties:
19652 type: array
19653 items:
19654 type: string
19655 servers:
19656 - url: /sdc2/rest
19657 variables: {}
19658 summary: '....'
19659 tags:
19660 - SDCE-2 APIs
19661 /v1/catalog/{componentType}/{componentId}/componentInstance/{componentInstanceId}/interfaceOperation:
19662 put:
19663 description: Update Interface Operation
19664 operationId: updateComponentInstanceInterfaceOperation
19665 parameters:
19666 - description: "valid values: resources / services"
19667 in: path
19668 name: componentType
19669 required: true
19670 schema:
19671 type: string
19672 enum:
19673 - resources
19674 - services
19675 - description: Component Id
19676 in: path
19677 name: componentId
19678 required: true
19679 schema:
19680 type: string
19681 - description: Component Instance Id
19682 in: path
19683 name: componentInstanceId
19684 required: true
19685 schema:
19686 type: string
19687 - in: header
19688 name: USER_ID
19689 schema:
19690 type: string
19691 responses:
19692 "201":
19693 description: Update Interface Operation
19694 "400":
19695 description: Invalid content / Missing content
19696 "403":
19697 description: Restricted operation
19698 default:
19699 content:
19700 application/json:
19701 schema:
19702 type: array
19703 items:
19704 type: object
19705 properties:
19706 allowedMethods:
19707 type: array
19708 items:
19709 type: string
19710 uniqueItems: true
19711 cookies:
19712 type: object
19713 additionalProperties:
19714 type: object
19715 properties:
19716 comment:
19717 type: string
19718 domain:
19719 type: string
19720 expiry:
19721 type: string
19722 format: date-time
19723 httpOnly:
19724 type: boolean
19725 maxAge:
19726 type: integer
19727 format: int32
19728 name:
19729 type: string
19730 path:
19731 type: string
19732 secure:
19733 type: boolean
19734 value:
19735 type: string
19736 version:
19737 type: integer
19738 format: int32
19739 date:
19740 type: string
19741 format: date-time
19742 entity:
19743 type: object
19744 entityTag:
19745 type: object
19746 properties:
19747 value:
19748 type: string
19749 weak:
19750 type: boolean
19751 headers:
19752 type: object
19753 additionalProperties:
19754 type: array
19755 items:
19756 type: object
19757 language:
19758 type: object
19759 properties:
19760 country:
19761 type: string
19762 displayCountry:
19763 type: string
19764 displayLanguage:
19765 type: string
19766 displayName:
19767 type: string
19768 displayScript:
19769 type: string
19770 displayVariant:
19771 type: string
19772 extensionKeys:
19773 type: array
19774 items:
19775 type: string
19776 uniqueItems: true
19777 iso3Country:
19778 type: string
19779 iso3Language:
19780 type: string
19781 language:
19782 type: string
19783 script:
19784 type: string
19785 unicodeLocaleAttributes:
19786 type: array
19787 items:
19788 type: string
19789 uniqueItems: true
19790 unicodeLocaleKeys:
19791 type: array
19792 items:
19793 type: string
19794 uniqueItems: true
19795 variant:
19796 type: string
19797 lastModified:
19798 type: string
19799 format: date-time
19800 length:
19801 type: integer
19802 format: int32
19803 links:
19804 type: array
19805 items:
19806 type: object
19807 properties:
19808 params:
19809 type: object
19810 additionalProperties:
19811 type: string
19812 rel:
19813 type: string
19814 rels:
19815 type: array
19816 items:
19817 type: string
19818 title:
19819 type: string
19820 type:
19821 type: string
19822 uri:
19823 type: string
19824 format: uri
19825 uriBuilder:
19826 type: object
19827 uniqueItems: true
19828 location:
19829 type: string
19830 format: uri
19831 mediaType:
19832 type: object
19833 properties:
19834 parameters:
19835 type: object
19836 additionalProperties:
19837 type: string
19838 subtype:
19839 type: string
19840 type:
19841 type: string
19842 wildcardSubtype:
19843 type: boolean
19844 wildcardType:
19845 type: boolean
19846 metadata:
19847 type: object
19848 additionalProperties:
19849 type: array
19850 items:
19851 type: object
19852 status:
19853 type: integer
19854 format: int32
19855 statusInfo:
19856 type: object
19857 properties:
19858 family:
19859 type: string
19860 enum:
19861 - INFORMATIONAL
19862 - SUCCESSFUL
19863 - REDIRECTION
19864 - CLIENT_ERROR
19865 - SERVER_ERROR
19866 - OTHER
19867 reasonPhrase:
19868 type: string
19869 statusCode:
19870 type: integer
19871 format: int32
19872 stringHeaders:
19873 type: object
19874 additionalProperties:
19875 type: array
19876 items:
19877 type: string
19878 servers:
19879 - url: /sdc2/rest
19880 variables: {}
19881 summary: Update Interface Operation on ComponentInstance
19882 tags:
19883 - SDCE-2 APIs
19884 /v1/catalog/{componentType}/{componentId}/componentInstance/{componentInstanceId}/{constraintType}/nodeFilter:
19885 post:
19886 description: Add Component Filter Constraint
19887 operationId: addComponentFilterConstraint
19888 parameters:
19889 - description: Component Id
19890 in: path
19891 name: componentId
19892 required: true
19893 schema:
19894 type: string
19895 - description: Component Instance Id
19896 in: path
19897 name: componentInstanceId
19898 required: true
19899 schema:
19900 type: string
19901 - description: "valid values: resources / services"
19902 in: path
19903 name: componentType
19904 required: true
19905 schema:
19906 type: string
19907 enum:
19908 - resources
19909 - services
19910 - description: "Constraint type. Valid values: properties / capabilities"
19911 in: path
19912 name: constraintType
19913 required: true
19914 schema:
19915 type: string
19916 enum:
19917 - properties
19918 - capabilities
19919 - in: header
19920 name: USER_ID
19921 schema:
19922 type: string
19923 requestBody:
19924 content:
19925 application/json:
19926 schema:
19927 type: string
19928 description: UIConstraint data
19929 required: true
19930 responses:
19931 "201":
19932 description: Create Component Filter
19933 "400":
19934 description: Invalid content / Missing content
19935 "403":
19936 description: Restricted operation
19937 default:
19938 content:
19939 application/json:
19940 schema:
19941 type: array
19942 items:
19943 type: object
19944 properties:
19945 allowedMethods:
19946 type: array
19947 items:
19948 type: string
19949 uniqueItems: true
19950 cookies:
19951 type: object
19952 additionalProperties:
19953 type: object
19954 properties:
19955 comment:
19956 type: string
19957 domain:
19958 type: string
19959 expiry:
19960 type: string
19961 format: date-time
19962 httpOnly:
19963 type: boolean
19964 maxAge:
19965 type: integer
19966 format: int32
19967 name:
19968 type: string
19969 path:
19970 type: string
19971 secure:
19972 type: boolean
19973 value:
19974 type: string
19975 version:
19976 type: integer
19977 format: int32
19978 date:
19979 type: string
19980 format: date-time
19981 entity:
19982 type: object
19983 entityTag:
19984 type: object
19985 properties:
19986 value:
19987 type: string
19988 weak:
19989 type: boolean
19990 headers:
19991 type: object
19992 additionalProperties:
19993 type: array
19994 items:
19995 type: object
19996 language:
19997 type: object
19998 properties:
19999 country:
20000 type: string
20001 displayCountry:
20002 type: string
20003 displayLanguage:
20004 type: string
20005 displayName:
20006 type: string
20007 displayScript:
20008 type: string
20009 displayVariant:
20010 type: string
20011 extensionKeys:
20012 type: array
20013 items:
20014 type: string
20015 uniqueItems: true
20016 iso3Country:
20017 type: string
20018 iso3Language:
20019 type: string
20020 language:
20021 type: string
20022 script:
20023 type: string
20024 unicodeLocaleAttributes:
20025 type: array
20026 items:
20027 type: string
20028 uniqueItems: true
20029 unicodeLocaleKeys:
20030 type: array
20031 items:
20032 type: string
20033 uniqueItems: true
20034 variant:
20035 type: string
20036 lastModified:
20037 type: string
20038 format: date-time
20039 length:
20040 type: integer
20041 format: int32
20042 links:
20043 type: array
20044 items:
20045 type: object
20046 properties:
20047 params:
20048 type: object
20049 additionalProperties:
20050 type: string
20051 rel:
20052 type: string
20053 rels:
20054 type: array
20055 items:
20056 type: string
20057 title:
20058 type: string
20059 type:
20060 type: string
20061 uri:
20062 type: string
20063 format: uri
20064 uriBuilder:
20065 type: object
20066 uniqueItems: true
20067 location:
20068 type: string
20069 format: uri
20070 mediaType:
20071 type: object
20072 properties:
20073 parameters:
20074 type: object
20075 additionalProperties:
20076 type: string
20077 subtype:
20078 type: string
20079 type:
20080 type: string
20081 wildcardSubtype:
20082 type: boolean
20083 wildcardType:
20084 type: boolean
20085 metadata:
20086 type: object
20087 additionalProperties:
20088 type: array
20089 items:
20090 type: object
20091 status:
20092 type: integer
20093 format: int32
20094 statusInfo:
20095 type: object
20096 properties:
20097 family:
20098 type: string
20099 enum:
20100 - INFORMATIONAL
20101 - SUCCESSFUL
20102 - REDIRECTION
20103 - CLIENT_ERROR
20104 - SERVER_ERROR
20105 - OTHER
20106 reasonPhrase:
20107 type: string
20108 statusCode:
20109 type: integer
20110 format: int32
20111 stringHeaders:
20112 type: object
20113 additionalProperties:
20114 type: array
20115 items:
20116 type: string
20117 summary: Add Component Filter Constraint
20118 tags:
20119 - SDCE-2 APIs
20120 /v1/catalog/{componentType}/{componentId}/componentInstance/{componentInstanceId}/{constraintType}/{constraintIndex}/nodeFilter:
20121 delete:
20122 description: Delete Component Filter Constraint
20123 operationId: deleteComponentFilterConstraint
20124 parameters:
20125 - description: Component Id
20126 in: path
20127 name: componentId
20128 required: true
20129 schema:
20130 type: string
20131 - description: Component Instance Id
20132 in: path
20133 name: componentInstanceId
20134 required: true
20135 schema:
20136 type: string
20137 - description: Constraint Index
20138 in: path
20139 name: constraintIndex
20140 required: true
20141 schema:
20142 type: integer
20143 format: int32
20144 - description: "valid values: resources / services"
20145 in: path
20146 name: componentType
20147 required: true
20148 schema:
20149 type: string
20150 enum:
20151 - resources
20152 - services
20153 - description: "Constraint type. Valid values: properties / capabilities"
20154 in: path
20155 name: constraintType
20156 required: true
20157 schema:
20158 type: string
20159 enum:
20160 - properties
20161 - capabilities
20162 - in: header
20163 name: USER_ID
20164 schema:
20165 type: string
20166 responses:
20167 "201":
20168 description: Delete Component Filter Constraint
20169 "400":
20170 description: Invalid content / Missing content
20171 "403":
20172 description: Restricted operation
20173 default:
20174 content:
20175 application/json:
20176 schema:
20177 type: array
20178 items:
20179 type: object
20180 properties:
20181 allowedMethods:
20182 type: array
20183 items:
20184 type: string
20185 uniqueItems: true
20186 cookies:
20187 type: object
20188 additionalProperties:
20189 type: object
20190 properties:
20191 comment:
20192 type: string
20193 domain:
20194 type: string
20195 expiry:
20196 type: string
20197 format: date-time
20198 httpOnly:
20199 type: boolean
20200 maxAge:
20201 type: integer
20202 format: int32
20203 name:
20204 type: string
20205 path:
20206 type: string
20207 secure:
20208 type: boolean
20209 value:
20210 type: string
20211 version:
20212 type: integer
20213 format: int32
20214 date:
20215 type: string
20216 format: date-time
20217 entity:
20218 type: object
20219 entityTag:
20220 type: object
20221 properties:
20222 value:
20223 type: string
20224 weak:
20225 type: boolean
20226 headers:
20227 type: object
20228 additionalProperties:
20229 type: array
20230 items:
20231 type: object
20232 language:
20233 type: object
20234 properties:
20235 country:
20236 type: string
20237 displayCountry:
20238 type: string
20239 displayLanguage:
20240 type: string
20241 displayName:
20242 type: string
20243 displayScript:
20244 type: string
20245 displayVariant:
20246 type: string
20247 extensionKeys:
20248 type: array
20249 items:
20250 type: string
20251 uniqueItems: true
20252 iso3Country:
20253 type: string
20254 iso3Language:
20255 type: string
20256 language:
20257 type: string
20258 script:
20259 type: string
20260 unicodeLocaleAttributes:
20261 type: array
20262 items:
20263 type: string
20264 uniqueItems: true
20265 unicodeLocaleKeys:
20266 type: array
20267 items:
20268 type: string
20269 uniqueItems: true
20270 variant:
20271 type: string
20272 lastModified:
20273 type: string
20274 format: date-time
20275 length:
20276 type: integer
20277 format: int32
20278 links:
20279 type: array
20280 items:
20281 type: object
20282 properties:
20283 params:
20284 type: object
20285 additionalProperties:
20286 type: string
20287 rel:
20288 type: string
20289 rels:
20290 type: array
20291 items:
20292 type: string
20293 title:
20294 type: string
20295 type:
20296 type: string
20297 uri:
20298 type: string
20299 format: uri
20300 uriBuilder:
20301 type: object
20302 uniqueItems: true
20303 location:
20304 type: string
20305 format: uri
20306 mediaType:
20307 type: object
20308 properties:
20309 parameters:
20310 type: object
20311 additionalProperties:
20312 type: string
20313 subtype:
20314 type: string
20315 type:
20316 type: string
20317 wildcardSubtype:
20318 type: boolean
20319 wildcardType:
20320 type: boolean
20321 metadata:
20322 type: object
20323 additionalProperties:
20324 type: array
20325 items:
20326 type: object
20327 status:
20328 type: integer
20329 format: int32
20330 statusInfo:
20331 type: object
20332 properties:
20333 family:
20334 type: string
20335 enum:
20336 - INFORMATIONAL
20337 - SUCCESSFUL
20338 - REDIRECTION
20339 - CLIENT_ERROR
20340 - SERVER_ERROR
20341 - OTHER
20342 reasonPhrase:
20343 type: string
20344 statusCode:
20345 type: integer
20346 format: int32
20347 stringHeaders:
20348 type: object
20349 additionalProperties:
20350 type: array
20351 items:
20352 type: string
20353 summary: Delete Component Filter Constraint
20354 tags:
20355 - SDCE-2 APIs
20356 put:
20357 description: Update Component Filter Constraint
20358 operationId: updateComponentFilterConstraint
20359 parameters:
20360 - description: Component Id
20361 in: path
20362 name: componentId
20363 required: true
20364 schema:
20365 type: string
20366 - description: Component Instance Id
20367 in: path
20368 name: componentInstanceId
20369 required: true
20370 schema:
20371 type: string
20372 - description: "valid values: resources / services"
20373 in: path
20374 name: componentType
20375 required: true
20376 schema:
20377 type: string
20378 enum:
20379 - resources
20380 - services
20381 - description: "Constraint type. Valid values: properties / capabilities"
20382 in: path
20383 name: constraintType
20384 required: true
20385 schema:
20386 type: string
20387 enum:
20388 - properties
20389 - capabilities
20390 - description: Constraint Index
20391 in: path
20392 name: constraintIndex
20393 required: true
20394 schema:
20395 type: integer
20396 format: int32
20397 - in: header
20398 name: USER_ID
20399 schema:
20400 type: string
20401 requestBody:
20402 content:
20403 application/json:
20404 schema:
20405 type: string
20406 description: UIConstraint data
20407 required: true
20408 responses:
20409 "201":
20410 description: Create Component Filter
20411 "400":
20412 description: Invalid content / Missing content
20413 "403":
20414 description: Restricted operation
20415 default:
20416 content:
20417 application/json:
20418 schema:
20419 type: array
20420 items:
20421 type: object
20422 properties:
20423 allowedMethods:
20424 type: array
20425 items:
20426 type: string
20427 uniqueItems: true
20428 cookies:
20429 type: object
20430 additionalProperties:
20431 type: object
20432 properties:
20433 comment:
20434 type: string
20435 domain:
20436 type: string
20437 expiry:
20438 type: string
20439 format: date-time
20440 httpOnly:
20441 type: boolean
20442 maxAge:
20443 type: integer
20444 format: int32
20445 name:
20446 type: string
20447 path:
20448 type: string
20449 secure:
20450 type: boolean
20451 value:
20452 type: string
20453 version:
20454 type: integer
20455 format: int32
20456 date:
20457 type: string
20458 format: date-time
20459 entity:
20460 type: object
20461 entityTag:
20462 type: object
20463 properties:
20464 value:
20465 type: string
20466 weak:
20467 type: boolean
20468 headers:
20469 type: object
20470 additionalProperties:
20471 type: array
20472 items:
20473 type: object
20474 language:
20475 type: object
20476 properties:
20477 country:
20478 type: string
20479 displayCountry:
20480 type: string
20481 displayLanguage:
20482 type: string
20483 displayName:
20484 type: string
20485 displayScript:
20486 type: string
20487 displayVariant:
20488 type: string
20489 extensionKeys:
20490 type: array
20491 items:
20492 type: string
20493 uniqueItems: true
20494 iso3Country:
20495 type: string
20496 iso3Language:
20497 type: string
20498 language:
20499 type: string
20500 script:
20501 type: string
20502 unicodeLocaleAttributes:
20503 type: array
20504 items:
20505 type: string
20506 uniqueItems: true
20507 unicodeLocaleKeys:
20508 type: array
20509 items:
20510 type: string
20511 uniqueItems: true
20512 variant:
20513 type: string
20514 lastModified:
20515 type: string
20516 format: date-time
20517 length:
20518 type: integer
20519 format: int32
20520 links:
20521 type: array
20522 items:
20523 type: object
20524 properties:
20525 params:
20526 type: object
20527 additionalProperties:
20528 type: string
20529 rel:
20530 type: string
20531 rels:
20532 type: array
20533 items:
20534 type: string
20535 title:
20536 type: string
20537 type:
20538 type: string
20539 uri:
20540 type: string
20541 format: uri
20542 uriBuilder:
20543 type: object
20544 uniqueItems: true
20545 location:
20546 type: string
20547 format: uri
20548 mediaType:
20549 type: object
20550 properties:
20551 parameters:
20552 type: object
20553 additionalProperties:
20554 type: string
20555 subtype:
20556 type: string
20557 type:
20558 type: string
20559 wildcardSubtype:
20560 type: boolean
20561 wildcardType:
20562 type: boolean
20563 metadata:
20564 type: object
20565 additionalProperties:
20566 type: array
20567 items:
20568 type: object
20569 status:
20570 type: integer
20571 format: int32
20572 statusInfo:
20573 type: object
20574 properties:
20575 family:
20576 type: string
20577 enum:
20578 - INFORMATIONAL
20579 - SUCCESSFUL
20580 - REDIRECTION
20581 - CLIENT_ERROR
20582 - SERVER_ERROR
20583 - OTHER
20584 reasonPhrase:
20585 type: string
20586 statusCode:
20587 type: integer
20588 format: int32
20589 stringHeaders:
20590 type: object
20591 additionalProperties:
20592 type: array
20593 items:
20594 type: string
20595 summary: Update Component Filter Constraint
20596 tags:
20597 - SDCE-2 APIs
20598 /v1/catalog/{componentType}/{componentId}/componentInstances:
20599 get:
20600 description: Get Component instances
20601 operationId: getComponentInstancesFilteredByPropertiesAndInputs
20602 parameters:
20603 - in: path
20604 name: componentType
20605 required: true
20606 schema:
20607 type: string
20608 - in: path
20609 name: componentId
20610 required: true
20611 schema:
20612 type: string
20613 - in: query
20614 name: searchText
20615 schema:
20616 type: string
20617 - in: header
20618 name: USER_ID
20619 schema:
20620 type: string
20621 requestBody:
20622 content:
20623 application/json:
20624 schema:
20625 type: string
20626 description: uid list
20627 required: true
20628 responses:
20629 "200":
20630 description: Component found
20631 "403":
20632 description: Restricted operation
20633 "404":
20634 description: Component not found
20635 default:
20636 content:
20637 application/json:
20638 schema:
20639 type: array
20640 items:
20641 $ref: '#/components/schemas/Resource'
20642 servers:
20643 - url: /sdc2/rest
20644 variables: {}
20645 summary: Returns component instances
20646 tags:
20647 - SDCE-2 APIs
20648 /v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{inputId}/properties:
20649 get:
20650 description: Get properties
20651 operationId: getInputPropertiesForComponentInstance
20652 parameters:
20653 - in: path
20654 name: componentType
20655 required: true
20656 schema:
20657 type: string
20658 - in: path
20659 name: componentId
20660 required: true
20661 schema:
20662 type: string
20663 - in: path
20664 name: instanceId
20665 required: true
20666 schema:
20667 type: string
20668 - in: path
20669 name: inputId
20670 required: true
20671 schema:
20672 type: string
20673 - in: header
20674 name: USER_ID
20675 schema:
20676 type: string
20677 responses:
20678 "200":
20679 description: Component found
20680 "403":
20681 description: Restricted operation
20682 "404":
20683 description: Component not found
20684 default:
20685 content:
20686 application/json:
20687 schema:
20688 type: array
20689 items:
20690 $ref: '#/components/schemas/Resource'
20691 servers:
20692 - url: /sdc2/rest
20693 variables: {}
20694 summary: Returns properties list
20695 tags:
20696 - SDCE-2 APIs
20697 /v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{originComponentUid}/inputs:
20698 get:
20699 description: Get Inputs only
20700 operationId: getComponentInstanceInputs
20701 parameters:
20702 - in: path
20703 name: componentType
20704 required: true
20705 schema:
20706 type: string
20707 - in: path
20708 name: componentId
20709 required: true
20710 schema:
20711 type: string
20712 - in: path
20713 name: instanceId
20714 required: true
20715 schema:
20716 type: string
20717 - in: path
20718 name: originComponentUid
20719 required: true
20720 schema:
20721 type: string
20722 - in: header
20723 name: USER_ID
20724 schema:
20725 type: string
20726 responses:
20727 "200":
20728 description: Component found
20729 "403":
20730 description: Restricted operation
20731 "404":
20732 description: Component not found
20733 default:
20734 content:
20735 application/json:
20736 schema:
20737 type: array
20738 items:
20739 $ref: '#/components/schemas/Resource'
20740 servers:
20741 - url: /sdc2/rest
20742 variables: {}
20743 summary: Returns Inputs list
20744 tags:
20745 - SDCE-2 APIs
20746 /v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{originComponentUid}/outputs:
20747 get:
20748 description: Get Outputs only
20749 operationId: getComponentInstanceOutputs
20750 parameters:
20751 - in: path
20752 name: componentType
20753 required: true
20754 schema:
20755 type: string
20756 - in: path
20757 name: componentId
20758 required: true
20759 schema:
20760 type: string
20761 - in: path
20762 name: instanceId
20763 required: true
20764 schema:
20765 type: string
20766 - in: path
20767 name: originComponentUid
20768 required: true
20769 schema:
20770 type: string
20771 - in: header
20772 name: USER_ID
20773 schema:
20774 type: string
20775 responses:
20776 "200":
20777 description: Component found
20778 "403":
20779 description: Restricted operation
20780 "404":
20781 description: Component not found
20782 default:
20783 content:
20784 application/json:
20785 schema:
20786 type: array
20787 items:
20788 $ref: '#/components/schemas/Resource'
20789 servers:
20790 - url: /sdc2/rest
20791 variables: {}
20792 summary: Returns Outputs list
20793 tags:
20794 - SDCE-2 APIs
20795 /v1/catalog/{componentType}/{componentId}/create/input:
20796 post:
20797 description: Create inputs on service
20798 operationId: createInput
20799 parameters:
20800 - in: path
20801 name: componentType
20802 required: true
20803 schema:
20804 type: string
20805 - in: path
20806 name: componentId
20807 required: true
20808 schema:
20809 type: string
20810 - in: header
20811 name: USER_ID
20812 schema:
20813 type: string
20814 requestBody:
20815 content:
20816 application/json:
20817 schema:
20818 type: string
20819 description: ComponentIns Inputs Object to be created
20820 required: true
20821 responses:
20822 "200":
20823 description: Component found
20824 "403":
20825 description: Restricted operation
20826 "404":
20827 description: Component not found
20828 default:
20829 content:
20830 application/json:
20831 schema:
20832 type: array
20833 items:
20834 $ref: '#/components/schemas/Resource'
20835 servers:
20836 - url: /sdc2/rest
20837 variables: {}
20838 summary: Return inputs list
20839 tags:
20840 - SDCE-2 APIs
20841 /v1/catalog/{componentType}/{componentId}/create/inputs:
20842 post:
20843 description: Create inputs on service
20844 operationId: createMultipleInputs
20845 parameters:
20846 - in: path
20847 name: componentType
20848 required: true
20849 schema:
20850 type: string
20851 - in: path
20852 name: componentId
20853 required: true
20854 schema:
20855 type: string
20856 - in: header
20857 name: USER_ID
20858 schema:
20859 type: string
20860 requestBody:
20861 content:
20862 application/json:
20863 schema:
20864 type: string
20865 description: ComponentIns Inputs Object to be created
20866 required: true
20867 responses:
20868 "200":
20869 description: Component found
20870 "403":
20871 description: Restricted operation
20872 "404":
20873 description: Component not found
20874 default:
20875 content:
20876 application/json:
20877 schema:
20878 type: array
20879 items:
20880 $ref: '#/components/schemas/Resource'
20881 servers:
20882 - url: /sdc2/rest
20883 variables: {}
20884 summary: Return inputs list
20885 tags:
20886 - SDCE-2 APIs
20887 /v1/catalog/{componentType}/{componentId}/create/listInput:
20888 post:
20889 description: Create a list input on service
20890 operationId: createListInput
20891 parameters:
20892 - in: path
20893 name: componentType
20894 required: true
20895 schema:
20896 type: string
20897 - in: path
20898 name: componentId
20899 required: true
20900 schema:
20901 type: string
20902 - in: header
20903 name: USER_ID
20904 schema:
20905 type: string
20906 requestBody:
20907 content:
20908 application/json:
20909 schema:
20910 type: string
20911 description: ComponentIns Inputs Object to be created
20912 required: true
20913 responses:
20914 "200":
20915 description: Component found
20916 "403":
20917 description: Restricted operation
20918 "404":
20919 description: Component not found
20920 default:
20921 content:
20922 application/json:
20923 schema:
20924 type: array
20925 items:
20926 $ref: '#/components/schemas/Resource'
20927 servers:
20928 - url: /sdc2/rest
20929 variables: {}
20930 summary: Return input
20931 tags:
20932 - SDCE-2 APIs
20933 /v1/catalog/{componentType}/{componentId}/create/outputs:
20934 post:
20935 description: Create outputs on service
20936 operationId: createMultipleOutputs
20937 parameters:
20938 - in: path
20939 name: componentType
20940 required: true
20941 schema:
20942 type: string
20943 - in: path
20944 name: componentId
20945 required: true
20946 schema:
20947 type: string
20948 - in: header
20949 name: USER_ID
20950 schema:
20951 type: string
20952 requestBody:
20953 content:
20954 application/json:
20955 schema:
20956 type: string
20957 description: ComponentIns Outputs Object to be created
20958 required: true
20959 responses:
20960 "200":
20961 description: Component found
20962 "403":
20963 description: Restricted operation
20964 "404":
20965 description: Component not found
20966 default:
20967 content:
20968 application/json:
20969 schema:
20970 type: array
20971 items:
20972 $ref: '#/components/schemas/Resource'
20973 servers:
20974 - url: /sdc2/rest
20975 variables: {}
20976 summary: Return outputs list
20977 tags:
20978 - SDCE-2 APIs
20979 /v1/catalog/{componentType}/{componentId}/create/policies:
20980 post:
20981 description: Create policies on service
20982 operationId: declareProperties
20983 parameters:
20984 - in: path
20985 name: componentType
20986 required: true
20987 schema:
20988 type: string
20989 - in: path
20990 name: componentId
20991 required: true
20992 schema:
20993 type: string
20994 - in: header
20995 name: USER_ID
20996 schema:
20997 type: string
20998 requestBody:
20999 content:
21000 application/json:
21001 schema:
21002 type: string
21003 description: ComponentIns policies Object to be created
21004 required: true
21005 responses:
21006 "200":
21007 description: Component found
21008 "403":
21009 description: Restricted operation
21010 "404":
21011 description: Component not found
21012 default:
21013 content:
21014 application/json:
21015 schema:
21016 type: array
21017 items:
21018 $ref: '#/components/schemas/Resource'
21019 servers:
21020 - url: /sdc2/rest
21021 variables: {}
21022 summary: Return policies list
21023 tags:
21024 - SDCE-2 APIs
21025 /v1/catalog/{componentType}/{componentId}/dataType/{dataTypeName}:
21026 delete:
21027 description: Delete data type from service
21028 operationId: deleteDataType
21029 parameters:
21030 - in: path
21031 name: componentType
21032 required: true
21033 schema:
21034 type: string
21035 - in: path
21036 name: componentId
21037 required: true
21038 schema:
21039 type: string
21040 - in: path
21041 name: dataTypeName
21042 required: true
21043 schema:
21044 type: string
21045 responses:
21046 "200":
21047 description: Data type deleted
21048 "403":
21049 description: Restricted operation
21050 "404":
21051 description: Data type not found
21052 default:
21053 content:
21054 application/json:
21055 schema:
21056 type: array
21057 items:
21058 $ref: '#/components/schemas/Resource'
21059 servers:
21060 - url: /sdc2/rest
21061 variables: {}
21062 summary: Delete service input
21063 tags:
21064 - SDCE-2 APIs
21065 get:
21066 description: Get data type in service
21067 operationId: getDataType
21068 parameters:
21069 - in: path
21070 name: componentType
21071 required: true
21072 schema:
21073 type: string
21074 - in: path
21075 name: componentId
21076 required: true
21077 schema:
21078 type: string
21079 - in: path
21080 name: dataTypeName
21081 required: true
21082 schema:
21083 type: string
21084 responses:
21085 "200":
21086 description: Data type found
21087 "403":
21088 description: Restricted operation
21089 "404":
21090 description: Data type not found
21091 default:
21092 content:
21093 application/json:
21094 schema:
21095 type: array
21096 items:
21097 $ref: '#/components/schemas/DataTypeDefinition'
21098 servers:
21099 - url: /sdc2/rest
21100 variables: {}
21101 summary: Get data type in service
21102 tags:
21103 - SDCE-2 APIs
21104 /v1/catalog/{componentType}/{componentId}/dataTypes:
21105 get:
21106 description: Get data types that service has
21107 operationId: getDataTypes
21108 parameters:
21109 - in: path
21110 name: componentType
21111 required: true
21112 schema:
21113 type: string
21114 - in: path
21115 name: componentId
21116 required: true
21117 schema:
21118 type: string
21119 responses:
21120 "200":
21121 description: Data type found
21122 "403":
21123 description: Restricted operation
21124 "404":
21125 description: Component not found
21126 default:
21127 content:
21128 application/json:
21129 schema:
21130 type: array
21131 items:
21132 $ref: '#/components/schemas/Resource'
21133 servers:
21134 - url: /sdc2/rest
21135 variables: {}
21136 summary: Get data types in service
21137 tags:
21138 - SDCE-2 APIs
21139 /v1/catalog/{componentType}/{componentId}/delete/{inputId}/input:
21140 delete:
21141 description: Delete input from service
21142 operationId: deleteInput
21143 parameters:
21144 - in: path
21145 name: componentType
21146 required: true
21147 schema:
21148 type: string
21149 - in: path
21150 name: componentId
21151 required: true
21152 schema:
21153 type: string
21154 - in: path
21155 name: inputId
21156 required: true
21157 schema:
21158 type: string
21159 - in: header
21160 name: USER_ID
21161 schema:
21162 type: string
21163 requestBody:
21164 content:
21165 application/json:
21166 schema:
21167 type: string
21168 description: Service Input to be deleted
21169 required: true
21170 responses:
21171 "200":
21172 description: Input deleted
21173 "403":
21174 description: Restricted operation
21175 "404":
21176 description: Input not found
21177 default:
21178 content:
21179 application/json:
21180 schema:
21181 type: array
21182 items:
21183 $ref: '#/components/schemas/Resource'
21184 servers:
21185 - url: /sdc2/rest
21186 variables: {}
21187 summary: Delete service input
21188 tags:
21189 - SDCE-2 APIs
21190 /v1/catalog/{componentType}/{componentId}/delete/{outputId}/output:
21191 delete:
21192 description: Delete output from service
21193 operationId: deleteOutput
21194 parameters:
21195 - in: path
21196 name: componentType
21197 required: true
21198 schema:
21199 type: string
21200 - in: path
21201 name: componentId
21202 required: true
21203 schema:
21204 type: string
21205 - in: path
21206 name: outputId
21207 required: true
21208 schema:
21209 type: string
21210 - in: header
21211 name: USER_ID
21212 schema:
21213 type: string
21214 requestBody:
21215 content:
21216 application/json:
21217 schema:
21218 type: string
21219 description: Service Output to be deleted
21220 required: true
21221 responses:
21222 "200":
21223 description: Output deleted
21224 "403":
21225 description: Restricted operation
21226 "404":
21227 description: Output not found
21228 default:
21229 content:
21230 application/json:
21231 schema:
21232 type: array
21233 items:
21234 $ref: '#/components/schemas/Resource'
21235 servers:
21236 - url: /sdc2/rest
21237 variables: {}
21238 summary: Delete service output
21239 tags:
21240 - SDCE-2 APIs
21241 /v1/catalog/{componentType}/{componentId}/dependencies:
21242 get:
21243 description: Autometed upgrade
21244 operationId: getComponentDependencies
21245 parameters:
21246 - in: path
21247 name: componentType
21248 required: true
21249 schema:
21250 type: string
21251 - in: path
21252 name: componentId
21253 required: true
21254 schema:
21255 type: string
21256 - in: header
21257 name: USER_ID
21258 schema:
21259 type: string
21260 requestBody:
21261 content:
21262 application/json:
21263 schema:
21264 type: array
21265 items:
21266 type: string
21267 description: Consumer Object to be created
21268 required: true
21269 responses:
21270 "200":
21271 description: Component found
21272 "403":
21273 description: Restricted operation
21274 "404":
21275 description: Component not found
21276 default:
21277 content:
21278 application/json:
21279 schema:
21280 type: array
21281 items:
21282 type: object
21283 properties:
21284 allowedMethods:
21285 type: array
21286 items:
21287 type: string
21288 uniqueItems: true
21289 cookies:
21290 type: object
21291 additionalProperties:
21292 type: object
21293 properties:
21294 comment:
21295 type: string
21296 domain:
21297 type: string
21298 expiry:
21299 type: string
21300 format: date-time
21301 httpOnly:
21302 type: boolean
21303 maxAge:
21304 type: integer
21305 format: int32
21306 name:
21307 type: string
21308 path:
21309 type: string
21310 secure:
21311 type: boolean
21312 value:
21313 type: string
21314 version:
21315 type: integer
21316 format: int32
21317 date:
21318 type: string
21319 format: date-time
21320 entity:
21321 type: object
21322 entityTag:
21323 type: object
21324 properties:
21325 value:
21326 type: string
21327 weak:
21328 type: boolean
21329 headers:
21330 type: object
21331 additionalProperties:
21332 type: array
21333 items:
21334 type: object
21335 language:
21336 type: object
21337 properties:
21338 country:
21339 type: string
21340 displayCountry:
21341 type: string
21342 displayLanguage:
21343 type: string
21344 displayName:
21345 type: string
21346 displayScript:
21347 type: string
21348 displayVariant:
21349 type: string
21350 extensionKeys:
21351 type: array
21352 items:
21353 type: string
21354 uniqueItems: true
21355 iso3Country:
21356 type: string
21357 iso3Language:
21358 type: string
21359 language:
21360 type: string
21361 script:
21362 type: string
21363 unicodeLocaleAttributes:
21364 type: array
21365 items:
21366 type: string
21367 uniqueItems: true
21368 unicodeLocaleKeys:
21369 type: array
21370 items:
21371 type: string
21372 uniqueItems: true
21373 variant:
21374 type: string
21375 lastModified:
21376 type: string
21377 format: date-time
21378 length:
21379 type: integer
21380 format: int32
21381 links:
21382 type: array
21383 items:
21384 type: object
21385 properties:
21386 params:
21387 type: object
21388 additionalProperties:
21389 type: string
21390 rel:
21391 type: string
21392 rels:
21393 type: array
21394 items:
21395 type: string
21396 title:
21397 type: string
21398 type:
21399 type: string
21400 uri:
21401 type: string
21402 format: uri
21403 uriBuilder:
21404 type: object
21405 uniqueItems: true
21406 location:
21407 type: string
21408 format: uri
21409 mediaType:
21410 type: object
21411 properties:
21412 parameters:
21413 type: object
21414 additionalProperties:
21415 type: string
21416 subtype:
21417 type: string
21418 type:
21419 type: string
21420 wildcardSubtype:
21421 type: boolean
21422 wildcardType:
21423 type: boolean
21424 metadata:
21425 type: object
21426 additionalProperties:
21427 type: array
21428 items:
21429 type: object
21430 status:
21431 type: integer
21432 format: int32
21433 statusInfo:
21434 type: object
21435 properties:
21436 family:
21437 type: string
21438 enum:
21439 - INFORMATIONAL
21440 - SUCCESSFUL
21441 - REDIRECTION
21442 - CLIENT_ERROR
21443 - SERVER_ERROR
21444 - OTHER
21445 reasonPhrase:
21446 type: string
21447 statusCode:
21448 type: integer
21449 format: int32
21450 stringHeaders:
21451 type: object
21452 additionalProperties:
21453 type: array
21454 items:
21455 type: string
21456 servers:
21457 - url: /sdc2/rest
21458 variables: {}
21459 summary: '....'
21460 tags:
21461 - SDCE-2 APIs
21462 /v1/catalog/{componentType}/{componentId}/filteredDataByParams:
21463 get:
21464 description: Retrieve Resource
21465 operationId: getComponentDataFilteredByParams
21466 parameters:
21467 - in: path
21468 name: componentType
21469 required: true
21470 schema:
21471 type: string
21472 - in: path
21473 name: componentId
21474 required: true
21475 schema:
21476 type: string
21477 - in: query
21478 name: include
21479 schema:
21480 type: array
21481 items:
21482 type: string
21483 - in: header
21484 name: USER_ID
21485 schema:
21486 type: string
21487 responses:
21488 "200":
21489 description: Resource found
21490 "403":
21491 description: Restricted operation
21492 "404":
21493 description: Resource not found
21494 default:
21495 content:
21496 application/json:
21497 schema:
21498 type: array
21499 items:
21500 $ref: '#/components/schemas/Resource'
21501 servers:
21502 - url: /sdc2/rest
21503 variables: {}
21504 summary: Returns resource according to resourceId
21505 tags:
21506 - SDCE-2 APIs
21507 /v1/catalog/{componentType}/{componentId}/filteredproperties/{propertyNameFragment}:
21508 get:
21509 description: Retrieve properties belonging to component instances of specific
21510 component by name and optionally resource type
21511 operationId: getFilteredComponentInstanceProperties
21512 parameters:
21513 - in: path
21514 name: componentType
21515 required: true
21516 schema:
21517 type: string
21518 - in: path
21519 name: componentId
21520 required: true
21521 schema:
21522 type: string
21523 - in: path
21524 name: propertyNameFragment
21525 required: true
21526 schema:
21527 type: string
21528 - in: query
21529 name: resourceType
21530 schema:
21531 type: array
21532 items:
21533 type: string
21534 - in: header
21535 name: USER_ID
21536 schema:
21537 type: string
21538 responses:
21539 "200":
21540 description: Component found
21541 "403":
21542 description: Restricted operation
21543 "404":
21544 description: Component not found
21545 default:
21546 content:
21547 application/json:
21548 schema:
21549 type: array
21550 items:
21551 type: string
21552 servers:
21553 - url: /sdc2/rest
21554 variables: {}
21555 summary: Returns properties belonging to component instances of specific component
21556 by name and optionally resource type
21557 tags:
21558 - SDCE-2 APIs
21559 /v1/catalog/{componentType}/{componentId}/inputs/{inputId}:
21560 get:
21561 description: Get inputs
21562 operationId: getInputsAndPropertiesForComponentInput
21563 parameters:
21564 - in: path
21565 name: componentType
21566 required: true
21567 schema:
21568 type: string
21569 - in: path
21570 name: componentId
21571 required: true
21572 schema:
21573 type: string
21574 - in: path
21575 name: inputId
21576 required: true
21577 schema:
21578 type: string
21579 - in: header
21580 name: USER_ID
21581 schema:
21582 type: string
21583 responses:
21584 "200":
21585 description: Component found
21586 "403":
21587 description: Restricted operation
21588 "404":
21589 description: Component not found
21590 default:
21591 content:
21592 application/json:
21593 schema:
21594 type: array
21595 items:
21596 $ref: '#/components/schemas/Resource'
21597 servers:
21598 - url: /sdc2/rest
21599 variables: {}
21600 summary: Returns inputs list
21601 tags:
21602 - SDCE-2 APIs
21603 /v1/catalog/{componentType}/{componentId}/inputs/{inputId}/inputs:
21604 get:
21605 description: Get inputs
21606 operationId: getInputsForComponentInput
21607 parameters:
21608 - in: path
21609 name: componentType
21610 required: true
21611 schema:
21612 type: string
21613 - in: path
21614 name: componentId
21615 required: true
21616 schema:
21617 type: string
21618 - in: path
21619 name: inputId
21620 required: true
21621 schema:
21622 type: string
21623 - in: header
21624 name: USER_ID
21625 schema:
21626 type: string
21627 responses:
21628 "200":
21629 description: Component found
21630 "403":
21631 description: Restricted operation
21632 "404":
21633 description: Component not found
21634 default:
21635 content:
21636 application/json:
21637 schema:
21638 type: array
21639 items:
21640 $ref: '#/components/schemas/Resource'
21641 servers:
21642 - url: /sdc2/rest
21643 variables: {}
21644 summary: Returns inputs list
21645 tags:
21646 - SDCE-2 APIs
21647 /v1/catalog/{componentType}/{componentId}/requirmentsCapabilities:
21648 get:
21649 description: Get Component Requirments And Capabilities
21650 operationId: getRequirementAndCapabilities
21651 parameters:
21652 - in: path
21653 name: componentType
21654 required: true
21655 schema:
21656 type: string
21657 - in: path
21658 name: componentId
21659 required: true
21660 schema:
21661 type: string
21662 - in: header
21663 name: USER_ID
21664 schema:
21665 type: string
21666 responses:
21667 "200":
21668 description: Component found
21669 "403":
21670 description: Restricted operation
21671 "404":
21672 description: Component not found
21673 default:
21674 content:
21675 application/json:
21676 schema:
21677 type: array
21678 items:
21679 $ref: '#/components/schemas/Resource'
21680 servers:
21681 - url: /sdc2/rest
21682 variables: {}
21683 summary: Returns Requirements And Capabilities according to componentId
21684 tags:
21685 - SDCE-2 APIs
21686 /v1/catalog/{componentType}/{componentId}/resource/interfaceOperation:
21687 post:
21688 description: Create Interface Operation
21689 operationId: createInterfaceOperationInResource
21690 parameters:
21691 - description: "valid values: resources"
21692 in: path
21693 name: componentType
21694 required: true
21695 schema:
21696 type: string
21697 enum:
21698 - resources
21699 - description: Component Id
21700 in: path
21701 name: componentId
21702 required: true
21703 schema:
21704 type: string
21705 - in: header
21706 name: USER_ID
21707 schema:
21708 type: string
21709 responses:
21710 "201":
21711 description: Create Interface Operation
21712 "400":
21713 description: Invalid content / Missing content
21714 "403":
21715 description: Restricted operation
21716 default:
21717 content:
21718 application/json:
21719 schema:
21720 type: array
21721 items:
21722 type: object
21723 properties:
21724 allowedMethods:
21725 type: array
21726 items:
21727 type: string
21728 uniqueItems: true
21729 cookies:
21730 type: object
21731 additionalProperties:
21732 type: object
21733 properties:
21734 comment:
21735 type: string
21736 domain:
21737 type: string
21738 expiry:
21739 type: string
21740 format: date-time
21741 httpOnly:
21742 type: boolean
21743 maxAge:
21744 type: integer
21745 format: int32
21746 name:
21747 type: string
21748 path:
21749 type: string
21750 secure:
21751 type: boolean
21752 value:
21753 type: string
21754 version:
21755 type: integer
21756 format: int32
21757 date:
21758 type: string
21759 format: date-time
21760 entity:
21761 type: object
21762 entityTag:
21763 type: object
21764 properties:
21765 value:
21766 type: string
21767 weak:
21768 type: boolean
21769 headers:
21770 type: object
21771 additionalProperties:
21772 type: array
21773 items:
21774 type: object
21775 language:
21776 type: object
21777 properties:
21778 country:
21779 type: string
21780 displayCountry:
21781 type: string
21782 displayLanguage:
21783 type: string
21784 displayName:
21785 type: string
21786 displayScript:
21787 type: string
21788 displayVariant:
21789 type: string
21790 extensionKeys:
21791 type: array
21792 items:
21793 type: string
21794 uniqueItems: true
21795 iso3Country:
21796 type: string
21797 iso3Language:
21798 type: string
21799 language:
21800 type: string
21801 script:
21802 type: string
21803 unicodeLocaleAttributes:
21804 type: array
21805 items:
21806 type: string
21807 uniqueItems: true
21808 unicodeLocaleKeys:
21809 type: array
21810 items:
21811 type: string
21812 uniqueItems: true
21813 variant:
21814 type: string
21815 lastModified:
21816 type: string
21817 format: date-time
21818 length:
21819 type: integer
21820 format: int32
21821 links:
21822 type: array
21823 items:
21824 type: object
21825 properties:
21826 params:
21827 type: object
21828 additionalProperties:
21829 type: string
21830 rel:
21831 type: string
21832 rels:
21833 type: array
21834 items:
21835 type: string
21836 title:
21837 type: string
21838 type:
21839 type: string
21840 uri:
21841 type: string
21842 format: uri
21843 uriBuilder:
21844 type: object
21845 uniqueItems: true
21846 location:
21847 type: string
21848 format: uri
21849 mediaType:
21850 type: object
21851 properties:
21852 parameters:
21853 type: object
21854 additionalProperties:
21855 type: string
21856 subtype:
21857 type: string
21858 type:
21859 type: string
21860 wildcardSubtype:
21861 type: boolean
21862 wildcardType:
21863 type: boolean
21864 metadata:
21865 type: object
21866 additionalProperties:
21867 type: array
21868 items:
21869 type: object
21870 status:
21871 type: integer
21872 format: int32
21873 statusInfo:
21874 type: object
21875 properties:
21876 family:
21877 type: string
21878 enum:
21879 - INFORMATIONAL
21880 - SUCCESSFUL
21881 - REDIRECTION
21882 - CLIENT_ERROR
21883 - SERVER_ERROR
21884 - OTHER
21885 reasonPhrase:
21886 type: string
21887 statusCode:
21888 type: integer
21889 format: int32
21890 stringHeaders:
21891 type: object
21892 additionalProperties:
21893 type: array
21894 items:
21895 type: string
21896 servers:
21897 - url: /sdc2/rest
21898 variables: {}
21899 summary: Create Interface Operation on ComponentInstance
21900 tags:
21901 - SDCE-2 APIs
21902 /v1/catalog/{componentType}/{componentId}/substitutionFilter/{constraintType}:
21903 post:
21904 description: Add Component Substitution Filter Constraint
21905 operationId: addSubstitutionFilter
21906 parameters:
21907 - description: Component Id
21908 in: path
21909 name: componentId
21910 required: true
21911 schema:
21912 type: string
21913 - description: "valid value: resources / services"
21914 in: path
21915 name: componentType
21916 required: true
21917 schema:
21918 type: string
21919 enum:
21920 - services
21921 - services
21922 - description: "Constraint type. Valid values: properties / capabilities"
21923 in: path
21924 name: constraintType
21925 required: true
21926 schema:
21927 type: string
21928 enum:
21929 - properties
21930 - capabilities
21931 - in: header
21932 name: USER_ID
21933 schema:
21934 type: string
21935 requestBody:
21936 content:
21937 application/json:
21938 schema:
21939 type: string
21940 description: UIConstraint data
21941 required: true
21942 responses:
21943 "201":
21944 description: Add Substitution Filter Constraint
21945 "400":
21946 description: Invalid content / Missing content
21947 "403":
21948 description: Restricted operation
21949 default:
21950 content:
21951 application/json:
21952 schema:
21953 type: array
21954 items:
21955 type: object
21956 properties:
21957 allowedMethods:
21958 type: array
21959 items:
21960 type: string
21961 uniqueItems: true
21962 cookies:
21963 type: object
21964 additionalProperties:
21965 type: object
21966 properties:
21967 comment:
21968 type: string
21969 domain:
21970 type: string
21971 expiry:
21972 type: string
21973 format: date-time
21974 httpOnly:
21975 type: boolean
21976 maxAge:
21977 type: integer
21978 format: int32
21979 name:
21980 type: string
21981 path:
21982 type: string
21983 secure:
21984 type: boolean
21985 value:
21986 type: string
21987 version:
21988 type: integer
21989 format: int32
21990 date:
21991 type: string
21992 format: date-time
21993 entity:
21994 type: object
21995 entityTag:
21996 type: object
21997 properties:
21998 value:
21999 type: string
22000 weak:
22001 type: boolean
22002 headers:
22003 type: object
22004 additionalProperties:
22005 type: array
22006 items:
22007 type: object
22008 language:
22009 type: object
22010 properties:
22011 country:
22012 type: string
22013 displayCountry:
22014 type: string
22015 displayLanguage:
22016 type: string
22017 displayName:
22018 type: string
22019 displayScript:
22020 type: string
22021 displayVariant:
22022 type: string
22023 extensionKeys:
22024 type: array
22025 items:
22026 type: string
22027 uniqueItems: true
22028 iso3Country:
22029 type: string
22030 iso3Language:
22031 type: string
22032 language:
22033 type: string
22034 script:
22035 type: string
22036 unicodeLocaleAttributes:
22037 type: array
22038 items:
22039 type: string
22040 uniqueItems: true
22041 unicodeLocaleKeys:
22042 type: array
22043 items:
22044 type: string
22045 uniqueItems: true
22046 variant:
22047 type: string
22048 lastModified:
22049 type: string
22050 format: date-time
22051 length:
22052 type: integer
22053 format: int32
22054 links:
22055 type: array
22056 items:
22057 type: object
22058 properties:
22059 params:
22060 type: object
22061 additionalProperties:
22062 type: string
22063 rel:
22064 type: string
22065 rels:
22066 type: array
22067 items:
22068 type: string
22069 title:
22070 type: string
22071 type:
22072 type: string
22073 uri:
22074 type: string
22075 format: uri
22076 uriBuilder:
22077 type: object
22078 uniqueItems: true
22079 location:
22080 type: string
22081 format: uri
22082 mediaType:
22083 type: object
22084 properties:
22085 parameters:
22086 type: object
22087 additionalProperties:
22088 type: string
22089 subtype:
22090 type: string
22091 type:
22092 type: string
22093 wildcardSubtype:
22094 type: boolean
22095 wildcardType:
22096 type: boolean
22097 metadata:
22098 type: object
22099 additionalProperties:
22100 type: array
22101 items:
22102 type: object
22103 status:
22104 type: integer
22105 format: int32
22106 statusInfo:
22107 type: object
22108 properties:
22109 family:
22110 type: string
22111 enum:
22112 - INFORMATIONAL
22113 - SUCCESSFUL
22114 - REDIRECTION
22115 - CLIENT_ERROR
22116 - SERVER_ERROR
22117 - OTHER
22118 reasonPhrase:
22119 type: string
22120 statusCode:
22121 type: integer
22122 format: int32
22123 stringHeaders:
22124 type: object
22125 additionalProperties:
22126 type: array
22127 items:
22128 type: string
22129 summary: Add Component Substitution Filter Constraint
22130 tags:
22131 - SDCE-2 APIs
22132 put:
22133 description: Update Component Substitution Filter Constraint
22134 operationId: updateSubstitutionFilters
22135 parameters:
22136 - description: Component Id
22137 in: path
22138 name: componentId
22139 required: true
22140 schema:
22141 type: string
22142 - description: "valid value: resources / services"
22143 in: path
22144 name: componentType
22145 required: true
22146 schema:
22147 type: string
22148 enum:
22149 - services
22150 - services
22151 - description: "Constraint type. Valid values: properties / capabilities"
22152 in: path
22153 name: constraintType
22154 required: true
22155 schema:
22156 type: string
22157 enum:
22158 - properties
22159 - capabilities
22160 - in: header
22161 name: USER_ID
22162 schema:
22163 type: string
22164 requestBody:
22165 content:
22166 application/json:
22167 schema:
22168 type: string
22169 description: UIConstraint data
22170 required: true
22171 responses:
22172 "201":
22173 description: Update Substitution Filter Constraint
22174 "400":
22175 description: Invalid content / Missing content
22176 "403":
22177 description: Restricted operation
22178 default:
22179 content:
22180 application/json:
22181 schema:
22182 type: array
22183 items:
22184 type: object
22185 properties:
22186 allowedMethods:
22187 type: array
22188 items:
22189 type: string
22190 uniqueItems: true
22191 cookies:
22192 type: object
22193 additionalProperties:
22194 type: object
22195 properties:
22196 comment:
22197 type: string
22198 domain:
22199 type: string
22200 expiry:
22201 type: string
22202 format: date-time
22203 httpOnly:
22204 type: boolean
22205 maxAge:
22206 type: integer
22207 format: int32
22208 name:
22209 type: string
22210 path:
22211 type: string
22212 secure:
22213 type: boolean
22214 value:
22215 type: string
22216 version:
22217 type: integer
22218 format: int32
22219 date:
22220 type: string
22221 format: date-time
22222 entity:
22223 type: object
22224 entityTag:
22225 type: object
22226 properties:
22227 value:
22228 type: string
22229 weak:
22230 type: boolean
22231 headers:
22232 type: object
22233 additionalProperties:
22234 type: array
22235 items:
22236 type: object
22237 language:
22238 type: object
22239 properties:
22240 country:
22241 type: string
22242 displayCountry:
22243 type: string
22244 displayLanguage:
22245 type: string
22246 displayName:
22247 type: string
22248 displayScript:
22249 type: string
22250 displayVariant:
22251 type: string
22252 extensionKeys:
22253 type: array
22254 items:
22255 type: string
22256 uniqueItems: true
22257 iso3Country:
22258 type: string
22259 iso3Language:
22260 type: string
22261 language:
22262 type: string
22263 script:
22264 type: string
22265 unicodeLocaleAttributes:
22266 type: array
22267 items:
22268 type: string
22269 uniqueItems: true
22270 unicodeLocaleKeys:
22271 type: array
22272 items:
22273 type: string
22274 uniqueItems: true
22275 variant:
22276 type: string
22277 lastModified:
22278 type: string
22279 format: date-time
22280 length:
22281 type: integer
22282 format: int32
22283 links:
22284 type: array
22285 items:
22286 type: object
22287 properties:
22288 params:
22289 type: object
22290 additionalProperties:
22291 type: string
22292 rel:
22293 type: string
22294 rels:
22295 type: array
22296 items:
22297 type: string
22298 title:
22299 type: string
22300 type:
22301 type: string
22302 uri:
22303 type: string
22304 format: uri
22305 uriBuilder:
22306 type: object
22307 uniqueItems: true
22308 location:
22309 type: string
22310 format: uri
22311 mediaType:
22312 type: object
22313 properties:
22314 parameters:
22315 type: object
22316 additionalProperties:
22317 type: string
22318 subtype:
22319 type: string
22320 type:
22321 type: string
22322 wildcardSubtype:
22323 type: boolean
22324 wildcardType:
22325 type: boolean
22326 metadata:
22327 type: object
22328 additionalProperties:
22329 type: array
22330 items:
22331 type: object
22332 status:
22333 type: integer
22334 format: int32
22335 statusInfo:
22336 type: object
22337 properties:
22338 family:
22339 type: string
22340 enum:
22341 - INFORMATIONAL
22342 - SUCCESSFUL
22343 - REDIRECTION
22344 - CLIENT_ERROR
22345 - SERVER_ERROR
22346 - OTHER
22347 reasonPhrase:
22348 type: string
22349 statusCode:
22350 type: integer
22351 format: int32
22352 stringHeaders:
22353 type: object
22354 additionalProperties:
22355 type: array
22356 items:
22357 type: string
22358 summary: Update Component Substitution Filter Constraint
22359 tags:
22360 - SDCE-2 APIs
22361 /v1/catalog/{componentType}/{componentId}/substitutionFilter/{constraintType}/{constraintIndex}:
22362 delete:
22363 description: Delete Component Substitution Filter Constraint
22364 operationId: deleteSubstitutionFilterConstraint
22365 parameters:
22366 - description: Component Id
22367 in: path
22368 name: componentId
22369 required: true
22370 schema:
22371 type: string
22372 - description: Constraint Index
22373 in: path
22374 name: constraintIndex
22375 required: true
22376 schema:
22377 type: integer
22378 format: int32
22379 - description: "valid value: resources / services"
22380 in: path
22381 name: componentType
22382 required: true
22383 schema:
22384 type: string
22385 enum:
22386 - services
22387 - services
22388 - description: "Constraint type. Valid values: properties / capabilities"
22389 in: path
22390 name: constraintType
22391 required: true
22392 schema:
22393 type: string
22394 enum:
22395 - properties
22396 - capabilities
22397 - in: header
22398 name: USER_ID
22399 schema:
22400 type: string
22401 responses:
22402 "201":
22403 description: Delete Substitution Filter Constraint
22404 "400":
22405 description: Invalid content / Missing content
22406 "403":
22407 description: Restricted operation
22408 default:
22409 content:
22410 application/json:
22411 schema:
22412 type: array
22413 items:
22414 type: object
22415 properties:
22416 allowedMethods:
22417 type: array
22418 items:
22419 type: string
22420 uniqueItems: true
22421 cookies:
22422 type: object
22423 additionalProperties:
22424 type: object
22425 properties:
22426 comment:
22427 type: string
22428 domain:
22429 type: string
22430 expiry:
22431 type: string
22432 format: date-time
22433 httpOnly:
22434 type: boolean
22435 maxAge:
22436 type: integer
22437 format: int32
22438 name:
22439 type: string
22440 path:
22441 type: string
22442 secure:
22443 type: boolean
22444 value:
22445 type: string
22446 version:
22447 type: integer
22448 format: int32
22449 date:
22450 type: string
22451 format: date-time
22452 entity:
22453 type: object
22454 entityTag:
22455 type: object
22456 properties:
22457 value:
22458 type: string
22459 weak:
22460 type: boolean
22461 headers:
22462 type: object
22463 additionalProperties:
22464 type: array
22465 items:
22466 type: object
22467 language:
22468 type: object
22469 properties:
22470 country:
22471 type: string
22472 displayCountry:
22473 type: string
22474 displayLanguage:
22475 type: string
22476 displayName:
22477 type: string
22478 displayScript:
22479 type: string
22480 displayVariant:
22481 type: string
22482 extensionKeys:
22483 type: array
22484 items:
22485 type: string
22486 uniqueItems: true
22487 iso3Country:
22488 type: string
22489 iso3Language:
22490 type: string
22491 language:
22492 type: string
22493 script:
22494 type: string
22495 unicodeLocaleAttributes:
22496 type: array
22497 items:
22498 type: string
22499 uniqueItems: true
22500 unicodeLocaleKeys:
22501 type: array
22502 items:
22503 type: string
22504 uniqueItems: true
22505 variant:
22506 type: string
22507 lastModified:
22508 type: string
22509 format: date-time
22510 length:
22511 type: integer
22512 format: int32
22513 links:
22514 type: array
22515 items:
22516 type: object
22517 properties:
22518 params:
22519 type: object
22520 additionalProperties:
22521 type: string
22522 rel:
22523 type: string
22524 rels:
22525 type: array
22526 items:
22527 type: string
22528 title:
22529 type: string
22530 type:
22531 type: string
22532 uri:
22533 type: string
22534 format: uri
22535 uriBuilder:
22536 type: object
22537 uniqueItems: true
22538 location:
22539 type: string
22540 format: uri
22541 mediaType:
22542 type: object
22543 properties:
22544 parameters:
22545 type: object
22546 additionalProperties:
22547 type: string
22548 subtype:
22549 type: string
22550 type:
22551 type: string
22552 wildcardSubtype:
22553 type: boolean
22554 wildcardType:
22555 type: boolean
22556 metadata:
22557 type: object
22558 additionalProperties:
22559 type: array
22560 items:
22561 type: object
22562 status:
22563 type: integer
22564 format: int32
22565 statusInfo:
22566 type: object
22567 properties:
22568 family:
22569 type: string
22570 enum:
22571 - INFORMATIONAL
22572 - SUCCESSFUL
22573 - REDIRECTION
22574 - CLIENT_ERROR
22575 - SERVER_ERROR
22576 - OTHER
22577 reasonPhrase:
22578 type: string
22579 statusCode:
22580 type: integer
22581 format: int32
22582 stringHeaders:
22583 type: object
22584 additionalProperties:
22585 type: array
22586 items:
22587 type: string
22588 summary: Delete Component Substitution Filter Constraint
22589 tags:
22590 - SDCE-2 APIs
22591 put:
22592 description: Update Component Substitution Filter Constraint
22593 operationId: updateSubstitutionFilter
22594 parameters:
22595 - description: Constraint Index
22596 in: path
22597 name: constraintIndex
22598 required: true
22599 schema:
22600 type: integer
22601 format: int32
22602 - description: Component Id
22603 in: path
22604 name: componentId
22605 required: true
22606 schema:
22607 type: string
22608 - description: The component type
22609 in: path
22610 name: componentType
22611 required: true
22612 schema:
22613 type: string
22614 enum:
22615 - services
22616 - resources
22617 - description: "Constraint type. Valid values: properties / capabilities"
22618 in: path
22619 name: constraintType
22620 required: true
22621 schema:
22622 type: string
22623 enum:
22624 - properties
22625 - capabilities
22626 - in: header
22627 name: USER_ID
22628 schema:
22629 type: string
22630 requestBody:
22631 content:
22632 application/json:
22633 schema:
22634 $ref: '#/components/schemas/UIConstraint'
22635 description: Filter constraint information
22636 required: true
22637 responses:
22638 "201":
22639 description: Update Substitution Filter Constraint
22640 "400":
22641 description: Invalid content / Missing content
22642 "403":
22643 description: Restricted operation
22644 default:
22645 content:
22646 application/json:
22647 schema:
22648 type: array
22649 items:
22650 type: object
22651 properties:
22652 allowedMethods:
22653 type: array
22654 items:
22655 type: string
22656 uniqueItems: true
22657 cookies:
22658 type: object
22659 additionalProperties:
22660 type: object
22661 properties:
22662 comment:
22663 type: string
22664 domain:
22665 type: string
22666 expiry:
22667 type: string
22668 format: date-time
22669 httpOnly:
22670 type: boolean
22671 maxAge:
22672 type: integer
22673 format: int32
22674 name:
22675 type: string
22676 path:
22677 type: string
22678 secure:
22679 type: boolean
22680 value:
22681 type: string
22682 version:
22683 type: integer
22684 format: int32
22685 date:
22686 type: string
22687 format: date-time
22688 entity:
22689 type: object
22690 entityTag:
22691 type: object
22692 properties:
22693 value:
22694 type: string
22695 weak:
22696 type: boolean
22697 headers:
22698 type: object
22699 additionalProperties:
22700 type: array
22701 items:
22702 type: object
22703 language:
22704 type: object
22705 properties:
22706 country:
22707 type: string
22708 displayCountry:
22709 type: string
22710 displayLanguage:
22711 type: string
22712 displayName:
22713 type: string
22714 displayScript:
22715 type: string
22716 displayVariant:
22717 type: string
22718 extensionKeys:
22719 type: array
22720 items:
22721 type: string
22722 uniqueItems: true
22723 iso3Country:
22724 type: string
22725 iso3Language:
22726 type: string
22727 language:
22728 type: string
22729 script:
22730 type: string
22731 unicodeLocaleAttributes:
22732 type: array
22733 items:
22734 type: string
22735 uniqueItems: true
22736 unicodeLocaleKeys:
22737 type: array
22738 items:
22739 type: string
22740 uniqueItems: true
22741 variant:
22742 type: string
22743 lastModified:
22744 type: string
22745 format: date-time
22746 length:
22747 type: integer
22748 format: int32
22749 links:
22750 type: array
22751 items:
22752 type: object
22753 properties:
22754 params:
22755 type: object
22756 additionalProperties:
22757 type: string
22758 rel:
22759 type: string
22760 rels:
22761 type: array
22762 items:
22763 type: string
22764 title:
22765 type: string
22766 type:
22767 type: string
22768 uri:
22769 type: string
22770 format: uri
22771 uriBuilder:
22772 type: object
22773 uniqueItems: true
22774 location:
22775 type: string
22776 format: uri
22777 mediaType:
22778 type: object
22779 properties:
22780 parameters:
22781 type: object
22782 additionalProperties:
22783 type: string
22784 subtype:
22785 type: string
22786 type:
22787 type: string
22788 wildcardSubtype:
22789 type: boolean
22790 wildcardType:
22791 type: boolean
22792 metadata:
22793 type: object
22794 additionalProperties:
22795 type: array
22796 items:
22797 type: object
22798 status:
22799 type: integer
22800 format: int32
22801 statusInfo:
22802 type: object
22803 properties:
22804 family:
22805 type: string
22806 enum:
22807 - INFORMATIONAL
22808 - SUCCESSFUL
22809 - REDIRECTION
22810 - CLIENT_ERROR
22811 - SERVER_ERROR
22812 - OTHER
22813 reasonPhrase:
22814 type: string
22815 statusCode:
22816 type: integer
22817 format: int32
22818 stringHeaders:
22819 type: object
22820 additionalProperties:
22821 type: array
22822 items:
22823 type: string
22824 summary: Update Component Substitution Filter Constraint
22825 tags:
22826 - SDCE-2 APIs
22827 /v1/catalog/{componentType}/{componentUuid}/conformanceLevelValidation:
22828 get:
22829 description: Validate Component Conformance Level
22830 operationId: conformanceLevelValidation
22831 parameters:
22832 - in: path
22833 name: componentType
22834 required: true
22835 schema:
22836 type: string
22837 - in: path
22838 name: componentUuid
22839 required: true
22840 schema:
22841 type: string
22842 - in: header
22843 name: USER_ID
22844 schema:
22845 type: string
22846 responses:
22847 "200":
22848 description: Component found
22849 "403":
22850 description: Restricted operation
22851 "404":
22852 description: Component not found
22853 default:
22854 content:
22855 application/json:
22856 schema:
22857 type: array
22858 items:
22859 $ref: '#/components/schemas/Resource'
22860 servers:
22861 - url: /sdc2/rest
22862 variables: {}
22863 summary: Returns the result according to conformance level in BE config
22864 tags:
22865 - SDCE-2 APIs
22866 /v1/catalog/{containerComponentType}/{componentId}/artifactsByType/{artifactGroupType}:
22867 get:
22868 description: Get component Artifacts
22869 operationId: getComponentArtifacts
22870 parameters:
22871 - description: "valid values: resources / services"
22872 in: path
22873 name: containerComponentType
22874 required: true
22875 schema:
22876 type: string
22877 enum:
22878 - resources
22879 - services
22880 - in: path
22881 name: componentId
22882 required: true
22883 schema:
22884 type: string
22885 - in: path
22886 name: artifactGroupType
22887 required: true
22888 schema:
22889 type: string
22890 responses:
22891 "200":
22892 description: Component artifacts
22893 "404":
22894 description: Resource/Artifact not found
22895 default:
22896 content:
22897 application/json:
22898 schema:
22899 type: array
22900 items:
22901 type: object
22902 properties:
22903 allowedMethods:
22904 type: array
22905 items:
22906 type: string
22907 uniqueItems: true
22908 cookies:
22909 type: object
22910 additionalProperties:
22911 type: object
22912 properties:
22913 comment:
22914 type: string
22915 domain:
22916 type: string
22917 expiry:
22918 type: string
22919 format: date-time
22920 httpOnly:
22921 type: boolean
22922 maxAge:
22923 type: integer
22924 format: int32
22925 name:
22926 type: string
22927 path:
22928 type: string
22929 secure:
22930 type: boolean
22931 value:
22932 type: string
22933 version:
22934 type: integer
22935 format: int32
22936 date:
22937 type: string
22938 format: date-time
22939 entity:
22940 type: object
22941 entityTag:
22942 type: object
22943 properties:
22944 value:
22945 type: string
22946 weak:
22947 type: boolean
22948 headers:
22949 type: object
22950 additionalProperties:
22951 type: array
22952 items:
22953 type: object
22954 language:
22955 type: object
22956 properties:
22957 country:
22958 type: string
22959 displayCountry:
22960 type: string
22961 displayLanguage:
22962 type: string
22963 displayName:
22964 type: string
22965 displayScript:
22966 type: string
22967 displayVariant:
22968 type: string
22969 extensionKeys:
22970 type: array
22971 items:
22972 type: string
22973 uniqueItems: true
22974 iso3Country:
22975 type: string
22976 iso3Language:
22977 type: string
22978 language:
22979 type: string
22980 script:
22981 type: string
22982 unicodeLocaleAttributes:
22983 type: array
22984 items:
22985 type: string
22986 uniqueItems: true
22987 unicodeLocaleKeys:
22988 type: array
22989 items:
22990 type: string
22991 uniqueItems: true
22992 variant:
22993 type: string
22994 lastModified:
22995 type: string
22996 format: date-time
22997 length:
22998 type: integer
22999 format: int32
23000 links:
23001 type: array
23002 items:
23003 type: object
23004 properties:
23005 params:
23006 type: object
23007 additionalProperties:
23008 type: string
23009 rel:
23010 type: string
23011 rels:
23012 type: array
23013 items:
23014 type: string
23015 title:
23016 type: string
23017 type:
23018 type: string
23019 uri:
23020 type: string
23021 format: uri
23022 uriBuilder:
23023 type: object
23024 uniqueItems: true
23025 location:
23026 type: string
23027 format: uri
23028 mediaType:
23029 type: object
23030 properties:
23031 parameters:
23032 type: object
23033 additionalProperties:
23034 type: string
23035 subtype:
23036 type: string
23037 type:
23038 type: string
23039 wildcardSubtype:
23040 type: boolean
23041 wildcardType:
23042 type: boolean
23043 metadata:
23044 type: object
23045 additionalProperties:
23046 type: array
23047 items:
23048 type: object
23049 status:
23050 type: integer
23051 format: int32
23052 statusInfo:
23053 type: object
23054 properties:
23055 family:
23056 type: string
23057 enum:
23058 - INFORMATIONAL
23059 - SUCCESSFUL
23060 - REDIRECTION
23061 - CLIENT_ERROR
23062 - SERVER_ERROR
23063 - OTHER
23064 reasonPhrase:
23065 type: string
23066 statusCode:
23067 type: integer
23068 format: int32
23069 stringHeaders:
23070 type: object
23071 additionalProperties:
23072 type: array
23073 items:
23074 type: string
23075 servers:
23076 - url: /sdc2/rest
23077 variables: {}
23078 summary: Returns artifacts
23079 tags:
23080 - SDCE-2 APIs
23081 /v1/catalog/{containerComponentType}/{componentId}/batchDeleteResourceInstances:
23082 post:
23083 description: Batch Delete ResourceInstances
23084 operationId: batchDeleteResourceInstances
23085 parameters:
23086 - description: "valid values: resources / services / products"
23087 in: path
23088 name: containerComponentType
23089 required: true
23090 schema:
23091 type: string
23092 enum:
23093 - resources
23094 - services
23095 - products
23096 - in: path
23097 name: componentId
23098 required: true
23099 schema:
23100 type: string
23101 requestBody:
23102 content:
23103 application/json:
23104 schema:
23105 type: string
23106 description: Component Instance Id List
23107 required: true
23108 responses:
23109 "203":
23110 description: ResourceInstances deleted
23111 "400":
23112 description: Invalid Content / Missing Content
23113 "403":
23114 description: Restricted Operation
23115 servers:
23116 - url: /sdc2/rest
23117 variables: {}
23118 tags:
23119 - SDCE-2 APIs
23120 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupId}:
23121 get:
23122 description: 'Get group artifacts '
23123 operationId: getGroupById
23124 parameters:
23125 - in: path
23126 name: containerComponentType
23127 required: true
23128 schema:
23129 type: string
23130 - in: path
23131 name: componentId
23132 required: true
23133 schema:
23134 type: string
23135 - in: path
23136 name: groupId
23137 required: true
23138 schema:
23139 type: string
23140 - in: header
23141 name: USER_ID
23142 schema:
23143 type: string
23144 responses:
23145 "200":
23146 description: group found
23147 "403":
23148 description: Restricted operation
23149 "404":
23150 description: Group not found
23151 default:
23152 content:
23153 application/json:
23154 schema:
23155 type: array
23156 items:
23157 $ref: '#/components/schemas/Resource'
23158 servers:
23159 - url: /sdc2/rest
23160 variables: {}
23161 summary: Returns artifacts metadata according to groupId
23162 tags:
23163 - SDCE-2 APIs
23164 put:
23165 description: Update Group metadata
23166 operationId: updateGroup
23167 parameters:
23168 - in: path
23169 name: containerComponentType
23170 required: true
23171 schema:
23172 type: string
23173 - in: path
23174 name: componentId
23175 required: true
23176 schema:
23177 type: string
23178 - in: path
23179 name: groupId
23180 required: true
23181 schema:
23182 type: string
23183 - in: header
23184 name: USER_ID
23185 schema:
23186 type: string
23187 requestBody:
23188 content:
23189 application/json:
23190 schema:
23191 $ref: '#/components/schemas/GroupDefinition'
23192 description: GroupDefinition
23193 required: true
23194 responses:
23195 "200":
23196 description: Group updated
23197 "400":
23198 description: Invalid content / Missing content
23199 "403":
23200 description: Restricted operation
23201 "404":
23202 description: component / group Not found
23203 default:
23204 content:
23205 application/json:
23206 schema:
23207 type: array
23208 items:
23209 type: object
23210 properties:
23211 allowedMethods:
23212 type: array
23213 items:
23214 type: string
23215 uniqueItems: true
23216 cookies:
23217 type: object
23218 additionalProperties:
23219 type: object
23220 properties:
23221 comment:
23222 type: string
23223 domain:
23224 type: string
23225 expiry:
23226 type: string
23227 format: date-time
23228 httpOnly:
23229 type: boolean
23230 maxAge:
23231 type: integer
23232 format: int32
23233 name:
23234 type: string
23235 path:
23236 type: string
23237 secure:
23238 type: boolean
23239 value:
23240 type: string
23241 version:
23242 type: integer
23243 format: int32
23244 date:
23245 type: string
23246 format: date-time
23247 entity:
23248 type: object
23249 entityTag:
23250 type: object
23251 properties:
23252 value:
23253 type: string
23254 weak:
23255 type: boolean
23256 headers:
23257 type: object
23258 additionalProperties:
23259 type: array
23260 items:
23261 type: object
23262 language:
23263 type: object
23264 properties:
23265 country:
23266 type: string
23267 displayCountry:
23268 type: string
23269 displayLanguage:
23270 type: string
23271 displayName:
23272 type: string
23273 displayScript:
23274 type: string
23275 displayVariant:
23276 type: string
23277 extensionKeys:
23278 type: array
23279 items:
23280 type: string
23281 uniqueItems: true
23282 iso3Country:
23283 type: string
23284 iso3Language:
23285 type: string
23286 language:
23287 type: string
23288 script:
23289 type: string
23290 unicodeLocaleAttributes:
23291 type: array
23292 items:
23293 type: string
23294 uniqueItems: true
23295 unicodeLocaleKeys:
23296 type: array
23297 items:
23298 type: string
23299 uniqueItems: true
23300 variant:
23301 type: string
23302 lastModified:
23303 type: string
23304 format: date-time
23305 length:
23306 type: integer
23307 format: int32
23308 links:
23309 type: array
23310 items:
23311 type: object
23312 properties:
23313 params:
23314 type: object
23315 additionalProperties:
23316 type: string
23317 rel:
23318 type: string
23319 rels:
23320 type: array
23321 items:
23322 type: string
23323 title:
23324 type: string
23325 type:
23326 type: string
23327 uri:
23328 type: string
23329 format: uri
23330 uriBuilder:
23331 type: object
23332 uniqueItems: true
23333 location:
23334 type: string
23335 format: uri
23336 mediaType:
23337 type: object
23338 properties:
23339 parameters:
23340 type: object
23341 additionalProperties:
23342 type: string
23343 subtype:
23344 type: string
23345 type:
23346 type: string
23347 wildcardSubtype:
23348 type: boolean
23349 wildcardType:
23350 type: boolean
23351 metadata:
23352 type: object
23353 additionalProperties:
23354 type: array
23355 items:
23356 type: object
23357 status:
23358 type: integer
23359 format: int32
23360 statusInfo:
23361 type: object
23362 properties:
23363 family:
23364 type: string
23365 enum:
23366 - INFORMATIONAL
23367 - SUCCESSFUL
23368 - REDIRECTION
23369 - CLIENT_ERROR
23370 - SERVER_ERROR
23371 - OTHER
23372 reasonPhrase:
23373 type: string
23374 statusCode:
23375 type: integer
23376 format: int32
23377 stringHeaders:
23378 type: object
23379 additionalProperties:
23380 type: array
23381 items:
23382 type: string
23383 servers:
23384 - url: /sdc2/rest
23385 variables: {}
23386 summary: Returns updated Group
23387 tags:
23388 - SDCE-2 APIs
23389 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupType}:
23390 post:
23391 description: 'Create group '
23392 operationId: createGroup
23393 parameters:
23394 - in: path
23395 name: containerComponentType
23396 required: true
23397 schema:
23398 type: string
23399 - in: path
23400 name: componentId
23401 required: true
23402 schema:
23403 type: string
23404 - in: path
23405 name: groupType
23406 required: true
23407 schema:
23408 type: string
23409 - in: header
23410 name: USER_ID
23411 schema:
23412 type: string
23413 responses:
23414 "201":
23415 description: Group created
23416 "400":
23417 description: "field name invalid type/length, characters; mandatory field\
23418 \ is absent, already exists (name)"
23419 "403":
23420 description: Restricted operation
23421 "404":
23422 description: Component not found
23423 "500":
23424 description: Internal Error
23425 default:
23426 content:
23427 application/json:
23428 schema:
23429 type: array
23430 items:
23431 $ref: '#/components/schemas/GroupDefinition'
23432 servers:
23433 - url: /sdc2/rest
23434 variables: {}
23435 summary: Creates new group in component and returns it
23436 tags:
23437 - SDCE-2 APIs
23438 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}:
23439 delete:
23440 description: Delete Group
23441 operationId: deleteGroup
23442 parameters:
23443 - in: path
23444 name: containerComponentType
23445 required: true
23446 schema:
23447 type: string
23448 - in: path
23449 name: componentId
23450 required: true
23451 schema:
23452 type: string
23453 - in: path
23454 name: groupUniqueId
23455 required: true
23456 schema:
23457 type: string
23458 - in: header
23459 name: USER_ID
23460 schema:
23461 type: string
23462 responses:
23463 "201":
23464 description: ResourceInstance deleted
23465 "400":
23466 description: "field name invalid type/length, characters; mandatory field\
23467 \ is absent, already exists (name)"
23468 "403":
23469 description: Restricted operation
23470 "404":
23471 description: Component not found
23472 "500":
23473 description: Internal Error
23474 default:
23475 content:
23476 application/json:
23477 schema:
23478 type: array
23479 items:
23480 type: object
23481 properties:
23482 allowedMethods:
23483 type: array
23484 items:
23485 type: string
23486 uniqueItems: true
23487 cookies:
23488 type: object
23489 additionalProperties:
23490 type: object
23491 properties:
23492 comment:
23493 type: string
23494 domain:
23495 type: string
23496 expiry:
23497 type: string
23498 format: date-time
23499 httpOnly:
23500 type: boolean
23501 maxAge:
23502 type: integer
23503 format: int32
23504 name:
23505 type: string
23506 path:
23507 type: string
23508 secure:
23509 type: boolean
23510 value:
23511 type: string
23512 version:
23513 type: integer
23514 format: int32
23515 date:
23516 type: string
23517 format: date-time
23518 entity:
23519 type: object
23520 entityTag:
23521 type: object
23522 properties:
23523 value:
23524 type: string
23525 weak:
23526 type: boolean
23527 headers:
23528 type: object
23529 additionalProperties:
23530 type: array
23531 items:
23532 type: object
23533 language:
23534 type: object
23535 properties:
23536 country:
23537 type: string
23538 displayCountry:
23539 type: string
23540 displayLanguage:
23541 type: string
23542 displayName:
23543 type: string
23544 displayScript:
23545 type: string
23546 displayVariant:
23547 type: string
23548 extensionKeys:
23549 type: array
23550 items:
23551 type: string
23552 uniqueItems: true
23553 iso3Country:
23554 type: string
23555 iso3Language:
23556 type: string
23557 language:
23558 type: string
23559 script:
23560 type: string
23561 unicodeLocaleAttributes:
23562 type: array
23563 items:
23564 type: string
23565 uniqueItems: true
23566 unicodeLocaleKeys:
23567 type: array
23568 items:
23569 type: string
23570 uniqueItems: true
23571 variant:
23572 type: string
23573 lastModified:
23574 type: string
23575 format: date-time
23576 length:
23577 type: integer
23578 format: int32
23579 links:
23580 type: array
23581 items:
23582 type: object
23583 properties:
23584 params:
23585 type: object
23586 additionalProperties:
23587 type: string
23588 rel:
23589 type: string
23590 rels:
23591 type: array
23592 items:
23593 type: string
23594 title:
23595 type: string
23596 type:
23597 type: string
23598 uri:
23599 type: string
23600 format: uri
23601 uriBuilder:
23602 type: object
23603 uniqueItems: true
23604 location:
23605 type: string
23606 format: uri
23607 mediaType:
23608 type: object
23609 properties:
23610 parameters:
23611 type: object
23612 additionalProperties:
23613 type: string
23614 subtype:
23615 type: string
23616 type:
23617 type: string
23618 wildcardSubtype:
23619 type: boolean
23620 wildcardType:
23621 type: boolean
23622 metadata:
23623 type: object
23624 additionalProperties:
23625 type: array
23626 items:
23627 type: object
23628 status:
23629 type: integer
23630 format: int32
23631 statusInfo:
23632 type: object
23633 properties:
23634 family:
23635 type: string
23636 enum:
23637 - INFORMATIONAL
23638 - SUCCESSFUL
23639 - REDIRECTION
23640 - CLIENT_ERROR
23641 - SERVER_ERROR
23642 - OTHER
23643 reasonPhrase:
23644 type: string
23645 statusCode:
23646 type: integer
23647 format: int32
23648 stringHeaders:
23649 type: object
23650 additionalProperties:
23651 type: array
23652 items:
23653 type: string
23654 servers:
23655 - url: /sdc2/rest
23656 variables: {}
23657 summary: Returns deleted group id
23658 tags:
23659 - SDCE-2 APIs
23660 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/members:
23661 post:
23662 description: 'Update group members '
23663 operationId: updateGroupMembers
23664 parameters:
23665 - in: path
23666 name: containerComponentType
23667 required: true
23668 schema:
23669 type: string
23670 - in: path
23671 name: componentId
23672 required: true
23673 schema:
23674 type: string
23675 - in: path
23676 name: groupUniqueId
23677 required: true
23678 schema:
23679 type: string
23680 - in: header
23681 name: USER_ID
23682 schema:
23683 type: string
23684 requestBody:
23685 content:
23686 application/json:
23687 schema:
23688 type: array
23689 items:
23690 type: string
23691 description: List of members unique ids
23692 required: true
23693 responses:
23694 "200":
23695 description: Group members updated
23696 "400":
23697 description: "field name invalid type/length, characters; mandatory field\
23698 \ is absent, already exists (name)"
23699 "403":
23700 description: Restricted operation
23701 "404":
23702 description: Component not found
23703 "500":
23704 description: Internal Error
23705 default:
23706 content:
23707 application/json:
23708 schema:
23709 type: array
23710 items:
23711 type: string
23712 servers:
23713 - url: /sdc2/rest
23714 variables: {}
23715 summary: Updates list of members and returns it
23716 tags:
23717 - SDCE-2 APIs
23718 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/metadata:
23719 put:
23720 description: Update Group Metadata
23721 operationId: updateGroupMetadata
23722 parameters:
23723 - in: path
23724 name: containerComponentType
23725 required: true
23726 schema:
23727 type: string
23728 - in: path
23729 name: componentId
23730 required: true
23731 schema:
23732 type: string
23733 - in: path
23734 name: groupUniqueId
23735 required: true
23736 schema:
23737 type: string
23738 - in: header
23739 name: USER_ID
23740 schema:
23741 type: string
23742 requestBody:
23743 content:
23744 application/json:
23745 schema:
23746 type: string
23747 description: Service object to be Updated
23748 required: true
23749 responses:
23750 "200":
23751 description: Group Updated
23752 "400":
23753 description: Invalid content / Missing content
23754 "403":
23755 description: Restricted operation
23756 default:
23757 content:
23758 application/json:
23759 schema:
23760 type: array
23761 items:
23762 $ref: '#/components/schemas/GroupDefinition'
23763 servers:
23764 - url: /sdc2/rest
23765 variables: {}
23766 summary: Returns updated group definition
23767 tags:
23768 - SDCE-2 APIs
23769 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/properties:
23770 get:
23771 description: Get List of properties on a group
23772 operationId: getGroupProperties
23773 parameters:
23774 - in: path
23775 name: containerComponentType
23776 required: true
23777 schema:
23778 type: string
23779 - in: path
23780 name: componentId
23781 required: true
23782 schema:
23783 type: string
23784 - in: path
23785 name: groupUniqueId
23786 required: true
23787 schema:
23788 type: string
23789 - in: header
23790 name: USER_ID
23791 schema:
23792 type: string
23793 responses:
23794 "200":
23795 description: Group Updated
23796 "400":
23797 description: Invalid content / Missing content
23798 "403":
23799 description: Restricted operation
23800 default:
23801 content:
23802 application/json:
23803 schema:
23804 type: array
23805 items:
23806 $ref: '#/components/schemas/GroupProperty'
23807 servers:
23808 - url: /sdc2/rest
23809 variables: {}
23810 summary: Returns list of properties
23811 tags:
23812 - SDCE-2 APIs
23813 put:
23814 description: Updates List of properties on a group (only values)
23815 operationId: updateGroupProperties
23816 parameters:
23817 - in: path
23818 name: containerComponentType
23819 required: true
23820 schema:
23821 type: string
23822 - in: path
23823 name: componentId
23824 required: true
23825 schema:
23826 type: string
23827 - in: path
23828 name: groupUniqueId
23829 required: true
23830 schema:
23831 type: string
23832 - in: header
23833 name: USER_ID
23834 schema:
23835 type: string
23836 requestBody:
23837 content:
23838 application/json:
23839 schema:
23840 type: array
23841 items:
23842 $ref: '#/components/schemas/GroupProperty'
23843 description: Group Properties to be Updated
23844 required: true
23845 responses:
23846 "200":
23847 description: Group Updated
23848 "400":
23849 description: Invalid content / Missing content
23850 "403":
23851 description: Restricted operation
23852 default:
23853 content:
23854 application/json:
23855 schema:
23856 type: array
23857 items:
23858 $ref: '#/components/schemas/GroupProperty'
23859 servers:
23860 - url: /sdc2/rest
23861 variables: {}
23862 summary: Returns updated list of properties
23863 tags:
23864 - SDCE-2 APIs
23865 /v1/catalog/{containerComponentType}/{componentId}/paths-to-delete:
23866 get:
23867 description: Check if forwarding path to delete on version change
23868 operationId: changeResourceInstanceVersion_1
23869 parameters:
23870 - in: path
23871 name: componentId
23872 required: true
23873 schema:
23874 type: string
23875 - in: query
23876 name: componentInstanceId
23877 schema:
23878 type: string
23879 - in: query
23880 name: newComponentInstanceId
23881 schema:
23882 type: string
23883 - description: "valid values: resources / services"
23884 in: path
23885 name: containerComponentType
23886 required: true
23887 schema:
23888 type: string
23889 enum:
23890 - resources
23891 - services
23892 responses:
23893 default:
23894 content:
23895 application/json:
23896 schema:
23897 type: array
23898 items:
23899 type: object
23900 properties:
23901 allowedMethods:
23902 type: array
23903 items:
23904 type: string
23905 uniqueItems: true
23906 cookies:
23907 type: object
23908 additionalProperties:
23909 type: object
23910 properties:
23911 comment:
23912 type: string
23913 domain:
23914 type: string
23915 expiry:
23916 type: string
23917 format: date-time
23918 httpOnly:
23919 type: boolean
23920 maxAge:
23921 type: integer
23922 format: int32
23923 name:
23924 type: string
23925 path:
23926 type: string
23927 secure:
23928 type: boolean
23929 value:
23930 type: string
23931 version:
23932 type: integer
23933 format: int32
23934 date:
23935 type: string
23936 format: date-time
23937 entity:
23938 type: object
23939 entityTag:
23940 type: object
23941 properties:
23942 value:
23943 type: string
23944 weak:
23945 type: boolean
23946 headers:
23947 type: object
23948 additionalProperties:
23949 type: array
23950 items:
23951 type: object
23952 language:
23953 type: object
23954 properties:
23955 country:
23956 type: string
23957 displayCountry:
23958 type: string
23959 displayLanguage:
23960 type: string
23961 displayName:
23962 type: string
23963 displayScript:
23964 type: string
23965 displayVariant:
23966 type: string
23967 extensionKeys:
23968 type: array
23969 items:
23970 type: string
23971 uniqueItems: true
23972 iso3Country:
23973 type: string
23974 iso3Language:
23975 type: string
23976 language:
23977 type: string
23978 script:
23979 type: string
23980 unicodeLocaleAttributes:
23981 type: array
23982 items:
23983 type: string
23984 uniqueItems: true
23985 unicodeLocaleKeys:
23986 type: array
23987 items:
23988 type: string
23989 uniqueItems: true
23990 variant:
23991 type: string
23992 lastModified:
23993 type: string
23994 format: date-time
23995 length:
23996 type: integer
23997 format: int32
23998 links:
23999 type: array
24000 items:
24001 type: object
24002 properties:
24003 params:
24004 type: object
24005 additionalProperties:
24006 type: string
24007 rel:
24008 type: string
24009 rels:
24010 type: array
24011 items:
24012 type: string
24013 title:
24014 type: string
24015 type:
24016 type: string
24017 uri:
24018 type: string
24019 format: uri
24020 uriBuilder:
24021 type: object
24022 uniqueItems: true
24023 location:
24024 type: string
24025 format: uri
24026 mediaType:
24027 type: object
24028 properties:
24029 parameters:
24030 type: object
24031 additionalProperties:
24032 type: string
24033 subtype:
24034 type: string
24035 type:
24036 type: string
24037 wildcardSubtype:
24038 type: boolean
24039 wildcardType:
24040 type: boolean
24041 metadata:
24042 type: object
24043 additionalProperties:
24044 type: array
24045 items:
24046 type: object
24047 status:
24048 type: integer
24049 format: int32
24050 statusInfo:
24051 type: object
24052 properties:
24053 family:
24054 type: string
24055 enum:
24056 - INFORMATIONAL
24057 - SUCCESSFUL
24058 - REDIRECTION
24059 - CLIENT_ERROR
24060 - SERVER_ERROR
24061 - OTHER
24062 reasonPhrase:
24063 type: string
24064 statusCode:
24065 type: integer
24066 format: int32
24067 stringHeaders:
24068 type: object
24069 additionalProperties:
24070 type: array
24071 items:
24072 type: string
24073 servers:
24074 - url: /sdc2/rest
24075 variables: {}
24076 summary: Returns forwarding paths to delete
24077 tags:
24078 - SDCE-2 APIs
24079 /v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}:
24080 delete:
24081 description: Delete Policy
24082 operationId: deletePolicy
24083 parameters:
24084 - in: path
24085 name: componentId
24086 required: true
24087 schema:
24088 type: string
24089 - description: "valid values: resources / services"
24090 in: path
24091 name: containerComponentType
24092 required: true
24093 schema:
24094 type: string
24095 enum:
24096 - resources
24097 - services
24098 - in: path
24099 name: policyId
24100 required: true
24101 schema:
24102 type: string
24103 - description: USER_ID of modifier user
24104 in: header
24105 name: USER_ID
24106 required: true
24107 schema:
24108 type: string
24109 responses:
24110 "204":
24111 description: Policy was deleted
24112 "400":
24113 description: Invalid content / Missing content
24114 "403":
24115 description: Restricted operation
24116 "404":
24117 description: component / policy Not found
24118 default:
24119 content:
24120 application/json:
24121 schema:
24122 type: array
24123 items:
24124 type: object
24125 properties:
24126 allowedMethods:
24127 type: array
24128 items:
24129 type: string
24130 uniqueItems: true
24131 cookies:
24132 type: object
24133 additionalProperties:
24134 type: object
24135 properties:
24136 comment:
24137 type: string
24138 domain:
24139 type: string
24140 expiry:
24141 type: string
24142 format: date-time
24143 httpOnly:
24144 type: boolean
24145 maxAge:
24146 type: integer
24147 format: int32
24148 name:
24149 type: string
24150 path:
24151 type: string
24152 secure:
24153 type: boolean
24154 value:
24155 type: string
24156 version:
24157 type: integer
24158 format: int32
24159 date:
24160 type: string
24161 format: date-time
24162 entity:
24163 type: object
24164 entityTag:
24165 type: object
24166 properties:
24167 value:
24168 type: string
24169 weak:
24170 type: boolean
24171 headers:
24172 type: object
24173 additionalProperties:
24174 type: array
24175 items:
24176 type: object
24177 language:
24178 type: object
24179 properties:
24180 country:
24181 type: string
24182 displayCountry:
24183 type: string
24184 displayLanguage:
24185 type: string
24186 displayName:
24187 type: string
24188 displayScript:
24189 type: string
24190 displayVariant:
24191 type: string
24192 extensionKeys:
24193 type: array
24194 items:
24195 type: string
24196 uniqueItems: true
24197 iso3Country:
24198 type: string
24199 iso3Language:
24200 type: string
24201 language:
24202 type: string
24203 script:
24204 type: string
24205 unicodeLocaleAttributes:
24206 type: array
24207 items:
24208 type: string
24209 uniqueItems: true
24210 unicodeLocaleKeys:
24211 type: array
24212 items:
24213 type: string
24214 uniqueItems: true
24215 variant:
24216 type: string
24217 lastModified:
24218 type: string
24219 format: date-time
24220 length:
24221 type: integer
24222 format: int32
24223 links:
24224 type: array
24225 items:
24226 type: object
24227 properties:
24228 params:
24229 type: object
24230 additionalProperties:
24231 type: string
24232 rel:
24233 type: string
24234 rels:
24235 type: array
24236 items:
24237 type: string
24238 title:
24239 type: string
24240 type:
24241 type: string
24242 uri:
24243 type: string
24244 format: uri
24245 uriBuilder:
24246 type: object
24247 uniqueItems: true
24248 location:
24249 type: string
24250 format: uri
24251 mediaType:
24252 type: object
24253 properties:
24254 parameters:
24255 type: object
24256 additionalProperties:
24257 type: string
24258 subtype:
24259 type: string
24260 type:
24261 type: string
24262 wildcardSubtype:
24263 type: boolean
24264 wildcardType:
24265 type: boolean
24266 metadata:
24267 type: object
24268 additionalProperties:
24269 type: array
24270 items:
24271 type: object
24272 status:
24273 type: integer
24274 format: int32
24275 statusInfo:
24276 type: object
24277 properties:
24278 family:
24279 type: string
24280 enum:
24281 - INFORMATIONAL
24282 - SUCCESSFUL
24283 - REDIRECTION
24284 - CLIENT_ERROR
24285 - SERVER_ERROR
24286 - OTHER
24287 reasonPhrase:
24288 type: string
24289 statusCode:
24290 type: integer
24291 format: int32
24292 stringHeaders:
24293 type: object
24294 additionalProperties:
24295 type: array
24296 items:
24297 type: string
24298 servers:
24299 - url: /sdc2/rest
24300 variables: {}
24301 summary: No body
24302 tags:
24303 - SDCE-2 APIs
24304 get:
24305 description: Get Policy
24306 operationId: getPolicy
24307 parameters:
24308 - in: path
24309 name: componentId
24310 required: true
24311 schema:
24312 type: string
24313 - description: "valid values: resources / services"
24314 in: path
24315 name: containerComponentType
24316 required: true
24317 schema:
24318 type: string
24319 enum:
24320 - resources
24321 - services
24322 - in: path
24323 name: policyId
24324 required: true
24325 schema:
24326 type: string
24327 - description: USER_ID of modifier user
24328 in: header
24329 name: USER_ID
24330 required: true
24331 schema:
24332 type: string
24333 responses:
24334 "200":
24335 description: Policy was found
24336 "400":
24337 description: Invalid content / Missing content
24338 "403":
24339 description: Restricted operation
24340 "404":
24341 description: component / policy Not found
24342 default:
24343 content:
24344 application/json:
24345 schema:
24346 type: array
24347 items:
24348 type: object
24349 properties:
24350 allowedMethods:
24351 type: array
24352 items:
24353 type: string
24354 uniqueItems: true
24355 cookies:
24356 type: object
24357 additionalProperties:
24358 type: object
24359 properties:
24360 comment:
24361 type: string
24362 domain:
24363 type: string
24364 expiry:
24365 type: string
24366 format: date-time
24367 httpOnly:
24368 type: boolean
24369 maxAge:
24370 type: integer
24371 format: int32
24372 name:
24373 type: string
24374 path:
24375 type: string
24376 secure:
24377 type: boolean
24378 value:
24379 type: string
24380 version:
24381 type: integer
24382 format: int32
24383 date:
24384 type: string
24385 format: date-time
24386 entity:
24387 type: object
24388 entityTag:
24389 type: object
24390 properties:
24391 value:
24392 type: string
24393 weak:
24394 type: boolean
24395 headers:
24396 type: object
24397 additionalProperties:
24398 type: array
24399 items:
24400 type: object
24401 language:
24402 type: object
24403 properties:
24404 country:
24405 type: string
24406 displayCountry:
24407 type: string
24408 displayLanguage:
24409 type: string
24410 displayName:
24411 type: string
24412 displayScript:
24413 type: string
24414 displayVariant:
24415 type: string
24416 extensionKeys:
24417 type: array
24418 items:
24419 type: string
24420 uniqueItems: true
24421 iso3Country:
24422 type: string
24423 iso3Language:
24424 type: string
24425 language:
24426 type: string
24427 script:
24428 type: string
24429 unicodeLocaleAttributes:
24430 type: array
24431 items:
24432 type: string
24433 uniqueItems: true
24434 unicodeLocaleKeys:
24435 type: array
24436 items:
24437 type: string
24438 uniqueItems: true
24439 variant:
24440 type: string
24441 lastModified:
24442 type: string
24443 format: date-time
24444 length:
24445 type: integer
24446 format: int32
24447 links:
24448 type: array
24449 items:
24450 type: object
24451 properties:
24452 params:
24453 type: object
24454 additionalProperties:
24455 type: string
24456 rel:
24457 type: string
24458 rels:
24459 type: array
24460 items:
24461 type: string
24462 title:
24463 type: string
24464 type:
24465 type: string
24466 uri:
24467 type: string
24468 format: uri
24469 uriBuilder:
24470 type: object
24471 uniqueItems: true
24472 location:
24473 type: string
24474 format: uri
24475 mediaType:
24476 type: object
24477 properties:
24478 parameters:
24479 type: object
24480 additionalProperties:
24481 type: string
24482 subtype:
24483 type: string
24484 type:
24485 type: string
24486 wildcardSubtype:
24487 type: boolean
24488 wildcardType:
24489 type: boolean
24490 metadata:
24491 type: object
24492 additionalProperties:
24493 type: array
24494 items:
24495 type: object
24496 status:
24497 type: integer
24498 format: int32
24499 statusInfo:
24500 type: object
24501 properties:
24502 family:
24503 type: string
24504 enum:
24505 - INFORMATIONAL
24506 - SUCCESSFUL
24507 - REDIRECTION
24508 - CLIENT_ERROR
24509 - SERVER_ERROR
24510 - OTHER
24511 reasonPhrase:
24512 type: string
24513 statusCode:
24514 type: integer
24515 format: int32
24516 stringHeaders:
24517 type: object
24518 additionalProperties:
24519 type: array
24520 items:
24521 type: string
24522 servers:
24523 - url: /sdc2/rest
24524 variables: {}
24525 summary: Returns Policy
24526 tags:
24527 - SDCE-2 APIs
24528 put:
24529 description: Update Policy metadata
24530 operationId: updatePolicy
24531 parameters:
24532 - in: path
24533 name: componentId
24534 required: true
24535 schema:
24536 type: string
24537 - description: "valid values: resources / services"
24538 in: path
24539 name: containerComponentType
24540 required: true
24541 schema:
24542 type: string
24543 enum:
24544 - resources
24545 - services
24546 - in: path
24547 name: policyId
24548 required: true
24549 schema:
24550 type: string
24551 - description: USER_ID of modifier user
24552 in: header
24553 name: USER_ID
24554 required: true
24555 schema:
24556 type: string
24557 requestBody:
24558 content:
24559 application/json:
24560 schema:
24561 type: string
24562 description: PolicyDefinition
24563 required: true
24564 responses:
24565 "200":
24566 description: Policy updated
24567 "400":
24568 description: Invalid content / Missing content
24569 "403":
24570 description: Restricted operation
24571 "404":
24572 description: component / policy Not found
24573 default:
24574 content:
24575 application/json:
24576 schema:
24577 type: array
24578 items:
24579 type: object
24580 properties:
24581 allowedMethods:
24582 type: array
24583 items:
24584 type: string
24585 uniqueItems: true
24586 cookies:
24587 type: object
24588 additionalProperties:
24589 type: object
24590 properties:
24591 comment:
24592 type: string
24593 domain:
24594 type: string
24595 expiry:
24596 type: string
24597 format: date-time
24598 httpOnly:
24599 type: boolean
24600 maxAge:
24601 type: integer
24602 format: int32
24603 name:
24604 type: string
24605 path:
24606 type: string
24607 secure:
24608 type: boolean
24609 value:
24610 type: string
24611 version:
24612 type: integer
24613 format: int32
24614 date:
24615 type: string
24616 format: date-time
24617 entity:
24618 type: object
24619 entityTag:
24620 type: object
24621 properties:
24622 value:
24623 type: string
24624 weak:
24625 type: boolean
24626 headers:
24627 type: object
24628 additionalProperties:
24629 type: array
24630 items:
24631 type: object
24632 language:
24633 type: object
24634 properties:
24635 country:
24636 type: string
24637 displayCountry:
24638 type: string
24639 displayLanguage:
24640 type: string
24641 displayName:
24642 type: string
24643 displayScript:
24644 type: string
24645 displayVariant:
24646 type: string
24647 extensionKeys:
24648 type: array
24649 items:
24650 type: string
24651 uniqueItems: true
24652 iso3Country:
24653 type: string
24654 iso3Language:
24655 type: string
24656 language:
24657 type: string
24658 script:
24659 type: string
24660 unicodeLocaleAttributes:
24661 type: array
24662 items:
24663 type: string
24664 uniqueItems: true
24665 unicodeLocaleKeys:
24666 type: array
24667 items:
24668 type: string
24669 uniqueItems: true
24670 variant:
24671 type: string
24672 lastModified:
24673 type: string
24674 format: date-time
24675 length:
24676 type: integer
24677 format: int32
24678 links:
24679 type: array
24680 items:
24681 type: object
24682 properties:
24683 params:
24684 type: object
24685 additionalProperties:
24686 type: string
24687 rel:
24688 type: string
24689 rels:
24690 type: array
24691 items:
24692 type: string
24693 title:
24694 type: string
24695 type:
24696 type: string
24697 uri:
24698 type: string
24699 format: uri
24700 uriBuilder:
24701 type: object
24702 uniqueItems: true
24703 location:
24704 type: string
24705 format: uri
24706 mediaType:
24707 type: object
24708 properties:
24709 parameters:
24710 type: object
24711 additionalProperties:
24712 type: string
24713 subtype:
24714 type: string
24715 type:
24716 type: string
24717 wildcardSubtype:
24718 type: boolean
24719 wildcardType:
24720 type: boolean
24721 metadata:
24722 type: object
24723 additionalProperties:
24724 type: array
24725 items:
24726 type: object
24727 status:
24728 type: integer
24729 format: int32
24730 statusInfo:
24731 type: object
24732 properties:
24733 family:
24734 type: string
24735 enum:
24736 - INFORMATIONAL
24737 - SUCCESSFUL
24738 - REDIRECTION
24739 - CLIENT_ERROR
24740 - SERVER_ERROR
24741 - OTHER
24742 reasonPhrase:
24743 type: string
24744 statusCode:
24745 type: integer
24746 format: int32
24747 stringHeaders:
24748 type: object
24749 additionalProperties:
24750 type: array
24751 items:
24752 type: string
24753 servers:
24754 - url: /sdc2/rest
24755 variables: {}
24756 summary: Returns updated Policy
24757 tags:
24758 - SDCE-2 APIs
24759 /v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/properties:
24760 get:
24761 description: Get component policy properties
24762 operationId: getPolicyProperties
24763 parameters:
24764 - description: the id of the component which is the container of the policy
24765 in: path
24766 name: componentId
24767 required: true
24768 schema:
24769 type: string
24770 - description: "valid values: resources / services"
24771 in: path
24772 name: containerComponentType
24773 required: true
24774 schema:
24775 type: string
24776 enum:
24777 - resources
24778 - services
24779 - description: the id of the policy which its properties are to return
24780 in: path
24781 name: policyId
24782 required: true
24783 schema:
24784 type: string
24785 - description: the userid
24786 in: header
24787 name: USER_ID
24788 required: true
24789 schema:
24790 type: string
24791 responses:
24792 "200":
24793 description: Properties found
24794 "400":
24795 description: "invalid content - Error: containerComponentType is invalid"
24796 "403":
24797 description: Restricted operation
24798 "404":
24799 description: Componentorpolicy not found
24800 "500":
24801 description: The GET request failed due to internal SDC problem.
24802 default:
24803 content:
24804 application/json:
24805 schema:
24806 type: array
24807 items:
24808 $ref: '#/components/schemas/PropertyDataDefinition'
24809 servers:
24810 - url: /sdc2/rest
24811 variables: {}
24812 summary: Returns component policy properties
24813 tags:
24814 - SDCE-2 APIs
24815 put:
24816 description: Update Policy properties
24817 operationId: updatePolicyProperties
24818 parameters:
24819 - in: path
24820 name: componentId
24821 required: true
24822 schema:
24823 type: string
24824 - description: "valid values: resources / services"
24825 in: path
24826 name: containerComponentType
24827 required: true
24828 schema:
24829 type: string
24830 enum:
24831 - resources
24832 - services
24833 - in: path
24834 name: policyId
24835 required: true
24836 schema:
24837 type: string
24838 - description: USER_ID of modifier user
24839 in: header
24840 name: USER_ID
24841 required: true
24842 schema:
24843 type: string
24844 requestBody:
24845 content:
24846 application/json:
24847 schema:
24848 type: string
24849 description: PolicyDefinition
24850 required: true
24851 responses:
24852 "200":
24853 description: Policy properties updated
24854 "400":
24855 description: Invalid content / Missing content
24856 "403":
24857 description: Restricted operation
24858 "404":
24859 description: component / policy Not found
24860 default:
24861 content:
24862 application/json:
24863 schema:
24864 type: array
24865 items:
24866 type: object
24867 properties:
24868 allowedMethods:
24869 type: array
24870 items:
24871 type: string
24872 uniqueItems: true
24873 cookies:
24874 type: object
24875 additionalProperties:
24876 type: object
24877 properties:
24878 comment:
24879 type: string
24880 domain:
24881 type: string
24882 expiry:
24883 type: string
24884 format: date-time
24885 httpOnly:
24886 type: boolean
24887 maxAge:
24888 type: integer
24889 format: int32
24890 name:
24891 type: string
24892 path:
24893 type: string
24894 secure:
24895 type: boolean
24896 value:
24897 type: string
24898 version:
24899 type: integer
24900 format: int32
24901 date:
24902 type: string
24903 format: date-time
24904 entity:
24905 type: object
24906 entityTag:
24907 type: object
24908 properties:
24909 value:
24910 type: string
24911 weak:
24912 type: boolean
24913 headers:
24914 type: object
24915 additionalProperties:
24916 type: array
24917 items:
24918 type: object
24919 language:
24920 type: object
24921 properties:
24922 country:
24923 type: string
24924 displayCountry:
24925 type: string
24926 displayLanguage:
24927 type: string
24928 displayName:
24929 type: string
24930 displayScript:
24931 type: string
24932 displayVariant:
24933 type: string
24934 extensionKeys:
24935 type: array
24936 items:
24937 type: string
24938 uniqueItems: true
24939 iso3Country:
24940 type: string
24941 iso3Language:
24942 type: string
24943 language:
24944 type: string
24945 script:
24946 type: string
24947 unicodeLocaleAttributes:
24948 type: array
24949 items:
24950 type: string
24951 uniqueItems: true
24952 unicodeLocaleKeys:
24953 type: array
24954 items:
24955 type: string
24956 uniqueItems: true
24957 variant:
24958 type: string
24959 lastModified:
24960 type: string
24961 format: date-time
24962 length:
24963 type: integer
24964 format: int32
24965 links:
24966 type: array
24967 items:
24968 type: object
24969 properties:
24970 params:
24971 type: object
24972 additionalProperties:
24973 type: string
24974 rel:
24975 type: string
24976 rels:
24977 type: array
24978 items:
24979 type: string
24980 title:
24981 type: string
24982 type:
24983 type: string
24984 uri:
24985 type: string
24986 format: uri
24987 uriBuilder:
24988 type: object
24989 uniqueItems: true
24990 location:
24991 type: string
24992 format: uri
24993 mediaType:
24994 type: object
24995 properties:
24996 parameters:
24997 type: object
24998 additionalProperties:
24999 type: string
25000 subtype:
25001 type: string
25002 type:
25003 type: string
25004 wildcardSubtype:
25005 type: boolean
25006 wildcardType:
25007 type: boolean
25008 metadata:
25009 type: object
25010 additionalProperties:
25011 type: array
25012 items:
25013 type: object
25014 status:
25015 type: integer
25016 format: int32
25017 statusInfo:
25018 type: object
25019 properties:
25020 family:
25021 type: string
25022 enum:
25023 - INFORMATIONAL
25024 - SUCCESSFUL
25025 - REDIRECTION
25026 - CLIENT_ERROR
25027 - SERVER_ERROR
25028 - OTHER
25029 reasonPhrase:
25030 type: string
25031 statusCode:
25032 type: integer
25033 format: int32
25034 stringHeaders:
25035 type: object
25036 additionalProperties:
25037 type: array
25038 items:
25039 type: string
25040 servers:
25041 - url: /sdc2/rest
25042 variables: {}
25043 summary: Returns updated Policy
25044 tags:
25045 - SDCE-2 APIs
25046 /v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/targets:
25047 post:
25048 description: update policy targets
25049 operationId: updatePolicyTargets
25050 parameters:
25051 - in: path
25052 name: componentId
25053 required: true
25054 schema:
25055 type: string
25056 - description: "valid values: resources / services"
25057 in: path
25058 name: containerComponentType
25059 required: true
25060 schema:
25061 type: string
25062 enum:
25063 - resources
25064 - services
25065 - in: path
25066 name: policyId
25067 required: true
25068 schema:
25069 type: string
25070 - description: USER_ID of modifier user
25071 in: header
25072 name: USER_ID
25073 required: true
25074 schema:
25075 type: string
25076 requestBody:
25077 content:
25078 application/json:
25079 schema:
25080 type: array
25081 items:
25082 $ref: '#/components/schemas/PolicyTargetDTO'
25083 responses:
25084 "201":
25085 description: Policy target updated
25086 "400":
25087 description: Invalid content / Missing content
25088 "403":
25089 description: Restricted operation
25090 default:
25091 content:
25092 application/json:
25093 schema:
25094 type: array
25095 items:
25096 type: object
25097 properties:
25098 allowedMethods:
25099 type: array
25100 items:
25101 type: string
25102 uniqueItems: true
25103 cookies:
25104 type: object
25105 additionalProperties:
25106 type: object
25107 properties:
25108 comment:
25109 type: string
25110 domain:
25111 type: string
25112 expiry:
25113 type: string
25114 format: date-time
25115 httpOnly:
25116 type: boolean
25117 maxAge:
25118 type: integer
25119 format: int32
25120 name:
25121 type: string
25122 path:
25123 type: string
25124 secure:
25125 type: boolean
25126 value:
25127 type: string
25128 version:
25129 type: integer
25130 format: int32
25131 date:
25132 type: string
25133 format: date-time
25134 entity:
25135 type: object
25136 entityTag:
25137 type: object
25138 properties:
25139 value:
25140 type: string
25141 weak:
25142 type: boolean
25143 headers:
25144 type: object
25145 additionalProperties:
25146 type: array
25147 items:
25148 type: object
25149 language:
25150 type: object
25151 properties:
25152 country:
25153 type: string
25154 displayCountry:
25155 type: string
25156 displayLanguage:
25157 type: string
25158 displayName:
25159 type: string
25160 displayScript:
25161 type: string
25162 displayVariant:
25163 type: string
25164 extensionKeys:
25165 type: array
25166 items:
25167 type: string
25168 uniqueItems: true
25169 iso3Country:
25170 type: string
25171 iso3Language:
25172 type: string
25173 language:
25174 type: string
25175 script:
25176 type: string
25177 unicodeLocaleAttributes:
25178 type: array
25179 items:
25180 type: string
25181 uniqueItems: true
25182 unicodeLocaleKeys:
25183 type: array
25184 items:
25185 type: string
25186 uniqueItems: true
25187 variant:
25188 type: string
25189 lastModified:
25190 type: string
25191 format: date-time
25192 length:
25193 type: integer
25194 format: int32
25195 links:
25196 type: array
25197 items:
25198 type: object
25199 properties:
25200 params:
25201 type: object
25202 additionalProperties:
25203 type: string
25204 rel:
25205 type: string
25206 rels:
25207 type: array
25208 items:
25209 type: string
25210 title:
25211 type: string
25212 type:
25213 type: string
25214 uri:
25215 type: string
25216 format: uri
25217 uriBuilder:
25218 type: object
25219 uniqueItems: true
25220 location:
25221 type: string
25222 format: uri
25223 mediaType:
25224 type: object
25225 properties:
25226 parameters:
25227 type: object
25228 additionalProperties:
25229 type: string
25230 subtype:
25231 type: string
25232 type:
25233 type: string
25234 wildcardSubtype:
25235 type: boolean
25236 wildcardType:
25237 type: boolean
25238 metadata:
25239 type: object
25240 additionalProperties:
25241 type: array
25242 items:
25243 type: object
25244 status:
25245 type: integer
25246 format: int32
25247 statusInfo:
25248 type: object
25249 properties:
25250 family:
25251 type: string
25252 enum:
25253 - INFORMATIONAL
25254 - SUCCESSFUL
25255 - REDIRECTION
25256 - CLIENT_ERROR
25257 - SERVER_ERROR
25258 - OTHER
25259 reasonPhrase:
25260 type: string
25261 statusCode:
25262 type: integer
25263 format: int32
25264 stringHeaders:
25265 type: object
25266 additionalProperties:
25267 type: array
25268 items:
25269 type: string
25270 servers:
25271 - url: /sdc2/rest
25272 variables: {}
25273 summary: Returns updated Policy
25274 tags:
25275 - SDCE-2 APIs
25276 /v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/undeclare:
25277 put:
25278 description: undeclare Policy
25279 operationId: undeclarePolicy
25280 parameters:
25281 - in: path
25282 name: componentId
25283 required: true
25284 schema:
25285 type: string
25286 - description: "valid values: resources / services"
25287 in: path
25288 name: containerComponentType
25289 required: true
25290 schema:
25291 type: string
25292 enum:
25293 - resources
25294 - services
25295 - in: path
25296 name: policyId
25297 required: true
25298 schema:
25299 type: string
25300 - description: USER_ID of modifier user
25301 in: header
25302 name: USER_ID
25303 required: true
25304 schema:
25305 type: string
25306 responses:
25307 "204":
25308 description: Policy was undeclared
25309 "400":
25310 description: Invalid content / Missing content
25311 "403":
25312 description: Restricted operation
25313 "404":
25314 description: component / policy Not found
25315 default:
25316 content:
25317 application/json:
25318 schema:
25319 type: array
25320 items:
25321 type: object
25322 properties:
25323 allowedMethods:
25324 type: array
25325 items:
25326 type: string
25327 uniqueItems: true
25328 cookies:
25329 type: object
25330 additionalProperties:
25331 type: object
25332 properties:
25333 comment:
25334 type: string
25335 domain:
25336 type: string
25337 expiry:
25338 type: string
25339 format: date-time
25340 httpOnly:
25341 type: boolean
25342 maxAge:
25343 type: integer
25344 format: int32
25345 name:
25346 type: string
25347 path:
25348 type: string
25349 secure:
25350 type: boolean
25351 value:
25352 type: string
25353 version:
25354 type: integer
25355 format: int32
25356 date:
25357 type: string
25358 format: date-time
25359 entity:
25360 type: object
25361 entityTag:
25362 type: object
25363 properties:
25364 value:
25365 type: string
25366 weak:
25367 type: boolean
25368 headers:
25369 type: object
25370 additionalProperties:
25371 type: array
25372 items:
25373 type: object
25374 language:
25375 type: object
25376 properties:
25377 country:
25378 type: string
25379 displayCountry:
25380 type: string
25381 displayLanguage:
25382 type: string
25383 displayName:
25384 type: string
25385 displayScript:
25386 type: string
25387 displayVariant:
25388 type: string
25389 extensionKeys:
25390 type: array
25391 items:
25392 type: string
25393 uniqueItems: true
25394 iso3Country:
25395 type: string
25396 iso3Language:
25397 type: string
25398 language:
25399 type: string
25400 script:
25401 type: string
25402 unicodeLocaleAttributes:
25403 type: array
25404 items:
25405 type: string
25406 uniqueItems: true
25407 unicodeLocaleKeys:
25408 type: array
25409 items:
25410 type: string
25411 uniqueItems: true
25412 variant:
25413 type: string
25414 lastModified:
25415 type: string
25416 format: date-time
25417 length:
25418 type: integer
25419 format: int32
25420 links:
25421 type: array
25422 items:
25423 type: object
25424 properties:
25425 params:
25426 type: object
25427 additionalProperties:
25428 type: string
25429 rel:
25430 type: string
25431 rels:
25432 type: array
25433 items:
25434 type: string
25435 title:
25436 type: string
25437 type:
25438 type: string
25439 uri:
25440 type: string
25441 format: uri
25442 uriBuilder:
25443 type: object
25444 uniqueItems: true
25445 location:
25446 type: string
25447 format: uri
25448 mediaType:
25449 type: object
25450 properties:
25451 parameters:
25452 type: object
25453 additionalProperties:
25454 type: string
25455 subtype:
25456 type: string
25457 type:
25458 type: string
25459 wildcardSubtype:
25460 type: boolean
25461 wildcardType:
25462 type: boolean
25463 metadata:
25464 type: object
25465 additionalProperties:
25466 type: array
25467 items:
25468 type: object
25469 status:
25470 type: integer
25471 format: int32
25472 statusInfo:
25473 type: object
25474 properties:
25475 family:
25476 type: string
25477 enum:
25478 - INFORMATIONAL
25479 - SUCCESSFUL
25480 - REDIRECTION
25481 - CLIENT_ERROR
25482 - SERVER_ERROR
25483 - OTHER
25484 reasonPhrase:
25485 type: string
25486 statusCode:
25487 type: integer
25488 format: int32
25489 stringHeaders:
25490 type: object
25491 additionalProperties:
25492 type: array
25493 items:
25494 type: string
25495 servers:
25496 - url: /sdc2/rest
25497 variables: {}
25498 summary: No body
25499 tags:
25500 - SDCE-2 APIs
25501 /v1/catalog/{containerComponentType}/{componentId}/policies/{policyTypeName}:
25502 post:
25503 description: Create Policy
25504 operationId: createPolicy
25505 parameters:
25506 - in: path
25507 name: componentId
25508 required: true
25509 schema:
25510 type: string
25511 - description: "valid values: resources / services"
25512 in: path
25513 name: containerComponentType
25514 required: true
25515 schema:
25516 type: string
25517 enum:
25518 - resources
25519 - services
25520 - in: path
25521 name: policyTypeName
25522 required: true
25523 schema:
25524 type: string
25525 - description: USER_ID of modifier user
25526 in: header
25527 name: USER_ID
25528 required: true
25529 schema:
25530 type: string
25531 responses:
25532 "201":
25533 description: Policy created
25534 "400":
25535 description: Invalid content / Missing content
25536 "403":
25537 description: Restricted operation
25538 "404":
25539 description: Component not found
25540 "409":
25541 description: Policy already exist
25542 default:
25543 content:
25544 application/json:
25545 schema:
25546 type: array
25547 items:
25548 type: object
25549 properties:
25550 allowedMethods:
25551 type: array
25552 items:
25553 type: string
25554 uniqueItems: true
25555 cookies:
25556 type: object
25557 additionalProperties:
25558 type: object
25559 properties:
25560 comment:
25561 type: string
25562 domain:
25563 type: string
25564 expiry:
25565 type: string
25566 format: date-time
25567 httpOnly:
25568 type: boolean
25569 maxAge:
25570 type: integer
25571 format: int32
25572 name:
25573 type: string
25574 path:
25575 type: string
25576 secure:
25577 type: boolean
25578 value:
25579 type: string
25580 version:
25581 type: integer
25582 format: int32
25583 date:
25584 type: string
25585 format: date-time
25586 entity:
25587 type: object
25588 entityTag:
25589 type: object
25590 properties:
25591 value:
25592 type: string
25593 weak:
25594 type: boolean
25595 headers:
25596 type: object
25597 additionalProperties:
25598 type: array
25599 items:
25600 type: object
25601 language:
25602 type: object
25603 properties:
25604 country:
25605 type: string
25606 displayCountry:
25607 type: string
25608 displayLanguage:
25609 type: string
25610 displayName:
25611 type: string
25612 displayScript:
25613 type: string
25614 displayVariant:
25615 type: string
25616 extensionKeys:
25617 type: array
25618 items:
25619 type: string
25620 uniqueItems: true
25621 iso3Country:
25622 type: string
25623 iso3Language:
25624 type: string
25625 language:
25626 type: string
25627 script:
25628 type: string
25629 unicodeLocaleAttributes:
25630 type: array
25631 items:
25632 type: string
25633 uniqueItems: true
25634 unicodeLocaleKeys:
25635 type: array
25636 items:
25637 type: string
25638 uniqueItems: true
25639 variant:
25640 type: string
25641 lastModified:
25642 type: string
25643 format: date-time
25644 length:
25645 type: integer
25646 format: int32
25647 links:
25648 type: array
25649 items:
25650 type: object
25651 properties:
25652 params:
25653 type: object
25654 additionalProperties:
25655 type: string
25656 rel:
25657 type: string
25658 rels:
25659 type: array
25660 items:
25661 type: string
25662 title:
25663 type: string
25664 type:
25665 type: string
25666 uri:
25667 type: string
25668 format: uri
25669 uriBuilder:
25670 type: object
25671 uniqueItems: true
25672 location:
25673 type: string
25674 format: uri
25675 mediaType:
25676 type: object
25677 properties:
25678 parameters:
25679 type: object
25680 additionalProperties:
25681 type: string
25682 subtype:
25683 type: string
25684 type:
25685 type: string
25686 wildcardSubtype:
25687 type: boolean
25688 wildcardType:
25689 type: boolean
25690 metadata:
25691 type: object
25692 additionalProperties:
25693 type: array
25694 items:
25695 type: object
25696 status:
25697 type: integer
25698 format: int32
25699 statusInfo:
25700 type: object
25701 properties:
25702 family:
25703 type: string
25704 enum:
25705 - INFORMATIONAL
25706 - SUCCESSFUL
25707 - REDIRECTION
25708 - CLIENT_ERROR
25709 - SERVER_ERROR
25710 - OTHER
25711 reasonPhrase:
25712 type: string
25713 statusCode:
25714 type: integer
25715 format: int32
25716 stringHeaders:
25717 type: object
25718 additionalProperties:
25719 type: array
25720 items:
25721 type: string
25722 servers:
25723 - url: /sdc2/rest
25724 variables: {}
25725 summary: Returns created Policy
25726 tags:
25727 - SDCE-2 APIs
25728 /v1/catalog/{containerComponentType}/{componentId}/relationId/{relationId}:
25729 get:
25730 description: Get relation
25731 operationId: getRelationById
25732 parameters:
25733 - in: path
25734 name: containerComponentType
25735 required: true
25736 schema:
25737 type: string
25738 - in: path
25739 name: componentId
25740 required: true
25741 schema:
25742 type: string
25743 - in: path
25744 name: relationId
25745 required: true
25746 schema:
25747 type: string
25748 - in: header
25749 name: USER_ID
25750 schema:
25751 type: string
25752 responses:
25753 "200":
25754 description: relation found
25755 "403":
25756 description: Restricted operation
25757 "404":
25758 description: Relation not found
25759 default:
25760 content:
25761 application/json:
25762 schema:
25763 type: array
25764 items:
25765 type: object
25766 properties:
25767 allowedMethods:
25768 type: array
25769 items:
25770 type: string
25771 uniqueItems: true
25772 cookies:
25773 type: object
25774 additionalProperties:
25775 type: object
25776 properties:
25777 comment:
25778 type: string
25779 domain:
25780 type: string
25781 expiry:
25782 type: string
25783 format: date-time
25784 httpOnly:
25785 type: boolean
25786 maxAge:
25787 type: integer
25788 format: int32
25789 name:
25790 type: string
25791 path:
25792 type: string
25793 secure:
25794 type: boolean
25795 value:
25796 type: string
25797 version:
25798 type: integer
25799 format: int32
25800 date:
25801 type: string
25802 format: date-time
25803 entity:
25804 type: object
25805 entityTag:
25806 type: object
25807 properties:
25808 value:
25809 type: string
25810 weak:
25811 type: boolean
25812 headers:
25813 type: object
25814 additionalProperties:
25815 type: array
25816 items:
25817 type: object
25818 language:
25819 type: object
25820 properties:
25821 country:
25822 type: string
25823 displayCountry:
25824 type: string
25825 displayLanguage:
25826 type: string
25827 displayName:
25828 type: string
25829 displayScript:
25830 type: string
25831 displayVariant:
25832 type: string
25833 extensionKeys:
25834 type: array
25835 items:
25836 type: string
25837 uniqueItems: true
25838 iso3Country:
25839 type: string
25840 iso3Language:
25841 type: string
25842 language:
25843 type: string
25844 script:
25845 type: string
25846 unicodeLocaleAttributes:
25847 type: array
25848 items:
25849 type: string
25850 uniqueItems: true
25851 unicodeLocaleKeys:
25852 type: array
25853 items:
25854 type: string
25855 uniqueItems: true
25856 variant:
25857 type: string
25858 lastModified:
25859 type: string
25860 format: date-time
25861 length:
25862 type: integer
25863 format: int32
25864 links:
25865 type: array
25866 items:
25867 type: object
25868 properties:
25869 params:
25870 type: object
25871 additionalProperties:
25872 type: string
25873 rel:
25874 type: string
25875 rels:
25876 type: array
25877 items:
25878 type: string
25879 title:
25880 type: string
25881 type:
25882 type: string
25883 uri:
25884 type: string
25885 format: uri
25886 uriBuilder:
25887 type: object
25888 uniqueItems: true
25889 location:
25890 type: string
25891 format: uri
25892 mediaType:
25893 type: object
25894 properties:
25895 parameters:
25896 type: object
25897 additionalProperties:
25898 type: string
25899 subtype:
25900 type: string
25901 type:
25902 type: string
25903 wildcardSubtype:
25904 type: boolean
25905 wildcardType:
25906 type: boolean
25907 metadata:
25908 type: object
25909 additionalProperties:
25910 type: array
25911 items:
25912 type: object
25913 status:
25914 type: integer
25915 format: int32
25916 statusInfo:
25917 type: object
25918 properties:
25919 family:
25920 type: string
25921 enum:
25922 - INFORMATIONAL
25923 - SUCCESSFUL
25924 - REDIRECTION
25925 - CLIENT_ERROR
25926 - SERVER_ERROR
25927 - OTHER
25928 reasonPhrase:
25929 type: string
25930 statusCode:
25931 type: integer
25932 format: int32
25933 stringHeaders:
25934 type: object
25935 additionalProperties:
25936 type: array
25937 items:
25938 type: string
25939 servers:
25940 - url: /sdc2/rest
25941 variables: {}
25942 summary: Returns relation metadata according to relationId
25943 tags:
25944 - SDCE-2 APIs
25945 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance:
25946 post:
25947 description: Create ComponentInstance
25948 operationId: createComponentInstance
25949 parameters:
25950 - in: path
25951 name: componentId
25952 required: true
25953 schema:
25954 type: string
25955 - description: "valid values: resources / services"
25956 in: path
25957 name: containerComponentType
25958 required: true
25959 schema:
25960 type: string
25961 enum:
25962 - resources
25963 - services
25964 - description: USER_ID of modifier user
25965 in: header
25966 name: USER_ID
25967 required: true
25968 schema:
25969 type: string
25970 requestBody:
25971 content:
25972 application/json:
25973 schema:
25974 type: string
25975 description: RI object to be created
25976 required: true
25977 responses:
25978 "201":
25979 description: Component created
25980 "400":
25981 description: Invalid content / Missing content
25982 "403":
25983 description: Restricted operation
25984 "409":
25985 description: Component instance already exist
25986 default:
25987 content:
25988 application/json:
25989 schema:
25990 type: array
25991 items:
25992 type: object
25993 properties:
25994 allowedMethods:
25995 type: array
25996 items:
25997 type: string
25998 uniqueItems: true
25999 cookies:
26000 type: object
26001 additionalProperties:
26002 type: object
26003 properties:
26004 comment:
26005 type: string
26006 domain:
26007 type: string
26008 expiry:
26009 type: string
26010 format: date-time
26011 httpOnly:
26012 type: boolean
26013 maxAge:
26014 type: integer
26015 format: int32
26016 name:
26017 type: string
26018 path:
26019 type: string
26020 secure:
26021 type: boolean
26022 value:
26023 type: string
26024 version:
26025 type: integer
26026 format: int32
26027 date:
26028 type: string
26029 format: date-time
26030 entity:
26031 type: object
26032 entityTag:
26033 type: object
26034 properties:
26035 value:
26036 type: string
26037 weak:
26038 type: boolean
26039 headers:
26040 type: object
26041 additionalProperties:
26042 type: array
26043 items:
26044 type: object
26045 language:
26046 type: object
26047 properties:
26048 country:
26049 type: string
26050 displayCountry:
26051 type: string
26052 displayLanguage:
26053 type: string
26054 displayName:
26055 type: string
26056 displayScript:
26057 type: string
26058 displayVariant:
26059 type: string
26060 extensionKeys:
26061 type: array
26062 items:
26063 type: string
26064 uniqueItems: true
26065 iso3Country:
26066 type: string
26067 iso3Language:
26068 type: string
26069 language:
26070 type: string
26071 script:
26072 type: string
26073 unicodeLocaleAttributes:
26074 type: array
26075 items:
26076 type: string
26077 uniqueItems: true
26078 unicodeLocaleKeys:
26079 type: array
26080 items:
26081 type: string
26082 uniqueItems: true
26083 variant:
26084 type: string
26085 lastModified:
26086 type: string
26087 format: date-time
26088 length:
26089 type: integer
26090 format: int32
26091 links:
26092 type: array
26093 items:
26094 type: object
26095 properties:
26096 params:
26097 type: object
26098 additionalProperties:
26099 type: string
26100 rel:
26101 type: string
26102 rels:
26103 type: array
26104 items:
26105 type: string
26106 title:
26107 type: string
26108 type:
26109 type: string
26110 uri:
26111 type: string
26112 format: uri
26113 uriBuilder:
26114 type: object
26115 uniqueItems: true
26116 location:
26117 type: string
26118 format: uri
26119 mediaType:
26120 type: object
26121 properties:
26122 parameters:
26123 type: object
26124 additionalProperties:
26125 type: string
26126 subtype:
26127 type: string
26128 type:
26129 type: string
26130 wildcardSubtype:
26131 type: boolean
26132 wildcardType:
26133 type: boolean
26134 metadata:
26135 type: object
26136 additionalProperties:
26137 type: array
26138 items:
26139 type: object
26140 status:
26141 type: integer
26142 format: int32
26143 statusInfo:
26144 type: object
26145 properties:
26146 family:
26147 type: string
26148 enum:
26149 - INFORMATIONAL
26150 - SUCCESSFUL
26151 - REDIRECTION
26152 - CLIENT_ERROR
26153 - SERVER_ERROR
26154 - OTHER
26155 reasonPhrase:
26156 type: string
26157 statusCode:
26158 type: integer
26159 format: int32
26160 stringHeaders:
26161 type: object
26162 additionalProperties:
26163 type: array
26164 items:
26165 type: string
26166 servers:
26167 - url: /sdc2/rest
26168 variables: {}
26169 summary: Returns created ComponentInstance
26170 tags:
26171 - SDCE-2 APIs
26172 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/associate:
26173 post:
26174 description: Associate RI to RI
26175 operationId: associateRIToRI
26176 parameters:
26177 - description: unique id of the container component
26178 in: path
26179 name: componentId
26180 required: true
26181 schema:
26182 type: string
26183 - description: allowed values are resources /services / products
26184 in: path
26185 name: containerComponentType
26186 required: true
26187 schema:
26188 type: string
26189 enum:
26190 - resources
26191 - services
26192 - products
26193 - in: header
26194 name: USER_ID
26195 schema:
26196 type: string
26197 requestBody:
26198 content:
26199 application/json:
26200 schema:
26201 type: string
26202 description: RelationshipInfo
26203 required: true
26204 responses:
26205 "201":
26206 description: Relationship created
26207 "400":
26208 description: Invalid content / Missing content
26209 "403":
26210 description: Missing information
26211 "409":
26212 description: Relationship already exist
26213 default:
26214 content:
26215 application/json:
26216 schema:
26217 type: array
26218 items:
26219 type: object
26220 properties:
26221 allowedMethods:
26222 type: array
26223 items:
26224 type: string
26225 uniqueItems: true
26226 cookies:
26227 type: object
26228 additionalProperties:
26229 type: object
26230 properties:
26231 comment:
26232 type: string
26233 domain:
26234 type: string
26235 expiry:
26236 type: string
26237 format: date-time
26238 httpOnly:
26239 type: boolean
26240 maxAge:
26241 type: integer
26242 format: int32
26243 name:
26244 type: string
26245 path:
26246 type: string
26247 secure:
26248 type: boolean
26249 value:
26250 type: string
26251 version:
26252 type: integer
26253 format: int32
26254 date:
26255 type: string
26256 format: date-time
26257 entity:
26258 type: object
26259 entityTag:
26260 type: object
26261 properties:
26262 value:
26263 type: string
26264 weak:
26265 type: boolean
26266 headers:
26267 type: object
26268 additionalProperties:
26269 type: array
26270 items:
26271 type: object
26272 language:
26273 type: object
26274 properties:
26275 country:
26276 type: string
26277 displayCountry:
26278 type: string
26279 displayLanguage:
26280 type: string
26281 displayName:
26282 type: string
26283 displayScript:
26284 type: string
26285 displayVariant:
26286 type: string
26287 extensionKeys:
26288 type: array
26289 items:
26290 type: string
26291 uniqueItems: true
26292 iso3Country:
26293 type: string
26294 iso3Language:
26295 type: string
26296 language:
26297 type: string
26298 script:
26299 type: string
26300 unicodeLocaleAttributes:
26301 type: array
26302 items:
26303 type: string
26304 uniqueItems: true
26305 unicodeLocaleKeys:
26306 type: array
26307 items:
26308 type: string
26309 uniqueItems: true
26310 variant:
26311 type: string
26312 lastModified:
26313 type: string
26314 format: date-time
26315 length:
26316 type: integer
26317 format: int32
26318 links:
26319 type: array
26320 items:
26321 type: object
26322 properties:
26323 params:
26324 type: object
26325 additionalProperties:
26326 type: string
26327 rel:
26328 type: string
26329 rels:
26330 type: array
26331 items:
26332 type: string
26333 title:
26334 type: string
26335 type:
26336 type: string
26337 uri:
26338 type: string
26339 format: uri
26340 uriBuilder:
26341 type: object
26342 uniqueItems: true
26343 location:
26344 type: string
26345 format: uri
26346 mediaType:
26347 type: object
26348 properties:
26349 parameters:
26350 type: object
26351 additionalProperties:
26352 type: string
26353 subtype:
26354 type: string
26355 type:
26356 type: string
26357 wildcardSubtype:
26358 type: boolean
26359 wildcardType:
26360 type: boolean
26361 metadata:
26362 type: object
26363 additionalProperties:
26364 type: array
26365 items:
26366 type: object
26367 status:
26368 type: integer
26369 format: int32
26370 statusInfo:
26371 type: object
26372 properties:
26373 family:
26374 type: string
26375 enum:
26376 - INFORMATIONAL
26377 - SUCCESSFUL
26378 - REDIRECTION
26379 - CLIENT_ERROR
26380 - SERVER_ERROR
26381 - OTHER
26382 reasonPhrase:
26383 type: string
26384 statusCode:
26385 type: integer
26386 format: int32
26387 stringHeaders:
26388 type: object
26389 additionalProperties:
26390 type: array
26391 items:
26392 type: string
26393 servers:
26394 - url: /sdc2/rest
26395 variables: {}
26396 summary: Returns created RelationshipInfo
26397 tags:
26398 - SDCE-2 APIs
26399 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/batchDissociate:
26400 put:
26401 description: Batch Dissociate RI from RI
26402 operationId: batchDissociateRIFromRI
26403 parameters:
26404 - description: allowed values are resources/services/products
26405 in: path
26406 name: containerComponentType
26407 required: true
26408 schema:
26409 type: string
26410 enum:
26411 - resources
26412 - services
26413 - products
26414 - description: unique id of the container component
26415 in: path
26416 name: componentId
26417 required: true
26418 schema:
26419 type: string
26420 - in: header
26421 name: USER_ID
26422 schema:
26423 type: string
26424 requestBody:
26425 content:
26426 application/json:
26427 schema:
26428 type: string
26429 description: RelationshipInfo
26430 required: true
26431 responses:
26432 "201":
26433 description: Relationship deleted
26434 "400":
26435 description: Invalid Content / Missing Content
26436 "403":
26437 description: Missing Information
26438 default:
26439 content:
26440 application/json:
26441 schema:
26442 type: array
26443 items:
26444 type: object
26445 properties:
26446 allowedMethods:
26447 type: array
26448 items:
26449 type: string
26450 uniqueItems: true
26451 cookies:
26452 type: object
26453 additionalProperties:
26454 type: object
26455 properties:
26456 comment:
26457 type: string
26458 domain:
26459 type: string
26460 expiry:
26461 type: string
26462 format: date-time
26463 httpOnly:
26464 type: boolean
26465 maxAge:
26466 type: integer
26467 format: int32
26468 name:
26469 type: string
26470 path:
26471 type: string
26472 secure:
26473 type: boolean
26474 value:
26475 type: string
26476 version:
26477 type: integer
26478 format: int32
26479 date:
26480 type: string
26481 format: date-time
26482 entity:
26483 type: object
26484 entityTag:
26485 type: object
26486 properties:
26487 value:
26488 type: string
26489 weak:
26490 type: boolean
26491 headers:
26492 type: object
26493 additionalProperties:
26494 type: array
26495 items:
26496 type: object
26497 language:
26498 type: object
26499 properties:
26500 country:
26501 type: string
26502 displayCountry:
26503 type: string
26504 displayLanguage:
26505 type: string
26506 displayName:
26507 type: string
26508 displayScript:
26509 type: string
26510 displayVariant:
26511 type: string
26512 extensionKeys:
26513 type: array
26514 items:
26515 type: string
26516 uniqueItems: true
26517 iso3Country:
26518 type: string
26519 iso3Language:
26520 type: string
26521 language:
26522 type: string
26523 script:
26524 type: string
26525 unicodeLocaleAttributes:
26526 type: array
26527 items:
26528 type: string
26529 uniqueItems: true
26530 unicodeLocaleKeys:
26531 type: array
26532 items:
26533 type: string
26534 uniqueItems: true
26535 variant:
26536 type: string
26537 lastModified:
26538 type: string
26539 format: date-time
26540 length:
26541 type: integer
26542 format: int32
26543 links:
26544 type: array
26545 items:
26546 type: object
26547 properties:
26548 params:
26549 type: object
26550 additionalProperties:
26551 type: string
26552 rel:
26553 type: string
26554 rels:
26555 type: array
26556 items:
26557 type: string
26558 title:
26559 type: string
26560 type:
26561 type: string
26562 uri:
26563 type: string
26564 format: uri
26565 uriBuilder:
26566 type: object
26567 uniqueItems: true
26568 location:
26569 type: string
26570 format: uri
26571 mediaType:
26572 type: object
26573 properties:
26574 parameters:
26575 type: object
26576 additionalProperties:
26577 type: string
26578 subtype:
26579 type: string
26580 type:
26581 type: string
26582 wildcardSubtype:
26583 type: boolean
26584 wildcardType:
26585 type: boolean
26586 metadata:
26587 type: object
26588 additionalProperties:
26589 type: array
26590 items:
26591 type: object
26592 status:
26593 type: integer
26594 format: int32
26595 statusInfo:
26596 type: object
26597 properties:
26598 family:
26599 type: string
26600 enum:
26601 - INFORMATIONAL
26602 - SUCCESSFUL
26603 - REDIRECTION
26604 - CLIENT_ERROR
26605 - SERVER_ERROR
26606 - OTHER
26607 reasonPhrase:
26608 type: string
26609 statusCode:
26610 type: integer
26611 format: int32
26612 stringHeaders:
26613 type: object
26614 additionalProperties:
26615 type: array
26616 items:
26617 type: string
26618 servers:
26619 - url: /sdc2/rest
26620 variables: {}
26621 summary: Returns deleted RelationShip Info
26622 tags:
26623 - SDCE-2 APIs
26624 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/createAndAssociate:
26625 post:
26626 description: Create RI and associate RI to RI
26627 operationId: createAndAssociateRIToRI
26628 parameters:
26629 - in: path
26630 name: componentId
26631 required: true
26632 schema:
26633 type: string
26634 - description: "valid values: resources / services"
26635 in: path
26636 name: containerComponentType
26637 required: true
26638 schema:
26639 type: string
26640 enum:
26641 - resources
26642 - services
26643 - products
26644 responses:
26645 "201":
26646 description: RI created
26647 "400":
26648 description: Invalid content / Missing content
26649 "403":
26650 description: Restricted operation
26651 "409":
26652 description: Relationship already exist
26653 default:
26654 content:
26655 application/json:
26656 schema:
26657 type: array
26658 items:
26659 type: object
26660 properties:
26661 allowedMethods:
26662 type: array
26663 items:
26664 type: string
26665 uniqueItems: true
26666 cookies:
26667 type: object
26668 additionalProperties:
26669 type: object
26670 properties:
26671 comment:
26672 type: string
26673 domain:
26674 type: string
26675 expiry:
26676 type: string
26677 format: date-time
26678 httpOnly:
26679 type: boolean
26680 maxAge:
26681 type: integer
26682 format: int32
26683 name:
26684 type: string
26685 path:
26686 type: string
26687 secure:
26688 type: boolean
26689 value:
26690 type: string
26691 version:
26692 type: integer
26693 format: int32
26694 date:
26695 type: string
26696 format: date-time
26697 entity:
26698 type: object
26699 entityTag:
26700 type: object
26701 properties:
26702 value:
26703 type: string
26704 weak:
26705 type: boolean
26706 headers:
26707 type: object
26708 additionalProperties:
26709 type: array
26710 items:
26711 type: object
26712 language:
26713 type: object
26714 properties:
26715 country:
26716 type: string
26717 displayCountry:
26718 type: string
26719 displayLanguage:
26720 type: string
26721 displayName:
26722 type: string
26723 displayScript:
26724 type: string
26725 displayVariant:
26726 type: string
26727 extensionKeys:
26728 type: array
26729 items:
26730 type: string
26731 uniqueItems: true
26732 iso3Country:
26733 type: string
26734 iso3Language:
26735 type: string
26736 language:
26737 type: string
26738 script:
26739 type: string
26740 unicodeLocaleAttributes:
26741 type: array
26742 items:
26743 type: string
26744 uniqueItems: true
26745 unicodeLocaleKeys:
26746 type: array
26747 items:
26748 type: string
26749 uniqueItems: true
26750 variant:
26751 type: string
26752 lastModified:
26753 type: string
26754 format: date-time
26755 length:
26756 type: integer
26757 format: int32
26758 links:
26759 type: array
26760 items:
26761 type: object
26762 properties:
26763 params:
26764 type: object
26765 additionalProperties:
26766 type: string
26767 rel:
26768 type: string
26769 rels:
26770 type: array
26771 items:
26772 type: string
26773 title:
26774 type: string
26775 type:
26776 type: string
26777 uri:
26778 type: string
26779 format: uri
26780 uriBuilder:
26781 type: object
26782 uniqueItems: true
26783 location:
26784 type: string
26785 format: uri
26786 mediaType:
26787 type: object
26788 properties:
26789 parameters:
26790 type: object
26791 additionalProperties:
26792 type: string
26793 subtype:
26794 type: string
26795 type:
26796 type: string
26797 wildcardSubtype:
26798 type: boolean
26799 wildcardType:
26800 type: boolean
26801 metadata:
26802 type: object
26803 additionalProperties:
26804 type: array
26805 items:
26806 type: object
26807 status:
26808 type: integer
26809 format: int32
26810 statusInfo:
26811 type: object
26812 properties:
26813 family:
26814 type: string
26815 enum:
26816 - INFORMATIONAL
26817 - SUCCESSFUL
26818 - REDIRECTION
26819 - CLIENT_ERROR
26820 - SERVER_ERROR
26821 - OTHER
26822 reasonPhrase:
26823 type: string
26824 statusCode:
26825 type: integer
26826 format: int32
26827 stringHeaders:
26828 type: object
26829 additionalProperties:
26830 type: array
26831 items:
26832 type: string
26833 servers:
26834 - url: /sdc2/rest
26835 variables: {}
26836 summary: Returns created RI and RelationshipInfo
26837 tags:
26838 - SDCE-2 APIs
26839 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/dissociate:
26840 put:
26841 description: Dissociate RI from RI
26842 operationId: dissociateRIFromRI
26843 parameters:
26844 - description: allowed values are resources /services / products
26845 in: path
26846 name: containerComponentType
26847 required: true
26848 schema:
26849 type: string
26850 enum:
26851 - resources
26852 - services
26853 - products
26854 - description: unique id of the container component
26855 in: path
26856 name: componentId
26857 required: true
26858 schema:
26859 type: string
26860 - in: header
26861 name: USER_ID
26862 schema:
26863 type: string
26864 requestBody:
26865 content:
26866 application/json:
26867 schema:
26868 type: string
26869 description: RelationshipInfo
26870 required: true
26871 responses:
26872 "201":
26873 description: Relationship deleted
26874 "400":
26875 description: Invalid content / Missing content
26876 "403":
26877 description: Missing information
26878 default:
26879 content:
26880 application/json:
26881 schema:
26882 type: array
26883 items:
26884 type: object
26885 properties:
26886 allowedMethods:
26887 type: array
26888 items:
26889 type: string
26890 uniqueItems: true
26891 cookies:
26892 type: object
26893 additionalProperties:
26894 type: object
26895 properties:
26896 comment:
26897 type: string
26898 domain:
26899 type: string
26900 expiry:
26901 type: string
26902 format: date-time
26903 httpOnly:
26904 type: boolean
26905 maxAge:
26906 type: integer
26907 format: int32
26908 name:
26909 type: string
26910 path:
26911 type: string
26912 secure:
26913 type: boolean
26914 value:
26915 type: string
26916 version:
26917 type: integer
26918 format: int32
26919 date:
26920 type: string
26921 format: date-time
26922 entity:
26923 type: object
26924 entityTag:
26925 type: object
26926 properties:
26927 value:
26928 type: string
26929 weak:
26930 type: boolean
26931 headers:
26932 type: object
26933 additionalProperties:
26934 type: array
26935 items:
26936 type: object
26937 language:
26938 type: object
26939 properties:
26940 country:
26941 type: string
26942 displayCountry:
26943 type: string
26944 displayLanguage:
26945 type: string
26946 displayName:
26947 type: string
26948 displayScript:
26949 type: string
26950 displayVariant:
26951 type: string
26952 extensionKeys:
26953 type: array
26954 items:
26955 type: string
26956 uniqueItems: true
26957 iso3Country:
26958 type: string
26959 iso3Language:
26960 type: string
26961 language:
26962 type: string
26963 script:
26964 type: string
26965 unicodeLocaleAttributes:
26966 type: array
26967 items:
26968 type: string
26969 uniqueItems: true
26970 unicodeLocaleKeys:
26971 type: array
26972 items:
26973 type: string
26974 uniqueItems: true
26975 variant:
26976 type: string
26977 lastModified:
26978 type: string
26979 format: date-time
26980 length:
26981 type: integer
26982 format: int32
26983 links:
26984 type: array
26985 items:
26986 type: object
26987 properties:
26988 params:
26989 type: object
26990 additionalProperties:
26991 type: string
26992 rel:
26993 type: string
26994 rels:
26995 type: array
26996 items:
26997 type: string
26998 title:
26999 type: string
27000 type:
27001 type: string
27002 uri:
27003 type: string
27004 format: uri
27005 uriBuilder:
27006 type: object
27007 uniqueItems: true
27008 location:
27009 type: string
27010 format: uri
27011 mediaType:
27012 type: object
27013 properties:
27014 parameters:
27015 type: object
27016 additionalProperties:
27017 type: string
27018 subtype:
27019 type: string
27020 type:
27021 type: string
27022 wildcardSubtype:
27023 type: boolean
27024 wildcardType:
27025 type: boolean
27026 metadata:
27027 type: object
27028 additionalProperties:
27029 type: array
27030 items:
27031 type: object
27032 status:
27033 type: integer
27034 format: int32
27035 statusInfo:
27036 type: object
27037 properties:
27038 family:
27039 type: string
27040 enum:
27041 - INFORMATIONAL
27042 - SUCCESSFUL
27043 - REDIRECTION
27044 - CLIENT_ERROR
27045 - SERVER_ERROR
27046 - OTHER
27047 reasonPhrase:
27048 type: string
27049 statusCode:
27050 type: integer
27051 format: int32
27052 stringHeaders:
27053 type: object
27054 additionalProperties:
27055 type: array
27056 items:
27057 type: string
27058 servers:
27059 - url: /sdc2/rest
27060 variables: {}
27061 summary: Returns deleted RelationshipInfo
27062 tags:
27063 - SDCE-2 APIs
27064 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/multipleComponentInstance:
27065 post:
27066 description: Update resource instance multiple component
27067 operationId: updateMultipleComponentInstance
27068 parameters:
27069 - in: path
27070 name: componentId
27071 required: true
27072 schema:
27073 type: string
27074 - description: "valid values: resources / services / products"
27075 in: path
27076 name: containerComponentType
27077 required: true
27078 schema:
27079 type: string
27080 enum:
27081 - resources
27082 - services
27083 - products
27084 requestBody:
27085 content:
27086 application/json:
27087 schema:
27088 type: string
27089 description: Component Instance JSON Array
27090 required: true
27091 responses:
27092 "200":
27093 description: Resource instance updated
27094 "400":
27095 description: Invalid content / Missing content
27096 "403":
27097 description: Restricted operation
27098 default:
27099 content:
27100 application/json:
27101 schema:
27102 type: array
27103 items:
27104 type: object
27105 properties:
27106 allowedMethods:
27107 type: array
27108 items:
27109 type: string
27110 uniqueItems: true
27111 cookies:
27112 type: object
27113 additionalProperties:
27114 type: object
27115 properties:
27116 comment:
27117 type: string
27118 domain:
27119 type: string
27120 expiry:
27121 type: string
27122 format: date-time
27123 httpOnly:
27124 type: boolean
27125 maxAge:
27126 type: integer
27127 format: int32
27128 name:
27129 type: string
27130 path:
27131 type: string
27132 secure:
27133 type: boolean
27134 value:
27135 type: string
27136 version:
27137 type: integer
27138 format: int32
27139 date:
27140 type: string
27141 format: date-time
27142 entity:
27143 type: object
27144 entityTag:
27145 type: object
27146 properties:
27147 value:
27148 type: string
27149 weak:
27150 type: boolean
27151 headers:
27152 type: object
27153 additionalProperties:
27154 type: array
27155 items:
27156 type: object
27157 language:
27158 type: object
27159 properties:
27160 country:
27161 type: string
27162 displayCountry:
27163 type: string
27164 displayLanguage:
27165 type: string
27166 displayName:
27167 type: string
27168 displayScript:
27169 type: string
27170 displayVariant:
27171 type: string
27172 extensionKeys:
27173 type: array
27174 items:
27175 type: string
27176 uniqueItems: true
27177 iso3Country:
27178 type: string
27179 iso3Language:
27180 type: string
27181 language:
27182 type: string
27183 script:
27184 type: string
27185 unicodeLocaleAttributes:
27186 type: array
27187 items:
27188 type: string
27189 uniqueItems: true
27190 unicodeLocaleKeys:
27191 type: array
27192 items:
27193 type: string
27194 uniqueItems: true
27195 variant:
27196 type: string
27197 lastModified:
27198 type: string
27199 format: date-time
27200 length:
27201 type: integer
27202 format: int32
27203 links:
27204 type: array
27205 items:
27206 type: object
27207 properties:
27208 params:
27209 type: object
27210 additionalProperties:
27211 type: string
27212 rel:
27213 type: string
27214 rels:
27215 type: array
27216 items:
27217 type: string
27218 title:
27219 type: string
27220 type:
27221 type: string
27222 uri:
27223 type: string
27224 format: uri
27225 uriBuilder:
27226 type: object
27227 uniqueItems: true
27228 location:
27229 type: string
27230 format: uri
27231 mediaType:
27232 type: object
27233 properties:
27234 parameters:
27235 type: object
27236 additionalProperties:
27237 type: string
27238 subtype:
27239 type: string
27240 type:
27241 type: string
27242 wildcardSubtype:
27243 type: boolean
27244 wildcardType:
27245 type: boolean
27246 metadata:
27247 type: object
27248 additionalProperties:
27249 type: array
27250 items:
27251 type: object
27252 status:
27253 type: integer
27254 format: int32
27255 statusInfo:
27256 type: object
27257 properties:
27258 family:
27259 type: string
27260 enum:
27261 - INFORMATIONAL
27262 - SUCCESSFUL
27263 - REDIRECTION
27264 - CLIENT_ERROR
27265 - SERVER_ERROR
27266 - OTHER
27267 reasonPhrase:
27268 type: string
27269 statusCode:
27270 type: integer
27271 format: int32
27272 stringHeaders:
27273 type: object
27274 additionalProperties:
27275 type: array
27276 items:
27277 type: string
27278 servers:
27279 - url: /sdc2/rest
27280 variables: {}
27281 summary: Returns updated resource instance
27282 tags:
27283 - SDCE-2 APIs
27284 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}:
27285 post:
27286 description: Update resource instance
27287 operationId: updateComponentInstanceMetadata
27288 parameters:
27289 - in: path
27290 name: componentId
27291 required: true
27292 schema:
27293 type: string
27294 - in: path
27295 name: componentInstanceId
27296 required: true
27297 schema:
27298 type: string
27299 - description: "valid values: resources / services / products"
27300 in: path
27301 name: containerComponentType
27302 required: true
27303 schema:
27304 type: string
27305 enum:
27306 - resources
27307 - services
27308 - products
27309 responses:
27310 "200":
27311 description: Resource instance updated
27312 "400":
27313 description: Invalid content / Missing content
27314 "403":
27315 description: Restricted operation
27316 default:
27317 content:
27318 application/json:
27319 schema:
27320 type: array
27321 items:
27322 type: object
27323 properties:
27324 allowedMethods:
27325 type: array
27326 items:
27327 type: string
27328 uniqueItems: true
27329 cookies:
27330 type: object
27331 additionalProperties:
27332 type: object
27333 properties:
27334 comment:
27335 type: string
27336 domain:
27337 type: string
27338 expiry:
27339 type: string
27340 format: date-time
27341 httpOnly:
27342 type: boolean
27343 maxAge:
27344 type: integer
27345 format: int32
27346 name:
27347 type: string
27348 path:
27349 type: string
27350 secure:
27351 type: boolean
27352 value:
27353 type: string
27354 version:
27355 type: integer
27356 format: int32
27357 date:
27358 type: string
27359 format: date-time
27360 entity:
27361 type: object
27362 entityTag:
27363 type: object
27364 properties:
27365 value:
27366 type: string
27367 weak:
27368 type: boolean
27369 headers:
27370 type: object
27371 additionalProperties:
27372 type: array
27373 items:
27374 type: object
27375 language:
27376 type: object
27377 properties:
27378 country:
27379 type: string
27380 displayCountry:
27381 type: string
27382 displayLanguage:
27383 type: string
27384 displayName:
27385 type: string
27386 displayScript:
27387 type: string
27388 displayVariant:
27389 type: string
27390 extensionKeys:
27391 type: array
27392 items:
27393 type: string
27394 uniqueItems: true
27395 iso3Country:
27396 type: string
27397 iso3Language:
27398 type: string
27399 language:
27400 type: string
27401 script:
27402 type: string
27403 unicodeLocaleAttributes:
27404 type: array
27405 items:
27406 type: string
27407 uniqueItems: true
27408 unicodeLocaleKeys:
27409 type: array
27410 items:
27411 type: string
27412 uniqueItems: true
27413 variant:
27414 type: string
27415 lastModified:
27416 type: string
27417 format: date-time
27418 length:
27419 type: integer
27420 format: int32
27421 links:
27422 type: array
27423 items:
27424 type: object
27425 properties:
27426 params:
27427 type: object
27428 additionalProperties:
27429 type: string
27430 rel:
27431 type: string
27432 rels:
27433 type: array
27434 items:
27435 type: string
27436 title:
27437 type: string
27438 type:
27439 type: string
27440 uri:
27441 type: string
27442 format: uri
27443 uriBuilder:
27444 type: object
27445 uniqueItems: true
27446 location:
27447 type: string
27448 format: uri
27449 mediaType:
27450 type: object
27451 properties:
27452 parameters:
27453 type: object
27454 additionalProperties:
27455 type: string
27456 subtype:
27457 type: string
27458 type:
27459 type: string
27460 wildcardSubtype:
27461 type: boolean
27462 wildcardType:
27463 type: boolean
27464 metadata:
27465 type: object
27466 additionalProperties:
27467 type: array
27468 items:
27469 type: object
27470 status:
27471 type: integer
27472 format: int32
27473 statusInfo:
27474 type: object
27475 properties:
27476 family:
27477 type: string
27478 enum:
27479 - INFORMATIONAL
27480 - SUCCESSFUL
27481 - REDIRECTION
27482 - CLIENT_ERROR
27483 - SERVER_ERROR
27484 - OTHER
27485 reasonPhrase:
27486 type: string
27487 statusCode:
27488 type: integer
27489 format: int32
27490 stringHeaders:
27491 type: object
27492 additionalProperties:
27493 type: array
27494 items:
27495 type: string
27496 servers:
27497 - url: /sdc2/rest
27498 variables: {}
27499 summary: Returns updated resource instance
27500 tags:
27501 - SDCE-2 APIs
27502 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts:
27503 post:
27504 description: Load Resource Instance artifact payload
27505 operationId: loadComponentInstanceArtifact
27506 parameters:
27507 - in: header
27508 name: USER_ID
27509 schema:
27510 type: string
27511 - in: header
27512 name: Content-MD5
27513 schema:
27514 type: string
27515 - description: "valid values: resources / services"
27516 in: path
27517 name: containerComponentType
27518 required: true
27519 schema:
27520 type: string
27521 enum:
27522 - resources
27523 - services
27524 - in: path
27525 name: componentId
27526 required: true
27527 schema:
27528 type: string
27529 - in: path
27530 name: componentInstanceId
27531 required: true
27532 schema:
27533 type: string
27534 requestBody:
27535 content:
27536 application/json:
27537 schema:
27538 type: string
27539 description: json describe the artifact
27540 required: true
27541 responses:
27542 "200":
27543 description: Artifact updated
27544 "400":
27545 description: Invalid content / Missing content
27546 "403":
27547 description: Restricted operation
27548 default:
27549 content:
27550 application/json:
27551 schema:
27552 type: array
27553 items:
27554 type: object
27555 properties:
27556 allowedMethods:
27557 type: array
27558 items:
27559 type: string
27560 uniqueItems: true
27561 cookies:
27562 type: object
27563 additionalProperties:
27564 type: object
27565 properties:
27566 comment:
27567 type: string
27568 domain:
27569 type: string
27570 expiry:
27571 type: string
27572 format: date-time
27573 httpOnly:
27574 type: boolean
27575 maxAge:
27576 type: integer
27577 format: int32
27578 name:
27579 type: string
27580 path:
27581 type: string
27582 secure:
27583 type: boolean
27584 value:
27585 type: string
27586 version:
27587 type: integer
27588 format: int32
27589 date:
27590 type: string
27591 format: date-time
27592 entity:
27593 type: object
27594 entityTag:
27595 type: object
27596 properties:
27597 value:
27598 type: string
27599 weak:
27600 type: boolean
27601 headers:
27602 type: object
27603 additionalProperties:
27604 type: array
27605 items:
27606 type: object
27607 language:
27608 type: object
27609 properties:
27610 country:
27611 type: string
27612 displayCountry:
27613 type: string
27614 displayLanguage:
27615 type: string
27616 displayName:
27617 type: string
27618 displayScript:
27619 type: string
27620 displayVariant:
27621 type: string
27622 extensionKeys:
27623 type: array
27624 items:
27625 type: string
27626 uniqueItems: true
27627 iso3Country:
27628 type: string
27629 iso3Language:
27630 type: string
27631 language:
27632 type: string
27633 script:
27634 type: string
27635 unicodeLocaleAttributes:
27636 type: array
27637 items:
27638 type: string
27639 uniqueItems: true
27640 unicodeLocaleKeys:
27641 type: array
27642 items:
27643 type: string
27644 uniqueItems: true
27645 variant:
27646 type: string
27647 lastModified:
27648 type: string
27649 format: date-time
27650 length:
27651 type: integer
27652 format: int32
27653 links:
27654 type: array
27655 items:
27656 type: object
27657 properties:
27658 params:
27659 type: object
27660 additionalProperties:
27661 type: string
27662 rel:
27663 type: string
27664 rels:
27665 type: array
27666 items:
27667 type: string
27668 title:
27669 type: string
27670 type:
27671 type: string
27672 uri:
27673 type: string
27674 format: uri
27675 uriBuilder:
27676 type: object
27677 uniqueItems: true
27678 location:
27679 type: string
27680 format: uri
27681 mediaType:
27682 type: object
27683 properties:
27684 parameters:
27685 type: object
27686 additionalProperties:
27687 type: string
27688 subtype:
27689 type: string
27690 type:
27691 type: string
27692 wildcardSubtype:
27693 type: boolean
27694 wildcardType:
27695 type: boolean
27696 metadata:
27697 type: object
27698 additionalProperties:
27699 type: array
27700 items:
27701 type: object
27702 status:
27703 type: integer
27704 format: int32
27705 statusInfo:
27706 type: object
27707 properties:
27708 family:
27709 type: string
27710 enum:
27711 - INFORMATIONAL
27712 - SUCCESSFUL
27713 - REDIRECTION
27714 - CLIENT_ERROR
27715 - SERVER_ERROR
27716 - OTHER
27717 reasonPhrase:
27718 type: string
27719 statusCode:
27720 type: integer
27721 format: int32
27722 stringHeaders:
27723 type: object
27724 additionalProperties:
27725 type: array
27726 items:
27727 type: string
27728 servers:
27729 - url: /sdc2/rest
27730 variables: {}
27731 summary: Returns updated artifact
27732 tags:
27733 - SDCE-2 APIs
27734 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}:
27735 delete:
27736 description: Delete Resource Instance artifact
27737 operationId: deleteComponentInstanceArtifact
27738 parameters:
27739 - in: header
27740 name: USER_ID
27741 schema:
27742 type: string
27743 - in: header
27744 name: Content-MD5
27745 schema:
27746 type: string
27747 - description: "valid values: resources / services"
27748 in: path
27749 name: containerComponentType
27750 required: true
27751 schema:
27752 type: string
27753 enum:
27754 - resources
27755 - services
27756 - in: path
27757 name: componentId
27758 required: true
27759 schema:
27760 type: string
27761 - in: path
27762 name: componentInstanceId
27763 required: true
27764 schema:
27765 type: string
27766 - in: path
27767 name: artifactId
27768 required: true
27769 schema:
27770 type: string
27771 requestBody:
27772 content:
27773 application/json:
27774 schema:
27775 type: string
27776 description: json describe the artifact
27777 required: true
27778 responses:
27779 "200":
27780 description: Artifact updated
27781 "400":
27782 description: Invalid content / Missing content
27783 "403":
27784 description: Restricted operation
27785 default:
27786 content:
27787 application/json:
27788 schema:
27789 type: array
27790 items:
27791 type: object
27792 properties:
27793 allowedMethods:
27794 type: array
27795 items:
27796 type: string
27797 uniqueItems: true
27798 cookies:
27799 type: object
27800 additionalProperties:
27801 type: object
27802 properties:
27803 comment:
27804 type: string
27805 domain:
27806 type: string
27807 expiry:
27808 type: string
27809 format: date-time
27810 httpOnly:
27811 type: boolean
27812 maxAge:
27813 type: integer
27814 format: int32
27815 name:
27816 type: string
27817 path:
27818 type: string
27819 secure:
27820 type: boolean
27821 value:
27822 type: string
27823 version:
27824 type: integer
27825 format: int32
27826 date:
27827 type: string
27828 format: date-time
27829 entity:
27830 type: object
27831 entityTag:
27832 type: object
27833 properties:
27834 value:
27835 type: string
27836 weak:
27837 type: boolean
27838 headers:
27839 type: object
27840 additionalProperties:
27841 type: array
27842 items:
27843 type: object
27844 language:
27845 type: object
27846 properties:
27847 country:
27848 type: string
27849 displayCountry:
27850 type: string
27851 displayLanguage:
27852 type: string
27853 displayName:
27854 type: string
27855 displayScript:
27856 type: string
27857 displayVariant:
27858 type: string
27859 extensionKeys:
27860 type: array
27861 items:
27862 type: string
27863 uniqueItems: true
27864 iso3Country:
27865 type: string
27866 iso3Language:
27867 type: string
27868 language:
27869 type: string
27870 script:
27871 type: string
27872 unicodeLocaleAttributes:
27873 type: array
27874 items:
27875 type: string
27876 uniqueItems: true
27877 unicodeLocaleKeys:
27878 type: array
27879 items:
27880 type: string
27881 uniqueItems: true
27882 variant:
27883 type: string
27884 lastModified:
27885 type: string
27886 format: date-time
27887 length:
27888 type: integer
27889 format: int32
27890 links:
27891 type: array
27892 items:
27893 type: object
27894 properties:
27895 params:
27896 type: object
27897 additionalProperties:
27898 type: string
27899 rel:
27900 type: string
27901 rels:
27902 type: array
27903 items:
27904 type: string
27905 title:
27906 type: string
27907 type:
27908 type: string
27909 uri:
27910 type: string
27911 format: uri
27912 uriBuilder:
27913 type: object
27914 uniqueItems: true
27915 location:
27916 type: string
27917 format: uri
27918 mediaType:
27919 type: object
27920 properties:
27921 parameters:
27922 type: object
27923 additionalProperties:
27924 type: string
27925 subtype:
27926 type: string
27927 type:
27928 type: string
27929 wildcardSubtype:
27930 type: boolean
27931 wildcardType:
27932 type: boolean
27933 metadata:
27934 type: object
27935 additionalProperties:
27936 type: array
27937 items:
27938 type: object
27939 status:
27940 type: integer
27941 format: int32
27942 statusInfo:
27943 type: object
27944 properties:
27945 family:
27946 type: string
27947 enum:
27948 - INFORMATIONAL
27949 - SUCCESSFUL
27950 - REDIRECTION
27951 - CLIENT_ERROR
27952 - SERVER_ERROR
27953 - OTHER
27954 reasonPhrase:
27955 type: string
27956 statusCode:
27957 type: integer
27958 format: int32
27959 stringHeaders:
27960 type: object
27961 additionalProperties:
27962 type: array
27963 items:
27964 type: string
27965 servers:
27966 - url: /sdc2/rest
27967 variables: {}
27968 summary: Returns deleted artifact
27969 tags:
27970 - SDCE-2 APIs
27971 post:
27972 description: Update Resource Instance artifact payload
27973 operationId: updateComponentInstanceArtifact
27974 parameters:
27975 - in: header
27976 name: USER_ID
27977 schema:
27978 type: string
27979 - in: header
27980 name: Content-MD5
27981 schema:
27982 type: string
27983 - description: "valid values: resources / services"
27984 in: path
27985 name: containerComponentType
27986 required: true
27987 schema:
27988 type: string
27989 enum:
27990 - resources
27991 - services
27992 - in: path
27993 name: componentId
27994 required: true
27995 schema:
27996 type: string
27997 - in: path
27998 name: componentInstanceId
27999 required: true
28000 schema:
28001 type: string
28002 - in: path
28003 name: artifactId
28004 required: true
28005 schema:
28006 type: string
28007 requestBody:
28008 content:
28009 application/json:
28010 schema:
28011 type: string
28012 description: json describe the artifact
28013 required: true
28014 responses:
28015 "200":
28016 description: Artifact updated
28017 "400":
28018 description: Invalid content / Missing content
28019 "403":
28020 description: Restricted operation
28021 default:
28022 content:
28023 application/json:
28024 schema:
28025 type: array
28026 items:
28027 type: object
28028 properties:
28029 allowedMethods:
28030 type: array
28031 items:
28032 type: string
28033 uniqueItems: true
28034 cookies:
28035 type: object
28036 additionalProperties:
28037 type: object
28038 properties:
28039 comment:
28040 type: string
28041 domain:
28042 type: string
28043 expiry:
28044 type: string
28045 format: date-time
28046 httpOnly:
28047 type: boolean
28048 maxAge:
28049 type: integer
28050 format: int32
28051 name:
28052 type: string
28053 path:
28054 type: string
28055 secure:
28056 type: boolean
28057 value:
28058 type: string
28059 version:
28060 type: integer
28061 format: int32
28062 date:
28063 type: string
28064 format: date-time
28065 entity:
28066 type: object
28067 entityTag:
28068 type: object
28069 properties:
28070 value:
28071 type: string
28072 weak:
28073 type: boolean
28074 headers:
28075 type: object
28076 additionalProperties:
28077 type: array
28078 items:
28079 type: object
28080 language:
28081 type: object
28082 properties:
28083 country:
28084 type: string
28085 displayCountry:
28086 type: string
28087 displayLanguage:
28088 type: string
28089 displayName:
28090 type: string
28091 displayScript:
28092 type: string
28093 displayVariant:
28094 type: string
28095 extensionKeys:
28096 type: array
28097 items:
28098 type: string
28099 uniqueItems: true
28100 iso3Country:
28101 type: string
28102 iso3Language:
28103 type: string
28104 language:
28105 type: string
28106 script:
28107 type: string
28108 unicodeLocaleAttributes:
28109 type: array
28110 items:
28111 type: string
28112 uniqueItems: true
28113 unicodeLocaleKeys:
28114 type: array
28115 items:
28116 type: string
28117 uniqueItems: true
28118 variant:
28119 type: string
28120 lastModified:
28121 type: string
28122 format: date-time
28123 length:
28124 type: integer
28125 format: int32
28126 links:
28127 type: array
28128 items:
28129 type: object
28130 properties:
28131 params:
28132 type: object
28133 additionalProperties:
28134 type: string
28135 rel:
28136 type: string
28137 rels:
28138 type: array
28139 items:
28140 type: string
28141 title:
28142 type: string
28143 type:
28144 type: string
28145 uri:
28146 type: string
28147 format: uri
28148 uriBuilder:
28149 type: object
28150 uniqueItems: true
28151 location:
28152 type: string
28153 format: uri
28154 mediaType:
28155 type: object
28156 properties:
28157 parameters:
28158 type: object
28159 additionalProperties:
28160 type: string
28161 subtype:
28162 type: string
28163 type:
28164 type: string
28165 wildcardSubtype:
28166 type: boolean
28167 wildcardType:
28168 type: boolean
28169 metadata:
28170 type: object
28171 additionalProperties:
28172 type: array
28173 items:
28174 type: object
28175 status:
28176 type: integer
28177 format: int32
28178 statusInfo:
28179 type: object
28180 properties:
28181 family:
28182 type: string
28183 enum:
28184 - INFORMATIONAL
28185 - SUCCESSFUL
28186 - REDIRECTION
28187 - CLIENT_ERROR
28188 - SERVER_ERROR
28189 - OTHER
28190 reasonPhrase:
28191 type: string
28192 statusCode:
28193 type: integer
28194 format: int32
28195 stringHeaders:
28196 type: object
28197 additionalProperties:
28198 type: array
28199 items:
28200 type: string
28201 servers:
28202 - url: /sdc2/rest
28203 variables: {}
28204 summary: Returns updated artifact
28205 tags:
28206 - SDCE-2 APIs
28207 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}/heatParams:
28208 post:
28209 description: Update Resource Instance HEAT_ENV parameters
28210 operationId: updateRIArtifact
28211 parameters:
28212 - description: "valid values: resources / services"
28213 in: path
28214 name: containerComponentType
28215 required: true
28216 schema:
28217 type: string
28218 enum:
28219 - resources
28220 - services
28221 - in: path
28222 name: componentId
28223 required: true
28224 schema:
28225 type: string
28226 - in: path
28227 name: componentInstanceId
28228 required: true
28229 schema:
28230 type: string
28231 - in: path
28232 name: artifactId
28233 required: true
28234 schema:
28235 type: string
28236 requestBody:
28237 content:
28238 application/json:
28239 schema:
28240 type: string
28241 description: json describe the artifact
28242 required: true
28243 responses:
28244 "200":
28245 description: Artifact updated
28246 "400":
28247 description: Invalid content / Missing content
28248 "403":
28249 description: Restricted operation
28250 default:
28251 content:
28252 application/json:
28253 schema:
28254 type: array
28255 items:
28256 type: object
28257 properties:
28258 allowedMethods:
28259 type: array
28260 items:
28261 type: string
28262 uniqueItems: true
28263 cookies:
28264 type: object
28265 additionalProperties:
28266 type: object
28267 properties:
28268 comment:
28269 type: string
28270 domain:
28271 type: string
28272 expiry:
28273 type: string
28274 format: date-time
28275 httpOnly:
28276 type: boolean
28277 maxAge:
28278 type: integer
28279 format: int32
28280 name:
28281 type: string
28282 path:
28283 type: string
28284 secure:
28285 type: boolean
28286 value:
28287 type: string
28288 version:
28289 type: integer
28290 format: int32
28291 date:
28292 type: string
28293 format: date-time
28294 entity:
28295 type: object
28296 entityTag:
28297 type: object
28298 properties:
28299 value:
28300 type: string
28301 weak:
28302 type: boolean
28303 headers:
28304 type: object
28305 additionalProperties:
28306 type: array
28307 items:
28308 type: object
28309 language:
28310 type: object
28311 properties:
28312 country:
28313 type: string
28314 displayCountry:
28315 type: string
28316 displayLanguage:
28317 type: string
28318 displayName:
28319 type: string
28320 displayScript:
28321 type: string
28322 displayVariant:
28323 type: string
28324 extensionKeys:
28325 type: array
28326 items:
28327 type: string
28328 uniqueItems: true
28329 iso3Country:
28330 type: string
28331 iso3Language:
28332 type: string
28333 language:
28334 type: string
28335 script:
28336 type: string
28337 unicodeLocaleAttributes:
28338 type: array
28339 items:
28340 type: string
28341 uniqueItems: true
28342 unicodeLocaleKeys:
28343 type: array
28344 items:
28345 type: string
28346 uniqueItems: true
28347 variant:
28348 type: string
28349 lastModified:
28350 type: string
28351 format: date-time
28352 length:
28353 type: integer
28354 format: int32
28355 links:
28356 type: array
28357 items:
28358 type: object
28359 properties:
28360 params:
28361 type: object
28362 additionalProperties:
28363 type: string
28364 rel:
28365 type: string
28366 rels:
28367 type: array
28368 items:
28369 type: string
28370 title:
28371 type: string
28372 type:
28373 type: string
28374 uri:
28375 type: string
28376 format: uri
28377 uriBuilder:
28378 type: object
28379 uniqueItems: true
28380 location:
28381 type: string
28382 format: uri
28383 mediaType:
28384 type: object
28385 properties:
28386 parameters:
28387 type: object
28388 additionalProperties:
28389 type: string
28390 subtype:
28391 type: string
28392 type:
28393 type: string
28394 wildcardSubtype:
28395 type: boolean
28396 wildcardType:
28397 type: boolean
28398 metadata:
28399 type: object
28400 additionalProperties:
28401 type: array
28402 items:
28403 type: object
28404 status:
28405 type: integer
28406 format: int32
28407 statusInfo:
28408 type: object
28409 properties:
28410 family:
28411 type: string
28412 enum:
28413 - INFORMATIONAL
28414 - SUCCESSFUL
28415 - REDIRECTION
28416 - CLIENT_ERROR
28417 - SERVER_ERROR
28418 - OTHER
28419 reasonPhrase:
28420 type: string
28421 statusCode:
28422 type: integer
28423 format: int32
28424 stringHeaders:
28425 type: object
28426 additionalProperties:
28427 type: array
28428 items:
28429 type: string
28430 servers:
28431 - url: /sdc2/rest
28432 variables: {}
28433 summary: Returns updated artifact
28434 tags:
28435 - SDCE-2 APIs
28436 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/attributes:
28437 post:
28438 description: Update resource instance attribute
28439 operationId: updateResourceInstanceAttribute
28440 parameters:
28441 - description: service id
28442 in: path
28443 name: componentId
28444 required: true
28445 schema:
28446 type: string
28447 - description: "valid values: resources / services"
28448 in: path
28449 name: containerComponentType
28450 required: true
28451 schema:
28452 type: string
28453 enum:
28454 - resources
28455 - services
28456 - description: resource instance id
28457 in: path
28458 name: componentInstanceId
28459 required: true
28460 schema:
28461 type: string
28462 - description: id of user initiating the operation
28463 in: header
28464 name: USER_ID
28465 schema:
28466 type: string
28467 requestBody:
28468 content:
28469 application/json:
28470 schema:
28471 type: string
28472 description: Component Instance Properties JSON Array
28473 required: true
28474 responses:
28475 "201":
28476 description: Resource instance created
28477 "400":
28478 description: Invalid content / Missing content
28479 "403":
28480 description: Restricted operation
28481 default:
28482 content:
28483 application/json:
28484 schema:
28485 type: array
28486 items:
28487 type: object
28488 properties:
28489 allowedMethods:
28490 type: array
28491 items:
28492 type: string
28493 uniqueItems: true
28494 cookies:
28495 type: object
28496 additionalProperties:
28497 type: object
28498 properties:
28499 comment:
28500 type: string
28501 domain:
28502 type: string
28503 expiry:
28504 type: string
28505 format: date-time
28506 httpOnly:
28507 type: boolean
28508 maxAge:
28509 type: integer
28510 format: int32
28511 name:
28512 type: string
28513 path:
28514 type: string
28515 secure:
28516 type: boolean
28517 value:
28518 type: string
28519 version:
28520 type: integer
28521 format: int32
28522 date:
28523 type: string
28524 format: date-time
28525 entity:
28526 type: object
28527 entityTag:
28528 type: object
28529 properties:
28530 value:
28531 type: string
28532 weak:
28533 type: boolean
28534 headers:
28535 type: object
28536 additionalProperties:
28537 type: array
28538 items:
28539 type: object
28540 language:
28541 type: object
28542 properties:
28543 country:
28544 type: string
28545 displayCountry:
28546 type: string
28547 displayLanguage:
28548 type: string
28549 displayName:
28550 type: string
28551 displayScript:
28552 type: string
28553 displayVariant:
28554 type: string
28555 extensionKeys:
28556 type: array
28557 items:
28558 type: string
28559 uniqueItems: true
28560 iso3Country:
28561 type: string
28562 iso3Language:
28563 type: string
28564 language:
28565 type: string
28566 script:
28567 type: string
28568 unicodeLocaleAttributes:
28569 type: array
28570 items:
28571 type: string
28572 uniqueItems: true
28573 unicodeLocaleKeys:
28574 type: array
28575 items:
28576 type: string
28577 uniqueItems: true
28578 variant:
28579 type: string
28580 lastModified:
28581 type: string
28582 format: date-time
28583 length:
28584 type: integer
28585 format: int32
28586 links:
28587 type: array
28588 items:
28589 type: object
28590 properties:
28591 params:
28592 type: object
28593 additionalProperties:
28594 type: string
28595 rel:
28596 type: string
28597 rels:
28598 type: array
28599 items:
28600 type: string
28601 title:
28602 type: string
28603 type:
28604 type: string
28605 uri:
28606 type: string
28607 format: uri
28608 uriBuilder:
28609 type: object
28610 uniqueItems: true
28611 location:
28612 type: string
28613 format: uri
28614 mediaType:
28615 type: object
28616 properties:
28617 parameters:
28618 type: object
28619 additionalProperties:
28620 type: string
28621 subtype:
28622 type: string
28623 type:
28624 type: string
28625 wildcardSubtype:
28626 type: boolean
28627 wildcardType:
28628 type: boolean
28629 metadata:
28630 type: object
28631 additionalProperties:
28632 type: array
28633 items:
28634 type: object
28635 status:
28636 type: integer
28637 format: int32
28638 statusInfo:
28639 type: object
28640 properties:
28641 family:
28642 type: string
28643 enum:
28644 - INFORMATIONAL
28645 - SUCCESSFUL
28646 - REDIRECTION
28647 - CLIENT_ERROR
28648 - SERVER_ERROR
28649 - OTHER
28650 reasonPhrase:
28651 type: string
28652 statusCode:
28653 type: integer
28654 format: int32
28655 stringHeaders:
28656 type: object
28657 additionalProperties:
28658 type: array
28659 items:
28660 type: string
28661 servers:
28662 - url: /sdc2/rest
28663 variables: {}
28664 summary: Returns updated resource instance property
28665 tags:
28666 - SDCE-2 APIs
28667 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/changeVersion:
28668 post:
28669 description: Update resource instance
28670 operationId: changeResourceInstanceVersion
28671 parameters:
28672 - in: path
28673 name: componentId
28674 required: true
28675 schema:
28676 type: string
28677 - in: path
28678 name: componentInstanceId
28679 required: true
28680 schema:
28681 type: string
28682 - description: "valid values: resources / services"
28683 in: path
28684 name: containerComponentType
28685 required: true
28686 schema:
28687 type: string
28688 enum:
28689 - resources
28690 - services
28691 responses:
28692 "201":
28693 description: Resource instance created
28694 "400":
28695 description: Invalid content / Missing content
28696 "403":
28697 description: Restricted operation
28698 default:
28699 content:
28700 application/json:
28701 schema:
28702 type: array
28703 items:
28704 type: object
28705 properties:
28706 allowedMethods:
28707 type: array
28708 items:
28709 type: string
28710 uniqueItems: true
28711 cookies:
28712 type: object
28713 additionalProperties:
28714 type: object
28715 properties:
28716 comment:
28717 type: string
28718 domain:
28719 type: string
28720 expiry:
28721 type: string
28722 format: date-time
28723 httpOnly:
28724 type: boolean
28725 maxAge:
28726 type: integer
28727 format: int32
28728 name:
28729 type: string
28730 path:
28731 type: string
28732 secure:
28733 type: boolean
28734 value:
28735 type: string
28736 version:
28737 type: integer
28738 format: int32
28739 date:
28740 type: string
28741 format: date-time
28742 entity:
28743 type: object
28744 entityTag:
28745 type: object
28746 properties:
28747 value:
28748 type: string
28749 weak:
28750 type: boolean
28751 headers:
28752 type: object
28753 additionalProperties:
28754 type: array
28755 items:
28756 type: object
28757 language:
28758 type: object
28759 properties:
28760 country:
28761 type: string
28762 displayCountry:
28763 type: string
28764 displayLanguage:
28765 type: string
28766 displayName:
28767 type: string
28768 displayScript:
28769 type: string
28770 displayVariant:
28771 type: string
28772 extensionKeys:
28773 type: array
28774 items:
28775 type: string
28776 uniqueItems: true
28777 iso3Country:
28778 type: string
28779 iso3Language:
28780 type: string
28781 language:
28782 type: string
28783 script:
28784 type: string
28785 unicodeLocaleAttributes:
28786 type: array
28787 items:
28788 type: string
28789 uniqueItems: true
28790 unicodeLocaleKeys:
28791 type: array
28792 items:
28793 type: string
28794 uniqueItems: true
28795 variant:
28796 type: string
28797 lastModified:
28798 type: string
28799 format: date-time
28800 length:
28801 type: integer
28802 format: int32
28803 links:
28804 type: array
28805 items:
28806 type: object
28807 properties:
28808 params:
28809 type: object
28810 additionalProperties:
28811 type: string
28812 rel:
28813 type: string
28814 rels:
28815 type: array
28816 items:
28817 type: string
28818 title:
28819 type: string
28820 type:
28821 type: string
28822 uri:
28823 type: string
28824 format: uri
28825 uriBuilder:
28826 type: object
28827 uniqueItems: true
28828 location:
28829 type: string
28830 format: uri
28831 mediaType:
28832 type: object
28833 properties:
28834 parameters:
28835 type: object
28836 additionalProperties:
28837 type: string
28838 subtype:
28839 type: string
28840 type:
28841 type: string
28842 wildcardSubtype:
28843 type: boolean
28844 wildcardType:
28845 type: boolean
28846 metadata:
28847 type: object
28848 additionalProperties:
28849 type: array
28850 items:
28851 type: object
28852 status:
28853 type: integer
28854 format: int32
28855 statusInfo:
28856 type: object
28857 properties:
28858 family:
28859 type: string
28860 enum:
28861 - INFORMATIONAL
28862 - SUCCESSFUL
28863 - REDIRECTION
28864 - CLIENT_ERROR
28865 - SERVER_ERROR
28866 - OTHER
28867 reasonPhrase:
28868 type: string
28869 statusCode:
28870 type: integer
28871 format: int32
28872 stringHeaders:
28873 type: object
28874 additionalProperties:
28875 type: array
28876 items:
28877 type: string
28878 servers:
28879 - url: /sdc2/rest
28880 variables: {}
28881 summary: Returns updated resource instance
28882 tags:
28883 - SDCE-2 APIs
28884 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstId}:
28885 get:
28886 description: 'Get group artifacts '
28887 operationId: getGroupArtifactById
28888 parameters:
28889 - in: path
28890 name: containerComponentType
28891 required: true
28892 schema:
28893 type: string
28894 - in: path
28895 name: componentId
28896 required: true
28897 schema:
28898 type: string
28899 - in: path
28900 name: componentInstanceId
28901 required: true
28902 schema:
28903 type: string
28904 - in: path
28905 name: groupInstId
28906 required: true
28907 schema:
28908 type: string
28909 - in: header
28910 name: USER_ID
28911 schema:
28912 type: string
28913 responses:
28914 "200":
28915 description: group found
28916 "403":
28917 description: Restricted operation
28918 "404":
28919 description: Group not found
28920 default:
28921 content:
28922 application/json:
28923 schema:
28924 type: array
28925 items:
28926 type: object
28927 properties:
28928 allowedMethods:
28929 type: array
28930 items:
28931 type: string
28932 uniqueItems: true
28933 cookies:
28934 type: object
28935 additionalProperties:
28936 type: object
28937 properties:
28938 comment:
28939 type: string
28940 domain:
28941 type: string
28942 expiry:
28943 type: string
28944 format: date-time
28945 httpOnly:
28946 type: boolean
28947 maxAge:
28948 type: integer
28949 format: int32
28950 name:
28951 type: string
28952 path:
28953 type: string
28954 secure:
28955 type: boolean
28956 value:
28957 type: string
28958 version:
28959 type: integer
28960 format: int32
28961 date:
28962 type: string
28963 format: date-time
28964 entity:
28965 type: object
28966 entityTag:
28967 type: object
28968 properties:
28969 value:
28970 type: string
28971 weak:
28972 type: boolean
28973 headers:
28974 type: object
28975 additionalProperties:
28976 type: array
28977 items:
28978 type: object
28979 language:
28980 type: object
28981 properties:
28982 country:
28983 type: string
28984 displayCountry:
28985 type: string
28986 displayLanguage:
28987 type: string
28988 displayName:
28989 type: string
28990 displayScript:
28991 type: string
28992 displayVariant:
28993 type: string
28994 extensionKeys:
28995 type: array
28996 items:
28997 type: string
28998 uniqueItems: true
28999 iso3Country:
29000 type: string
29001 iso3Language:
29002 type: string
29003 language:
29004 type: string
29005 script:
29006 type: string
29007 unicodeLocaleAttributes:
29008 type: array
29009 items:
29010 type: string
29011 uniqueItems: true
29012 unicodeLocaleKeys:
29013 type: array
29014 items:
29015 type: string
29016 uniqueItems: true
29017 variant:
29018 type: string
29019 lastModified:
29020 type: string
29021 format: date-time
29022 length:
29023 type: integer
29024 format: int32
29025 links:
29026 type: array
29027 items:
29028 type: object
29029 properties:
29030 params:
29031 type: object
29032 additionalProperties:
29033 type: string
29034 rel:
29035 type: string
29036 rels:
29037 type: array
29038 items:
29039 type: string
29040 title:
29041 type: string
29042 type:
29043 type: string
29044 uri:
29045 type: string
29046 format: uri
29047 uriBuilder:
29048 type: object
29049 uniqueItems: true
29050 location:
29051 type: string
29052 format: uri
29053 mediaType:
29054 type: object
29055 properties:
29056 parameters:
29057 type: object
29058 additionalProperties:
29059 type: string
29060 subtype:
29061 type: string
29062 type:
29063 type: string
29064 wildcardSubtype:
29065 type: boolean
29066 wildcardType:
29067 type: boolean
29068 metadata:
29069 type: object
29070 additionalProperties:
29071 type: array
29072 items:
29073 type: object
29074 status:
29075 type: integer
29076 format: int32
29077 statusInfo:
29078 type: object
29079 properties:
29080 family:
29081 type: string
29082 enum:
29083 - INFORMATIONAL
29084 - SUCCESSFUL
29085 - REDIRECTION
29086 - CLIENT_ERROR
29087 - SERVER_ERROR
29088 - OTHER
29089 reasonPhrase:
29090 type: string
29091 statusCode:
29092 type: integer
29093 format: int32
29094 stringHeaders:
29095 type: object
29096 additionalProperties:
29097 type: array
29098 items:
29099 type: string
29100 servers:
29101 - url: /sdc2/rest
29102 variables: {}
29103 summary: Returns artifacts metadata according to groupInstId
29104 tags:
29105 - SDCE-2 APIs
29106 ? /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}/property
29107 : post:
29108 description: Update resource instance property
29109 operationId: updateGroupInstanceProperty
29110 parameters:
29111 - description: service id
29112 in: path
29113 name: componentId
29114 required: true
29115 schema:
29116 type: string
29117 - description: "valid values: resources / services"
29118 in: path
29119 name: containerComponentType
29120 required: true
29121 schema:
29122 type: string
29123 enum:
29124 - resources
29125 - services
29126 - description: resource instance id
29127 in: path
29128 name: componentInstanceId
29129 required: true
29130 schema:
29131 type: string
29132 - description: group instance id
29133 in: path
29134 name: groupInstanceId
29135 required: true
29136 schema:
29137 type: string
29138 - description: id of user initiating the operation
29139 in: header
29140 name: USER_ID
29141 schema:
29142 type: string
29143 responses:
29144 "201":
29145 description: Resource instance created
29146 "400":
29147 description: Invalid content / Missing content
29148 "403":
29149 description: Restricted operation
29150 default:
29151 content:
29152 application/json:
29153 schema:
29154 type: array
29155 items:
29156 type: object
29157 properties:
29158 allowedMethods:
29159 type: array
29160 items:
29161 type: string
29162 uniqueItems: true
29163 cookies:
29164 type: object
29165 additionalProperties:
29166 type: object
29167 properties:
29168 comment:
29169 type: string
29170 domain:
29171 type: string
29172 expiry:
29173 type: string
29174 format: date-time
29175 httpOnly:
29176 type: boolean
29177 maxAge:
29178 type: integer
29179 format: int32
29180 name:
29181 type: string
29182 path:
29183 type: string
29184 secure:
29185 type: boolean
29186 value:
29187 type: string
29188 version:
29189 type: integer
29190 format: int32
29191 date:
29192 type: string
29193 format: date-time
29194 entity:
29195 type: object
29196 entityTag:
29197 type: object
29198 properties:
29199 value:
29200 type: string
29201 weak:
29202 type: boolean
29203 headers:
29204 type: object
29205 additionalProperties:
29206 type: array
29207 items:
29208 type: object
29209 language:
29210 type: object
29211 properties:
29212 country:
29213 type: string
29214 displayCountry:
29215 type: string
29216 displayLanguage:
29217 type: string
29218 displayName:
29219 type: string
29220 displayScript:
29221 type: string
29222 displayVariant:
29223 type: string
29224 extensionKeys:
29225 type: array
29226 items:
29227 type: string
29228 uniqueItems: true
29229 iso3Country:
29230 type: string
29231 iso3Language:
29232 type: string
29233 language:
29234 type: string
29235 script:
29236 type: string
29237 unicodeLocaleAttributes:
29238 type: array
29239 items:
29240 type: string
29241 uniqueItems: true
29242 unicodeLocaleKeys:
29243 type: array
29244 items:
29245 type: string
29246 uniqueItems: true
29247 variant:
29248 type: string
29249 lastModified:
29250 type: string
29251 format: date-time
29252 length:
29253 type: integer
29254 format: int32
29255 links:
29256 type: array
29257 items:
29258 type: object
29259 properties:
29260 params:
29261 type: object
29262 additionalProperties:
29263 type: string
29264 rel:
29265 type: string
29266 rels:
29267 type: array
29268 items:
29269 type: string
29270 title:
29271 type: string
29272 type:
29273 type: string
29274 uri:
29275 type: string
29276 format: uri
29277 uriBuilder:
29278 type: object
29279 uniqueItems: true
29280 location:
29281 type: string
29282 format: uri
29283 mediaType:
29284 type: object
29285 properties:
29286 parameters:
29287 type: object
29288 additionalProperties:
29289 type: string
29290 subtype:
29291 type: string
29292 type:
29293 type: string
29294 wildcardSubtype:
29295 type: boolean
29296 wildcardType:
29297 type: boolean
29298 metadata:
29299 type: object
29300 additionalProperties:
29301 type: array
29302 items:
29303 type: object
29304 status:
29305 type: integer
29306 format: int32
29307 statusInfo:
29308 type: object
29309 properties:
29310 family:
29311 type: string
29312 enum:
29313 - INFORMATIONAL
29314 - SUCCESSFUL
29315 - REDIRECTION
29316 - CLIENT_ERROR
29317 - SERVER_ERROR
29318 - OTHER
29319 reasonPhrase:
29320 type: string
29321 statusCode:
29322 type: integer
29323 format: int32
29324 stringHeaders:
29325 type: object
29326 additionalProperties:
29327 type: array
29328 items:
29329 type: string
29330 servers:
29331 - url: /sdc2/rest
29332 variables: {}
29333 summary: Returns updated resource instance property
29334 tags:
29335 - SDCE-2 APIs
29336 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/inputs:
29337 post:
29338 description: Update resource instance property
29339 operationId: updateResourceInstanceInput
29340 parameters:
29341 - description: service id
29342 in: path
29343 name: componentId
29344 required: true
29345 schema:
29346 type: string
29347 - description: "valid values: resources / services"
29348 in: path
29349 name: containerComponentType
29350 required: true
29351 schema:
29352 type: string
29353 enum:
29354 - resources
29355 - services
29356 - description: resource instance id
29357 in: path
29358 name: componentInstanceId
29359 required: true
29360 schema:
29361 type: string
29362 - description: id of user initiating the operation
29363 in: header
29364 name: USER_ID
29365 schema:
29366 type: string
29367 requestBody:
29368 content:
29369 application/json:
29370 schema:
29371 type: string
29372 description: Component Instance Properties JSON Array
29373 required: true
29374 responses:
29375 "201":
29376 description: Resource instance created
29377 "400":
29378 description: Invalid content / Missing content
29379 "403":
29380 description: Restricted operation
29381 default:
29382 content:
29383 application/json:
29384 schema:
29385 type: array
29386 items:
29387 type: object
29388 properties:
29389 allowedMethods:
29390 type: array
29391 items:
29392 type: string
29393 uniqueItems: true
29394 cookies:
29395 type: object
29396 additionalProperties:
29397 type: object
29398 properties:
29399 comment:
29400 type: string
29401 domain:
29402 type: string
29403 expiry:
29404 type: string
29405 format: date-time
29406 httpOnly:
29407 type: boolean
29408 maxAge:
29409 type: integer
29410 format: int32
29411 name:
29412 type: string
29413 path:
29414 type: string
29415 secure:
29416 type: boolean
29417 value:
29418 type: string
29419 version:
29420 type: integer
29421 format: int32
29422 date:
29423 type: string
29424 format: date-time
29425 entity:
29426 type: object
29427 entityTag:
29428 type: object
29429 properties:
29430 value:
29431 type: string
29432 weak:
29433 type: boolean
29434 headers:
29435 type: object
29436 additionalProperties:
29437 type: array
29438 items:
29439 type: object
29440 language:
29441 type: object
29442 properties:
29443 country:
29444 type: string
29445 displayCountry:
29446 type: string
29447 displayLanguage:
29448 type: string
29449 displayName:
29450 type: string
29451 displayScript:
29452 type: string
29453 displayVariant:
29454 type: string
29455 extensionKeys:
29456 type: array
29457 items:
29458 type: string
29459 uniqueItems: true
29460 iso3Country:
29461 type: string
29462 iso3Language:
29463 type: string
29464 language:
29465 type: string
29466 script:
29467 type: string
29468 unicodeLocaleAttributes:
29469 type: array
29470 items:
29471 type: string
29472 uniqueItems: true
29473 unicodeLocaleKeys:
29474 type: array
29475 items:
29476 type: string
29477 uniqueItems: true
29478 variant:
29479 type: string
29480 lastModified:
29481 type: string
29482 format: date-time
29483 length:
29484 type: integer
29485 format: int32
29486 links:
29487 type: array
29488 items:
29489 type: object
29490 properties:
29491 params:
29492 type: object
29493 additionalProperties:
29494 type: string
29495 rel:
29496 type: string
29497 rels:
29498 type: array
29499 items:
29500 type: string
29501 title:
29502 type: string
29503 type:
29504 type: string
29505 uri:
29506 type: string
29507 format: uri
29508 uriBuilder:
29509 type: object
29510 uniqueItems: true
29511 location:
29512 type: string
29513 format: uri
29514 mediaType:
29515 type: object
29516 properties:
29517 parameters:
29518 type: object
29519 additionalProperties:
29520 type: string
29521 subtype:
29522 type: string
29523 type:
29524 type: string
29525 wildcardSubtype:
29526 type: boolean
29527 wildcardType:
29528 type: boolean
29529 metadata:
29530 type: object
29531 additionalProperties:
29532 type: array
29533 items:
29534 type: object
29535 status:
29536 type: integer
29537 format: int32
29538 statusInfo:
29539 type: object
29540 properties:
29541 family:
29542 type: string
29543 enum:
29544 - INFORMATIONAL
29545 - SUCCESSFUL
29546 - REDIRECTION
29547 - CLIENT_ERROR
29548 - SERVER_ERROR
29549 - OTHER
29550 reasonPhrase:
29551 type: string
29552 statusCode:
29553 type: integer
29554 format: int32
29555 stringHeaders:
29556 type: object
29557 additionalProperties:
29558 type: array
29559 items:
29560 type: string
29561 servers:
29562 - url: /sdc2/rest
29563 variables: {}
29564 summary: Returns updated resource instance property
29565 tags:
29566 - SDCE-2 APIs
29567 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/properties:
29568 post:
29569 description: Update resource instance property
29570 operationId: updateResourceInstanceProperties
29571 parameters:
29572 - description: service id
29573 in: path
29574 name: componentId
29575 required: true
29576 schema:
29577 type: string
29578 - description: "valid values: resources / services"
29579 in: path
29580 name: containerComponentType
29581 required: true
29582 schema:
29583 type: string
29584 enum:
29585 - resources
29586 - services
29587 - description: resource instance id
29588 in: path
29589 name: componentInstanceId
29590 required: true
29591 schema:
29592 type: string
29593 - description: id of user initiating the operation
29594 in: header
29595 name: USER_ID
29596 schema:
29597 type: string
29598 requestBody:
29599 content:
29600 application/json:
29601 schema:
29602 type: string
29603 description: Component Instance Properties JSON Array
29604 required: true
29605 responses:
29606 "201":
29607 description: Resource instance created
29608 "400":
29609 description: Invalid content / Missing content
29610 "403":
29611 description: Restricted operation
29612 default:
29613 content:
29614 application/json:
29615 schema:
29616 type: array
29617 items:
29618 type: object
29619 properties:
29620 allowedMethods:
29621 type: array
29622 items:
29623 type: string
29624 uniqueItems: true
29625 cookies:
29626 type: object
29627 additionalProperties:
29628 type: object
29629 properties:
29630 comment:
29631 type: string
29632 domain:
29633 type: string
29634 expiry:
29635 type: string
29636 format: date-time
29637 httpOnly:
29638 type: boolean
29639 maxAge:
29640 type: integer
29641 format: int32
29642 name:
29643 type: string
29644 path:
29645 type: string
29646 secure:
29647 type: boolean
29648 value:
29649 type: string
29650 version:
29651 type: integer
29652 format: int32
29653 date:
29654 type: string
29655 format: date-time
29656 entity:
29657 type: object
29658 entityTag:
29659 type: object
29660 properties:
29661 value:
29662 type: string
29663 weak:
29664 type: boolean
29665 headers:
29666 type: object
29667 additionalProperties:
29668 type: array
29669 items:
29670 type: object
29671 language:
29672 type: object
29673 properties:
29674 country:
29675 type: string
29676 displayCountry:
29677 type: string
29678 displayLanguage:
29679 type: string
29680 displayName:
29681 type: string
29682 displayScript:
29683 type: string
29684 displayVariant:
29685 type: string
29686 extensionKeys:
29687 type: array
29688 items:
29689 type: string
29690 uniqueItems: true
29691 iso3Country:
29692 type: string
29693 iso3Language:
29694 type: string
29695 language:
29696 type: string
29697 script:
29698 type: string
29699 unicodeLocaleAttributes:
29700 type: array
29701 items:
29702 type: string
29703 uniqueItems: true
29704 unicodeLocaleKeys:
29705 type: array
29706 items:
29707 type: string
29708 uniqueItems: true
29709 variant:
29710 type: string
29711 lastModified:
29712 type: string
29713 format: date-time
29714 length:
29715 type: integer
29716 format: int32
29717 links:
29718 type: array
29719 items:
29720 type: object
29721 properties:
29722 params:
29723 type: object
29724 additionalProperties:
29725 type: string
29726 rel:
29727 type: string
29728 rels:
29729 type: array
29730 items:
29731 type: string
29732 title:
29733 type: string
29734 type:
29735 type: string
29736 uri:
29737 type: string
29738 format: uri
29739 uriBuilder:
29740 type: object
29741 uniqueItems: true
29742 location:
29743 type: string
29744 format: uri
29745 mediaType:
29746 type: object
29747 properties:
29748 parameters:
29749 type: object
29750 additionalProperties:
29751 type: string
29752 subtype:
29753 type: string
29754 type:
29755 type: string
29756 wildcardSubtype:
29757 type: boolean
29758 wildcardType:
29759 type: boolean
29760 metadata:
29761 type: object
29762 additionalProperties:
29763 type: array
29764 items:
29765 type: object
29766 status:
29767 type: integer
29768 format: int32
29769 statusInfo:
29770 type: object
29771 properties:
29772 family:
29773 type: string
29774 enum:
29775 - INFORMATIONAL
29776 - SUCCESSFUL
29777 - REDIRECTION
29778 - CLIENT_ERROR
29779 - SERVER_ERROR
29780 - OTHER
29781 reasonPhrase:
29782 type: string
29783 statusCode:
29784 type: integer
29785 format: int32
29786 stringHeaders:
29787 type: object
29788 additionalProperties:
29789 type: array
29790 items:
29791 type: string
29792 servers:
29793 - url: /sdc2/rest
29794 variables: {}
29795 summary: Returns updated resource instance property
29796 tags:
29797 - SDCE-2 APIs
29798 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/property/{propertyId}:
29799 delete:
29800 description: Update resource instance
29801 operationId: deleteResourceInstanceProperty
29802 parameters:
29803 - description: service id
29804 in: path
29805 name: componentId
29806 required: true
29807 schema:
29808 type: string
29809 - description: "valid values: resources / services"
29810 in: path
29811 name: containerComponentType
29812 required: true
29813 schema:
29814 type: string
29815 enum:
29816 - resources
29817 - services
29818 - description: resource instance id
29819 in: path
29820 name: componentInstanceId
29821 required: true
29822 schema:
29823 type: string
29824 - description: property id
29825 in: path
29826 name: propertyId
29827 required: true
29828 schema:
29829 type: string
29830 - description: id of user initiating the operation
29831 in: header
29832 name: USER_ID
29833 schema:
29834 type: string
29835 responses:
29836 "201":
29837 description: Resource instance created
29838 "400":
29839 description: Invalid content / Missing content
29840 "403":
29841 description: Restricted operation
29842 default:
29843 content:
29844 application/json:
29845 schema:
29846 type: array
29847 items:
29848 type: object
29849 properties:
29850 allowedMethods:
29851 type: array
29852 items:
29853 type: string
29854 uniqueItems: true
29855 cookies:
29856 type: object
29857 additionalProperties:
29858 type: object
29859 properties:
29860 comment:
29861 type: string
29862 domain:
29863 type: string
29864 expiry:
29865 type: string
29866 format: date-time
29867 httpOnly:
29868 type: boolean
29869 maxAge:
29870 type: integer
29871 format: int32
29872 name:
29873 type: string
29874 path:
29875 type: string
29876 secure:
29877 type: boolean
29878 value:
29879 type: string
29880 version:
29881 type: integer
29882 format: int32
29883 date:
29884 type: string
29885 format: date-time
29886 entity:
29887 type: object
29888 entityTag:
29889 type: object
29890 properties:
29891 value:
29892 type: string
29893 weak:
29894 type: boolean
29895 headers:
29896 type: object
29897 additionalProperties:
29898 type: array
29899 items:
29900 type: object
29901 language:
29902 type: object
29903 properties:
29904 country:
29905 type: string
29906 displayCountry:
29907 type: string
29908 displayLanguage:
29909 type: string
29910 displayName:
29911 type: string
29912 displayScript:
29913 type: string
29914 displayVariant:
29915 type: string
29916 extensionKeys:
29917 type: array
29918 items:
29919 type: string
29920 uniqueItems: true
29921 iso3Country:
29922 type: string
29923 iso3Language:
29924 type: string
29925 language:
29926 type: string
29927 script:
29928 type: string
29929 unicodeLocaleAttributes:
29930 type: array
29931 items:
29932 type: string
29933 uniqueItems: true
29934 unicodeLocaleKeys:
29935 type: array
29936 items:
29937 type: string
29938 uniqueItems: true
29939 variant:
29940 type: string
29941 lastModified:
29942 type: string
29943 format: date-time
29944 length:
29945 type: integer
29946 format: int32
29947 links:
29948 type: array
29949 items:
29950 type: object
29951 properties:
29952 params:
29953 type: object
29954 additionalProperties:
29955 type: string
29956 rel:
29957 type: string
29958 rels:
29959 type: array
29960 items:
29961 type: string
29962 title:
29963 type: string
29964 type:
29965 type: string
29966 uri:
29967 type: string
29968 format: uri
29969 uriBuilder:
29970 type: object
29971 uniqueItems: true
29972 location:
29973 type: string
29974 format: uri
29975 mediaType:
29976 type: object
29977 properties:
29978 parameters:
29979 type: object
29980 additionalProperties:
29981 type: string
29982 subtype:
29983 type: string
29984 type:
29985 type: string
29986 wildcardSubtype:
29987 type: boolean
29988 wildcardType:
29989 type: boolean
29990 metadata:
29991 type: object
29992 additionalProperties:
29993 type: array
29994 items:
29995 type: object
29996 status:
29997 type: integer
29998 format: int32
29999 statusInfo:
30000 type: object
30001 properties:
30002 family:
30003 type: string
30004 enum:
30005 - INFORMATIONAL
30006 - SUCCESSFUL
30007 - REDIRECTION
30008 - CLIENT_ERROR
30009 - SERVER_ERROR
30010 - OTHER
30011 reasonPhrase:
30012 type: string
30013 statusCode:
30014 type: integer
30015 format: int32
30016 stringHeaders:
30017 type: object
30018 additionalProperties:
30019 type: array
30020 items:
30021 type: string
30022 servers:
30023 - url: /sdc2/rest
30024 variables: {}
30025 summary: Returns deleted resource instance property
30026 tags:
30027 - SDCE-2 APIs
30028 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{resourceInstanceId}:
30029 delete:
30030 description: Delete ResourceInstance
30031 operationId: deleteResourceInstance
30032 parameters:
30033 - in: path
30034 name: componentId
30035 required: true
30036 schema:
30037 type: string
30038 - in: path
30039 name: resourceInstanceId
30040 required: true
30041 schema:
30042 type: string
30043 - description: "valid values: resources / services / products"
30044 in: path
30045 name: containerComponentType
30046 required: true
30047 schema:
30048 type: string
30049 enum:
30050 - resources
30051 - services
30052 - products
30053 responses:
30054 "201":
30055 description: ResourceInstance deleted
30056 "400":
30057 description: Invalid content / Missing content
30058 "403":
30059 description: Restricted operation
30060 default:
30061 content:
30062 application/json:
30063 schema:
30064 type: array
30065 items:
30066 type: object
30067 properties:
30068 allowedMethods:
30069 type: array
30070 items:
30071 type: string
30072 uniqueItems: true
30073 cookies:
30074 type: object
30075 additionalProperties:
30076 type: object
30077 properties:
30078 comment:
30079 type: string
30080 domain:
30081 type: string
30082 expiry:
30083 type: string
30084 format: date-time
30085 httpOnly:
30086 type: boolean
30087 maxAge:
30088 type: integer
30089 format: int32
30090 name:
30091 type: string
30092 path:
30093 type: string
30094 secure:
30095 type: boolean
30096 value:
30097 type: string
30098 version:
30099 type: integer
30100 format: int32
30101 date:
30102 type: string
30103 format: date-time
30104 entity:
30105 type: object
30106 entityTag:
30107 type: object
30108 properties:
30109 value:
30110 type: string
30111 weak:
30112 type: boolean
30113 headers:
30114 type: object
30115 additionalProperties:
30116 type: array
30117 items:
30118 type: object
30119 language:
30120 type: object
30121 properties:
30122 country:
30123 type: string
30124 displayCountry:
30125 type: string
30126 displayLanguage:
30127 type: string
30128 displayName:
30129 type: string
30130 displayScript:
30131 type: string
30132 displayVariant:
30133 type: string
30134 extensionKeys:
30135 type: array
30136 items:
30137 type: string
30138 uniqueItems: true
30139 iso3Country:
30140 type: string
30141 iso3Language:
30142 type: string
30143 language:
30144 type: string
30145 script:
30146 type: string
30147 unicodeLocaleAttributes:
30148 type: array
30149 items:
30150 type: string
30151 uniqueItems: true
30152 unicodeLocaleKeys:
30153 type: array
30154 items:
30155 type: string
30156 uniqueItems: true
30157 variant:
30158 type: string
30159 lastModified:
30160 type: string
30161 format: date-time
30162 length:
30163 type: integer
30164 format: int32
30165 links:
30166 type: array
30167 items:
30168 type: object
30169 properties:
30170 params:
30171 type: object
30172 additionalProperties:
30173 type: string
30174 rel:
30175 type: string
30176 rels:
30177 type: array
30178 items:
30179 type: string
30180 title:
30181 type: string
30182 type:
30183 type: string
30184 uri:
30185 type: string
30186 format: uri
30187 uriBuilder:
30188 type: object
30189 uniqueItems: true
30190 location:
30191 type: string
30192 format: uri
30193 mediaType:
30194 type: object
30195 properties:
30196 parameters:
30197 type: object
30198 additionalProperties:
30199 type: string
30200 subtype:
30201 type: string
30202 type:
30203 type: string
30204 wildcardSubtype:
30205 type: boolean
30206 wildcardType:
30207 type: boolean
30208 metadata:
30209 type: object
30210 additionalProperties:
30211 type: array
30212 items:
30213 type: object
30214 status:
30215 type: integer
30216 format: int32
30217 statusInfo:
30218 type: object
30219 properties:
30220 family:
30221 type: string
30222 enum:
30223 - INFORMATIONAL
30224 - SUCCESSFUL
30225 - REDIRECTION
30226 - CLIENT_ERROR
30227 - SERVER_ERROR
30228 - OTHER
30229 reasonPhrase:
30230 type: string
30231 statusCode:
30232 type: integer
30233 format: int32
30234 stringHeaders:
30235 type: object
30236 additionalProperties:
30237 type: array
30238 items:
30239 type: string
30240 servers:
30241 - url: /sdc2/rest
30242 variables: {}
30243 summary: Returns delete resourceInstance
30244 tags:
30245 - SDCE-2 APIs
30246 /v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifacts/{artifactId}:
30247 get:
30248 description: Download component Artifact in Base64
30249 operationId: downloadResourceInstanceArtifactBase64
30250 parameters:
30251 - description: "valid values: resources / services"
30252 in: path
30253 name: containerComponentType
30254 required: true
30255 schema:
30256 type: string
30257 enum:
30258 - resources
30259 - services
30260 - in: path
30261 name: componentId
30262 required: true
30263 schema:
30264 type: string
30265 - in: path
30266 name: componentInstanceId
30267 required: true
30268 schema:
30269 type: string
30270 - in: path
30271 name: artifactId
30272 required: true
30273 schema:
30274 type: string
30275 responses:
30276 "200":
30277 description: ResourceInstance artifact downloaded
30278 "404":
30279 description: ResourceInstance/Artifact not found
30280 default:
30281 content:
30282 application/json:
30283 schema:
30284 type: array
30285 items:
30286 type: object
30287 properties:
30288 allowedMethods:
30289 type: array
30290 items:
30291 type: string
30292 uniqueItems: true
30293 cookies:
30294 type: object
30295 additionalProperties:
30296 type: object
30297 properties:
30298 comment:
30299 type: string
30300 domain:
30301 type: string
30302 expiry:
30303 type: string
30304 format: date-time
30305 httpOnly:
30306 type: boolean
30307 maxAge:
30308 type: integer
30309 format: int32
30310 name:
30311 type: string
30312 path:
30313 type: string
30314 secure:
30315 type: boolean
30316 value:
30317 type: string
30318 version:
30319 type: integer
30320 format: int32
30321 date:
30322 type: string
30323 format: date-time
30324 entity:
30325 type: object
30326 entityTag:
30327 type: object
30328 properties:
30329 value:
30330 type: string
30331 weak:
30332 type: boolean
30333 headers:
30334 type: object
30335 additionalProperties:
30336 type: array
30337 items:
30338 type: object
30339 language:
30340 type: object
30341 properties:
30342 country:
30343 type: string
30344 displayCountry:
30345 type: string
30346 displayLanguage:
30347 type: string
30348 displayName:
30349 type: string
30350 displayScript:
30351 type: string
30352 displayVariant:
30353 type: string
30354 extensionKeys:
30355 type: array
30356 items:
30357 type: string
30358 uniqueItems: true
30359 iso3Country:
30360 type: string
30361 iso3Language:
30362 type: string
30363 language:
30364 type: string
30365 script:
30366 type: string
30367 unicodeLocaleAttributes:
30368 type: array
30369 items:
30370 type: string
30371 uniqueItems: true
30372 unicodeLocaleKeys:
30373 type: array
30374 items:
30375 type: string
30376 uniqueItems: true
30377 variant:
30378 type: string
30379 lastModified:
30380 type: string
30381 format: date-time
30382 length:
30383 type: integer
30384 format: int32
30385 links:
30386 type: array
30387 items:
30388 type: object
30389 properties:
30390 params:
30391 type: object
30392 additionalProperties:
30393 type: string
30394 rel:
30395 type: string
30396 rels:
30397 type: array
30398 items:
30399 type: string
30400 title:
30401 type: string
30402 type:
30403 type: string
30404 uri:
30405 type: string
30406 format: uri
30407 uriBuilder:
30408 type: object
30409 uniqueItems: true
30410 location:
30411 type: string
30412 format: uri
30413 mediaType:
30414 type: object
30415 properties:
30416 parameters:
30417 type: object
30418 additionalProperties:
30419 type: string
30420 subtype:
30421 type: string
30422 type:
30423 type: string
30424 wildcardSubtype:
30425 type: boolean
30426 wildcardType:
30427 type: boolean
30428 metadata:
30429 type: object
30430 additionalProperties:
30431 type: array
30432 items:
30433 type: object
30434 status:
30435 type: integer
30436 format: int32
30437 statusInfo:
30438 type: object
30439 properties:
30440 family:
30441 type: string
30442 enum:
30443 - INFORMATIONAL
30444 - SUCCESSFUL
30445 - REDIRECTION
30446 - CLIENT_ERROR
30447 - SERVER_ERROR
30448 - OTHER
30449 reasonPhrase:
30450 type: string
30451 statusCode:
30452 type: integer
30453 format: int32
30454 stringHeaders:
30455 type: object
30456 additionalProperties:
30457 type: array
30458 items:
30459 type: string
30460 servers:
30461 - url: /sdc2/rest
30462 variables: {}
30463 summary: Returns downloaded artifact
30464 tags:
30465 - SDCE-2 APIs
30466 /v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifactsByType/{artifactGroupType}:
30467 get:
30468 description: Get component Artifacts
30469 operationId: getComponentInstanceArtifacts
30470 parameters:
30471 - description: "valid values: resources / services"
30472 in: path
30473 name: containerComponentType
30474 required: true
30475 schema:
30476 type: string
30477 enum:
30478 - resources
30479 - services
30480 - in: path
30481 name: componentId
30482 required: true
30483 schema:
30484 type: string
30485 - in: path
30486 name: componentInstanceId
30487 required: true
30488 schema:
30489 type: string
30490 - in: path
30491 name: artifactGroupType
30492 required: true
30493 schema:
30494 type: string
30495 responses:
30496 "200":
30497 description: Component artifacts
30498 "404":
30499 description: Resource/Artifact not found
30500 default:
30501 content:
30502 application/json:
30503 schema:
30504 type: array
30505 items:
30506 type: object
30507 properties:
30508 allowedMethods:
30509 type: array
30510 items:
30511 type: string
30512 uniqueItems: true
30513 cookies:
30514 type: object
30515 additionalProperties:
30516 type: object
30517 properties:
30518 comment:
30519 type: string
30520 domain:
30521 type: string
30522 expiry:
30523 type: string
30524 format: date-time
30525 httpOnly:
30526 type: boolean
30527 maxAge:
30528 type: integer
30529 format: int32
30530 name:
30531 type: string
30532 path:
30533 type: string
30534 secure:
30535 type: boolean
30536 value:
30537 type: string
30538 version:
30539 type: integer
30540 format: int32
30541 date:
30542 type: string
30543 format: date-time
30544 entity:
30545 type: object
30546 entityTag:
30547 type: object
30548 properties:
30549 value:
30550 type: string
30551 weak:
30552 type: boolean
30553 headers:
30554 type: object
30555 additionalProperties:
30556 type: array
30557 items:
30558 type: object
30559 language:
30560 type: object
30561 properties:
30562 country:
30563 type: string
30564 displayCountry:
30565 type: string
30566 displayLanguage:
30567 type: string
30568 displayName:
30569 type: string
30570 displayScript:
30571 type: string
30572 displayVariant:
30573 type: string
30574 extensionKeys:
30575 type: array
30576 items:
30577 type: string
30578 uniqueItems: true
30579 iso3Country:
30580 type: string
30581 iso3Language:
30582 type: string
30583 language:
30584 type: string
30585 script:
30586 type: string
30587 unicodeLocaleAttributes:
30588 type: array
30589 items:
30590 type: string
30591 uniqueItems: true
30592 unicodeLocaleKeys:
30593 type: array
30594 items:
30595 type: string
30596 uniqueItems: true
30597 variant:
30598 type: string
30599 lastModified:
30600 type: string
30601 format: date-time
30602 length:
30603 type: integer
30604 format: int32
30605 links:
30606 type: array
30607 items:
30608 type: object
30609 properties:
30610 params:
30611 type: object
30612 additionalProperties:
30613 type: string
30614 rel:
30615 type: string
30616 rels:
30617 type: array
30618 items:
30619 type: string
30620 title:
30621 type: string
30622 type:
30623 type: string
30624 uri:
30625 type: string
30626 format: uri
30627 uriBuilder:
30628 type: object
30629 uniqueItems: true
30630 location:
30631 type: string
30632 format: uri
30633 mediaType:
30634 type: object
30635 properties:
30636 parameters:
30637 type: object
30638 additionalProperties:
30639 type: string
30640 subtype:
30641 type: string
30642 type:
30643 type: string
30644 wildcardSubtype:
30645 type: boolean
30646 wildcardType:
30647 type: boolean
30648 metadata:
30649 type: object
30650 additionalProperties:
30651 type: array
30652 items:
30653 type: object
30654 status:
30655 type: integer
30656 format: int32
30657 statusInfo:
30658 type: object
30659 properties:
30660 family:
30661 type: string
30662 enum:
30663 - INFORMATIONAL
30664 - SUCCESSFUL
30665 - REDIRECTION
30666 - CLIENT_ERROR
30667 - SERVER_ERROR
30668 - OTHER
30669 reasonPhrase:
30670 type: string
30671 statusCode:
30672 type: integer
30673 format: int32
30674 stringHeaders:
30675 type: object
30676 additionalProperties:
30677 type: array
30678 items:
30679 type: string
30680 servers:
30681 - url: /sdc2/rest
30682 variables: {}
30683 summary: Returns artifacts
30684 tags:
30685 - SDCE-2 APIs
30686 /v1/catalog/{containerComponentType}/{componentId}/update/inputs:
30687 post:
30688 description: Update resource inputs
30689 operationId: updateComponentInputs
30690 parameters:
30691 - description: "valid values: resources / services"
30692 in: path
30693 name: containerComponentType
30694 required: true
30695 schema:
30696 type: string
30697 enum:
30698 - resources
30699 - services
30700 - in: path
30701 name: componentId
30702 required: true
30703 schema:
30704 type: string
30705 requestBody:
30706 content:
30707 application/json:
30708 schema:
30709 type: string
30710 description: json describe the input
30711 required: true
30712 responses:
30713 "200":
30714 description: Input updated
30715 "400":
30716 description: Invalid content / Missing content
30717 "403":
30718 description: Restricted operation
30719 default:
30720 content:
30721 application/json:
30722 schema:
30723 type: array
30724 items:
30725 type: object
30726 properties:
30727 allowedMethods:
30728 type: array
30729 items:
30730 type: string
30731 uniqueItems: true
30732 cookies:
30733 type: object
30734 additionalProperties:
30735 type: object
30736 properties:
30737 comment:
30738 type: string
30739 domain:
30740 type: string
30741 expiry:
30742 type: string
30743 format: date-time
30744 httpOnly:
30745 type: boolean
30746 maxAge:
30747 type: integer
30748 format: int32
30749 name:
30750 type: string
30751 path:
30752 type: string
30753 secure:
30754 type: boolean
30755 value:
30756 type: string
30757 version:
30758 type: integer
30759 format: int32
30760 date:
30761 type: string
30762 format: date-time
30763 entity:
30764 type: object
30765 entityTag:
30766 type: object
30767 properties:
30768 value:
30769 type: string
30770 weak:
30771 type: boolean
30772 headers:
30773 type: object
30774 additionalProperties:
30775 type: array
30776 items:
30777 type: object
30778 language:
30779 type: object
30780 properties:
30781 country:
30782 type: string
30783 displayCountry:
30784 type: string
30785 displayLanguage:
30786 type: string
30787 displayName:
30788 type: string
30789 displayScript:
30790 type: string
30791 displayVariant:
30792 type: string
30793 extensionKeys:
30794 type: array
30795 items:
30796 type: string
30797 uniqueItems: true
30798 iso3Country:
30799 type: string
30800 iso3Language:
30801 type: string
30802 language:
30803 type: string
30804 script:
30805 type: string
30806 unicodeLocaleAttributes:
30807 type: array
30808 items:
30809 type: string
30810 uniqueItems: true
30811 unicodeLocaleKeys:
30812 type: array
30813 items:
30814 type: string
30815 uniqueItems: true
30816 variant:
30817 type: string
30818 lastModified:
30819 type: string
30820 format: date-time
30821 length:
30822 type: integer
30823 format: int32
30824 links:
30825 type: array
30826 items:
30827 type: object
30828 properties:
30829 params:
30830 type: object
30831 additionalProperties:
30832 type: string
30833 rel:
30834 type: string
30835 rels:
30836 type: array
30837 items:
30838 type: string
30839 title:
30840 type: string
30841 type:
30842 type: string
30843 uri:
30844 type: string
30845 format: uri
30846 uriBuilder:
30847 type: object
30848 uniqueItems: true
30849 location:
30850 type: string
30851 format: uri
30852 mediaType:
30853 type: object
30854 properties:
30855 parameters:
30856 type: object
30857 additionalProperties:
30858 type: string
30859 subtype:
30860 type: string
30861 type:
30862 type: string
30863 wildcardSubtype:
30864 type: boolean
30865 wildcardType:
30866 type: boolean
30867 metadata:
30868 type: object
30869 additionalProperties:
30870 type: array
30871 items:
30872 type: object
30873 status:
30874 type: integer
30875 format: int32
30876 statusInfo:
30877 type: object
30878 properties:
30879 family:
30880 type: string
30881 enum:
30882 - INFORMATIONAL
30883 - SUCCESSFUL
30884 - REDIRECTION
30885 - CLIENT_ERROR
30886 - SERVER_ERROR
30887 - OTHER
30888 reasonPhrase:
30889 type: string
30890 statusCode:
30891 type: integer
30892 format: int32
30893 stringHeaders:
30894 type: object
30895 additionalProperties:
30896 type: array
30897 items:
30898 type: string
30899 servers:
30900 - url: /sdc2/rest
30901 variables: {}
30902 summary: Returns updated input
30903 tags:
30904 - SDCE-2 APIs
30905 /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/attributes:
30906 get:
30907 description: Get component instance attributes
30908 operationId: getInstanceAttributesById
30909 parameters:
30910 - in: path
30911 name: containerComponentType
30912 required: true
30913 schema:
30914 type: string
30915 - in: path
30916 name: containerComponentId
30917 required: true
30918 schema:
30919 type: string
30920 - in: path
30921 name: componentInstanceUniqueId
30922 required: true
30923 schema:
30924 type: string
30925 - in: header
30926 name: USER_ID
30927 schema:
30928 type: string
30929 responses:
30930 "200":
30931 description: Attributes found
30932 "403":
30933 description: Restricted operation
30934 "404":
30935 description: Component/Component Instance - not found
30936 default:
30937 content:
30938 application/json:
30939 schema:
30940 type: array
30941 items:
30942 type: object
30943 properties:
30944 allowedMethods:
30945 type: array
30946 items:
30947 type: string
30948 uniqueItems: true
30949 cookies:
30950 type: object
30951 additionalProperties:
30952 type: object
30953 properties:
30954 comment:
30955 type: string
30956 domain:
30957 type: string
30958 expiry:
30959 type: string
30960 format: date-time
30961 httpOnly:
30962 type: boolean
30963 maxAge:
30964 type: integer
30965 format: int32
30966 name:
30967 type: string
30968 path:
30969 type: string
30970 secure:
30971 type: boolean
30972 value:
30973 type: string
30974 version:
30975 type: integer
30976 format: int32
30977 date:
30978 type: string
30979 format: date-time
30980 entity:
30981 type: object
30982 entityTag:
30983 type: object
30984 properties:
30985 value:
30986 type: string
30987 weak:
30988 type: boolean
30989 headers:
30990 type: object
30991 additionalProperties:
30992 type: array
30993 items:
30994 type: object
30995 language:
30996 type: object
30997 properties:
30998 country:
30999 type: string
31000 displayCountry:
31001 type: string
31002 displayLanguage:
31003 type: string
31004 displayName:
31005 type: string
31006 displayScript:
31007 type: string
31008 displayVariant:
31009 type: string
31010 extensionKeys:
31011 type: array
31012 items:
31013 type: string
31014 uniqueItems: true
31015 iso3Country:
31016 type: string
31017 iso3Language:
31018 type: string
31019 language:
31020 type: string
31021 script:
31022 type: string
31023 unicodeLocaleAttributes:
31024 type: array
31025 items:
31026 type: string
31027 uniqueItems: true
31028 unicodeLocaleKeys:
31029 type: array
31030 items:
31031 type: string
31032 uniqueItems: true
31033 variant:
31034 type: string
31035 lastModified:
31036 type: string
31037 format: date-time
31038 length:
31039 type: integer
31040 format: int32
31041 links:
31042 type: array
31043 items:
31044 type: object
31045 properties:
31046 params:
31047 type: object
31048 additionalProperties:
31049 type: string
31050 rel:
31051 type: string
31052 rels:
31053 type: array
31054 items:
31055 type: string
31056 title:
31057 type: string
31058 type:
31059 type: string
31060 uri:
31061 type: string
31062 format: uri
31063 uriBuilder:
31064 type: object
31065 uniqueItems: true
31066 location:
31067 type: string
31068 format: uri
31069 mediaType:
31070 type: object
31071 properties:
31072 parameters:
31073 type: object
31074 additionalProperties:
31075 type: string
31076 subtype:
31077 type: string
31078 type:
31079 type: string
31080 wildcardSubtype:
31081 type: boolean
31082 wildcardType:
31083 type: boolean
31084 metadata:
31085 type: object
31086 additionalProperties:
31087 type: array
31088 items:
31089 type: object
31090 status:
31091 type: integer
31092 format: int32
31093 statusInfo:
31094 type: object
31095 properties:
31096 family:
31097 type: string
31098 enum:
31099 - INFORMATIONAL
31100 - SUCCESSFUL
31101 - REDIRECTION
31102 - CLIENT_ERROR
31103 - SERVER_ERROR
31104 - OTHER
31105 reasonPhrase:
31106 type: string
31107 statusCode:
31108 type: integer
31109 format: int32
31110 stringHeaders:
31111 type: object
31112 additionalProperties:
31113 type: array
31114 items:
31115 type: string
31116 servers:
31117 - url: /sdc2/rest
31118 variables: {}
31119 summary: Returns component instance attributes
31120 tags:
31121 - SDCE-2 APIs
31122 /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/capability:
31123 put:
31124 description: Update Component Instance Capability
31125 operationId: updateInstanceRequirement
31126 parameters:
31127 - in: path
31128 name: containerComponentType
31129 required: true
31130 schema:
31131 type: string
31132 - in: path
31133 name: containerComponentId
31134 required: true
31135 schema:
31136 type: string
31137 - in: path
31138 name: componentInstanceUniqueId
31139 required: true
31140 schema:
31141 type: string
31142 - in: header
31143 name: USER_ID
31144 schema:
31145 type: string
31146 requestBody:
31147 content:
31148 application/json:
31149 schema:
31150 $ref: '#/components/schemas/ComponentInstanceCapabilityUpdateModel'
31151 description: Component instance capability to update
31152 required: true
31153 responses:
31154 "200":
31155 description: Resource instance capability successfully updated
31156 "400":
31157 description: Invalid content / Missing content
31158 "403":
31159 description: Restricted operation
31160 "404":
31161 description: Component/Component Instance/Capability not found
31162 default:
31163 content:
31164 application/json:
31165 schema:
31166 type: array
31167 items:
31168 type: object
31169 properties:
31170 allowedMethods:
31171 type: array
31172 items:
31173 type: string
31174 uniqueItems: true
31175 cookies:
31176 type: object
31177 additionalProperties:
31178 type: object
31179 properties:
31180 comment:
31181 type: string
31182 domain:
31183 type: string
31184 expiry:
31185 type: string
31186 format: date-time
31187 httpOnly:
31188 type: boolean
31189 maxAge:
31190 type: integer
31191 format: int32
31192 name:
31193 type: string
31194 path:
31195 type: string
31196 secure:
31197 type: boolean
31198 value:
31199 type: string
31200 version:
31201 type: integer
31202 format: int32
31203 date:
31204 type: string
31205 format: date-time
31206 entity:
31207 type: object
31208 entityTag:
31209 type: object
31210 properties:
31211 value:
31212 type: string
31213 weak:
31214 type: boolean
31215 headers:
31216 type: object
31217 additionalProperties:
31218 type: array
31219 items:
31220 type: object
31221 language:
31222 type: object
31223 properties:
31224 country:
31225 type: string
31226 displayCountry:
31227 type: string
31228 displayLanguage:
31229 type: string
31230 displayName:
31231 type: string
31232 displayScript:
31233 type: string
31234 displayVariant:
31235 type: string
31236 extensionKeys:
31237 type: array
31238 items:
31239 type: string
31240 uniqueItems: true
31241 iso3Country:
31242 type: string
31243 iso3Language:
31244 type: string
31245 language:
31246 type: string
31247 script:
31248 type: string
31249 unicodeLocaleAttributes:
31250 type: array
31251 items:
31252 type: string
31253 uniqueItems: true
31254 unicodeLocaleKeys:
31255 type: array
31256 items:
31257 type: string
31258 uniqueItems: true
31259 variant:
31260 type: string
31261 lastModified:
31262 type: string
31263 format: date-time
31264 length:
31265 type: integer
31266 format: int32
31267 links:
31268 type: array
31269 items:
31270 type: object
31271 properties:
31272 params:
31273 type: object
31274 additionalProperties:
31275 type: string
31276 rel:
31277 type: string
31278 rels:
31279 type: array
31280 items:
31281 type: string
31282 title:
31283 type: string
31284 type:
31285 type: string
31286 uri:
31287 type: string
31288 format: uri
31289 uriBuilder:
31290 type: object
31291 uniqueItems: true
31292 location:
31293 type: string
31294 format: uri
31295 mediaType:
31296 type: object
31297 properties:
31298 parameters:
31299 type: object
31300 additionalProperties:
31301 type: string
31302 subtype:
31303 type: string
31304 type:
31305 type: string
31306 wildcardSubtype:
31307 type: boolean
31308 wildcardType:
31309 type: boolean
31310 metadata:
31311 type: object
31312 additionalProperties:
31313 type: array
31314 items:
31315 type: object
31316 status:
31317 type: integer
31318 format: int32
31319 statusInfo:
31320 type: object
31321 properties:
31322 family:
31323 type: string
31324 enum:
31325 - INFORMATIONAL
31326 - SUCCESSFUL
31327 - REDIRECTION
31328 - CLIENT_ERROR
31329 - SERVER_ERROR
31330 - OTHER
31331 reasonPhrase:
31332 type: string
31333 statusCode:
31334 type: integer
31335 format: int32
31336 stringHeaders:
31337 type: object
31338 additionalProperties:
31339 type: array
31340 items:
31341 type: string
31342 servers:
31343 - url: /sdc2/rest
31344 variables: {}
31345 summary: Returns updated Component Instance Capability
31346 tags:
31347 - SDCE-2 APIs
31348 ? /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/capability/{capabilityType}/capabilityName/{capabilityName}/ownerId/{ownerId}/properties
31349 : get:
31350 description: Get component instance capability properties
31351 operationId: getInstanceCapabilityPropertiesById
31352 parameters:
31353 - in: path
31354 name: containerComponentType
31355 required: true
31356 schema:
31357 type: string
31358 - in: path
31359 name: containerComponentId
31360 required: true
31361 schema:
31362 type: string
31363 - in: path
31364 name: componentInstanceUniqueId
31365 required: true
31366 schema:
31367 type: string
31368 - in: path
31369 name: capabilityType
31370 required: true
31371 schema:
31372 type: string
31373 - in: path
31374 name: capabilityName
31375 required: true
31376 schema:
31377 type: string
31378 - in: path
31379 name: ownerId
31380 required: true
31381 schema:
31382 type: string
31383 - in: header
31384 name: USER_ID
31385 schema:
31386 type: string
31387 responses:
31388 "200":
31389 description: Properties found
31390 "403":
31391 description: Restricted operation
31392 "404":
31393 description: Component/Component Instance/Capability - not found
31394 default:
31395 content:
31396 application/json:
31397 schema:
31398 type: array
31399 items:
31400 type: object
31401 properties:
31402 allowedMethods:
31403 type: array
31404 items:
31405 type: string
31406 uniqueItems: true
31407 cookies:
31408 type: object
31409 additionalProperties:
31410 type: object
31411 properties:
31412 comment:
31413 type: string
31414 domain:
31415 type: string
31416 expiry:
31417 type: string
31418 format: date-time
31419 httpOnly:
31420 type: boolean
31421 maxAge:
31422 type: integer
31423 format: int32
31424 name:
31425 type: string
31426 path:
31427 type: string
31428 secure:
31429 type: boolean
31430 value:
31431 type: string
31432 version:
31433 type: integer
31434 format: int32
31435 date:
31436 type: string
31437 format: date-time
31438 entity:
31439 type: object
31440 entityTag:
31441 type: object
31442 properties:
31443 value:
31444 type: string
31445 weak:
31446 type: boolean
31447 headers:
31448 type: object
31449 additionalProperties:
31450 type: array
31451 items:
31452 type: object
31453 language:
31454 type: object
31455 properties:
31456 country:
31457 type: string
31458 displayCountry:
31459 type: string
31460 displayLanguage:
31461 type: string
31462 displayName:
31463 type: string
31464 displayScript:
31465 type: string
31466 displayVariant:
31467 type: string
31468 extensionKeys:
31469 type: array
31470 items:
31471 type: string
31472 uniqueItems: true
31473 iso3Country:
31474 type: string
31475 iso3Language:
31476 type: string
31477 language:
31478 type: string
31479 script:
31480 type: string
31481 unicodeLocaleAttributes:
31482 type: array
31483 items:
31484 type: string
31485 uniqueItems: true
31486 unicodeLocaleKeys:
31487 type: array
31488 items:
31489 type: string
31490 uniqueItems: true
31491 variant:
31492 type: string
31493 lastModified:
31494 type: string
31495 format: date-time
31496 length:
31497 type: integer
31498 format: int32
31499 links:
31500 type: array
31501 items:
31502 type: object
31503 properties:
31504 params:
31505 type: object
31506 additionalProperties:
31507 type: string
31508 rel:
31509 type: string
31510 rels:
31511 type: array
31512 items:
31513 type: string
31514 title:
31515 type: string
31516 type:
31517 type: string
31518 uri:
31519 type: string
31520 format: uri
31521 uriBuilder:
31522 type: object
31523 uniqueItems: true
31524 location:
31525 type: string
31526 format: uri
31527 mediaType:
31528 type: object
31529 properties:
31530 parameters:
31531 type: object
31532 additionalProperties:
31533 type: string
31534 subtype:
31535 type: string
31536 type:
31537 type: string
31538 wildcardSubtype:
31539 type: boolean
31540 wildcardType:
31541 type: boolean
31542 metadata:
31543 type: object
31544 additionalProperties:
31545 type: array
31546 items:
31547 type: object
31548 status:
31549 type: integer
31550 format: int32
31551 statusInfo:
31552 type: object
31553 properties:
31554 family:
31555 type: string
31556 enum:
31557 - INFORMATIONAL
31558 - SUCCESSFUL
31559 - REDIRECTION
31560 - CLIENT_ERROR
31561 - SERVER_ERROR
31562 - OTHER
31563 reasonPhrase:
31564 type: string
31565 statusCode:
31566 type: integer
31567 format: int32
31568 stringHeaders:
31569 type: object
31570 additionalProperties:
31571 type: array
31572 items:
31573 type: string
31574 servers:
31575 - url: /sdc2/rest
31576 variables: {}
31577 summary: Returns component instance capability properties
31578 tags:
31579 - SDCE-2 APIs
31580 put:
31581 description: Update Instance Capabilty Property
31582 operationId: updateInstanceCapabilityProperty
31583 parameters:
31584 - in: path
31585 name: containerComponentType
31586 required: true
31587 schema:
31588 type: string
31589 - in: path
31590 name: containerComponentId
31591 required: true
31592 schema:
31593 type: string
31594 - in: path
31595 name: componentInstanceUniqueId
31596 required: true
31597 schema:
31598 type: string
31599 - in: path
31600 name: capabilityType
31601 required: true
31602 schema:
31603 type: string
31604 - in: path
31605 name: capabilityName
31606 required: true
31607 schema:
31608 type: string
31609 - in: path
31610 name: ownerId
31611 required: true
31612 schema:
31613 type: string
31614 - in: header
31615 name: USER_ID
31616 schema:
31617 type: string
31618 requestBody:
31619 content:
31620 application/json:
31621 schema:
31622 type: string
31623 description: Instance capabilty property to update
31624 required: true
31625 responses:
31626 "200":
31627 description: Resource instance capabilty property updated
31628 "400":
31629 description: Invalid content / Missing content
31630 "403":
31631 description: Restricted operation
31632 "404":
31633 description: Component/Component Instance/Capability - not found
31634 default:
31635 content:
31636 application/json:
31637 schema:
31638 type: array
31639 items:
31640 type: object
31641 properties:
31642 allowedMethods:
31643 type: array
31644 items:
31645 type: string
31646 uniqueItems: true
31647 cookies:
31648 type: object
31649 additionalProperties:
31650 type: object
31651 properties:
31652 comment:
31653 type: string
31654 domain:
31655 type: string
31656 expiry:
31657 type: string
31658 format: date-time
31659 httpOnly:
31660 type: boolean
31661 maxAge:
31662 type: integer
31663 format: int32
31664 name:
31665 type: string
31666 path:
31667 type: string
31668 secure:
31669 type: boolean
31670 value:
31671 type: string
31672 version:
31673 type: integer
31674 format: int32
31675 date:
31676 type: string
31677 format: date-time
31678 entity:
31679 type: object
31680 entityTag:
31681 type: object
31682 properties:
31683 value:
31684 type: string
31685 weak:
31686 type: boolean
31687 headers:
31688 type: object
31689 additionalProperties:
31690 type: array
31691 items:
31692 type: object
31693 language:
31694 type: object
31695 properties:
31696 country:
31697 type: string
31698 displayCountry:
31699 type: string
31700 displayLanguage:
31701 type: string
31702 displayName:
31703 type: string
31704 displayScript:
31705 type: string
31706 displayVariant:
31707 type: string
31708 extensionKeys:
31709 type: array
31710 items:
31711 type: string
31712 uniqueItems: true
31713 iso3Country:
31714 type: string
31715 iso3Language:
31716 type: string
31717 language:
31718 type: string
31719 script:
31720 type: string
31721 unicodeLocaleAttributes:
31722 type: array
31723 items:
31724 type: string
31725 uniqueItems: true
31726 unicodeLocaleKeys:
31727 type: array
31728 items:
31729 type: string
31730 uniqueItems: true
31731 variant:
31732 type: string
31733 lastModified:
31734 type: string
31735 format: date-time
31736 length:
31737 type: integer
31738 format: int32
31739 links:
31740 type: array
31741 items:
31742 type: object
31743 properties:
31744 params:
31745 type: object
31746 additionalProperties:
31747 type: string
31748 rel:
31749 type: string
31750 rels:
31751 type: array
31752 items:
31753 type: string
31754 title:
31755 type: string
31756 type:
31757 type: string
31758 uri:
31759 type: string
31760 format: uri
31761 uriBuilder:
31762 type: object
31763 uniqueItems: true
31764 location:
31765 type: string
31766 format: uri
31767 mediaType:
31768 type: object
31769 properties:
31770 parameters:
31771 type: object
31772 additionalProperties:
31773 type: string
31774 subtype:
31775 type: string
31776 type:
31777 type: string
31778 wildcardSubtype:
31779 type: boolean
31780 wildcardType:
31781 type: boolean
31782 metadata:
31783 type: object
31784 additionalProperties:
31785 type: array
31786 items:
31787 type: object
31788 status:
31789 type: integer
31790 format: int32
31791 statusInfo:
31792 type: object
31793 properties:
31794 family:
31795 type: string
31796 enum:
31797 - INFORMATIONAL
31798 - SUCCESSFUL
31799 - REDIRECTION
31800 - CLIENT_ERROR
31801 - SERVER_ERROR
31802 - OTHER
31803 reasonPhrase:
31804 type: string
31805 statusCode:
31806 type: integer
31807 format: int32
31808 stringHeaders:
31809 type: object
31810 additionalProperties:
31811 type: array
31812 items:
31813 type: string
31814 servers:
31815 - url: /sdc2/rest
31816 variables: {}
31817 summary: Returns updated property
31818 tags:
31819 - SDCE-2 APIs
31820 /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/properties:
31821 get:
31822 description: Get component instance properties
31823 operationId: getInstancePropertiesById
31824 parameters:
31825 - in: path
31826 name: containerComponentType
31827 required: true
31828 schema:
31829 type: string
31830 - in: path
31831 name: containerComponentId
31832 required: true
31833 schema:
31834 type: string
31835 - in: path
31836 name: componentInstanceUniqueId
31837 required: true
31838 schema:
31839 type: string
31840 - in: header
31841 name: USER_ID
31842 schema:
31843 type: string
31844 responses:
31845 "200":
31846 description: Properties found
31847 "403":
31848 description: Restricted operation
31849 "404":
31850 description: Component/Component Instance - not found
31851 default:
31852 content:
31853 application/json:
31854 schema:
31855 type: array
31856 items:
31857 type: object
31858 properties:
31859 allowedMethods:
31860 type: array
31861 items:
31862 type: string
31863 uniqueItems: true
31864 cookies:
31865 type: object
31866 additionalProperties:
31867 type: object
31868 properties:
31869 comment:
31870 type: string
31871 domain:
31872 type: string
31873 expiry:
31874 type: string
31875 format: date-time
31876 httpOnly:
31877 type: boolean
31878 maxAge:
31879 type: integer
31880 format: int32
31881 name:
31882 type: string
31883 path:
31884 type: string
31885 secure:
31886 type: boolean
31887 value:
31888 type: string
31889 version:
31890 type: integer
31891 format: int32
31892 date:
31893 type: string
31894 format: date-time
31895 entity:
31896 type: object
31897 entityTag:
31898 type: object
31899 properties:
31900 value:
31901 type: string
31902 weak:
31903 type: boolean
31904 headers:
31905 type: object
31906 additionalProperties:
31907 type: array
31908 items:
31909 type: object
31910 language:
31911 type: object
31912 properties:
31913 country:
31914 type: string
31915 displayCountry:
31916 type: string
31917 displayLanguage:
31918 type: string
31919 displayName:
31920 type: string
31921 displayScript:
31922 type: string
31923 displayVariant:
31924 type: string
31925 extensionKeys:
31926 type: array
31927 items:
31928 type: string
31929 uniqueItems: true
31930 iso3Country:
31931 type: string
31932 iso3Language:
31933 type: string
31934 language:
31935 type: string
31936 script:
31937 type: string
31938 unicodeLocaleAttributes:
31939 type: array
31940 items:
31941 type: string
31942 uniqueItems: true
31943 unicodeLocaleKeys:
31944 type: array
31945 items:
31946 type: string
31947 uniqueItems: true
31948 variant:
31949 type: string
31950 lastModified:
31951 type: string
31952 format: date-time
31953 length:
31954 type: integer
31955 format: int32
31956 links:
31957 type: array
31958 items:
31959 type: object
31960 properties:
31961 params:
31962 type: object
31963 additionalProperties:
31964 type: string
31965 rel:
31966 type: string
31967 rels:
31968 type: array
31969 items:
31970 type: string
31971 title:
31972 type: string
31973 type:
31974 type: string
31975 uri:
31976 type: string
31977 format: uri
31978 uriBuilder:
31979 type: object
31980 uniqueItems: true
31981 location:
31982 type: string
31983 format: uri
31984 mediaType:
31985 type: object
31986 properties:
31987 parameters:
31988 type: object
31989 additionalProperties:
31990 type: string
31991 subtype:
31992 type: string
31993 type:
31994 type: string
31995 wildcardSubtype:
31996 type: boolean
31997 wildcardType:
31998 type: boolean
31999 metadata:
32000 type: object
32001 additionalProperties:
32002 type: array
32003 items:
32004 type: object
32005 status:
32006 type: integer
32007 format: int32
32008 statusInfo:
32009 type: object
32010 properties:
32011 family:
32012 type: string
32013 enum:
32014 - INFORMATIONAL
32015 - SUCCESSFUL
32016 - REDIRECTION
32017 - CLIENT_ERROR
32018 - SERVER_ERROR
32019 - OTHER
32020 reasonPhrase:
32021 type: string
32022 statusCode:
32023 type: integer
32024 format: int32
32025 stringHeaders:
32026 type: object
32027 additionalProperties:
32028 type: array
32029 items:
32030 type: string
32031 servers:
32032 - url: /sdc2/rest
32033 variables: {}
32034 summary: Returns component instance properties
32035 tags:
32036 - SDCE-2 APIs
32037 ? /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/requirement/{capabilityType}/requirementName/{requirementName}
32038 : put:
32039 description: Update Instance Requirement
32040 operationId: updateInstanceRequirement_1
32041 parameters:
32042 - in: path
32043 name: containerComponentType
32044 required: true
32045 schema:
32046 type: string
32047 - in: path
32048 name: containerComponentId
32049 required: true
32050 schema:
32051 type: string
32052 - in: path
32053 name: componentInstanceUniqueId
32054 required: true
32055 schema:
32056 type: string
32057 - in: path
32058 name: capabilityType
32059 required: true
32060 schema:
32061 type: string
32062 - in: path
32063 name: requirementName
32064 required: true
32065 schema:
32066 type: string
32067 - in: header
32068 name: USER_ID
32069 schema:
32070 type: string
32071 requestBody:
32072 content:
32073 application/json:
32074 schema:
32075 type: string
32076 description: Instance capabilty requirement to update
32077 required: true
32078 responses:
32079 "200":
32080 description: Resource instance requirement updated
32081 "400":
32082 description: Invalid content / Missing content
32083 "403":
32084 description: Restricted operation
32085 "404":
32086 description: Component/Component Instance/Requirement - not found
32087 default:
32088 content:
32089 application/json:
32090 schema:
32091 type: array
32092 items:
32093 type: object
32094 properties:
32095 allowedMethods:
32096 type: array
32097 items:
32098 type: string
32099 uniqueItems: true
32100 cookies:
32101 type: object
32102 additionalProperties:
32103 type: object
32104 properties:
32105 comment:
32106 type: string
32107 domain:
32108 type: string
32109 expiry:
32110 type: string
32111 format: date-time
32112 httpOnly:
32113 type: boolean
32114 maxAge:
32115 type: integer
32116 format: int32
32117 name:
32118 type: string
32119 path:
32120 type: string
32121 secure:
32122 type: boolean
32123 value:
32124 type: string
32125 version:
32126 type: integer
32127 format: int32
32128 date:
32129 type: string
32130 format: date-time
32131 entity:
32132 type: object
32133 entityTag:
32134 type: object
32135 properties:
32136 value:
32137 type: string
32138 weak:
32139 type: boolean
32140 headers:
32141 type: object
32142 additionalProperties:
32143 type: array
32144 items:
32145 type: object
32146 language:
32147 type: object
32148 properties:
32149 country:
32150 type: string
32151 displayCountry:
32152 type: string
32153 displayLanguage:
32154 type: string
32155 displayName:
32156 type: string
32157 displayScript:
32158 type: string
32159 displayVariant:
32160 type: string
32161 extensionKeys:
32162 type: array
32163 items:
32164 type: string
32165 uniqueItems: true
32166 iso3Country:
32167 type: string
32168 iso3Language:
32169 type: string
32170 language:
32171 type: string
32172 script:
32173 type: string
32174 unicodeLocaleAttributes:
32175 type: array
32176 items:
32177 type: string
32178 uniqueItems: true
32179 unicodeLocaleKeys:
32180 type: array
32181 items:
32182 type: string
32183 uniqueItems: true
32184 variant:
32185 type: string
32186 lastModified:
32187 type: string
32188 format: date-time
32189 length:
32190 type: integer
32191 format: int32
32192 links:
32193 type: array
32194 items:
32195 type: object
32196 properties:
32197 params:
32198 type: object
32199 additionalProperties:
32200 type: string
32201 rel:
32202 type: string
32203 rels:
32204 type: array
32205 items:
32206 type: string
32207 title:
32208 type: string
32209 type:
32210 type: string
32211 uri:
32212 type: string
32213 format: uri
32214 uriBuilder:
32215 type: object
32216 uniqueItems: true
32217 location:
32218 type: string
32219 format: uri
32220 mediaType:
32221 type: object
32222 properties:
32223 parameters:
32224 type: object
32225 additionalProperties:
32226 type: string
32227 subtype:
32228 type: string
32229 type:
32230 type: string
32231 wildcardSubtype:
32232 type: boolean
32233 wildcardType:
32234 type: boolean
32235 metadata:
32236 type: object
32237 additionalProperties:
32238 type: array
32239 items:
32240 type: object
32241 status:
32242 type: integer
32243 format: int32
32244 statusInfo:
32245 type: object
32246 properties:
32247 family:
32248 type: string
32249 enum:
32250 - INFORMATIONAL
32251 - SUCCESSFUL
32252 - REDIRECTION
32253 - CLIENT_ERROR
32254 - SERVER_ERROR
32255 - OTHER
32256 reasonPhrase:
32257 type: string
32258 statusCode:
32259 type: integer
32260 format: int32
32261 stringHeaders:
32262 type: object
32263 additionalProperties:
32264 type: array
32265 items:
32266 type: string
32267 servers:
32268 - url: /sdc2/rest
32269 variables: {}
32270 summary: Returns updated requirement
32271 tags:
32272 - SDCE-2 APIs
32273 /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy:
32274 post:
32275 description: Create service proxy
32276 operationId: createServiceProxy
32277 parameters:
32278 - in: path
32279 name: containerComponentId
32280 required: true
32281 schema:
32282 type: string
32283 - description: "valid values: resources / services"
32284 in: path
32285 name: containerComponentType
32286 required: true
32287 schema:
32288 type: string
32289 enum:
32290 - resources
32291 - services
32292 - description: USER_ID of modifier user
32293 in: header
32294 name: USER_ID
32295 required: true
32296 schema:
32297 type: string
32298 requestBody:
32299 content:
32300 application/json:
32301 schema:
32302 type: string
32303 description: RI object to be created
32304 required: true
32305 responses:
32306 "201":
32307 description: Service proxy created
32308 "400":
32309 description: Invalid content / Missing content
32310 "403":
32311 description: Restricted operation
32312 "409":
32313 description: Service proxy already exist
32314 default:
32315 content:
32316 application/json:
32317 schema:
32318 type: array
32319 items:
32320 type: object
32321 properties:
32322 allowedMethods:
32323 type: array
32324 items:
32325 type: string
32326 uniqueItems: true
32327 cookies:
32328 type: object
32329 additionalProperties:
32330 type: object
32331 properties:
32332 comment:
32333 type: string
32334 domain:
32335 type: string
32336 expiry:
32337 type: string
32338 format: date-time
32339 httpOnly:
32340 type: boolean
32341 maxAge:
32342 type: integer
32343 format: int32
32344 name:
32345 type: string
32346 path:
32347 type: string
32348 secure:
32349 type: boolean
32350 value:
32351 type: string
32352 version:
32353 type: integer
32354 format: int32
32355 date:
32356 type: string
32357 format: date-time
32358 entity:
32359 type: object
32360 entityTag:
32361 type: object
32362 properties:
32363 value:
32364 type: string
32365 weak:
32366 type: boolean
32367 headers:
32368 type: object
32369 additionalProperties:
32370 type: array
32371 items:
32372 type: object
32373 language:
32374 type: object
32375 properties:
32376 country:
32377 type: string
32378 displayCountry:
32379 type: string
32380 displayLanguage:
32381 type: string
32382 displayName:
32383 type: string
32384 displayScript:
32385 type: string
32386 displayVariant:
32387 type: string
32388 extensionKeys:
32389 type: array
32390 items:
32391 type: string
32392 uniqueItems: true
32393 iso3Country:
32394 type: string
32395 iso3Language:
32396 type: string
32397 language:
32398 type: string
32399 script:
32400 type: string
32401 unicodeLocaleAttributes:
32402 type: array
32403 items:
32404 type: string
32405 uniqueItems: true
32406 unicodeLocaleKeys:
32407 type: array
32408 items:
32409 type: string
32410 uniqueItems: true
32411 variant:
32412 type: string
32413 lastModified:
32414 type: string
32415 format: date-time
32416 length:
32417 type: integer
32418 format: int32
32419 links:
32420 type: array
32421 items:
32422 type: object
32423 properties:
32424 params:
32425 type: object
32426 additionalProperties:
32427 type: string
32428 rel:
32429 type: string
32430 rels:
32431 type: array
32432 items:
32433 type: string
32434 title:
32435 type: string
32436 type:
32437 type: string
32438 uri:
32439 type: string
32440 format: uri
32441 uriBuilder:
32442 type: object
32443 uniqueItems: true
32444 location:
32445 type: string
32446 format: uri
32447 mediaType:
32448 type: object
32449 properties:
32450 parameters:
32451 type: object
32452 additionalProperties:
32453 type: string
32454 subtype:
32455 type: string
32456 type:
32457 type: string
32458 wildcardSubtype:
32459 type: boolean
32460 wildcardType:
32461 type: boolean
32462 metadata:
32463 type: object
32464 additionalProperties:
32465 type: array
32466 items:
32467 type: object
32468 status:
32469 type: integer
32470 format: int32
32471 statusInfo:
32472 type: object
32473 properties:
32474 family:
32475 type: string
32476 enum:
32477 - INFORMATIONAL
32478 - SUCCESSFUL
32479 - REDIRECTION
32480 - CLIENT_ERROR
32481 - SERVER_ERROR
32482 - OTHER
32483 reasonPhrase:
32484 type: string
32485 statusCode:
32486 type: integer
32487 format: int32
32488 stringHeaders:
32489 type: object
32490 additionalProperties:
32491 type: array
32492 items:
32493 type: string
32494 servers:
32495 - url: /sdc2/rest
32496 variables: {}
32497 summary: Returns created service proxy
32498 tags:
32499 - SDCE-2 APIs
32500 /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy/{serviceProxyId}:
32501 delete:
32502 description: Delete service proxy
32503 operationId: deleteServiceProxy
32504 parameters:
32505 - in: path
32506 name: containerComponentId
32507 required: true
32508 schema:
32509 type: string
32510 - in: path
32511 name: serviceProxyId
32512 required: true
32513 schema:
32514 type: string
32515 - description: "valid values: resources / services / products"
32516 in: path
32517 name: containerComponentType
32518 required: true
32519 schema:
32520 type: string
32521 enum:
32522 - resources
32523 - services
32524 responses:
32525 "201":
32526 description: Service proxy deleted
32527 "400":
32528 description: Invalid content / Missing content
32529 "403":
32530 description: Restricted operation
32531 default:
32532 content:
32533 application/json:
32534 schema:
32535 type: array
32536 items:
32537 type: object
32538 properties:
32539 allowedMethods:
32540 type: array
32541 items:
32542 type: string
32543 uniqueItems: true
32544 cookies:
32545 type: object
32546 additionalProperties:
32547 type: object
32548 properties:
32549 comment:
32550 type: string
32551 domain:
32552 type: string
32553 expiry:
32554 type: string
32555 format: date-time
32556 httpOnly:
32557 type: boolean
32558 maxAge:
32559 type: integer
32560 format: int32
32561 name:
32562 type: string
32563 path:
32564 type: string
32565 secure:
32566 type: boolean
32567 value:
32568 type: string
32569 version:
32570 type: integer
32571 format: int32
32572 date:
32573 type: string
32574 format: date-time
32575 entity:
32576 type: object
32577 entityTag:
32578 type: object
32579 properties:
32580 value:
32581 type: string
32582 weak:
32583 type: boolean
32584 headers:
32585 type: object
32586 additionalProperties:
32587 type: array
32588 items:
32589 type: object
32590 language:
32591 type: object
32592 properties:
32593 country:
32594 type: string
32595 displayCountry:
32596 type: string
32597 displayLanguage:
32598 type: string
32599 displayName:
32600 type: string
32601 displayScript:
32602 type: string
32603 displayVariant:
32604 type: string
32605 extensionKeys:
32606 type: array
32607 items:
32608 type: string
32609 uniqueItems: true
32610 iso3Country:
32611 type: string
32612 iso3Language:
32613 type: string
32614 language:
32615 type: string
32616 script:
32617 type: string
32618 unicodeLocaleAttributes:
32619 type: array
32620 items:
32621 type: string
32622 uniqueItems: true
32623 unicodeLocaleKeys:
32624 type: array
32625 items:
32626 type: string
32627 uniqueItems: true
32628 variant:
32629 type: string
32630 lastModified:
32631 type: string
32632 format: date-time
32633 length:
32634 type: integer
32635 format: int32
32636 links:
32637 type: array
32638 items:
32639 type: object
32640 properties:
32641 params:
32642 type: object
32643 additionalProperties:
32644 type: string
32645 rel:
32646 type: string
32647 rels:
32648 type: array
32649 items:
32650 type: string
32651 title:
32652 type: string
32653 type:
32654 type: string
32655 uri:
32656 type: string
32657 format: uri
32658 uriBuilder:
32659 type: object
32660 uniqueItems: true
32661 location:
32662 type: string
32663 format: uri
32664 mediaType:
32665 type: object
32666 properties:
32667 parameters:
32668 type: object
32669 additionalProperties:
32670 type: string
32671 subtype:
32672 type: string
32673 type:
32674 type: string
32675 wildcardSubtype:
32676 type: boolean
32677 wildcardType:
32678 type: boolean
32679 metadata:
32680 type: object
32681 additionalProperties:
32682 type: array
32683 items:
32684 type: object
32685 status:
32686 type: integer
32687 format: int32
32688 statusInfo:
32689 type: object
32690 properties:
32691 family:
32692 type: string
32693 enum:
32694 - INFORMATIONAL
32695 - SUCCESSFUL
32696 - REDIRECTION
32697 - CLIENT_ERROR
32698 - SERVER_ERROR
32699 - OTHER
32700 reasonPhrase:
32701 type: string
32702 statusCode:
32703 type: integer
32704 format: int32
32705 stringHeaders:
32706 type: object
32707 additionalProperties:
32708 type: array
32709 items:
32710 type: string
32711 servers:
32712 - url: /sdc2/rest
32713 variables: {}
32714 summary: Returns delete service proxy
32715 tags:
32716 - SDCE-2 APIs
32717 /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy/{serviceProxyId}/changeVersion/{newServiceId}:
32718 post:
32719 description: Update service proxy with new version
32720 operationId: changeServiceProxyVersion
32721 parameters:
32722 - in: path
32723 name: containerComponentId
32724 required: true
32725 schema:
32726 type: string
32727 - in: path
32728 name: serviceProxyId
32729 required: true
32730 schema:
32731 type: string
32732 - description: "valid values: resources / services"
32733 in: path
32734 name: containerComponentType
32735 required: true
32736 schema:
32737 type: string
32738 enum:
32739 - resources
32740 - services
32741 responses:
32742 "201":
32743 description: Service proxy created
32744 "400":
32745 description: Invalid content / Missing content
32746 "403":
32747 description: Restricted operation
32748 default:
32749 content:
32750 application/json:
32751 schema:
32752 type: array
32753 items:
32754 type: object
32755 properties:
32756 allowedMethods:
32757 type: array
32758 items:
32759 type: string
32760 uniqueItems: true
32761 cookies:
32762 type: object
32763 additionalProperties:
32764 type: object
32765 properties:
32766 comment:
32767 type: string
32768 domain:
32769 type: string
32770 expiry:
32771 type: string
32772 format: date-time
32773 httpOnly:
32774 type: boolean
32775 maxAge:
32776 type: integer
32777 format: int32
32778 name:
32779 type: string
32780 path:
32781 type: string
32782 secure:
32783 type: boolean
32784 value:
32785 type: string
32786 version:
32787 type: integer
32788 format: int32
32789 date:
32790 type: string
32791 format: date-time
32792 entity:
32793 type: object
32794 entityTag:
32795 type: object
32796 properties:
32797 value:
32798 type: string
32799 weak:
32800 type: boolean
32801 headers:
32802 type: object
32803 additionalProperties:
32804 type: array
32805 items:
32806 type: object
32807 language:
32808 type: object
32809 properties:
32810 country:
32811 type: string
32812 displayCountry:
32813 type: string
32814 displayLanguage:
32815 type: string
32816 displayName:
32817 type: string
32818 displayScript:
32819 type: string
32820 displayVariant:
32821 type: string
32822 extensionKeys:
32823 type: array
32824 items:
32825 type: string
32826 uniqueItems: true
32827 iso3Country:
32828 type: string
32829 iso3Language:
32830 type: string
32831 language:
32832 type: string
32833 script:
32834 type: string
32835 unicodeLocaleAttributes:
32836 type: array
32837 items:
32838 type: string
32839 uniqueItems: true
32840 unicodeLocaleKeys:
32841 type: array
32842 items:
32843 type: string
32844 uniqueItems: true
32845 variant:
32846 type: string
32847 lastModified:
32848 type: string
32849 format: date-time
32850 length:
32851 type: integer
32852 format: int32
32853 links:
32854 type: array
32855 items:
32856 type: object
32857 properties:
32858 params:
32859 type: object
32860 additionalProperties:
32861 type: string
32862 rel:
32863 type: string
32864 rels:
32865 type: array
32866 items:
32867 type: string
32868 title:
32869 type: string
32870 type:
32871 type: string
32872 uri:
32873 type: string
32874 format: uri
32875 uriBuilder:
32876 type: object
32877 uniqueItems: true
32878 location:
32879 type: string
32880 format: uri
32881 mediaType:
32882 type: object
32883 properties:
32884 parameters:
32885 type: object
32886 additionalProperties:
32887 type: string
32888 subtype:
32889 type: string
32890 type:
32891 type: string
32892 wildcardSubtype:
32893 type: boolean
32894 wildcardType:
32895 type: boolean
32896 metadata:
32897 type: object
32898 additionalProperties:
32899 type: array
32900 items:
32901 type: object
32902 status:
32903 type: integer
32904 format: int32
32905 statusInfo:
32906 type: object
32907 properties:
32908 family:
32909 type: string
32910 enum:
32911 - INFORMATIONAL
32912 - SUCCESSFUL
32913 - REDIRECTION
32914 - CLIENT_ERROR
32915 - SERVER_ERROR
32916 - OTHER
32917 reasonPhrase:
32918 type: string
32919 statusCode:
32920 type: integer
32921 format: int32
32922 stringHeaders:
32923 type: object
32924 additionalProperties:
32925 type: array
32926 items:
32927 type: string
32928 servers:
32929 - url: /sdc2/rest
32930 variables: {}
32931 summary: Returns updated service proxy
32932 tags:
32933 - SDCE-2 APIs
32934 /v1/catalog/{containerComponentType}/{serviceId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}:
32935 put:
32936 description: Update Group Instance Property Values
32937 operationId: updateGroupInstancePropertyValues
32938 parameters:
32939 - in: path
32940 name: serviceId
32941 required: true
32942 schema:
32943 type: string
32944 - in: path
32945 name: componentInstanceId
32946 required: true
32947 schema:
32948 type: string
32949 - in: path
32950 name: groupInstanceId
32951 required: true
32952 schema:
32953 type: string
32954 - in: header
32955 name: USER_ID
32956 schema:
32957 type: string
32958 requestBody:
32959 content:
32960 application/json:
32961 schema:
32962 type: string
32963 description: Group instance object to be Updated
32964 required: true
32965 responses:
32966 "200":
32967 description: Group Instance Property Values Updated
32968 "400":
32969 description: Invalid content / Missing content
32970 "403":
32971 description: Restricted operation
32972 default:
32973 content:
32974 application/json:
32975 schema:
32976 type: array
32977 items:
32978 $ref: '#/components/schemas/Service'
32979 servers:
32980 - url: /sdc2/rest
32981 variables: {}
32982 summary: Returns updated group instance
32983 tags:
32984 - SDCE-2 APIs
32985 /v1/catalogUpdateTime:
32986 get:
32987 description: Retrieve previus and current catalog update time
32988 operationId: getCatalogUpdateTime
32989 parameters:
32990 - in: header
32991 name: USER_ID
32992 schema:
32993 type: string
32994 responses:
32995 "200":
32996 description: Retrieve previus and current catalog update time
32997 default:
32998 content:
32999 application/json:
33000 schema:
33001 type: array
33002 items:
33003 type: object
33004 properties:
33005 allowedMethods:
33006 type: array
33007 items:
33008 type: string
33009 uniqueItems: true
33010 cookies:
33011 type: object
33012 additionalProperties:
33013 type: object
33014 properties:
33015 comment:
33016 type: string
33017 domain:
33018 type: string
33019 expiry:
33020 type: string
33021 format: date-time
33022 httpOnly:
33023 type: boolean
33024 maxAge:
33025 type: integer
33026 format: int32
33027 name:
33028 type: string
33029 path:
33030 type: string
33031 secure:
33032 type: boolean
33033 value:
33034 type: string
33035 version:
33036 type: integer
33037 format: int32
33038 date:
33039 type: string
33040 format: date-time
33041 entity:
33042 type: object
33043 entityTag:
33044 type: object
33045 properties:
33046 value:
33047 type: string
33048 weak:
33049 type: boolean
33050 headers:
33051 type: object
33052 additionalProperties:
33053 type: array
33054 items:
33055 type: object
33056 language:
33057 type: object
33058 properties:
33059 country:
33060 type: string
33061 displayCountry:
33062 type: string
33063 displayLanguage:
33064 type: string
33065 displayName:
33066 type: string
33067 displayScript:
33068 type: string
33069 displayVariant:
33070 type: string
33071 extensionKeys:
33072 type: array
33073 items:
33074 type: string
33075 uniqueItems: true
33076 iso3Country:
33077 type: string
33078 iso3Language:
33079 type: string
33080 language:
33081 type: string
33082 script:
33083 type: string
33084 unicodeLocaleAttributes:
33085 type: array
33086 items:
33087 type: string
33088 uniqueItems: true
33089 unicodeLocaleKeys:
33090 type: array
33091 items:
33092 type: string
33093 uniqueItems: true
33094 variant:
33095 type: string
33096 lastModified:
33097 type: string
33098 format: date-time
33099 length:
33100 type: integer
33101 format: int32
33102 links:
33103 type: array
33104 items:
33105 type: object
33106 properties:
33107 params:
33108 type: object
33109 additionalProperties:
33110 type: string
33111 rel:
33112 type: string
33113 rels:
33114 type: array
33115 items:
33116 type: string
33117 title:
33118 type: string
33119 type:
33120 type: string
33121 uri:
33122 type: string
33123 format: uri
33124 uriBuilder:
33125 type: object
33126 uniqueItems: true
33127 location:
33128 type: string
33129 format: uri
33130 mediaType:
33131 type: object
33132 properties:
33133 parameters:
33134 type: object
33135 additionalProperties:
33136 type: string
33137 subtype:
33138 type: string
33139 type:
33140 type: string
33141 wildcardSubtype:
33142 type: boolean
33143 wildcardType:
33144 type: boolean
33145 metadata:
33146 type: object
33147 additionalProperties:
33148 type: array
33149 items:
33150 type: object
33151 status:
33152 type: integer
33153 format: int32
33154 statusInfo:
33155 type: object
33156 properties:
33157 family:
33158 type: string
33159 enum:
33160 - INFORMATIONAL
33161 - SUCCESSFUL
33162 - REDIRECTION
33163 - CLIENT_ERROR
33164 - SERVER_ERROR
33165 - OTHER
33166 reasonPhrase:
33167 type: string
33168 statusCode:
33169 type: integer
33170 format: int32
33171 stringHeaders:
33172 type: object
33173 additionalProperties:
33174 type: array
33175 items:
33176 type: string
33177 servers:
33178 - url: /sdc2/rest
33179 variables: {}
33180 summary: Retrieve previus and current catalog update time
33181 tags:
33182 - SDCE-2 APIs
33183 /v1/categories/{componentType}:
33184 get:
33185 description: Retrieve the list of all resource/service/product categories/sub-categories/groupings
33186 operationId: getComponentCategories
33187 parameters:
33188 - description: allowed values are resources / services/ products
33189 in: path
33190 name: componentType
33191 required: true
33192 schema:
33193 type: string
33194 enum:
33195 - resources
33196 - services
33197 - products
33198 - in: header
33199 name: USER_ID
33200 schema:
33201 type: string
33202 responses:
33203 "200":
33204 description: Returns categories Ok
33205 "400":
33206 description: Invalid component type
33207 "403":
33208 description: Missing information
33209 "409":
33210 description: Restricted operation
33211 "500":
33212 description: Internal Server Error
33213 default:
33214 content:
33215 application/json:
33216 schema:
33217 type: array
33218 items:
33219 type: object
33220 properties:
33221 allowedMethods:
33222 type: array
33223 items:
33224 type: string
33225 uniqueItems: true
33226 cookies:
33227 type: object
33228 additionalProperties:
33229 type: object
33230 properties:
33231 comment:
33232 type: string
33233 domain:
33234 type: string
33235 expiry:
33236 type: string
33237 format: date-time
33238 httpOnly:
33239 type: boolean
33240 maxAge:
33241 type: integer
33242 format: int32
33243 name:
33244 type: string
33245 path:
33246 type: string
33247 secure:
33248 type: boolean
33249 value:
33250 type: string
33251 version:
33252 type: integer
33253 format: int32
33254 date:
33255 type: string
33256 format: date-time
33257 entity:
33258 type: object
33259 entityTag:
33260 type: object
33261 properties:
33262 value:
33263 type: string
33264 weak:
33265 type: boolean
33266 headers:
33267 type: object
33268 additionalProperties:
33269 type: array
33270 items:
33271 type: object
33272 language:
33273 type: object
33274 properties:
33275 country:
33276 type: string
33277 displayCountry:
33278 type: string
33279 displayLanguage:
33280 type: string
33281 displayName:
33282 type: string
33283 displayScript:
33284 type: string
33285 displayVariant:
33286 type: string
33287 extensionKeys:
33288 type: array
33289 items:
33290 type: string
33291 uniqueItems: true
33292 iso3Country:
33293 type: string
33294 iso3Language:
33295 type: string
33296 language:
33297 type: string
33298 script:
33299 type: string
33300 unicodeLocaleAttributes:
33301 type: array
33302 items:
33303 type: string
33304 uniqueItems: true
33305 unicodeLocaleKeys:
33306 type: array
33307 items:
33308 type: string
33309 uniqueItems: true
33310 variant:
33311 type: string
33312 lastModified:
33313 type: string
33314 format: date-time
33315 length:
33316 type: integer
33317 format: int32
33318 links:
33319 type: array
33320 items:
33321 type: object
33322 properties:
33323 params:
33324 type: object
33325 additionalProperties:
33326 type: string
33327 rel:
33328 type: string
33329 rels:
33330 type: array
33331 items:
33332 type: string
33333 title:
33334 type: string
33335 type:
33336 type: string
33337 uri:
33338 type: string
33339 format: uri
33340 uriBuilder:
33341 type: object
33342 uniqueItems: true
33343 location:
33344 type: string
33345 format: uri
33346 mediaType:
33347 type: object
33348 properties:
33349 parameters:
33350 type: object
33351 additionalProperties:
33352 type: string
33353 subtype:
33354 type: string
33355 type:
33356 type: string
33357 wildcardSubtype:
33358 type: boolean
33359 wildcardType:
33360 type: boolean
33361 metadata:
33362 type: object
33363 additionalProperties:
33364 type: array
33365 items:
33366 type: object
33367 status:
33368 type: integer
33369 format: int32
33370 statusInfo:
33371 type: object
33372 properties:
33373 family:
33374 type: string
33375 enum:
33376 - INFORMATIONAL
33377 - SUCCESSFUL
33378 - REDIRECTION
33379 - CLIENT_ERROR
33380 - SERVER_ERROR
33381 - OTHER
33382 reasonPhrase:
33383 type: string
33384 statusCode:
33385 type: integer
33386 format: int32
33387 stringHeaders:
33388 type: object
33389 additionalProperties:
33390 type: array
33391 items:
33392 type: string
33393 servers:
33394 - url: /sdc2/rest
33395 variables: {}
33396 summary: Retrieve the list of all resource/service/product categories/sub-categories/groupings.
33397 tags:
33398 - SDCE-2 APIs
33399 /v1/category/{componentType}:
33400 post:
33401 description: Create new component category
33402 operationId: createComponentCategory
33403 parameters:
33404 - description: allowed values are resources /services / products
33405 in: path
33406 name: componentType
33407 required: true
33408 schema:
33409 type: string
33410 enum:
33411 - resources
33412 - services
33413 - products
33414 - in: header
33415 name: USER_ID
33416 schema:
33417 type: string
33418 requestBody:
33419 content:
33420 application/json:
33421 schema:
33422 type: string
33423 description: Category to be created
33424 required: true
33425 responses:
33426 "201":
33427 description: Category created
33428 "400":
33429 description: Invalid category data
33430 "403":
33431 description: USER_ID header is missing
33432 "409":
33433 description: Category already exists / User not permitted to perform the
33434 action
33435 "500":
33436 description: General Error
33437 servers:
33438 - url: /sdc2/rest
33439 variables: {}
33440 summary: Create new component category
33441 tags:
33442 - SDCE-2 APIs
33443 /v1/category/{componentType}/{categoryId}/subCategory:
33444 post:
33445 description: Create new component sub-category
33446 operationId: createComponentSubCategory
33447 parameters:
33448 - description: allowed values are resources / products
33449 in: path
33450 name: componentType
33451 required: true
33452 schema:
33453 type: string
33454 enum:
33455 - resources
33456 - products
33457 - description: Parent category unique ID
33458 in: path
33459 name: categoryId
33460 required: true
33461 schema:
33462 type: string
33463 - in: header
33464 name: USER_ID
33465 schema:
33466 type: string
33467 requestBody:
33468 content:
33469 application/json:
33470 schema:
33471 type: string
33472 description: "Subcategory to be created. \ne.g. {\"name\":\"Resource-subcat\"\
33473 }"
33474 required: true
33475 responses:
33476 "201":
33477 description: Subcategory created
33478 "400":
33479 description: Invalid subcategory data
33480 "403":
33481 description: USER_ID header is missing
33482 "404":
33483 description: Parent category wasn't found
33484 "409":
33485 description: Subcategory already exists / User not permitted to perform
33486 the action
33487 "500":
33488 description: General Error
33489 servers:
33490 - url: /sdc2/rest
33491 variables: {}
33492 summary: Create new component sub-category for existing category
33493 tags:
33494 - SDCE-2 APIs
33495 /v1/category/{componentType}/{categoryId}/subCategory/{subCategoryId}/grouping:
33496 post:
33497 description: Create new component grouping
33498 operationId: createComponentGrouping
33499 parameters:
33500 - description: allowed values are products
33501 in: path
33502 name: componentType
33503 required: true
33504 schema:
33505 type: string
33506 enum:
33507 - products
33508 - description: Parent category unique ID
33509 in: path
33510 name: categoryId
33511 required: true
33512 schema:
33513 type: string
33514 - description: Parent sub-category unique ID
33515 in: path
33516 name: subCategoryId
33517 required: true
33518 schema:
33519 type: string
33520 - in: header
33521 name: USER_ID
33522 schema:
33523 type: string
33524 requestBody:
33525 content:
33526 application/json:
33527 schema:
33528 type: string
33529 description: Subcategory to be created
33530 required: true
33531 responses:
33532 "201":
33533 description: Grouping created
33534 "400":
33535 description: Invalid grouping data
33536 "403":
33537 description: USER_ID header is missing
33538 "404":
33539 description: Parent category or subcategory were not found
33540 "409":
33541 description: Grouping already exists / User not permitted to perform the
33542 action
33543 "500":
33544 description: General Error
33545 servers:
33546 - url: /sdc2/rest
33547 variables: {}
33548 summary: Create new component grouping for existing sub-category
33549 tags:
33550 - SDCE-2 APIs
33551 /v1/category/{componentType}/{categoryName}/baseTypes:
33552 get:
33553 description: Get base types for category
33554 operationId: getCategoryBaseTypes
33555 parameters:
33556 - in: path
33557 name: categoryName
33558 required: true
33559 schema:
33560 type: string
33561 - in: path
33562 name: componentType
33563 required: true
33564 schema:
33565 type: string
33566 - in: header
33567 name: USER_ID
33568 schema:
33569 type: string
33570 - description: model
33571 in: query
33572 name: model
33573 schema:
33574 type: string
33575 responses:
33576 "200":
33577 description: Returns base types Ok
33578 "404":
33579 description: No base types were found
33580 "500":
33581 description: Internal Server Error
33582 servers:
33583 - url: /sdc2/rest
33584 variables: {}
33585 summary: Get base types for category
33586 tags:
33587 - SDCE-2 APIs
33588 /v1/category/{componentType}/{categoryUniqueId}:
33589 delete:
33590 description: Delete component category
33591 operationId: deleteComponentCategory
33592 parameters:
33593 - in: path
33594 name: categoryUniqueId
33595 required: true
33596 schema:
33597 type: string
33598 - in: path
33599 name: componentType
33600 required: true
33601 schema:
33602 type: string
33603 - in: header
33604 name: USER_ID
33605 schema:
33606 type: string
33607 responses:
33608 "204":
33609 description: Category deleted
33610 "403":
33611 description: USER_ID header is missing
33612 "404":
33613 description: Category not found
33614 "409":
33615 description: User not permitted to perform the action
33616 "500":
33617 description: General Error
33618 default:
33619 content:
33620 application/json:
33621 schema:
33622 type: array
33623 items:
33624 $ref: '#/components/schemas/Category'
33625 servers:
33626 - url: /sdc2/rest
33627 variables: {}
33628 summary: Delete component category
33629 tags:
33630 - SDCE-2 APIs
33631 /v1/category/{componentType}/{categoryUniqueId}/subCategory/{subCategoryUniqueId}:
33632 delete:
33633 description: Delete component category
33634 operationId: deleteComponentSubCategory
33635 parameters:
33636 - in: path
33637 name: categoryUniqueId
33638 required: true
33639 schema:
33640 type: string
33641 - in: path
33642 name: subCategoryUniqueId
33643 required: true
33644 schema:
33645 type: string
33646 - in: path
33647 name: componentType
33648 required: true
33649 schema:
33650 type: string
33651 - in: header
33652 name: USER_ID
33653 schema:
33654 type: string
33655 responses:
33656 "204":
33657 description: Category deleted
33658 "403":
33659 description: USER_ID header is missing
33660 "404":
33661 description: Category not found
33662 "409":
33663 description: User not permitted to perform the action
33664 "500":
33665 description: General Error
33666 default:
33667 content:
33668 application/json:
33669 schema:
33670 type: array
33671 items:
33672 $ref: '#/components/schemas/Category'
33673 servers:
33674 - url: /sdc2/rest
33675 variables: {}
33676 summary: Delete component category
33677 tags:
33678 - SDCE-2 APIs
33679 /v1/category/{componentType}/{categoryUniqueId}/subCategory/{subCategoryUniqueId}/grouping/{groupingUniqueId}:
33680 delete:
33681 description: Delete component category
33682 operationId: deleteComponentGrouping
33683 parameters:
33684 - in: path
33685 name: categoryUniqueId
33686 required: true
33687 schema:
33688 type: string
33689 - in: path
33690 name: subCategoryUniqueId
33691 required: true
33692 schema:
33693 type: string
33694 - in: path
33695 name: groupingUniqueId
33696 required: true
33697 schema:
33698 type: string
33699 - in: path
33700 name: componentType
33701 required: true
33702 schema:
33703 type: string
33704 - in: header
33705 name: USER_ID
33706 schema:
33707 type: string
33708 responses:
33709 "204":
33710 description: Category deleted
33711 "403":
33712 description: USER_ID header is missing
33713 "404":
33714 description: Category not found
33715 "409":
33716 description: User not permitted to perform the action
33717 "500":
33718 description: General Error
33719 default:
33720 content:
33721 application/json:
33722 schema:
33723 type: array
33724 items:
33725 $ref: '#/components/schemas/Category'
33726 servers:
33727 - url: /sdc2/rest
33728 variables: {}
33729 summary: Delete component category
33730 tags:
33731 - SDCE-2 APIs
33732 /v1/consumers:
33733 post:
33734 description: Consumer credentials
33735 operationId: createConsumer
33736 parameters:
33737 - in: header
33738 name: USER_ID
33739 schema:
33740 type: string
33741 requestBody:
33742 content:
33743 application/json:
33744 schema:
33745 type: string
33746 description: Consumer Object to be created
33747 required: true
33748 responses:
33749 "201":
33750 description: Consumer credentials created
33751 "400":
33752 description: Invalid content / Missing content
33753 "403":
33754 description: Restricted operation
33755 default:
33756 content:
33757 application/json:
33758 schema:
33759 type: array
33760 items:
33761 type: object
33762 properties:
33763 allowedMethods:
33764 type: array
33765 items:
33766 type: string
33767 uniqueItems: true
33768 cookies:
33769 type: object
33770 additionalProperties:
33771 type: object
33772 properties:
33773 comment:
33774 type: string
33775 domain:
33776 type: string
33777 expiry:
33778 type: string
33779 format: date-time
33780 httpOnly:
33781 type: boolean
33782 maxAge:
33783 type: integer
33784 format: int32
33785 name:
33786 type: string
33787 path:
33788 type: string
33789 secure:
33790 type: boolean
33791 value:
33792 type: string
33793 version:
33794 type: integer
33795 format: int32
33796 date:
33797 type: string
33798 format: date-time
33799 entity:
33800 type: object
33801 entityTag:
33802 type: object
33803 properties:
33804 value:
33805 type: string
33806 weak:
33807 type: boolean
33808 headers:
33809 type: object
33810 additionalProperties:
33811 type: array
33812 items:
33813 type: object
33814 language:
33815 type: object
33816 properties:
33817 country:
33818 type: string
33819 displayCountry:
33820 type: string
33821 displayLanguage:
33822 type: string
33823 displayName:
33824 type: string
33825 displayScript:
33826 type: string
33827 displayVariant:
33828 type: string
33829 extensionKeys:
33830 type: array
33831 items:
33832 type: string
33833 uniqueItems: true
33834 iso3Country:
33835 type: string
33836 iso3Language:
33837 type: string
33838 language:
33839 type: string
33840 script:
33841 type: string
33842 unicodeLocaleAttributes:
33843 type: array
33844 items:
33845 type: string
33846 uniqueItems: true
33847 unicodeLocaleKeys:
33848 type: array
33849 items:
33850 type: string
33851 uniqueItems: true
33852 variant:
33853 type: string
33854 lastModified:
33855 type: string
33856 format: date-time
33857 length:
33858 type: integer
33859 format: int32
33860 links:
33861 type: array
33862 items:
33863 type: object
33864 properties:
33865 params:
33866 type: object
33867 additionalProperties:
33868 type: string
33869 rel:
33870 type: string
33871 rels:
33872 type: array
33873 items:
33874 type: string
33875 title:
33876 type: string
33877 type:
33878 type: string
33879 uri:
33880 type: string
33881 format: uri
33882 uriBuilder:
33883 type: object
33884 uniqueItems: true
33885 location:
33886 type: string
33887 format: uri
33888 mediaType:
33889 type: object
33890 properties:
33891 parameters:
33892 type: object
33893 additionalProperties:
33894 type: string
33895 subtype:
33896 type: string
33897 type:
33898 type: string
33899 wildcardSubtype:
33900 type: boolean
33901 wildcardType:
33902 type: boolean
33903 metadata:
33904 type: object
33905 additionalProperties:
33906 type: array
33907 items:
33908 type: object
33909 status:
33910 type: integer
33911 format: int32
33912 statusInfo:
33913 type: object
33914 properties:
33915 family:
33916 type: string
33917 enum:
33918 - INFORMATIONAL
33919 - SUCCESSFUL
33920 - REDIRECTION
33921 - CLIENT_ERROR
33922 - SERVER_ERROR
33923 - OTHER
33924 reasonPhrase:
33925 type: string
33926 statusCode:
33927 type: integer
33928 format: int32
33929 stringHeaders:
33930 type: object
33931 additionalProperties:
33932 type: array
33933 items:
33934 type: string
33935 servers:
33936 - url: /sdc2/rest
33937 variables: {}
33938 summary: Returns created ECOMP consumer credentials
33939 tags:
33940 - SDCE-2 APIs
33941 /v1/consumers/{consumerId}:
33942 delete:
33943 description: Deletes Consumer
33944 operationId: deleteConsumer
33945 parameters:
33946 - in: path
33947 name: consumerId
33948 required: true
33949 schema:
33950 type: string
33951 - in: header
33952 name: USER_ID
33953 schema:
33954 type: string
33955 responses:
33956 "204":
33957 description: Consumer deleted
33958 "403":
33959 description: Restricted operation
33960 "404":
33961 description: Consumer not found
33962 default:
33963 content:
33964 application/json:
33965 schema:
33966 type: array
33967 items:
33968 $ref: '#/components/schemas/ConsumerDefinition'
33969 servers:
33970 - url: /sdc2/rest
33971 variables: {}
33972 summary: Returns deleted consumer according to ConsumerID
33973 tags:
33974 - SDCE-2 APIs
33975 get:
33976 description: Retrieve Consumer
33977 operationId: getConsumer
33978 parameters:
33979 - in: path
33980 name: consumerId
33981 required: true
33982 schema:
33983 type: string
33984 - in: header
33985 name: USER_ID
33986 schema:
33987 type: string
33988 responses:
33989 "200":
33990 description: Consumer found
33991 "403":
33992 description: Restricted operation
33993 "404":
33994 description: Consumer not found
33995 default:
33996 content:
33997 application/json:
33998 schema:
33999 type: array
34000 items:
34001 $ref: '#/components/schemas/ConsumerDefinition'
34002 servers:
34003 - url: /sdc2/rest
34004 variables: {}
34005 summary: Returns consumer according to ConsumerID
34006 tags:
34007 - SDCE-2 APIs
34008 /v1/ecompPortalMenu:
34009 get:
34010 description: Retrieve ecomp portal menu - MOC
34011 operationId: getListOfCsars
34012 responses:
34013 "200":
34014 description: Retrieve ecomp portal menu
34015 default:
34016 content:
34017 application/json:
34018 schema:
34019 type: array
34020 items:
34021 $ref: '#/components/schemas/User'
34022 servers:
34023 - url: /sdc2/rest
34024 variables: {}
34025 summary: Retrieve ecomp portal menu
34026 tags:
34027 - SDCE-2 APIs
34028 /v1/followed:
34029 get:
34030 description: Retrieve all followed
34031 operationId: getFollowedResourcesServices
34032 parameters:
34033 - in: header
34034 name: USER_ID
34035 schema:
34036 type: string
34037 responses:
34038 "200":
34039 description: Returns followed Ok
34040 "404":
34041 description: User not found
34042 "500":
34043 description: Internal Server Error
34044 default:
34045 content:
34046 application/json:
34047 schema:
34048 type: array
34049 items:
34050 $ref: '#/components/schemas/User'
34051 servers:
34052 - url: /sdc2/rest
34053 variables: {}
34054 summary: Retrieve all followed
34055 tags:
34056 - SDCE-2 APIs
34057 /v1/inactiveComponents/{componentType}:
34058 delete:
34059 operationId: deleteMarkedResources
34060 parameters:
34061 - in: path
34062 name: componentType
34063 required: true
34064 schema:
34065 type: string
34066 responses:
34067 default:
34068 content:
34069 '*/*': {}
34070 description: default response
34071 servers:
34072 - url: /sdc2/rest
34073 variables: {}
34074 tags:
34075 - SDCE-2 APIs
34076 /v1/propertyScopes:
34077 get:
34078 description: Retrieve all propertyScopes
34079 operationId: getPropertyScopes
34080 parameters:
34081 - in: header
34082 name: USER_ID
34083 schema:
34084 type: string
34085 responses:
34086 "200":
34087 description: Returns propertyScopes Ok
34088 "404":
34089 description: No propertyScopes were found
34090 "500":
34091 description: Internal Server Error
34092 default:
34093 content:
34094 application/json:
34095 schema:
34096 type: array
34097 items:
34098 $ref: '#/components/schemas/User'
34099 servers:
34100 - url: /sdc2/rest
34101 variables: {}
34102 summary: Retrieve all propertyScopes
34103 tags:
34104 - SDCE-2 APIs
34105 /v1/screen:
34106 get:
34107 description: Retrieve catalog resources and services
34108 operationId: getCatalogComponents
34109 parameters:
34110 - in: header
34111 name: USER_ID
34112 schema:
34113 type: string
34114 - in: query
34115 name: excludeTypes
34116 schema:
34117 type: array
34118 items:
34119 type: string
34120 enum:
34121 - PRODUCT
34122 - SERVICE
34123 - VF
34124 - VFC
34125 - CP
34126 - VL
34127 - Configuration
34128 - VFCMT
34129 - CVFC
34130 - PNF
34131 - CR
34132 - ServiceProxy
34133 - ServiceSubstitution
34134 responses:
34135 "200":
34136 description: Returns resources and services Ok
34137 "404":
34138 description: User not found
34139 "500":
34140 description: Internal Server Error
34141 default:
34142 content:
34143 application/json:
34144 schema:
34145 type: array
34146 items:
34147 $ref: '#/components/schemas/User'
34148 servers:
34149 - url: /sdc2/rest
34150 variables: {}
34151 summary: Retrieve catalog resources and services
34152 tags:
34153 - SDCE-2 APIs
34154 /v1/setup/ui:
34155 get:
34156 description: "Retrieve all artifactTypes, ui configuration and sdc version"
34157 operationId: getConfCategoriesAndVersion_1
34158 parameters:
34159 - in: header
34160 name: USER_ID
34161 schema:
34162 type: string
34163 responses:
34164 "200":
34165 description: "Returns artifactTypes, ui configuration and sdc version Ok"
34166 "404":
34167 description: No artifactTypes were found/no ui configuration were found/no
34168 sdc version were found
34169 "500":
34170 description: Internal Server Error
34171 default:
34172 content:
34173 application/json:
34174 schema:
34175 type: array
34176 items:
34177 $ref: '#/components/schemas/User'
34178 servers:
34179 - url: /sdc2/rest
34180 variables: {}
34181 summary: "Retrieve all artifactTypes, ui configuration and sdc version"
34182 tags:
34183 - SDCE-2 APIs
34184 /v1/tags:
34185 get:
34186 description: Retrieve all tags
34187 operationId: getTags
34188 parameters:
34189 - in: header
34190 name: USER_ID
34191 schema:
34192 type: string
34193 responses:
34194 "200":
34195 description: Returns tags Ok
34196 "404":
34197 description: No tags were found
34198 "500":
34199 description: Internal Server Error
34200 default:
34201 content:
34202 application/json:
34203 schema:
34204 type: array
34205 items:
34206 $ref: '#/components/schemas/User'
34207 servers:
34208 - url: /sdc2/rest
34209 variables: {}
34210 summary: Retrieve all tags
34211 tags:
34212 - SDCE-2 APIs
34213 /v1/user:
34214 post:
34215 description: add user
34216 operationId: createUser
34217 parameters:
34218 - in: header
34219 name: USER_ID
34220 schema:
34221 type: string
34222 requestBody:
34223 content:
34224 application/json:
34225 schema:
34226 $ref: '#/components/schemas/User'
34227 description: json describe the user
34228 required: true
34229 responses:
34230 "201":
34231 description: New user created
34232 "400":
34233 description: Invalid Content.
34234 "403":
34235 description: Missing information
34236 "405":
34237 description: Method Not Allowed
34238 "409":
34239 description: User already exists
34240 "500":
34241 description: Internal Server Error
34242 default:
34243 content:
34244 application/json:
34245 schema:
34246 type: array
34247 items:
34248 $ref: '#/components/schemas/User'
34249 servers:
34250 - url: /sdc2/rest
34251 variables: {}
34252 summary: Provision new user
34253 tags:
34254 - SDCE-2 APIs
34255 /v1/user/admins:
34256 get:
34257 description: retrieve all administrators
34258 operationId: getAdminsUser
34259 responses:
34260 "200":
34261 description: Returns user Ok
34262 "405":
34263 description: Method Not Allowed
34264 "500":
34265 description: Internal Server Error
34266 default:
34267 content:
34268 application/json:
34269 schema:
34270 type: array
34271 items:
34272 $ref: '#/components/schemas/User'
34273 servers:
34274 - url: /sdc2/rest
34275 variables: {}
34276 summary: Returns all administrators
34277 tags:
34278 - SDCE-2 APIs
34279 /v1/user/authorize:
34280 get:
34281 description: authorize
34282 operationId: authorize
34283 parameters:
34284 - in: header
34285 name: USER_ID
34286 schema:
34287 type: string
34288 - in: header
34289 name: HTTP_CSP_FIRSTNAME
34290 schema:
34291 type: string
34292 - in: header
34293 name: HTTP_CSP_LASTNAME
34294 schema:
34295 type: string
34296 - in: header
34297 name: HTTP_CSP_EMAIL
34298 schema:
34299 type: string
34300 responses:
34301 "200":
34302 description: Returns user Ok
34303 "403":
34304 description: Restricted Access
34305 "500":
34306 description: Internal Server Error
34307 default:
34308 content:
34309 application/json:
34310 schema:
34311 type: array
34312 items:
34313 $ref: '#/components/schemas/User'
34314 servers:
34315 - url: /sdc2/rest
34316 variables: {}
34317 summary: authorize user
34318 tags:
34319 - SDCE-2 APIs
34320 /v1/user/users:
34321 get:
34322 description: Retrieve the list of all active ASDC users or only group of users
34323 having specific roles.
34324 operationId: getUsersList
34325 parameters:
34326 - description: 'Any active user''s USER_ID '
34327 in: header
34328 name: USER_ID
34329 schema:
34330 type: string
34331 - description: "TESTER,DESIGNER,PRODUCT_STRATEGIST,OPS,PRODUCT_MANAGER,GOVERNOR,\
34332 \ ADMIN OR all users by not typing anything"
34333 in: query
34334 name: roles
34335 schema:
34336 type: string
34337 responses:
34338 "200":
34339 description: Returns users Ok
34340 "204":
34341 description: No provisioned ASDC users of requested role
34342 "400":
34343 description: Missing content
34344 "403":
34345 description: Restricted Access
34346 "500":
34347 description: Internal Server Error
34348 default:
34349 content:
34350 application/json:
34351 schema:
34352 type: array
34353 items:
34354 $ref: '#/components/schemas/User'
34355 servers:
34356 - url: /sdc2/rest
34357 variables: {}
34358 summary: "Returns list of users with the specified roles, or all of users in\
34359 \ the case of empty 'roles' header"
34360 tags:
34361 - SDCE-2 APIs
34362 /v1/user/{userId}:
34363 delete:
34364 description: delete user
34365 operationId: deActivateUser
34366 parameters:
34367 - description: userId of user to get
34368 in: path
34369 name: userId
34370 required: true
34371 schema:
34372 type: string
34373 - in: header
34374 name: USER_ID
34375 schema:
34376 type: string
34377 responses:
34378 "200":
34379 description: Update deleted OK
34380 "400":
34381 description: Invalid Content.
34382 "403":
34383 description: Missing information
34384 "404":
34385 description: User not found
34386 "405":
34387 description: Method Not Allowed
34388 "409":
34389 description: Restricted operation
34390 "500":
34391 description: Internal Server Error
34392 default:
34393 content:
34394 application/json:
34395 schema:
34396 type: array
34397 items:
34398 $ref: '#/components/schemas/User'
34399 servers:
34400 - url: /sdc2/rest
34401 variables: {}
34402 summary: Delete user
34403 tags:
34404 - SDCE-2 APIs
34405 get:
34406 description: retrieve user details
34407 operationId: get
34408 parameters:
34409 - description: userId of user to get
34410 in: path
34411 name: userId
34412 required: true
34413 schema:
34414 type: string
34415 responses:
34416 "200":
34417 description: Returns user Ok
34418 "404":
34419 description: User not found
34420 "405":
34421 description: Method Not Allowed
34422 "500":
34423 description: Internal Server Error
34424 default:
34425 content:
34426 application/json:
34427 schema:
34428 type: array
34429 items:
34430 $ref: '#/components/schemas/User'
34431 servers:
34432 - url: /sdc2/rest
34433 variables: {}
34434 summary: Returns user details according to userId
34435 tags:
34436 - SDCE-2 APIs
34437 /v1/user/{userId}/role:
34438 get:
34439 description: retrieve user role
34440 operationId: getRole
34441 parameters:
34442 - description: userId of user to get
34443 in: path
34444 name: userId
34445 required: true
34446 schema:
34447 type: string
34448 responses:
34449 "200":
34450 description: Returns user role Ok
34451 "404":
34452 description: User not found
34453 "405":
34454 description: Method Not Allowed
34455 "500":
34456 description: Internal Server Error
34457 default:
34458 content:
34459 application/json:
34460 schema:
34461 type: array
34462 items:
34463 type: string
34464 servers:
34465 - url: /sdc2/rest
34466 variables: {}
34467 summary: Returns user role according to userId
34468 tags:
34469 - SDCE-2 APIs
34470 post:
34471 description: update user role
34472 operationId: updateUserRole
34473 parameters:
34474 - description: userId of user to get
34475 in: path
34476 name: userId
34477 required: true
34478 schema:
34479 type: string
34480 - in: header
34481 name: USER_ID
34482 schema:
34483 type: string
34484 requestBody:
34485 content:
34486 application/json:
34487 schema:
34488 $ref: '#/components/schemas/UserRole'
34489 description: json describe the update role
34490 required: true
34491 responses:
34492 "200":
34493 description: Update user OK
34494 "400":
34495 description: Invalid Content.
34496 "403":
34497 description: Missing information/Restricted operation
34498 "404":
34499 description: User not found
34500 "405":
34501 description: Method Not Allowed
34502 "409":
34503 description: User already exists
34504 "500":
34505 description: Internal Server Error
34506 default:
34507 content:
34508 application/json:
34509 schema:
34510 type: array
34511 items:
34512 $ref: '#/components/schemas/User'
34513 servers:
34514 - url: /sdc2/rest
34515 variables: {}
34516 summary: Update user role
34517 tags:
34518 - SDCE-2 APIs
34519components:
34520 schemas:
34521 AdditionalInfoParameterInfo:
34522 type: object
34523 properties:
34524 empty:
34525 type: boolean
34526 key:
34527 type: string
34528 ownerId:
34529 type: string
34530 ownerIdIfEmpty:
34531 type: string
34532 writeOnly: true
34533 type:
34534 type: string
34535 uniqueId:
34536 type: string
34537 value:
34538 type: string
34539 version:
34540 type: string
34541 AdditionalInformationDefinition:
34542 type: object
34543 properties:
34544 creationTime:
34545 type: integer
34546 format: int64
34547 empty:
34548 type: boolean
34549 lastCreatedCounter:
34550 type: integer
34551 format: int32
34552 modificationTime:
34553 type: integer
34554 format: int64
34555 ownerId:
34556 type: string
34557 ownerIdIfEmpty:
34558 type: string
34559 writeOnly: true
34560 parameters:
34561 type: array
34562 items:
34563 $ref: '#/components/schemas/AdditionalInfoParameterInfo'
34564 parentUniqueId:
34565 type: string
34566 type:
34567 type: string
34568 uniqueId:
34569 type: string
34570 version:
34571 type: string
34572 Annotation:
34573 type: object
34574 properties:
34575 description:
34576 type: string
34577 name:
34578 type: string
34579 properties:
34580 type: array
34581 items:
34582 $ref: '#/components/schemas/PropertyDataDefinition'
34583 type:
34584 type: string
34585 ApplicationL1CacheCatalogInfo:
34586 type: object
34587 properties:
34588 enabled:
34589 type: boolean
34590 productsSizeInCache:
34591 type: integer
34592 format: int32
34593 resourcesSizeInCache:
34594 type: integer
34595 format: int32
34596 servicesSizeInCache:
34597 type: integer
34598 format: int32
34599 ApplicationL1CacheConfig:
34600 type: object
34601 properties:
34602 datatypes:
34603 $ref: '#/components/schemas/ApplicationL1CacheInfo'
34604 ApplicationL1CacheInfo:
34605 type: object
34606 properties:
34607 enabled:
34608 type: boolean
34609 firstRunDelay:
34610 type: integer
34611 format: int32
34612 pollIntervalInSec:
34613 type: integer
34614 format: int32
34615 ApplicationL2CacheConfig:
34616 type: object
34617 properties:
34618 catalogL1Cache:
34619 $ref: '#/components/schemas/ApplicationL1CacheCatalogInfo'
34620 enabled:
34621 type: boolean
34622 queue:
34623 $ref: '#/components/schemas/QueueInfo'
34624 ArtifactConfiguration:
34625 type: object
34626 properties:
34627 acceptedTypes:
34628 type: array
34629 items:
34630 type: string
34631 categories:
34632 type: array
34633 items:
34634 type: string
34635 enum:
34636 - INFORMATIONAL
34637 - DEPLOYMENT
34638 - LIFE_CYCLE
34639 - SERVICE_API
34640 - TOSCA
34641 - OTHER
34642 componentTypes:
34643 type: array
34644 items:
34645 type: string
34646 enum:
34647 - RESOURCE
34648 - SERVICE
34649 - RESOURCE_INSTANCE
34650 - SERVICE_INSTANCE
34651 resourceTypes:
34652 type: array
34653 items:
34654 type: string
34655 type:
34656 type: string
34657 ArtifactDataDefinition:
34658 type: object
34659 properties:
34660 apiUrl:
34661 type: string
34662 artifactChecksum:
34663 type: string
34664 artifactCreator:
34665 type: string
34666 artifactDisplayName:
34667 type: string
34668 artifactGroupType:
34669 type: string
34670 enum:
34671 - INFORMATIONAL
34672 - DEPLOYMENT
34673 - LIFE_CYCLE
34674 - SERVICE_API
34675 - TOSCA
34676 - OTHER
34677 artifactLabel:
34678 type: string
34679 artifactName:
34680 type: string
34681 artifactRef:
34682 type: string
34683 artifactRepository:
34684 type: string
34685 artifactType:
34686 type: string
34687 artifactUUID:
34688 type: string
34689 artifactVersion:
34690 type: string
34691 creationDate:
34692 type: integer
34693 format: int64
34694 creatorFullName:
34695 type: string
34696 description:
34697 type: string
34698 duplicated:
34699 type: boolean
34700 empty:
34701 type: boolean
34702 esId:
34703 type: string
34704 generated:
34705 type: boolean
34706 generatedFromId:
34707 type: string
34708 heatEnvType:
34709 type: boolean
34710 heatParameters:
34711 type: array
34712 items:
34713 $ref: '#/components/schemas/HeatParameterDataDefinition'
34714 heatParamsUpdateDate:
34715 type: integer
34716 format: int64
34717 isFromCsar:
34718 type: boolean
34719 lastUpdateDate:
34720 type: integer
34721 format: int64
34722 mandatory:
34723 type: boolean
34724 ownerId:
34725 type: string
34726 ownerIdIfEmpty:
34727 type: string
34728 writeOnly: true
34729 payloadUpdateDate:
34730 type: integer
34731 format: int64
34732 properties:
34733 type: array
34734 items:
34735 $ref: '#/components/schemas/PropertyDataDefinition'
34736 requiredArtifacts:
34737 type: array
34738 items:
34739 type: string
34740 serviceApi:
34741 type: boolean
34742 timeout:
34743 type: integer
34744 format: int32
34745 type:
34746 type: string
34747 uniqueId:
34748 type: string
34749 updaterFullName:
34750 type: string
34751 userIdCreator:
34752 type: string
34753 userIdLastUpdater:
34754 type: string
34755 version:
34756 type: string
34757 ArtifactDefinition:
34758 type: object
34759 properties:
34760 apiUrl:
34761 type: string
34762 artifactChecksum:
34763 type: string
34764 artifactCreator:
34765 type: string
34766 artifactDisplayName:
34767 type: string
34768 artifactGroupType:
34769 type: string
34770 enum:
34771 - INFORMATIONAL
34772 - DEPLOYMENT
34773 - LIFE_CYCLE
34774 - SERVICE_API
34775 - TOSCA
34776 - OTHER
34777 artifactLabel:
34778 type: string
34779 artifactName:
34780 type: string
34781 artifactRef:
34782 type: string
34783 artifactRepository:
34784 type: string
34785 artifactType:
34786 type: string
34787 artifactUUID:
34788 type: string
34789 artifactVersion:
34790 type: string
34791 creationDate:
34792 type: integer
34793 format: int64
34794 creatorFullName:
34795 type: string
34796 description:
34797 type: string
34798 duplicated:
34799 type: boolean
34800 empty:
34801 type: boolean
34802 esId:
34803 type: string
34804 generated:
34805 type: boolean
34806 generatedFromId:
34807 type: string
34808 heatEnvType:
34809 type: boolean
34810 heatParamUpdated:
34811 type: boolean
34812 heatParameters:
34813 type: array
34814 items:
34815 $ref: '#/components/schemas/HeatParameterDataDefinition'
34816 heatParamsUpdateDate:
34817 type: integer
34818 format: int64
34819 isFromCsar:
34820 type: boolean
34821 lastUpdateDate:
34822 type: integer
34823 format: int64
34824 listHeatParameters:
34825 type: array
34826 items:
34827 $ref: '#/components/schemas/HeatParameterDefinition'
34828 mandatory:
34829 type: boolean
34830 ownerId:
34831 type: string
34832 ownerIdIfEmpty:
34833 type: string
34834 writeOnly: true
34835 payload:
34836 type: array
34837 items:
34838 type: string
34839 format: byte
34840 writeOnly: true
34841 payloadData:
34842 type: array
34843 items:
34844 type: string
34845 format: byte
34846 payloadUpdateDate:
34847 type: integer
34848 format: int64
34849 properties:
34850 type: array
34851 items:
34852 $ref: '#/components/schemas/PropertyDataDefinition'
34853 requiredArtifacts:
34854 type: array
34855 items:
34856 type: string
34857 serviceApi:
34858 type: boolean
34859 timeout:
34860 type: integer
34861 format: int32
34862 type:
34863 type: string
34864 uniqueId:
34865 type: string
34866 updaterFullName:
34867 type: string
34868 userIdCreator:
34869 type: string
34870 userIdLastUpdater:
34871 type: string
34872 version:
34873 type: string
34874 AttributeDefinition:
34875 type: object
34876 properties:
34877 attributeId:
34878 type: string
34879 defaultValue:
34880 type: string
34881 definition:
34882 type: boolean
34883 description:
34884 type: string
34885 empty:
34886 type: boolean
34887 entry_schema:
34888 $ref: '#/components/schemas/EntrySchema'
34889 getOutputAttribute:
34890 type: boolean
34891 getOutputValues:
34892 type: array
34893 items:
34894 $ref: '#/components/schemas/GetOutputValueDataDefinition'
34895 get_default:
34896 type: object
34897 instanceUniqueId:
34898 type: string
34899 model:
34900 type: string
34901 name:
34902 type: string
34903 outputId:
34904 type: string
34905 outputPath:
34906 type: string
34907 ownerId:
34908 type: string
34909 ownerIdIfEmpty:
34910 type: string
34911 writeOnly: true
34912 parentUniqueId:
34913 type: string
34914 schema:
34915 $ref: '#/components/schemas/SchemaDefinition'
34916 schemaType:
34917 type: string
34918 status:
34919 type: string
34920 type:
34921 type: string
34922 uniqueId:
34923 type: string
34924 value:
34925 type: string
34926 version:
34927 type: string
34928 BasicAuthConfig:
34929 type: object
34930 properties:
34931 enabled:
34932 type: boolean
34933 excludedUrls:
34934 type: string
34935 userName:
34936 type: string
34937 userPass:
34938 type: string
34939 BeMonitoringConfig:
34940 type: object
34941 properties:
34942 enabled:
34943 type: boolean
34944 isProxy:
34945 type: boolean
34946 probeIntervalInSeconds:
34947 type: integer
34948 format: int32
34949 CINodeFilterDataDefinition:
34950 type: object
34951 properties:
34952 capabilities:
34953 $ref: '#/components/schemas/ListDataDefinitionRequirementNodeFilterCapabilityDataDefinition'
34954 empty:
34955 type: boolean
34956 id:
34957 type: string
34958 name:
34959 type: string
34960 ownerId:
34961 type: string
34962 ownerIdIfEmpty:
34963 type: string
34964 writeOnly: true
34965 properties:
34966 $ref: '#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition'
34967 tosca_id:
34968 type: object
34969 type:
34970 type: string
34971 version:
34972 type: string
34973 CadiFilterParams:
34974 type: object
34975 properties:
34976 aafLocateUrl:
34977 type: string
34978 aaf_env:
34979 type: string
34980 aaf_id:
34981 type: string
34982 aaf_password:
34983 type: string
34984 aaf_url:
34985 type: string
34986 aft_ENVIRONMENT:
34987 type: string
34988 aft_LATITUDE:
34989 type: string
34990 aft_LONGITUDE:
34991 type: string
34992 cadiX509Issuers:
34993 type: string
34994 cadi_keyfile:
34995 type: string
34996 cadi_loglevel:
34997 type: string
34998 cadi_truststore:
34999 type: string
35000 cadi_truststore_password:
35001 type: string
35002 csp_domain:
35003 type: string
35004 hostname:
35005 type: string
35006 CapabilityDataDefinition:
35007 type: object
35008 properties:
35009 capabilitySources:
35010 type: array
35011 items:
35012 type: string
35013 description:
35014 type: string
35015 empty:
35016 type: boolean
35017 external:
35018 type: boolean
35019 externalName:
35020 type: string
35021 leftOccurrences:
35022 type: string
35023 maxOccurrences:
35024 type: string
35025 minOccurrences:
35026 type: string
35027 name:
35028 type: string
35029 ownerId:
35030 type: string
35031 ownerIdIfEmpty:
35032 type: string
35033 writeOnly: true
35034 ownerName:
35035 type: string
35036 ownerType:
35037 type: string
35038 enum:
35039 - GROUP
35040 - COMPONENT_INSTANCE
35041 - RESOURCE
35042 parentName:
35043 type: string
35044 path:
35045 type: array
35046 items:
35047 type: string
35048 previousName:
35049 type: string
35050 source:
35051 type: string
35052 type:
35053 type: string
35054 uniqueId:
35055 type: string
35056 validSourceTypes:
35057 type: array
35058 items:
35059 type: string
35060 version:
35061 type: string
35062 CapabilityDefinition:
35063 type: object
35064 properties:
35065 capabilitySources:
35066 type: array
35067 items:
35068 type: string
35069 description:
35070 type: string
35071 empty:
35072 type: boolean
35073 external:
35074 type: boolean
35075 externalName:
35076 type: string
35077 leftOccurrences:
35078 type: string
35079 maxOccurrences:
35080 type: string
35081 minOccurrences:
35082 type: string
35083 name:
35084 type: string
35085 ownerId:
35086 type: string
35087 ownerIdIfEmpty:
35088 type: string
35089 writeOnly: true
35090 ownerName:
35091 type: string
35092 ownerType:
35093 type: string
35094 enum:
35095 - GROUP
35096 - COMPONENT_INSTANCE
35097 - RESOURCE
35098 ownerTypeIfEmpty:
35099 type: string
35100 enum:
35101 - GROUP
35102 - COMPONENT_INSTANCE
35103 - RESOURCE
35104 writeOnly: true
35105 parentName:
35106 type: string
35107 path:
35108 type: array
35109 items:
35110 type: string
35111 previousName:
35112 type: string
35113 properties:
35114 type: array
35115 items:
35116 $ref: '#/components/schemas/ComponentInstanceProperty'
35117 source:
35118 type: string
35119 type:
35120 type: string
35121 uniqueId:
35122 type: string
35123 validSourceTypes:
35124 type: array
35125 items:
35126 type: string
35127 version:
35128 type: string
35129 CapabilityRequirementRelationship:
35130 type: object
35131 properties:
35132 capability:
35133 $ref: '#/components/schemas/CapabilityDataDefinition'
35134 operations:
35135 type: array
35136 items:
35137 $ref: '#/components/schemas/OperationUi'
35138 relation:
35139 $ref: '#/components/schemas/RelationshipInfo'
35140 requirement:
35141 $ref: '#/components/schemas/RequirementDataDefinition'
35142 CassandrConfig:
35143 type: object
35144 properties:
35145 authenticate:
35146 type: boolean
35147 cassandraHosts:
35148 type: array
35149 items:
35150 type: string
35151 cassandraPort:
35152 type: integer
35153 format: int32
35154 keySpaces:
35155 type: array
35156 items:
35157 $ref: '#/components/schemas/KeyspaceConfig'
35158 localDataCenter:
35159 type: string
35160 maxWaitSeconds:
35161 type: integer
35162 format: int32
35163 password:
35164 type: string
35165 reconnectTimeout:
35166 type: integer
35167 format: int64
35168 socketConnectTimeout:
35169 type: integer
35170 format: int32
35171 socketReadTimeout:
35172 type: integer
35173 format: int32
35174 ssl:
35175 type: boolean
35176 truststorePassword:
35177 type: string
35178 truststorePath:
35179 type: string
35180 username:
35181 type: string
35182 CatalogComponent:
35183 type: object
35184 properties:
35185 categories:
35186 type: array
35187 items:
35188 $ref: '#/components/schemas/CategoryDefinition'
35189 categoryNormalizedName:
35190 type: string
35191 componentType:
35192 type: string
35193 enum:
35194 - RESOURCE
35195 - SERVICE
35196 - RESOURCE_INSTANCE
35197 - PRODUCT
35198 - SERVICE_INSTANCE
35199 description:
35200 type: string
35201 distributionStatus:
35202 type: string
35203 icon:
35204 type: string
35205 invariantUUID:
35206 type: string
35207 isHighestVersion:
35208 type: boolean
35209 lastUpdateDate:
35210 type: integer
35211 format: int64
35212 lastUpdaterUserId:
35213 type: string
35214 lifecycleState:
35215 type: string
35216 model:
35217 type: string
35218 name:
35219 type: string
35220 resourceType:
35221 type: string
35222 subCategoryNormalizedName:
35223 type: string
35224 systemName:
35225 type: string
35226 tags:
35227 type: array
35228 items:
35229 type: string
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]35230 tenant:
35231 type: string
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]35232 uniqueId:
35233 type: string
35234 uuid:
35235 type: string
35236 version:
35237 type: string
35238 Category:
35239 type: object
35240 properties:
35241 name:
35242 type: string
35243 CategoryBaseTypeConfig:
35244 type: object
35245 properties:
35246 baseTypes:
35247 type: array
35248 items:
35249 type: string
35250 defaultBaseType:
35251 type: string
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]35252 doNotExtendBaseType:
35253 type: boolean
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]35254 required:
35255 type: boolean
35256 CategoryDefinition:
35257 type: object
35258 properties:
35259 displayName:
35260 type: string
35261 empty:
35262 type: boolean
35263 icons:
35264 type: array
35265 items:
35266 type: string
35267 metadataKeys:
35268 type: array
35269 items:
35270 $ref: '#/components/schemas/MetadataKeyDataDefinition'
35271 models:
35272 type: array
35273 items:
35274 type: string
35275 name:
35276 type: string
35277 normalizedName:
35278 type: string
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]35279 notApplicableMetadataKeys:
35280 type: array
35281 items:
35282 type: string
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]35283 ownerId:
35284 type: string
35285 ownerIdIfEmpty:
35286 type: string
35287 writeOnly: true
35288 subcategories:
35289 type: array
35290 items:
35291 $ref: '#/components/schemas/SubCategoryDefinition'
35292 type:
35293 type: string
35294 uniqueId:
35295 type: string
35296 useServiceSubstitutionForNestedServices:
35297 type: boolean
35298 version:
35299 type: string
35300 CleanComponentsConfiguration:
35301 type: object
35302 properties:
35303 cleanIntervalInMinutes:
35304 type: integer
35305 format: int64
35306 componentsToClean:
35307 type: array
35308 items:
35309 type: string
35310 ComponentInstance:
35311 type: object
35312 properties:
35313 actualComponentUid:
35314 type: string
35315 artifacts:
35316 type: object
35317 additionalProperties:
35318 $ref: '#/components/schemas/ArtifactDefinition'
35319 attributeValueCounter:
35320 type: integer
35321 format: int32
35322 attributes:
35323 type: array
35324 items:
35325 $ref: '#/components/schemas/AttributeDefinition'
35326 capabilities:
35327 type: object
35328 additionalProperties:
35329 type: array
35330 items:
35331 $ref: '#/components/schemas/CapabilityDefinition'
35332 componentMetadataForSupportLog:
35333 type: object
35334 additionalProperties:
35335 type: string
35336 componentName:
35337 type: string
35338 componentUid:
35339 type: string
35340 componentVersion:
35341 type: string
35342 createdFrom:
35343 type: string
35344 enum:
35345 - UI
35346 - CSAR
35347 createdFromCsar:
35348 type: boolean
35349 creationTime:
35350 type: integer
35351 format: int64
35352 customizationUUID:
35353 type: string
35354 deploymentArtifacts:
35355 type: object
35356 additionalProperties:
35357 $ref: '#/components/schemas/ArtifactDefinition'
35358 description:
35359 type: string
35360 directives:
35361 type: array
35362 items:
35363 type: string
35364 empty:
35365 type: boolean
35366 groupInstances:
35367 type: array
35368 items:
35369 $ref: '#/components/schemas/GroupInstance'
35370 icon:
35371 type: string
35372 inputValueCounter:
35373 type: integer
35374 format: int32
35375 inputs:
35376 type: array
35377 items:
35378 $ref: '#/components/schemas/InputDefinition'
35379 instanceCount:
35380 type: string
35381 interfaces:
35382 type: object
35383 additionalProperties:
35384 type: object
35385 invariantName:
35386 type: string
35387 isProxy:
35388 type: boolean
35389 maxOccurrences:
35390 type: string
35391 minOccurrences:
35392 type: string
35393 modificationTime:
35394 type: integer
35395 format: int64
35396 name:
35397 type: string
35398 nodeFilter:
35399 $ref: '#/components/schemas/CINodeFilterDataDefinition'
35400 normalizedName:
35401 type: string
35402 originArchived:
35403 type: boolean
35404 originType:
35405 type: string
35406 enum:
35407 - PRODUCT
35408 - SERVICE
35409 - VF
35410 - VFC
35411 - CP
35412 - VL
35413 - Configuration
35414 - VFCMT
35415 - CVFC
35416 - PNF
35417 - CR
35418 - ServiceProxy
35419 - ServiceSubstitution
35420 ownerId:
35421 type: string
35422 ownerIdIfEmpty:
35423 type: string
35424 writeOnly: true
35425 posX:
35426 type: string
35427 posY:
35428 type: string
35429 properties:
35430 type: array
35431 items:
35432 $ref: '#/components/schemas/PropertyDefinition'
35433 propertyValueCounter:
35434 type: integer
35435 format: int32
35436 requirements:
35437 type: object
35438 additionalProperties:
35439 type: array
35440 items:
35441 $ref: '#/components/schemas/RequirementDefinition'
35442 serviceSubstitution:
35443 type: boolean
35444 sourceModelInvariant:
35445 type: string
35446 sourceModelName:
35447 type: string
35448 sourceModelUid:
35449 type: string
35450 sourceModelUuid:
35451 type: string
35452 toscaArtifacts:
35453 type: object
35454 additionalProperties:
35455 $ref: '#/components/schemas/ToscaArtifactDataDefinition'
35456 toscaComponentName:
35457 type: string
35458 type:
35459 type: string
35460 uniqueId:
35461 type: string
35462 version:
35463 type: string
35464 ComponentInstanceAttribute:
35465 type: object
35466 properties:
35467 attributeId:
35468 type: string
35469 componentInstanceId:
35470 type: string
35471 componentInstanceName:
35472 type: string
35473 defaultValue:
35474 type: string
35475 definition:
35476 type: boolean
35477 description:
35478 type: string
35479 empty:
35480 type: boolean
35481 entry_schema:
35482 $ref: '#/components/schemas/EntrySchema'
35483 getOutputAttribute:
35484 type: boolean
35485 getOutputValues:
35486 type: array
35487 items:
35488 $ref: '#/components/schemas/GetOutputValueDataDefinition'
35489 get_default:
35490 type: object
35491 instanceUniqueId:
35492 type: string
35493 model:
35494 type: string
35495 name:
35496 type: string
35497 outputId:
35498 type: string
35499 outputPath:
35500 type: string
35501 ownerId:
35502 type: string
35503 ownerIdIfEmpty:
35504 type: string
35505 writeOnly: true
35506 parentUniqueId:
35507 type: string
35508 path:
35509 type: array
35510 items:
35511 type: string
35512 rules:
35513 type: array
35514 items:
35515 $ref: '#/components/schemas/PropertyRule'
35516 schema:
35517 $ref: '#/components/schemas/SchemaDefinition'
35518 schemaType:
35519 type: string
35520 status:
35521 type: string
35522 type:
35523 type: string
35524 uniqueId:
35525 type: string
35526 value:
35527 type: string
35528 valueUniqueUid:
35529 type: string
35530 version:
35531 type: string
35532 ComponentInstanceCapabilityUpdateModel:
35533 type: object
35534 properties:
35535 external:
35536 type: boolean
35537 name:
35538 type: string
35539 maxLength: 2147483647
35540 minLength: 1
35541 ownerId:
35542 type: string
35543 maxLength: 2147483647
35544 minLength: 1
35545 ownerName:
35546 type: string
35547 maxLength: 2147483647
35548 minLength: 1
35549 type:
35550 type: string
35551 maxLength: 2147483647
35552 minLength: 1
35553 uniqueId:
35554 type: string
35555 maxLength: 2147483647
35556 minLength: 1
35557 required:
35558 - external
35559 - name
35560 - ownerId
35561 - ownerName
35562 - type
35563 - uniqueId
35564 ComponentInstanceInput:
35565 type: object
35566 properties:
35567 annotations:
35568 type: array
35569 items:
35570 $ref: '#/components/schemas/Annotation'
35571 annotationsToInput:
35572 type: array
35573 items:
35574 $ref: '#/components/schemas/Annotation'
35575 writeOnly: true
35576 componentInstanceId:
35577 type: string
35578 componentInstanceName:
35579 type: string
35580 constraints:
35581 type: array
35582 items:
35583 $ref: '#/components/schemas/PropertyConstraint'
35584 defaultValue:
35585 type: string
35586 definition:
35587 type: boolean
35588 description:
35589 type: string
35590 empty:
35591 type: boolean
35592 getInputProperty:
35593 type: boolean
35594 getInputValues:
35595 type: array
35596 items:
35597 $ref: '#/components/schemas/GetInputValueDataDefinition'
35598 getPolicyValues:
35599 type: array
35600 items:
35601 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
35602 hidden:
35603 type: boolean
35604 immutable:
35605 type: boolean
35606 inputId:
35607 type: string
35608 inputPath:
35609 type: string
35610 instanceUniqueId:
35611 type: string
35612 isDeclaredListInput:
35613 type: boolean
35614 label:
35615 type: string
35616 mappedToComponentProperty:
35617 type: boolean
35618 metadata:
35619 type: object
35620 additionalProperties:
35621 type: string
35622 model:
35623 type: string
35624 name:
35625 type: string
35626 ownerId:
35627 type: string
35628 ownerIdIfEmpty:
35629 type: string
35630 writeOnly: true
35631 parentPropertyType:
35632 type: string
35633 parentUniqueId:
35634 type: string
35635 password:
35636 type: boolean
35637 path:
35638 type: array
35639 items:
35640 type: string
35641 properties:
35642 type: array
35643 items:
35644 $ref: '#/components/schemas/ComponentInstanceProperty'
35645 propertyConstraints:
35646 type: array
35647 items:
35648 type: string
35649 propertyId:
35650 type: string
35651 required:
35652 type: boolean
35653 rules:
35654 type: array
35655 items:
35656 $ref: '#/components/schemas/PropertyRule'
35657 schema:
35658 $ref: '#/components/schemas/SchemaDefinition'
35659 schemaProperty:
35660 $ref: '#/components/schemas/PropertyDataDefinition'
35661 schemaType:
35662 type: string
35663 status:
35664 type: string
35665 subPropertyInputPath:
35666 type: string
35667 subPropertyToscaFunctions:
35668 type: array
35669 items:
35670 $ref: '#/components/schemas/SubPropertyToscaFunction'
35671 toscaFunction:
35672 $ref: '#/components/schemas/ToscaFunction'
35673 toscaGetFunction:
35674 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
35675 toscaGetFunctionType:
35676 type: string
35677 enum:
35678 - GET_INPUT
35679 - GET_PROPERTY
35680 - GET_ATTRIBUTE
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]35681 toscaSubPath:
35682 type: string
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]35683 type:
35684 type: string
35685 uniqueId:
35686 type: string
35687 userCreated:
35688 type: boolean
35689 value:
35690 type: string
35691 valueUniqueUid:
35692 type: string
35693 version:
35694 type: string
35695 ComponentInstanceInterface:
35696 type: object
35697 properties:
35698 creationDate:
35699 type: integer
35700 format: int64
35701 definition:
35702 type: boolean
35703 derivedFrom:
35704 type: string
35705 description:
35706 type: string
35707 empty:
35708 type: boolean
35709 inputs:
35710 type: object
35711 additionalProperties:
35712 $ref: '#/components/schemas/InputDataDefinition'
35713 interfaceId:
35714 type: string
35715 interfaceInstanceDataDefinition:
35716 $ref: '#/components/schemas/InterfaceInstanceDataDefinition'
35717 lastUpdateDate:
35718 type: integer
35719 format: int64
35720 model:
35721 type: string
35722 operations:
35723 type: object
35724 additionalProperties:
35725 $ref: '#/components/schemas/OperationDataDefinition'
35726 ownerId:
35727 type: string
35728 ownerIdIfEmpty:
35729 type: string
35730 writeOnly: true
35731 toscaResourceName:
35732 type: string
35733 type:
35734 type: string
35735 uniqueId:
35736 type: string
35737 userCreated:
35738 type: boolean
35739 version:
35740 type: string
35741 ComponentInstanceOutput:
35742 type: object
35743 properties:
35744 attribute:
35745 $ref: '#/components/schemas/ComponentInstanceAttribute'
35746 attributeId:
35747 type: string
35748 componentInstanceId:
35749 type: string
35750 componentInstanceName:
35751 type: string
35752 defaultValue:
35753 type: string
35754 definition:
35755 type: boolean
35756 description:
35757 type: string
35758 empty:
35759 type: boolean
35760 entry_schema:
35761 $ref: '#/components/schemas/EntrySchema'
35762 getOutputAttribute:
35763 type: boolean
35764 getOutputValues:
35765 type: array
35766 items:
35767 $ref: '#/components/schemas/GetOutputValueDataDefinition'
35768 get_default:
35769 type: object
35770 instanceUniqueId:
35771 type: string
35772 model:
35773 type: string
35774 name:
35775 type: string
35776 outputId:
35777 type: string
35778 outputPath:
35779 type: string
35780 ownerId:
35781 type: string
35782 ownerIdIfEmpty:
35783 type: string
35784 writeOnly: true
35785 parentUniqueId:
35786 type: string
35787 path:
35788 type: array
35789 items:
35790 type: string
35791 rules:
35792 type: array
35793 items:
35794 $ref: '#/components/schemas/PropertyRule'
35795 schema:
35796 $ref: '#/components/schemas/SchemaDefinition'
35797 schemaType:
35798 type: string
35799 status:
35800 type: string
35801 type:
35802 type: string
35803 uniqueId:
35804 type: string
35805 value:
35806 type: string
35807 valueUniqueUid:
35808 type: string
35809 version:
35810 type: string
35811 ComponentInstanceProperty:
35812 type: object
35813 properties:
35814 annotations:
35815 type: array
35816 items:
35817 $ref: '#/components/schemas/Annotation'
35818 componentInstanceId:
35819 type: string
35820 componentInstanceName:
35821 type: string
35822 constraints:
35823 type: array
35824 items:
35825 $ref: '#/components/schemas/PropertyConstraint'
35826 defaultValue:
35827 type: string
35828 definition:
35829 type: boolean
35830 description:
35831 type: string
35832 empty:
35833 type: boolean
35834 getInputProperty:
35835 type: boolean
35836 getInputValues:
35837 type: array
35838 items:
35839 $ref: '#/components/schemas/GetInputValueDataDefinition'
35840 getPolicyValues:
35841 type: array
35842 items:
35843 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
35844 hidden:
35845 type: boolean
35846 immutable:
35847 type: boolean
35848 inputId:
35849 type: string
35850 inputPath:
35851 type: string
35852 instanceUniqueId:
35853 type: string
35854 isDeclaredListInput:
35855 type: boolean
35856 label:
35857 type: string
35858 mappedToComponentProperty:
35859 type: boolean
35860 metadata:
35861 type: object
35862 additionalProperties:
35863 type: string
35864 model:
35865 type: string
35866 name:
35867 type: string
35868 ownerId:
35869 type: string
35870 ownerIdIfEmpty:
35871 type: string
35872 writeOnly: true
35873 parentPropertyType:
35874 type: string
35875 parentUniqueId:
35876 type: string
35877 password:
35878 type: boolean
35879 path:
35880 type: array
35881 items:
35882 type: string
35883 propertyConstraints:
35884 type: array
35885 items:
35886 type: string
35887 propertyId:
35888 type: string
35889 required:
35890 type: boolean
35891 rules:
35892 type: array
35893 items:
35894 $ref: '#/components/schemas/PropertyRule'
35895 schema:
35896 $ref: '#/components/schemas/SchemaDefinition'
35897 schemaProperty:
35898 $ref: '#/components/schemas/PropertyDataDefinition'
35899 schemaType:
35900 type: string
35901 status:
35902 type: string
35903 subPropertyInputPath:
35904 type: string
35905 subPropertyToscaFunctions:
35906 type: array
35907 items:
35908 $ref: '#/components/schemas/SubPropertyToscaFunction'
35909 toscaFunction:
35910 $ref: '#/components/schemas/ToscaFunction'
35911 toscaGetFunction:
35912 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
35913 toscaGetFunctionType:
35914 type: string
35915 enum:
35916 - GET_INPUT
35917 - GET_PROPERTY
35918 - GET_ATTRIBUTE
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]35919 toscaSubPath:
35920 type: string
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]35921 type:
35922 type: string
35923 uniqueId:
35924 type: string
35925 userCreated:
35926 type: boolean
35927 value:
35928 type: string
35929 valueUniqueUid:
35930 type: string
35931 version:
35932 type: string
35933 Configuration:
35934 type: object
35935 properties:
35936 aafAuthNeeded:
35937 type: boolean
35938 aafNamespace:
35939 type: string
35940 additionalInformationMaxNumberOfKeys:
35941 type: integer
35942 format: int32
35943 appVersion:
35944 type: string
35945 applicationL1Cache:
35946 $ref: '#/components/schemas/ApplicationL1CacheConfig'
35947 applicationL2Cache:
35948 $ref: '#/components/schemas/ApplicationL2CacheConfig'
35949 artifactGeneratorConfig:
35950 type: string
35951 artifacts:
35952 type: array
35953 items:
35954 $ref: '#/components/schemas/ArtifactConfiguration'
35955 artifactsIndex:
35956 type: string
35957 authCookie:
35958 $ref: '#/components/schemas/CookieConfig'
35959 autoHealingOwner:
35960 type: string
35961 basicAuth:
35962 $ref: '#/components/schemas/BasicAuthConfig'
35963 beContext:
35964 type: string
35965 beFqdn:
35966 type: string
35967 beHttpPort:
35968 type: integer
35969 format: int32
35970 beProtocol:
35971 type: string
35972 beSslPort:
35973 type: integer
35974 format: int32
35975 cadiFilterParams:
35976 $ref: '#/components/schemas/CadiFilterParams'
35977 cassandraConfig:
35978 $ref: '#/components/schemas/CassandrConfig'
35979 cleanComponentsConfiguration:
35980 $ref: '#/components/schemas/CleanComponentsConfiguration'
35981 componentAllowedInstanceTypes:
35982 type: object
35983 additionalProperties:
35984 type: object
35985 additionalProperties:
35986 type: array
35987 items:
35988 type: string
35989 componentInstanceCounterDelimiter:
35990 type: string
35991 consumerBusinessLogic:
35992 type: boolean
35993 csarFormat:
35994 $ref: '#/components/schemas/CsarFormat'
35995 dataValidatorFilterExcludedUrls:
35996 type: string
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]35997 defaultCustomToscaFunctions:
35998 type: array
35999 items:
36000 $ref: '#/components/schemas/CustomToscaFunction'
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]36001 defaultImports:
36002 type: array
36003 items:
36004 type: object
36005 additionalProperties:
36006 type: object
36007 additionalProperties:
36008 type: string
36009 definedResourceNamespace:
36010 type: array
36011 items:
36012 type: string
36013 deleteLockTimeoutInSeconds:
36014 type: integer
36015 format: int32
36016 deploymentResourceArtifacts:
36017 type: object
36018 additionalProperties:
36019 type: object
36020 deploymentResourceInstanceArtifacts:
36021 type: object
36022 additionalProperties:
36023 type: object
36024 directives:
36025 type: array
36026 items:
36027 type: string
36028 disableAudit:
36029 type: boolean
36030 dmaapConsumerConfiguration:
36031 $ref: '#/components/schemas/DmaapConsumerConfiguration'
36032 dmaapProducerConfiguration:
36033 $ref: '#/components/schemas/DmaapProducerConfiguration'
36034 dmeConfiguration:
36035 $ref: '#/components/schemas/DmeConfiguration'
36036 ecompPortal:
36037 $ref: '#/components/schemas/EcompPortalConfig'
36038 enableAutoHealing:
36039 type: boolean
36040 environmentContext:
36041 $ref: '#/components/schemas/EnvironmentContext'
36042 excludeResourceCategory:
36043 type: array
36044 items:
36045 type: string
36046 excludeResourceType:
36047 type: array
36048 items:
36049 type: string
36050 excludeServiceCategory:
36051 type: array
36052 items:
36053 type: string
36054 excludedGroupTypesMapping:
36055 type: object
36056 additionalProperties:
36057 type: array
36058 items:
36059 type: string
36060 uniqueItems: true
36061 excludedPolicyTypesMapping:
36062 type: object
36063 additionalProperties:
36064 type: array
36065 items:
36066 type: string
36067 uniqueItems: true
36068 externalCsarStore:
36069 $ref: '#/components/schemas/ExternalCsarStore'
36070 gabConfig:
36071 type: array
36072 items:
36073 $ref: '#/components/schemas/GabConfig'
36074 genericAssetNodeTypes:
36075 type: object
36076 additionalProperties:
36077 type: string
36078 globalCsarImports:
36079 type: array
36080 items:
36081 type: string
36082 healthStatusExclude:
36083 type: array
36084 items:
36085 type: string
36086 heatArtifactDeploymentTimeout:
36087 $ref: '#/components/schemas/HeatDeploymentArtifactTimeout'
36088 heatEnvArtifactFooter:
36089 type: string
36090 heatEnvArtifactHeader:
36091 type: string
36092 heatTranslatorPath:
36093 type: string
36094 identificationHeaderFields:
36095 type: array
36096 items:
36097 type: string
36098 informationalResourceArtifacts:
36099 type: object
36100 additionalProperties:
36101 type: object
36102 informationalServiceArtifacts:
36103 type: object
36104 additionalProperties:
36105 type: object
36106 janusGraphCfgFile:
36107 type: string
36108 janusGraphHealthCheckReadTimeout:
36109 type: integer
36110 format: int64
36111 janusGraphInMemoryGraph:
36112 type: boolean
36113 janusGraphLockTimeout:
36114 type: integer
36115 format: int64
36116 janusGraphMigrationKeySpaceCfgFile:
36117 type: string
36118 janusGraphReconnectIntervalInSeconds:
36119 type: integer
36120 format: int64
36121 licenseTypes:
36122 type: array
36123 items:
36124 type: string
36125 maxDeleteComponents:
36126 type: integer
36127 format: int32
36128 minToscaConformanceLevel:
36129 type: string
36130 neo4j:
36131 type: object
36132 additionalProperties:
36133 type: object
36134 onboarding:
36135 $ref: '#/components/schemas/OnboardingConfig'
36136 permittedAncestors:
36137 type: string
36138 protocols:
36139 type: array
36140 items:
36141 type: string
36142 released:
36143 type: string
36144 format: date-time
36145 resourceNodeTypes:
36146 type: object
36147 additionalProperties:
36148 type: object
36149 additionalProperties:
36150 type: string
36151 resourceTypes:
36152 type: array
36153 items:
36154 type: string
36155 resourcesForUpgrade:
36156 type: object
36157 additionalProperties:
36158 type: array
36159 items:
36160 type: string
36161 serviceApiArtifacts:
36162 type: object
36163 additionalProperties:
36164 type: object
36165 serviceBaseNodeTypes:
36166 type: object
36167 additionalProperties:
36168 $ref: '#/components/schemas/CategoryBaseTypeConfig'
36169 skipUpgradeFailedVfs:
36170 type: boolean
36171 skipUpgradeVSPs:
36172 type: boolean
36173 startMigrationFrom:
36174 type: integer
36175 format: int32
36176 supportAllottedResourcesAndProxy:
36177 type: boolean
36178 switchoverDetector:
36179 $ref: '#/components/schemas/SwitchoverDetectorConfig'
36180 systemMonitoring:
36181 $ref: '#/components/schemas/BeMonitoringConfig'
36182 toscaArtifacts:
36183 type: object
36184 additionalProperties:
36185 type: object
36186 toscaConformanceLevel:
36187 type: string
36188 toscaFilesDir:
36189 type: string
36190 toscaValidators:
36191 $ref: '#/components/schemas/ToscaValidatorsConfig'
36192 uebHealthCheckReadTimeout:
36193 type: integer
36194 format: int64
36195 uebHealthCheckReconnectIntervalInSeconds:
36196 type: integer
36197 format: int64
36198 unLoggedUrls:
36199 type: array
36200 items:
36201 type: string
36202 users:
36203 type: object
36204 additionalProperties:
36205 type: string
36206 version:
36207 type: string
36208 vfModuleProperties:
36209 type: object
36210 additionalProperties:
36211 $ref: '#/components/schemas/VfModuleProperty'
36212 workloadContext:
36213 type: string
36214 Constraint:
36215 type: object
36216 properties:
36217 equal:
36218 type: object
36219 greater_or_equal:
36220 type: object
36221 greater_than:
36222 type: object
36223 in_range:
36224 type: array
36225 items:
36226 type: object
36227 length:
36228 type: integer
36229 format: int32
36230 less_or_equal:
36231 type: object
36232 less_than:
36233 type: object
36234 max_length:
36235 type: integer
36236 format: int32
36237 min_length:
36238 type: integer
36239 format: int32
36240 pattern:
36241 type: object
36242 valid_values:
36243 type: array
36244 items:
36245 type: object
36246 ConsumerDefinition:
36247 type: object
36248 properties:
36249 consumerDetailsLastupdatedtime:
36250 type: integer
36251 format: int64
36252 consumerLastAuthenticationTime:
36253 type: integer
36254 format: int64
36255 consumerName:
36256 type: string
36257 consumerPassword:
36258 type: string
36259 consumerSalt:
36260 type: string
36261 empty:
36262 type: boolean
36263 lastModfierAtuid:
36264 type: string
36265 ownerId:
36266 type: string
36267 ownerIdIfEmpty:
36268 type: string
36269 writeOnly: true
36270 type:
36271 type: string
36272 version:
36273 type: string
36274 CookieConfig:
36275 type: object
36276 properties:
36277 cookieName:
36278 type: string
36279 domain:
36280 type: string
36281 excludedUrls:
36282 type: array
36283 items:
36284 type: string
36285 httpOnly:
36286 type: boolean
36287 isHttpOnly:
36288 type: boolean
36289 writeOnly: true
36290 maxSessionTimeOut:
36291 type: integer
36292 format: int64
36293 onboardingExcludedUrls:
36294 type: array
36295 items:
36296 type: string
36297 path:
36298 type: string
36299 redirectURL:
36300 type: string
36301 securityKey:
36302 type: string
36303 sessionIdleTimeOut:
36304 type: integer
36305 format: int64
36306 Credential:
36307 type: object
36308 properties:
36309 password:
36310 type: string
36311 username:
36312 type: string
36313 Credentials:
36314 type: object
36315 properties:
36316 accessKey:
36317 type: string
36318 secretKey:
36319 type: string
36320 CsarFormat:
36321 type: object
36322 properties:
36323 defaultFormat:
36324 type: string
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]36325 CustomToscaFunction:
36326 type: object
36327 properties:
36328 name:
36329 type: string
36330 type:
36331 type: string
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]36332 DataTypeDataDefinition:
36333 type: object
36334 properties:
36335 creationTime:
36336 type: integer
36337 format: int64
36338 derivedFromName:
36339 type: string
36340 description:
36341 type: string
36342 empty:
36343 type: boolean
36344 model:
36345 type: string
36346 modificationTime:
36347 type: integer
36348 format: int64
36349 name:
36350 type: string
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]36351 normative:
36352 type: boolean
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]36353 ownerId:
36354 type: string
36355 ownerIdIfEmpty:
36356 type: string
36357 writeOnly: true
36358 propertiesData:
36359 type: array
36360 items:
36361 $ref: '#/components/schemas/PropertyDataDefinition'
36362 type:
36363 type: string
36364 uniqueId:
36365 type: string
36366 version:
36367 type: string
36368 DataTypeDefinition:
36369 type: object
36370 properties:
36371 constraints:
36372 type: array
36373 items:
36374 $ref: '#/components/schemas/PropertyConstraint'
36375 creationTime:
36376 type: integer
36377 format: int64
36378 derivedFrom:
36379 $ref: '#/components/schemas/DataTypeDefinition'
36380 derivedFromName:
36381 type: string
36382 description:
36383 type: string
36384 empty:
36385 type: boolean
36386 model:
36387 type: string
36388 modificationTime:
36389 type: integer
36390 format: int64
36391 name:
36392 type: string
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]36393 normative:
36394 type: boolean
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]36395 ownerId:
36396 type: string
36397 ownerIdIfEmpty:
36398 type: string
36399 writeOnly: true
36400 properties:
36401 type: array
36402 items:
36403 $ref: '#/components/schemas/PropertyDefinition'
36404 propertiesData:
36405 type: array
36406 items:
36407 $ref: '#/components/schemas/PropertyDataDefinition'
36408 type:
36409 type: string
36410 uniqueId:
36411 type: string
36412 version:
36413 type: string
36414 DistributionStatusInfo:
36415 type: object
36416 properties:
36417 errorReason:
36418 type: string
36419 omfComponentID:
36420 type: string
36421 status:
36422 type: string
36423 timestamp:
36424 type: string
36425 url:
36426 type: string
36427 DistributionStatusListResponse:
36428 type: object
36429 properties:
36430 distributionStatusList:
36431 type: array
36432 items:
36433 $ref: '#/components/schemas/DistributionStatusInfo'
36434 DmaapConsumerConfiguration:
36435 type: object
36436 properties:
36437 active:
36438 type: boolean
36439 aftDme2ClientIgnoreSslConfig:
36440 type: boolean
36441 aftDme2ClientKeystore:
36442 type: string
36443 aftDme2ClientKeystorePassword:
36444 type: string
36445 aftDme2ClientSslCertAlias:
36446 type: string
36447 aftDme2ConnectionTimeoutMs:
36448 type: integer
36449 format: int32
36450 aftDme2ReadTimeoutMs:
36451 type: integer
36452 format: int32
36453 aftDme2RoundtripTimeoutMs:
36454 type: integer
36455 format: int32
36456 aftDme2SslEnable:
36457 type: boolean
36458 aftEnvironment:
36459 type: string
36460 consumerGroup:
36461 type: string
36462 consumerId:
36463 type: string
36464 contenttype:
36465 type: string
36466 credential:
36467 $ref: '#/components/schemas/Credential'
36468 dme2TraceOn:
36469 type: boolean
36470 dme2preferredRouterFilePath:
36471 type: string
36472 environment:
36473 type: string
36474 hosts:
36475 type: string
36476 latitude:
36477 type: number
36478 format: double
36479 limit:
36480 type: integer
36481 format: int32
36482 longitude:
36483 type: number
36484 format: double
36485 partner:
36486 type: string
36487 pollingInterval:
36488 type: integer
36489 format: int32
36490 protocol:
36491 type: string
36492 routeOffer:
36493 type: string
36494 serviceName:
36495 type: string
36496 timeLimitForNotificationHandleMs:
36497 type: integer
36498 format: int32
36499 timeoutMs:
36500 type: integer
36501 format: int32
36502 topic:
36503 type: string
36504 version:
36505 type: string
36506 DmaapProducerConfiguration:
36507 type: object
36508 properties:
36509 active:
36510 type: boolean
36511 aftDme2ClientIgnoreSslConfig:
36512 type: boolean
36513 aftDme2ClientKeystore:
36514 type: string
36515 aftDme2ClientKeystorePassword:
36516 type: string
36517 aftDme2ClientSslCertAlias:
36518 type: string
36519 aftDme2ConnectionTimeoutMs:
36520 type: integer
36521 format: int32
36522 aftDme2ReadTimeoutMs:
36523 type: integer
36524 format: int32
36525 aftDme2RoundtripTimeoutMs:
36526 type: integer
36527 format: int32
36528 aftDme2SslEnable:
36529 type: boolean
36530 aftEnvironment:
36531 type: string
36532 consumerGroup:
36533 type: string
36534 consumerId:
36535 type: string
36536 contenttype:
36537 type: string
36538 credential:
36539 $ref: '#/components/schemas/Credential'
36540 dme2TraceOn:
36541 type: boolean
36542 dme2preferredRouterFilePath:
36543 type: string
36544 environment:
36545 type: string
36546 hosts:
36547 type: string
36548 latitude:
36549 type: number
36550 format: double
36551 limit:
36552 type: integer
36553 format: int32
36554 longitude:
36555 type: number
36556 format: double
36557 partner:
36558 type: string
36559 pollingInterval:
36560 type: integer
36561 format: int32
36562 protocol:
36563 type: string
36564 routeOffer:
36565 type: string
36566 serviceName:
36567 type: string
36568 timeLimitForNotificationHandleMs:
36569 type: integer
36570 format: int32
36571 timeoutMs:
36572 type: integer
36573 format: int32
36574 topic:
36575 type: string
36576 version:
36577 type: string
36578 DmeConfiguration:
36579 type: object
36580 properties:
36581 lookupUriFormat:
36582 type: string
36583 EcompPortalConfig:
36584 type: object
36585 properties:
36586 defaultFunctionalMenu:
36587 type: string
36588 healthCheckUri:
36589 type: string
36590 host:
36591 type: string
36592 pollingInterval:
36593 type: integer
36594 format: int32
36595 port:
36596 type: integer
36597 format: int32
36598 protocol:
36599 type: string
36600 timeoutMs:
36601 type: integer
36602 format: int32
36603 Endpoint:
36604 type: object
36605 properties:
36606 host:
36607 type: string
36608 port:
36609 type: integer
36610 format: int32
36611 secure:
36612 type: boolean
36613 EntrySchema:
36614 type: object
36615 properties:
36616 constraints:
36617 type: array
36618 items:
36619 $ref: '#/components/schemas/Constraint'
36620 description:
36621 type: string
36622 type:
36623 type: string
36624 EnvironmentContext:
36625 type: object
36626 properties:
36627 defaultValue:
36628 type: string
36629 validValues:
36630 type: array
36631 items:
36632 type: string
36633 ExternalCsarStore:
36634 type: object
36635 properties:
36636 credentials:
36637 $ref: '#/components/schemas/Credentials'
36638 endpoint:
36639 $ref: '#/components/schemas/Endpoint'
36640 storageType:
36641 type: string
36642 tempPath:
36643 type: string
36644 uploadPartSize:
36645 type: integer
36646 format: int32
36647 FormDataContentDisposition:
36648 type: object
36649 properties:
36650 creationDate:
36651 type: string
36652 format: date-time
36653 fileName:
36654 type: string
36655 modificationDate:
36656 type: string
36657 format: date-time
36658 name:
36659 type: string
36660 parameters:
36661 type: object
36662 additionalProperties:
36663 type: string
36664 readDate:
36665 type: string
36666 format: date-time
36667 size:
36668 type: integer
36669 format: int64
36670 type:
36671 type: string
36672 ForwardingPathDataDefinition:
36673 type: object
36674 properties:
36675 description:
36676 type: string
36677 destinationPortNumber:
36678 type: string
36679 empty:
36680 type: boolean
36681 name:
36682 type: string
36683 ownerId:
36684 type: string
36685 ownerIdIfEmpty:
36686 type: string
36687 writeOnly: true
36688 pathElements:
36689 $ref: '#/components/schemas/ListDataDefinitionForwardingPathElementDataDefinition'
36690 protocol:
36691 type: string
36692 toscaResourceName:
36693 type: string
36694 type:
36695 type: string
36696 uniqueId:
36697 type: string
36698 version:
36699 type: string
36700 ForwardingPathElementDataDefinition:
36701 type: object
36702 properties:
36703 empty:
36704 type: boolean
36705 fromCP:
36706 type: string
36707 fromCPOriginId:
36708 type: string
36709 fromNode:
36710 type: string
36711 ownerId:
36712 type: string
36713 ownerIdIfEmpty:
36714 type: string
36715 writeOnly: true
36716 toCP:
36717 type: string
36718 toCPOriginId:
36719 type: string
36720 toNode:
36721 type: string
36722 type:
36723 type: string
36724 version:
36725 type: string
36726 GabConfig:
36727 type: object
36728 properties:
36729 artifactType:
36730 type: string
36731 pathsAndNamesDefinitions:
36732 type: array
36733 items:
36734 $ref: '#/components/schemas/PathsAndNamesDefinition'
36735 GenericArtifactQueryInfo:
36736 type: object
36737 properties:
36738 artifactUniqueId:
36739 type: string
36740 fields:
36741 type: array
36742 items:
36743 type: string
36744 uniqueItems: true
36745 parentId:
36746 type: string
36747 GetInputValueDataDefinition:
36748 type: object
36749 properties:
36750 empty:
36751 type: boolean
36752 getInputIndex:
36753 $ref: '#/components/schemas/GetInputValueDataDefinition'
36754 indexValue:
36755 type: integer
36756 format: int32
36757 inputId:
36758 type: string
36759 inputName:
36760 type: string
36761 inputType:
36762 type: string
36763 list:
36764 type: boolean
36765 ownerId:
36766 type: string
36767 ownerIdIfEmpty:
36768 type: string
36769 writeOnly: true
36770 propName:
36771 type: string
36772 type:
36773 type: string
36774 version:
36775 type: string
36776 GetOutputValueDataDefinition:
36777 type: object
36778 properties:
36779 attribName:
36780 type: string
36781 empty:
36782 type: boolean
36783 getOutputIndex:
36784 $ref: '#/components/schemas/GetOutputValueDataDefinition'
36785 indexValue:
36786 type: integer
36787 format: int32
36788 list:
36789 type: boolean
36790 outputId:
36791 type: string
36792 outputName:
36793 type: string
36794 ownerId:
36795 type: string
36796 ownerIdIfEmpty:
36797 type: string
36798 writeOnly: true
36799 type:
36800 type: string
36801 version:
36802 type: string
36803 GetPolicyValueDataDefinition:
36804 type: object
36805 properties:
36806 origPropertyValue:
36807 type: string
36808 policyId:
36809 type: string
36810 propertyName:
36811 type: string
36812 GroupDefinition:
36813 type: object
36814 properties:
36815 artifacts:
36816 type: array
36817 items:
36818 type: string
36819 artifactsUuid:
36820 type: array
36821 items:
36822 type: string
36823 capabilities:
36824 type: object
36825 additionalProperties:
36826 type: array
36827 items:
36828 $ref: '#/components/schemas/CapabilityDefinition'
36829 createdFrom:
36830 type: string
36831 enum:
36832 - UI
36833 - CSAR
36834 description:
36835 type: string
36836 empty:
36837 type: boolean
36838 groupUUID:
36839 type: string
36840 invariantName:
36841 type: string
36842 invariantUUID:
36843 type: string
36844 members:
36845 type: object
36846 additionalProperties:
36847 type: string
36848 name:
36849 type: string
36850 normalizedName:
36851 type: string
36852 ownerId:
36853 type: string
36854 ownerIdIfEmpty:
36855 type: string
36856 writeOnly: true
36857 properties:
36858 type: array
36859 items:
36860 $ref: '#/components/schemas/PropertyDataDefinition'
36861 propertyValueCounter:
36862 type: integer
36863 format: int32
36864 type:
36865 type: string
36866 typeUid:
36867 type: string
36868 uniqueId:
36869 type: string
36870 userDefined:
36871 type: boolean
36872 version:
36873 type: string
36874 vspOriginated:
36875 type: boolean
36876 GroupInfo:
36877 type: object
36878 properties:
36879 changePriorityBody:
36880 type: string
36881 changePriorityUrl:
36882 type: string
36883 GroupInstance:
36884 type: object
36885 properties:
36886 artifacts:
36887 type: array
36888 items:
36889 type: string
36890 artifactsUuid:
36891 type: array
36892 items:
36893 type: string
36894 creationTime:
36895 type: integer
36896 format: int64
36897 customizationUUID:
36898 type: string
36899 description:
36900 type: string
36901 empty:
36902 type: boolean
36903 groupInstanceArtifacts:
36904 type: array
36905 items:
36906 type: string
36907 groupInstanceArtifactsUuid:
36908 type: array
36909 items:
36910 type: string
36911 groupName:
36912 type: string
36913 groupUUID:
36914 type: string
36915 groupUid:
36916 type: string
36917 invariantUUID:
36918 type: string
36919 modificationTime:
36920 type: integer
36921 format: int64
36922 name:
36923 type: string
36924 normalizedName:
36925 type: string
36926 ownerId:
36927 type: string
36928 ownerIdIfEmpty:
36929 type: string
36930 writeOnly: true
36931 posX:
36932 type: string
36933 posY:
36934 type: string
36935 properties:
36936 type: array
36937 items:
36938 $ref: '#/components/schemas/PropertyDataDefinition'
36939 propertyValueCounter:
36940 type: integer
36941 format: int32
36942 type:
36943 type: string
36944 uniqueId:
36945 type: string
36946 version:
36947 type: string
36948 GroupProperty:
36949 type: object
36950 properties:
36951 annotations:
36952 type: array
36953 items:
36954 $ref: '#/components/schemas/Annotation'
36955 constraints:
36956 type: array
36957 items:
36958 $ref: '#/components/schemas/PropertyConstraint'
36959 defaultValue:
36960 type: string
36961 definition:
36962 type: boolean
36963 description:
36964 type: string
36965 empty:
36966 type: boolean
36967 getInputProperty:
36968 type: boolean
36969 getInputValues:
36970 type: array
36971 items:
36972 $ref: '#/components/schemas/GetInputValueDataDefinition'
36973 getPolicyValues:
36974 type: array
36975 items:
36976 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
36977 hidden:
36978 type: boolean
36979 immutable:
36980 type: boolean
36981 inputId:
36982 type: string
36983 inputPath:
36984 type: string
36985 instanceUniqueId:
36986 type: string
36987 isDeclaredListInput:
36988 type: boolean
36989 label:
36990 type: string
36991 mappedToComponentProperty:
36992 type: boolean
36993 metadata:
36994 type: object
36995 additionalProperties:
36996 type: string
36997 model:
36998 type: string
36999 name:
37000 type: string
37001 ownerId:
37002 type: string
37003 ownerIdIfEmpty:
37004 type: string
37005 writeOnly: true
37006 parentPropertyType:
37007 type: string
37008 parentUniqueId:
37009 type: string
37010 password:
37011 type: boolean
37012 propertyConstraints:
37013 type: array
37014 items:
37015 type: string
37016 propertyId:
37017 type: string
37018 required:
37019 type: boolean
37020 schema:
37021 $ref: '#/components/schemas/SchemaDefinition'
37022 schemaProperty:
37023 $ref: '#/components/schemas/PropertyDataDefinition'
37024 schemaType:
37025 type: string
37026 status:
37027 type: string
37028 subPropertyInputPath:
37029 type: string
37030 subPropertyToscaFunctions:
37031 type: array
37032 items:
37033 $ref: '#/components/schemas/SubPropertyToscaFunction'
37034 toscaFunction:
37035 $ref: '#/components/schemas/ToscaFunction'
37036 toscaGetFunction:
37037 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
37038 toscaGetFunctionType:
37039 type: string
37040 enum:
37041 - GET_INPUT
37042 - GET_PROPERTY
37043 - GET_ATTRIBUTE
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]37044 toscaSubPath:
37045 type: string
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]37046 type:
37047 type: string
37048 uniqueId:
37049 type: string
37050 userCreated:
37051 type: boolean
37052 value:
37053 type: string
37054 valueUniqueUid:
37055 type: string
37056 version:
37057 type: string
37058 GroupTypeDefinition:
37059 type: object
37060 properties:
37061 capabilities:
37062 type: object
37063 additionalProperties:
37064 $ref: '#/components/schemas/CapabilityDefinition'
37065 creationTime:
37066 type: integer
37067 format: int64
37068 derivedFrom:
37069 type: string
37070 description:
37071 type: string
37072 empty:
37073 type: boolean
37074 highestVersion:
37075 type: boolean
37076 icon:
37077 type: string
37078 members:
37079 type: array
37080 items:
37081 type: string
37082 metadata:
37083 type: object
37084 additionalProperties:
37085 type: string
37086 model:
37087 type: string
37088 modificationTime:
37089 type: integer
37090 format: int64
37091 name:
37092 type: string
37093 ownerId:
37094 type: string
37095 ownerIdIfEmpty:
37096 type: string
37097 writeOnly: true
37098 properties:
37099 type: array
37100 items:
37101 $ref: '#/components/schemas/PropertyDefinition'
37102 type:
37103 type: string
37104 uniqueId:
37105 type: string
37106 version:
37107 type: string
37108 GroupingDefinition:
37109 type: object
37110 properties:
37111 empty:
37112 type: boolean
37113 name:
37114 type: string
37115 normalizedName:
37116 type: string
37117 ownerId:
37118 type: string
37119 ownerIdIfEmpty:
37120 type: string
37121 writeOnly: true
37122 type:
37123 type: string
37124 uniqueId:
37125 type: string
37126 version:
37127 type: string
37128 HeatDeploymentArtifactTimeout:
37129 type: object
37130 properties:
37131 defaultMinutes:
37132 type: integer
37133 format: int32
37134 maxMinutes:
37135 type: integer
37136 format: int32
37137 minMinutes:
37138 type: integer
37139 format: int32
37140 HeatParameterDataDefinition:
37141 type: object
37142 properties:
37143 currentValue:
37144 type: string
37145 defaultValue:
37146 type: string
37147 description:
37148 type: string
37149 empty:
37150 type: boolean
37151 name:
37152 type: string
37153 ownerId:
37154 type: string
37155 ownerIdIfEmpty:
37156 type: string
37157 writeOnly: true
37158 type:
37159 type: string
37160 uniqueId:
37161 type: string
37162 version:
37163 type: string
37164 HeatParameterDefinition:
37165 type: object
37166 properties:
37167 currentValue:
37168 type: string
37169 defaultValue:
37170 type: string
37171 description:
37172 type: string
37173 empty:
37174 type: boolean
37175 name:
37176 type: string
37177 ownerId:
37178 type: string
37179 ownerIdIfEmpty:
37180 type: string
37181 writeOnly: true
37182 type:
37183 type: string
37184 uniqueId:
37185 type: string
37186 version:
37187 type: string
37188 InputDataDefinition:
37189 type: object
37190 properties:
37191 annotations:
37192 type: array
37193 items:
37194 $ref: '#/components/schemas/Annotation'
37195 defaultValue:
37196 type: string
37197 definition:
37198 type: boolean
37199 description:
37200 type: string
37201 empty:
37202 type: boolean
37203 getInputProperty:
37204 type: boolean
37205 getInputValues:
37206 type: array
37207 items:
37208 $ref: '#/components/schemas/GetInputValueDataDefinition'
37209 getPolicyValues:
37210 type: array
37211 items:
37212 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
37213 hidden:
37214 type: boolean
37215 immutable:
37216 type: boolean
37217 inputId:
37218 type: string
37219 inputPath:
37220 type: string
37221 instanceUniqueId:
37222 type: string
37223 isDeclaredListInput:
37224 type: boolean
37225 label:
37226 type: string
37227 mappedToComponentProperty:
37228 type: boolean
37229 metadata:
37230 type: object
37231 additionalProperties:
37232 type: string
37233 model:
37234 type: string
37235 name:
37236 type: string
37237 ownerId:
37238 type: string
37239 ownerIdIfEmpty:
37240 type: string
37241 writeOnly: true
37242 parentPropertyType:
37243 type: string
37244 parentUniqueId:
37245 type: string
37246 password:
37247 type: boolean
37248 propertyConstraints:
37249 type: array
37250 items:
37251 type: string
37252 propertyId:
37253 type: string
37254 required:
37255 type: boolean
37256 schema:
37257 $ref: '#/components/schemas/SchemaDefinition'
37258 schemaProperty:
37259 $ref: '#/components/schemas/PropertyDataDefinition'
37260 schemaType:
37261 type: string
37262 status:
37263 type: string
37264 subPropertyInputPath:
37265 type: string
37266 subPropertyToscaFunctions:
37267 type: array
37268 items:
37269 $ref: '#/components/schemas/SubPropertyToscaFunction'
37270 toscaFunction:
37271 $ref: '#/components/schemas/ToscaFunction'
37272 toscaGetFunction:
37273 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
37274 toscaGetFunctionType:
37275 type: string
37276 enum:
37277 - GET_INPUT
37278 - GET_PROPERTY
37279 - GET_ATTRIBUTE
37280 type:
37281 type: string
37282 uniqueId:
37283 type: string
37284 userCreated:
37285 type: boolean
37286 value:
37287 type: string
37288 version:
37289 type: string
37290 InputDefinition:
37291 type: object
37292 properties:
37293 annotations:
37294 type: array
37295 items:
37296 $ref: '#/components/schemas/Annotation'
37297 annotationsToInput:
37298 type: array
37299 items:
37300 $ref: '#/components/schemas/Annotation'
37301 writeOnly: true
37302 constraints:
37303 type: array
37304 items:
37305 $ref: '#/components/schemas/PropertyConstraint'
37306 defaultValue:
37307 type: string
37308 definition:
37309 type: boolean
37310 description:
37311 type: string
37312 empty:
37313 type: boolean
37314 getInputProperty:
37315 type: boolean
37316 getInputValues:
37317 type: array
37318 items:
37319 $ref: '#/components/schemas/GetInputValueDataDefinition'
37320 getPolicyValues:
37321 type: array
37322 items:
37323 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
37324 hidden:
37325 type: boolean
37326 immutable:
37327 type: boolean
37328 inputId:
37329 type: string
37330 inputPath:
37331 type: string
37332 inputs:
37333 type: array
37334 items:
37335 $ref: '#/components/schemas/ComponentInstanceInput'
37336 instanceUniqueId:
37337 type: string
37338 isDeclaredListInput:
37339 type: boolean
37340 label:
37341 type: string
37342 mappedToComponentProperty:
37343 type: boolean
37344 metadata:
37345 type: object
37346 additionalProperties:
37347 type: string
37348 model:
37349 type: string
37350 name:
37351 type: string
37352 ownerId:
37353 type: string
37354 ownerIdIfEmpty:
37355 type: string
37356 writeOnly: true
37357 parentPropertyType:
37358 type: string
37359 parentUniqueId:
37360 type: string
37361 password:
37362 type: boolean
37363 properties:
37364 type: array
37365 items:
37366 $ref: '#/components/schemas/ComponentInstanceProperty'
37367 propertyConstraints:
37368 type: array
37369 items:
37370 type: string
37371 propertyId:
37372 type: string
37373 required:
37374 type: boolean
37375 schema:
37376 $ref: '#/components/schemas/SchemaDefinition'
37377 schemaProperty:
37378 $ref: '#/components/schemas/PropertyDataDefinition'
37379 schemaType:
37380 type: string
37381 status:
37382 type: string
37383 subPropertyInputPath:
37384 type: string
37385 subPropertyToscaFunctions:
37386 type: array
37387 items:
37388 $ref: '#/components/schemas/SubPropertyToscaFunction'
37389 toscaFunction:
37390 $ref: '#/components/schemas/ToscaFunction'
37391 toscaGetFunction:
37392 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
37393 toscaGetFunctionType:
37394 type: string
37395 enum:
37396 - GET_INPUT
37397 - GET_PROPERTY
37398 - GET_ATTRIBUTE
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]37399 toscaSubPath:
37400 type: string
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]37401 type:
37402 type: string
37403 uniqueId:
37404 type: string
37405 userCreated:
37406 type: boolean
37407 value:
37408 type: string
37409 version:
37410 type: string
37411 InterfaceDefinition:
37412 type: object
37413 properties:
37414 creationDate:
37415 type: integer
37416 format: int64
37417 definition:
37418 type: boolean
37419 derivedFrom:
37420 type: string
37421 description:
37422 type: string
37423 empty:
37424 type: boolean
37425 inputs:
37426 type: object
37427 additionalProperties:
37428 $ref: '#/components/schemas/InputDataDefinition'
37429 lastUpdateDate:
37430 type: integer
37431 format: int64
37432 model:
37433 type: string
37434 operations:
37435 type: object
37436 additionalProperties:
37437 $ref: '#/components/schemas/OperationDataDefinition'
37438 ownerId:
37439 type: string
37440 ownerIdIfEmpty:
37441 type: string
37442 writeOnly: true
37443 toscaResourceName:
37444 type: string
37445 type:
37446 type: string
37447 uniqueId:
37448 type: string
37449 userCreated:
37450 type: boolean
37451 version:
37452 type: string
37453 InterfaceInstanceDataDefinition:
37454 type: object
37455 properties:
37456 empty:
37457 type: boolean
37458 inputs:
37459 type: object
37460 additionalProperties:
37461 type: object
37462 operations:
37463 type: object
37464 additionalProperties:
37465 $ref: '#/components/schemas/OperationInstance'
37466 ownerId:
37467 type: string
37468 ownerIdIfEmpty:
37469 type: string
37470 writeOnly: true
37471 type:
37472 type: string
37473 version:
37474 type: string
37475 KeyspaceConfig:
37476 type: object
37477 properties:
37478 name:
37479 type: string
37480 replicationInfo:
37481 type: array
37482 items:
37483 type: string
37484 replicationStrategy:
37485 type: string
37486 ListDataDefinitionForwardingPathElementDataDefinition:
37487 type: object
37488 properties:
37489 empty:
37490 type: boolean
37491 listToscaDataDefinition:
37492 type: array
37493 items:
37494 $ref: '#/components/schemas/ForwardingPathElementDataDefinition'
37495 ownerId:
37496 type: string
37497 ownerIdIfEmpty:
37498 type: string
37499 writeOnly: true
37500 type:
37501 type: string
37502 version:
37503 type: string
37504 ListDataDefinitionOperationInputDefinition:
37505 type: object
37506 properties:
37507 empty:
37508 type: boolean
37509 listToscaDataDefinition:
37510 type: array
37511 items:
37512 $ref: '#/components/schemas/OperationInputDefinition'
37513 ownerId:
37514 type: string
37515 ownerIdIfEmpty:
37516 type: string
37517 writeOnly: true
37518 type:
37519 type: string
37520 version:
37521 type: string
37522 ListDataDefinitionOperationOutputDefinition:
37523 type: object
37524 properties:
37525 empty:
37526 type: boolean
37527 listToscaDataDefinition:
37528 type: array
37529 items:
37530 $ref: '#/components/schemas/OperationOutputDefinition'
37531 ownerId:
37532 type: string
37533 ownerIdIfEmpty:
37534 type: string
37535 writeOnly: true
37536 type:
37537 type: string
37538 version:
37539 type: string
37540 ListDataDefinitionPropertyFilterDataDefinition:
37541 type: object
37542 properties:
37543 empty:
37544 type: boolean
37545 listToscaDataDefinition:
37546 type: array
37547 items:
37548 $ref: '#/components/schemas/PropertyFilterDataDefinition'
37549 ownerId:
37550 type: string
37551 ownerIdIfEmpty:
37552 type: string
37553 writeOnly: true
37554 type:
37555 type: string
37556 version:
37557 type: string
37558 ListDataDefinitionRequirementNodeFilterCapabilityDataDefinition:
37559 type: object
37560 properties:
37561 empty:
37562 type: boolean
37563 listToscaDataDefinition:
37564 type: array
37565 items:
37566 $ref: '#/components/schemas/RequirementNodeFilterCapabilityDataDefinition'
37567 ownerId:
37568 type: string
37569 ownerIdIfEmpty:
37570 type: string
37571 writeOnly: true
37572 type:
37573 type: string
37574 version:
37575 type: string
37576 ListDataDefinitionRequirementSubstitutionFilterCapabilityDataDefinition:
37577 type: object
37578 properties:
37579 empty:
37580 type: boolean
37581 listToscaDataDefinition:
37582 type: array
37583 items:
37584 $ref: '#/components/schemas/RequirementSubstitutionFilterCapabilityDataDefinition'
37585 ownerId:
37586 type: string
37587 ownerIdIfEmpty:
37588 type: string
37589 writeOnly: true
37590 type:
37591 type: string
37592 version:
37593 type: string
37594 ListDataDefinitionSubstitutionFilterPropertyDataDefinition:
37595 type: object
37596 properties:
37597 empty:
37598 type: boolean
37599 listToscaDataDefinition:
37600 type: array
37601 items:
37602 $ref: '#/components/schemas/SubstitutionFilterPropertyDataDefinition'
37603 ownerId:
37604 type: string
37605 ownerIdIfEmpty:
37606 type: string
37607 writeOnly: true
37608 type:
37609 type: string
37610 version:
37611 type: string
37612 MetadataKeyDataDefinition:
37613 type: object
37614 properties:
37615 defaultValue:
37616 type: string
37617 displayName:
37618 type: string
37619 empty:
37620 type: boolean
37621 mandatory:
37622 type: boolean
37623 name:
37624 type: string
37625 ownerId:
37626 type: string
37627 ownerIdIfEmpty:
37628 type: string
37629 writeOnly: true
37630 type:
37631 type: string
37632 validValues:
37633 type: array
37634 items:
37635 type: string
37636 version:
37637 type: string
37638 Model:
37639 type: object
37640 properties:
37641 derivedFrom:
37642 type: string
37643 modelType:
37644 type: string
37645 enum:
37646 - NORMATIVE
37647 - NORMATIVE_EXTENSION
37648 name:
37649 type: string
37650 ModelCreateRequest:
37651 type: object
37652 properties:
37653 derivedFrom:
37654 type: string
37655 modelType:
37656 type: string
37657 enum:
37658 - NORMATIVE
37659 - NORMATIVE_EXTENSION
37660 name:
37661 type: string
37662 maxLength: 2147483647
37663 minLength: 2
37664 required:
37665 - modelType
37666 - name
37667 NameIdPair:
37668 type: object
37669 additionalProperties:
37670 type: object
37671 properties:
37672 empty:
37673 type: boolean
37674 id:
37675 type: string
37676 name:
37677 type: string
37678 ownerId:
37679 type: string
37680 NameIdPairWrapper:
37681 type: object
37682 additionalProperties:
37683 type: object
37684 properties:
37685 data:
37686 type: object
37687 additionalProperties:
37688 type: object
37689 properties:
37690 empty:
37691 type: boolean
37692 id:
37693 type: string
37694 name:
37695 type: string
37696 ownerId:
37697 type: string
37698 empty:
37699 type: boolean
37700 id:
37701 type: string
37702 nameIdPair:
37703 type: object
37704 additionalProperties:
37705 type: object
37706 properties:
37707 empty:
37708 type: boolean
37709 id:
37710 type: string
37711 name:
37712 type: string
37713 ownerId:
37714 type: string
37715 NodeTypeMetadata:
37716 type: object
37717 properties:
37718 categories:
37719 type: array
37720 items:
37721 $ref: '#/components/schemas/CategoryDefinition'
37722 contactId:
37723 type: string
37724 description:
37725 type: string
37726 icon:
37727 type: string
37728 model:
37729 type: string
37730 name:
37731 type: string
37732 normative:
37733 type: boolean
37734 resourceIconPath:
37735 type: string
37736 resourceType:
37737 type: string
37738 resourceVendorModelNumber:
37739 type: string
37740 tags:
37741 type: array
37742 items:
37743 type: string
37744 toscaName:
37745 type: string
37746 vendorName:
37747 type: string
37748 vendorRelease:
37749 type: string
37750 NodeTypesMetadataList:
37751 type: object
37752 properties:
37753 nodeMetadataList:
37754 type: array
37755 items:
37756 $ref: '#/components/schemas/NodeTypeMetadata'
37757 OnboardingConfig:
37758 type: object
37759 properties:
37760 getLatestVspPackageUri:
37761 type: string
37762 getLatestVspUri:
37763 type: string
37764 getVspPackageUri:
37765 type: string
37766 getVspUri:
37767 type: string
37768 healthCheckUri:
37769 type: string
37770 host:
37771 type: string
37772 port:
37773 type: integer
37774 format: int32
37775 protocol:
37776 type: string
37777 OperationDataDefinition:
37778 type: object
37779 properties:
37780 creationDate:
37781 type: integer
37782 format: int64
37783 description:
37784 type: string
37785 empty:
37786 type: boolean
37787 implementation:
37788 $ref: '#/components/schemas/ArtifactDataDefinition'
37789 inputs:
37790 $ref: '#/components/schemas/ListDataDefinitionOperationInputDefinition'
37791 lastUpdateDate:
37792 type: integer
37793 format: int64
37794 name:
37795 type: string
37796 outputs:
37797 $ref: '#/components/schemas/ListDataDefinitionOperationOutputDefinition'
37798 ownerId:
37799 type: string
37800 ownerIdIfEmpty:
37801 type: string
37802 writeOnly: true
37803 type:
37804 type: string
37805 uniqueId:
37806 type: string
37807 version:
37808 type: string
37809 workflowAssociationType:
37810 type: string
37811 workflowId:
37812 type: string
37813 workflowName:
37814 type: string
37815 workflowVersion:
37816 type: string
37817 workflowVersionId:
37818 type: string
37819 OperationImplementation:
37820 type: object
37821 properties:
37822 dependencies:
37823 type: array
37824 items:
37825 type: string
37826 primary:
37827 type: string
37828 OperationInputDefinition:
37829 type: object
37830 properties:
37831 annotations:
37832 type: array
37833 items:
37834 $ref: '#/components/schemas/Annotation'
37835 defaultValue:
37836 type: string
37837 definition:
37838 type: boolean
37839 description:
37840 type: string
37841 empty:
37842 type: boolean
37843 getInputProperty:
37844 type: boolean
37845 getInputValues:
37846 type: array
37847 items:
37848 $ref: '#/components/schemas/GetInputValueDataDefinition'
37849 getPolicyValues:
37850 type: array
37851 items:
37852 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
37853 hidden:
37854 type: boolean
37855 immutable:
37856 type: boolean
37857 inputId:
37858 type: string
37859 inputPath:
37860 type: string
37861 instanceUniqueId:
37862 type: string
37863 isDeclaredListInput:
37864 type: boolean
37865 label:
37866 type: string
37867 mappedToComponentProperty:
37868 type: boolean
37869 metadata:
37870 type: object
37871 additionalProperties:
37872 type: string
37873 model:
37874 type: string
37875 name:
37876 type: string
37877 ownerId:
37878 type: string
37879 ownerIdIfEmpty:
37880 type: string
37881 writeOnly: true
37882 parentPropertyType:
37883 type: string
37884 parentUniqueId:
37885 type: string
37886 password:
37887 type: boolean
37888 propertyConstraints:
37889 type: array
37890 items:
37891 type: string
37892 propertyId:
37893 type: string
37894 required:
37895 type: boolean
37896 schema:
37897 $ref: '#/components/schemas/SchemaDefinition'
37898 schemaProperty:
37899 $ref: '#/components/schemas/PropertyDataDefinition'
37900 schemaType:
37901 type: string
37902 source:
37903 type: string
37904 sourceProperty:
37905 type: string
37906 status:
37907 type: string
37908 subPropertyInputPath:
37909 type: string
37910 subPropertyToscaFunctions:
37911 type: array
37912 items:
37913 $ref: '#/components/schemas/SubPropertyToscaFunction'
37914 toscaDefaultValue:
37915 type: string
37916 toscaFunction:
37917 $ref: '#/components/schemas/ToscaFunction'
37918 toscaGetFunction:
37919 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
37920 toscaGetFunctionType:
37921 type: string
37922 enum:
37923 - GET_INPUT
37924 - GET_PROPERTY
37925 - GET_ATTRIBUTE
37926 type:
37927 type: string
37928 uniqueId:
37929 type: string
37930 userCreated:
37931 type: boolean
37932 value:
37933 type: string
37934 version:
37935 type: string
37936 OperationInstance:
37937 type: object
37938 properties:
37939 implementation:
37940 $ref: '#/components/schemas/OperationImplementation'
37941 inputs:
37942 type: object
37943 additionalProperties:
37944 type: object
37945 OperationOutputDefinition:
37946 type: object
37947 properties:
37948 annotations:
37949 type: array
37950 items:
37951 $ref: '#/components/schemas/Annotation'
37952 defaultValue:
37953 type: string
37954 definition:
37955 type: boolean
37956 description:
37957 type: string
37958 empty:
37959 type: boolean
37960 getInputProperty:
37961 type: boolean
37962 getInputValues:
37963 type: array
37964 items:
37965 $ref: '#/components/schemas/GetInputValueDataDefinition'
37966 getPolicyValues:
37967 type: array
37968 items:
37969 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
37970 hidden:
37971 type: boolean
37972 immutable:
37973 type: boolean
37974 inputId:
37975 type: string
37976 inputPath:
37977 type: string
37978 instanceUniqueId:
37979 type: string
37980 isDeclaredListInput:
37981 type: boolean
37982 label:
37983 type: string
37984 mappedToComponentProperty:
37985 type: boolean
37986 metadata:
37987 type: object
37988 additionalProperties:
37989 type: string
37990 model:
37991 type: string
37992 name:
37993 type: string
37994 ownerId:
37995 type: string
37996 ownerIdIfEmpty:
37997 type: string
37998 writeOnly: true
37999 parentPropertyType:
38000 type: string
38001 parentUniqueId:
38002 type: string
38003 password:
38004 type: boolean
38005 propertyConstraints:
38006 type: array
38007 items:
38008 type: string
38009 propertyId:
38010 type: string
38011 required:
38012 type: boolean
38013 schema:
38014 $ref: '#/components/schemas/SchemaDefinition'
38015 schemaProperty:
38016 $ref: '#/components/schemas/PropertyDataDefinition'
38017 schemaType:
38018 type: string
38019 status:
38020 type: string
38021 subPropertyInputPath:
38022 type: string
38023 subPropertyToscaFunctions:
38024 type: array
38025 items:
38026 $ref: '#/components/schemas/SubPropertyToscaFunction'
38027 toscaFunction:
38028 $ref: '#/components/schemas/ToscaFunction'
38029 toscaGetFunction:
38030 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
38031 toscaGetFunctionType:
38032 type: string
38033 enum:
38034 - GET_INPUT
38035 - GET_PROPERTY
38036 - GET_ATTRIBUTE
38037 type:
38038 type: string
38039 uniqueId:
38040 type: string
38041 userCreated:
38042 type: boolean
38043 value:
38044 type: string
38045 version:
38046 type: string
38047 OperationUi:
38048 type: object
38049 properties:
38050 implementation:
38051 type: object
38052 inputs:
38053 type: array
38054 items:
38055 $ref: '#/components/schemas/PropertyAssignmentUi'
38056 interfaceType:
38057 type: string
38058 operationType:
38059 type: string
38060 OutputDefinition:
38061 type: object
38062 properties:
38063 attribute:
38064 $ref: '#/components/schemas/ComponentInstanceAttribute'
38065 attributeId:
38066 type: string
38067 defaultValue:
38068 type: string
38069 definition:
38070 type: boolean
38071 description:
38072 type: string
38073 empty:
38074 type: boolean
38075 entry_schema:
38076 $ref: '#/components/schemas/EntrySchema'
38077 getOutputAttribute:
38078 type: boolean
38079 getOutputValues:
38080 type: array
38081 items:
38082 $ref: '#/components/schemas/GetOutputValueDataDefinition'
38083 get_default:
38084 type: object
38085 instanceUniqueId:
38086 type: string
38087 model:
38088 type: string
38089 name:
38090 type: string
38091 outputId:
38092 type: string
38093 outputPath:
38094 type: string
38095 ownerId:
38096 type: string
38097 ownerIdIfEmpty:
38098 type: string
38099 writeOnly: true
38100 parentUniqueId:
38101 type: string
38102 schema:
38103 $ref: '#/components/schemas/SchemaDefinition'
38104 schemaType:
38105 type: string
38106 status:
38107 type: string
38108 type:
38109 type: string
38110 uniqueId:
38111 type: string
38112 value:
38113 type: string
38114 version:
38115 type: string
38116 PathsAndNamesDefinition:
38117 type: object
38118 properties:
38119 friendlyName:
38120 type: string
38121 path:
38122 type: string
38123 searchable:
38124 type: boolean
38125 PolicyDefinition:
38126 type: object
38127 properties:
38128 annotations:
38129 type: array
38130 items:
38131 $ref: '#/components/schemas/Annotation'
38132 componentName:
38133 type: string
38134 defaultValue:
38135 type: string
38136 definition:
38137 type: boolean
38138 derivedFrom:
38139 type: string
38140 description:
38141 type: string
38142 empty:
38143 type: boolean
38144 getInputProperty:
38145 type: boolean
38146 getInputValues:
38147 type: array
38148 items:
38149 $ref: '#/components/schemas/GetInputValueDataDefinition'
38150 getPolicyValues:
38151 type: array
38152 items:
38153 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
38154 hidden:
38155 type: boolean
38156 immutable:
38157 type: boolean
38158 inputId:
38159 type: string
38160 inputPath:
38161 type: string
38162 instanceUniqueId:
38163 type: string
38164 invariantName:
38165 type: string
38166 invariantUUID:
38167 type: string
38168 isDeclaredListInput:
38169 type: boolean
38170 isFromCsar:
38171 type: boolean
38172 label:
38173 type: string
38174 mappedToComponentProperty:
38175 type: boolean
38176 metadata:
38177 type: object
38178 additionalProperties:
38179 type: string
38180 model:
38181 type: string
38182 name:
38183 type: string
38184 normalizedName:
38185 type: string
38186 ownerId:
38187 type: string
38188 ownerIdIfEmpty:
38189 type: string
38190 writeOnly: true
38191 parentPropertyType:
38192 type: string
38193 parentUniqueId:
38194 type: string
38195 password:
38196 type: boolean
38197 policyTypeName:
38198 type: string
38199 policyTypeUid:
38200 type: string
38201 policyUUID:
38202 type: string
38203 properties:
38204 type: array
38205 items:
38206 $ref: '#/components/schemas/PropertyDataDefinition'
38207 propertyConstraints:
38208 type: array
38209 items:
38210 type: string
38211 propertyId:
38212 type: string
38213 required:
38214 type: boolean
38215 schema:
38216 $ref: '#/components/schemas/SchemaDefinition'
38217 schemaProperty:
38218 $ref: '#/components/schemas/PropertyDataDefinition'
38219 schemaType:
38220 type: string
38221 status:
38222 type: string
38223 subPropertyInputPath:
38224 type: string
38225 subPropertyToscaFunctions:
38226 type: array
38227 items:
38228 $ref: '#/components/schemas/SubPropertyToscaFunction'
38229 targets:
38230 type: object
38231 additionalProperties:
38232 type: array
38233 items:
38234 type: string
38235 toscaFunction:
38236 $ref: '#/components/schemas/ToscaFunction'
38237 toscaGetFunction:
38238 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
38239 toscaGetFunctionType:
38240 type: string
38241 enum:
38242 - GET_INPUT
38243 - GET_PROPERTY
38244 - GET_ATTRIBUTE
38245 type:
38246 type: string
38247 uniqueId:
38248 type: string
38249 userCreated:
38250 type: boolean
38251 value:
38252 type: string
38253 version:
38254 type: string
38255 PolicyTargetDTO:
38256 type: object
38257 properties:
38258 type:
38259 type: string
38260 uniqueIds:
38261 type: array
38262 items:
38263 type: string
38264 PolicyTypeDefinition:
38265 type: object
38266 properties:
38267 creationTime:
38268 type: integer
38269 format: int64
38270 derivedFrom:
38271 type: string
38272 description:
38273 type: string
38274 empty:
38275 type: boolean
38276 highestVersion:
38277 type: boolean
38278 icon:
38279 type: string
38280 metadata:
38281 type: object
38282 additionalProperties:
38283 type: string
38284 model:
38285 type: string
38286 modificationTime:
38287 type: integer
38288 format: int64
38289 name:
38290 type: string
38291 ownerId:
38292 type: string
38293 ownerIdIfEmpty:
38294 type: string
38295 writeOnly: true
38296 properties:
38297 type: array
38298 items:
38299 $ref: '#/components/schemas/PropertyDefinition'
38300 targets:
38301 type: array
38302 items:
38303 type: string
38304 type:
38305 type: string
38306 uniqueId:
38307 type: string
38308 version:
38309 type: string
38310 PropertyAssignmentUi:
38311 type: object
38312 properties:
38313 name:
38314 type: string
38315 type:
38316 type: string
38317 value:
38318 type: string
38319 PropertyConstraint:
38320 type: object
38321 PropertyDataDefinition:
38322 type: object
38323 properties:
38324 annotations:
38325 type: array
38326 items:
38327 $ref: '#/components/schemas/Annotation'
38328 defaultValue:
38329 type: string
38330 definition:
38331 type: boolean
38332 description:
38333 type: string
38334 empty:
38335 type: boolean
38336 getInputProperty:
38337 type: boolean
38338 getInputValues:
38339 type: array
38340 items:
38341 $ref: '#/components/schemas/GetInputValueDataDefinition'
38342 getPolicyValues:
38343 type: array
38344 items:
38345 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
38346 hidden:
38347 type: boolean
38348 immutable:
38349 type: boolean
38350 inputId:
38351 type: string
38352 inputPath:
38353 type: string
38354 instanceUniqueId:
38355 type: string
38356 isDeclaredListInput:
38357 type: boolean
38358 label:
38359 type: string
38360 mappedToComponentProperty:
38361 type: boolean
38362 metadata:
38363 type: object
38364 additionalProperties:
38365 type: string
38366 model:
38367 type: string
38368 name:
38369 type: string
38370 ownerId:
38371 type: string
38372 ownerIdIfEmpty:
38373 type: string
38374 writeOnly: true
38375 parentPropertyType:
38376 type: string
38377 parentUniqueId:
38378 type: string
38379 password:
38380 type: boolean
38381 propertyConstraints:
38382 type: array
38383 items:
38384 type: string
38385 propertyId:
38386 type: string
38387 required:
38388 type: boolean
38389 schema:
38390 $ref: '#/components/schemas/SchemaDefinition'
38391 schemaProperty:
38392 $ref: '#/components/schemas/PropertyDataDefinition'
38393 schemaType:
38394 type: string
38395 status:
38396 type: string
38397 subPropertyInputPath:
38398 type: string
38399 subPropertyToscaFunctions:
38400 type: array
38401 items:
38402 $ref: '#/components/schemas/SubPropertyToscaFunction'
38403 toscaFunction:
38404 $ref: '#/components/schemas/ToscaFunction'
38405 toscaGetFunction:
38406 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
38407 toscaGetFunctionType:
38408 type: string
38409 enum:
38410 - GET_INPUT
38411 - GET_PROPERTY
38412 - GET_ATTRIBUTE
38413 type:
38414 type: string
38415 uniqueId:
38416 type: string
38417 userCreated:
38418 type: boolean
38419 value:
38420 type: string
38421 version:
38422 type: string
38423 PropertyDefinition:
38424 type: object
38425 properties:
38426 annotations:
38427 type: array
38428 items:
38429 $ref: '#/components/schemas/Annotation'
38430 constraints:
38431 type: array
38432 items:
38433 $ref: '#/components/schemas/PropertyConstraint'
38434 defaultValue:
38435 type: string
38436 definition:
38437 type: boolean
38438 description:
38439 type: string
38440 empty:
38441 type: boolean
38442 getInputProperty:
38443 type: boolean
38444 getInputValues:
38445 type: array
38446 items:
38447 $ref: '#/components/schemas/GetInputValueDataDefinition'
38448 getPolicyValues:
38449 type: array
38450 items:
38451 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
38452 hidden:
38453 type: boolean
38454 immutable:
38455 type: boolean
38456 inputId:
38457 type: string
38458 inputPath:
38459 type: string
38460 instanceUniqueId:
38461 type: string
38462 isDeclaredListInput:
38463 type: boolean
38464 label:
38465 type: string
38466 mappedToComponentProperty:
38467 type: boolean
38468 metadata:
38469 type: object
38470 additionalProperties:
38471 type: string
38472 model:
38473 type: string
38474 name:
38475 type: string
38476 ownerId:
38477 type: string
38478 ownerIdIfEmpty:
38479 type: string
38480 writeOnly: true
38481 parentPropertyType:
38482 type: string
38483 parentUniqueId:
38484 type: string
38485 password:
38486 type: boolean
38487 propertyConstraints:
38488 type: array
38489 items:
38490 type: string
38491 propertyId:
38492 type: string
38493 required:
38494 type: boolean
38495 schema:
38496 $ref: '#/components/schemas/SchemaDefinition'
38497 schemaProperty:
38498 $ref: '#/components/schemas/PropertyDataDefinition'
38499 schemaType:
38500 type: string
38501 status:
38502 type: string
38503 subPropertyInputPath:
38504 type: string
38505 subPropertyToscaFunctions:
38506 type: array
38507 items:
38508 $ref: '#/components/schemas/SubPropertyToscaFunction'
38509 toscaFunction:
38510 $ref: '#/components/schemas/ToscaFunction'
38511 toscaGetFunction:
38512 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
38513 toscaGetFunctionType:
38514 type: string
38515 enum:
38516 - GET_INPUT
38517 - GET_PROPERTY
38518 - GET_ATTRIBUTE
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]38519 toscaSubPath:
38520 type: string
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]38521 type:
38522 type: string
38523 uniqueId:
38524 type: string
38525 userCreated:
38526 type: boolean
38527 value:
38528 type: string
38529 version:
38530 type: string
38531 PropertyDefinitionDto:
38532 type: object
38533 properties:
38534 constraints:
38535 type: array
38536 items:
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]38537 type: object
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]38538 defaultValue:
38539 type: object
38540 description:
38541 type: string
38542 name:
38543 type: string
38544 required:
38545 type: boolean
38546 schemaType:
38547 type: string
38548 type:
38549 type: string
38550 uniqueId:
38551 type: string
38552 value:
38553 type: object
38554 PropertyFilterConstraintDataDefinition:
38555 type: object
38556 properties:
38557 capabilityName:
38558 type: string
38559 operator:
38560 type: string
38561 enum:
38562 - EQUAL
38563 - IN_RANGE
38564 - GREATER_THAN
38565 - GREATER_OR_EQUAL
38566 - LESS_OR_EQUAL
38567 - LENGTH
38568 - MIN_LENGTH
38569 - MAX_LENGTH
38570 - VALID_VALUES
38571 - LESS_THAN
38572 - PATTERN
38573 - SCHEMA
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]38574 originalType:
38575 type: string
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]38576 propertyName:
38577 type: string
38578 targetType:
38579 type: string
38580 enum:
38581 - CAPABILITY
38582 - PROPERTY
38583 value:
38584 type: object
38585 valueType:
38586 type: string
38587 enum:
38588 - STATIC
38589 - GET_PROPERTY
38590 - GET_INPUT
38591 - GET_ATTRIBUTE
38592 - YAML
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]38593 - CUSTOM
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]38594 - CONCAT
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]38595 - SEVERAL
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]38596 PropertyFilterDataDefinition:
38597 type: object
38598 properties:
38599 constraints:
38600 type: array
38601 items:
38602 $ref: '#/components/schemas/PropertyFilterConstraintDataDefinition'
38603 empty:
38604 type: boolean
38605 name:
38606 type: string
38607 ownerId:
38608 type: string
38609 ownerIdIfEmpty:
38610 type: string
38611 writeOnly: true
38612 type:
38613 type: string
38614 version:
38615 type: string
38616 PropertyRule:
38617 type: object
38618 properties:
38619 empty:
38620 type: boolean
38621 ownerId:
38622 type: string
38623 ownerIdIfEmpty:
38624 type: string
38625 writeOnly: true
38626 rule:
38627 type: array
38628 items:
38629 type: string
38630 type:
38631 type: string
38632 value:
38633 type: string
38634 version:
38635 type: string
38636 QueueInfo:
38637 type: object
38638 properties:
38639 numberOfCacheWorkers:
38640 type: integer
38641 format: int32
38642 syncIntervalInSecondes:
38643 type: integer
38644 format: int32
38645 waitOnShutDownInMinutes:
38646 type: integer
38647 format: int32
38648 RelationshipImpl:
38649 type: object
38650 properties:
38651 type:
38652 type: string
38653 RelationshipInfo:
38654 type: object
38655 properties:
38656 capability:
38657 type: string
38658 capabilityOwnerId:
38659 type: string
38660 capabilityUid:
38661 type: string
38662 id:
38663 type: string
38664 relationship:
38665 $ref: '#/components/schemas/RelationshipImpl'
38666 relationships:
38667 $ref: '#/components/schemas/RelationshipImpl'
38668 requirement:
38669 type: string
38670 requirementOwnerId:
38671 type: string
38672 requirementUid:
38673 type: string
38674 ReplaceVNFInfo:
38675 type: object
38676 properties:
38677 abstractResourceUniqueId:
38678 type: string
38679 realVNFComponentInstance:
38680 $ref: '#/components/schemas/ComponentInstance'
38681 serviceUniqueId:
38682 type: string
38683 RequirementCapabilityRelDef:
38684 type: object
38685 properties:
38686 fromNode:
38687 type: string
38688 originUI:
38689 type: boolean
38690 relationships:
38691 type: array
38692 items:
38693 $ref: '#/components/schemas/CapabilityRequirementRelationship'
38694 toNode:
38695 type: string
38696 uid:
38697 type: string
38698 RequirementDataDefinition:
38699 type: object
38700 properties:
38701 capability:
38702 type: string
38703 empty:
38704 type: boolean
38705 external:
38706 type: boolean
38707 externalName:
38708 type: string
38709 leftOccurrences:
38710 type: string
38711 maxOccurrences:
38712 type: string
38713 minOccurrences:
38714 type: string
38715 name:
38716 type: string
38717 node:
38718 type: string
38719 ownerId:
38720 type: string
38721 ownerIdIfEmpty:
38722 type: string
38723 writeOnly: true
38724 ownerName:
38725 type: string
38726 parentName:
38727 type: string
38728 path:
38729 type: array
38730 items:
38731 type: string
38732 previousName:
38733 type: string
38734 relationship:
38735 type: string
38736 source:
38737 type: string
38738 type:
38739 type: string
38740 uniqueId:
38741 type: string
38742 version:
38743 type: string
38744 RequirementDefinition:
38745 type: object
38746 properties:
38747 capability:
38748 type: string
38749 empty:
38750 type: boolean
38751 external:
38752 type: boolean
38753 externalName:
38754 type: string
38755 leftOccurrences:
38756 type: string
38757 maxOccurrences:
38758 type: string
38759 minOccurrences:
38760 type: string
38761 name:
38762 type: string
38763 node:
38764 type: string
38765 ownerId:
38766 type: string
38767 ownerIdIfEmpty:
38768 type: string
38769 writeOnly: true
38770 ownerName:
38771 type: string
38772 parentName:
38773 type: string
38774 path:
38775 type: array
38776 items:
38777 type: string
38778 previousName:
38779 type: string
38780 relationship:
38781 type: string
38782 source:
38783 type: string
38784 type:
38785 type: string
38786 uniqueId:
38787 type: string
38788 version:
38789 type: string
38790 RequirementNodeFilterCapabilityDataDefinition:
38791 type: object
38792 properties:
38793 empty:
38794 type: boolean
38795 name:
38796 type: string
38797 ownerId:
38798 type: string
38799 ownerIdIfEmpty:
38800 type: string
38801 writeOnly: true
38802 properties:
38803 $ref: '#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition'
38804 type:
38805 type: string
38806 version:
38807 type: string
38808 RequirementSubstitutionFilterCapabilityDataDefinition:
38809 type: object
38810 properties:
38811 empty:
38812 type: boolean
38813 name:
38814 type: string
38815 ownerId:
38816 type: string
38817 ownerIdIfEmpty:
38818 type: string
38819 writeOnly: true
38820 properties:
38821 $ref: '#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition'
38822 type:
38823 type: string
38824 version:
38825 type: string
38826 Resource:
38827 type: object
38828 properties:
38829 abstract:
38830 type: boolean
38831 actualComponentType:
38832 type: string
38833 additionalInformation:
38834 type: array
38835 items:
38836 $ref: '#/components/schemas/AdditionalInformationDefinition'
38837 allArtifacts:
38838 type: object
38839 additionalProperties:
38840 $ref: '#/components/schemas/ArtifactDefinition'
38841 allVersions:
38842 type: object
38843 additionalProperties:
38844 type: string
38845 archiveTime:
38846 type: integer
38847 format: int64
38848 archived:
38849 type: boolean
38850 artifacts:
38851 type: object
38852 additionalProperties:
38853 $ref: '#/components/schemas/ArtifactDefinition'
38854 attributes:
38855 type: array
38856 items:
38857 $ref: '#/components/schemas/AttributeDefinition'
38858 capabilities:
38859 type: object
38860 additionalProperties:
38861 type: array
38862 items:
38863 $ref: '#/components/schemas/CapabilityDefinition'
38864 categories:
38865 type: array
38866 items:
38867 $ref: '#/components/schemas/CategoryDefinition'
38868 categorySpecificMetadata:
38869 type: object
38870 additionalProperties:
38871 type: string
38872 componentInstances:
38873 type: array
38874 items:
38875 $ref: '#/components/schemas/ComponentInstance'
38876 componentInstancesAttributes:
38877 type: object
38878 additionalProperties:
38879 type: array
38880 items:
38881 $ref: '#/components/schemas/ComponentInstanceAttribute'
38882 componentInstancesInputs:
38883 type: object
38884 additionalProperties:
38885 type: array
38886 items:
38887 $ref: '#/components/schemas/ComponentInstanceInput'
38888 componentInstancesInterfaces:
38889 type: object
38890 additionalProperties:
38891 type: array
38892 items:
38893 $ref: '#/components/schemas/ComponentInstanceInterface'
38894 componentInstancesOutputs:
38895 type: object
38896 additionalProperties:
38897 type: array
38898 items:
38899 $ref: '#/components/schemas/ComponentInstanceOutput'
38900 componentInstancesProperties:
38901 type: object
38902 additionalProperties:
38903 type: array
38904 items:
38905 $ref: '#/components/schemas/ComponentInstanceProperty'
38906 componentInstancesRelations:
38907 type: array
38908 items:
38909 $ref: '#/components/schemas/RequirementCapabilityRelDef'
38910 componentMetadataForSupportLog:
38911 type: object
38912 additionalProperties:
38913 type: string
38914 componentType:
38915 type: string
38916 enum:
38917 - RESOURCE
38918 - SERVICE
38919 - RESOURCE_INSTANCE
38920 - PRODUCT
38921 - SERVICE_INSTANCE
38922 conformanceLevel:
38923 type: string
38924 contactId:
38925 type: string
38926 cost:
38927 type: string
38928 creationDate:
38929 type: integer
38930 format: int64
38931 creatorFullName:
38932 type: string
38933 creatorUserId:
38934 type: string
38935 csarUUID:
38936 type: string
38937 csarVersion:
38938 type: string
38939 csarVersionId:
38940 type: string
38941 dataTypes:
38942 type: array
38943 items:
38944 $ref: '#/components/schemas/DataTypeDefinition'
38945 deploymentArtifacts:
38946 type: object
38947 additionalProperties:
38948 $ref: '#/components/schemas/ArtifactDefinition'
38949 derivedFrom:
38950 type: array
38951 items:
38952 type: string
38953 derivedFromGenericInfo:
38954 $ref: '#/components/schemas/Resource'
38955 derivedFromGenericType:
38956 type: string
38957 derivedFromGenericVersion:
38958 type: string
38959 derivedFromMapOfIdToName:
38960 type: object
38961 additionalProperties:
38962 type: string
38963 derivedList:
38964 type: array
38965 items:
38966 type: string
38967 description:
38968 type: string
38969 groups:
38970 type: array
38971 items:
38972 $ref: '#/components/schemas/GroupDefinition'
38973 highestVersion:
38974 type: boolean
38975 icon:
38976 type: string
38977 importedToscaChecksum:
38978 type: string
38979 inputs:
38980 type: array
38981 items:
38982 $ref: '#/components/schemas/InputDefinition'
38983 interfaces:
38984 type: object
38985 additionalProperties:
38986 $ref: '#/components/schemas/InterfaceDefinition'
38987 invariantUUID:
38988 type: string
38989 isDeleted:
38990 type: boolean
38991 lastUpdateDate:
38992 type: integer
38993 format: int64
38994 lastUpdaterFullName:
38995 type: string
38996 lastUpdaterUserId:
38997 type: string
38998 licenseType:
38999 type: string
39000 lifecycleState:
39001 type: string
39002 enum:
39003 - CERTIFIED
39004 - NOT_CERTIFIED_CHECKIN
39005 - NOT_CERTIFIED_CHECKOUT
39006 model:
39007 type: string
39008 name:
39009 type: string
39010 nodeFilterComponents:
39011 type: object
39012 additionalProperties:
39013 $ref: '#/components/schemas/CINodeFilterDataDefinition'
39014 normalizedName:
39015 type: string
39016 outputs:
39017 type: array
39018 items:
39019 $ref: '#/components/schemas/OutputDefinition'
39020 policies:
39021 type: object
39022 additionalProperties:
39023 $ref: '#/components/schemas/PolicyDefinition'
39024 projectCode:
39025 type: string
39026 properties:
39027 type: array
39028 items:
39029 $ref: '#/components/schemas/PropertyDefinition'
39030 requirements:
39031 type: object
39032 additionalProperties:
39033 type: array
39034 items:
39035 $ref: '#/components/schemas/RequirementDefinition'
39036 resourceType:
39037 type: string
39038 enum:
39039 - VFC
39040 - VF
39041 - CR
39042 - CP
39043 - PNF
39044 - CVFC
39045 - VL
39046 - VFCMT
39047 - Configuration
39048 - ServiceProxy
39049 - ABSTRACT
39050 - SERVICE
39051 resourceVendorModelNumber:
39052 type: string
39053 service:
39054 type: boolean
39055 specificComponetTypeArtifacts:
39056 type: object
39057 additionalProperties:
39058 $ref: '#/components/schemas/ArtifactDefinition'
39059 writeOnly: true
39060 state:
39061 type: string
39062 enum:
39063 - CERTIFIED
39064 - NOT_CERTIFIED_CHECKIN
39065 - NOT_CERTIFIED_CHECKOUT
39066 writeOnly: true
39067 substitutionFilter:
39068 $ref: '#/components/schemas/SubstitutionFilterDataDefinition'
39069 systemName:
39070 type: string
39071 tags:
39072 type: array
39073 items:
39074 type: string
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]39075 tenant:
39076 type: string
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]39077 topologyTemplate:
39078 type: boolean
39079 toscaArtifacts:
39080 type: object
39081 additionalProperties:
39082 $ref: '#/components/schemas/ArtifactDefinition'
39083 toscaResourceName:
39084 type: string
39085 toscaType:
39086 type: string
39087 toscaVersion:
39088 type: string
39089 uniqueId:
39090 type: string
39091 uuid:
39092 type: string
39093 vendorName:
39094 type: string
39095 vendorRelease:
39096 type: string
39097 version:
39098 type: string
39099 vspArchived:
39100 type: boolean
39101 SchemaDefinition:
39102 type: object
39103 properties:
39104 constraints:
39105 type: array
39106 items:
39107 type: string
39108 derivedFrom:
39109 type: string
39110 empty:
39111 type: boolean
39112 ownerId:
39113 type: string
39114 ownerIdIfEmpty:
39115 type: string
39116 writeOnly: true
39117 properties:
39118 type: object
39119 additionalProperties:
39120 $ref: '#/components/schemas/PropertyDataDefinition'
39121 property:
39122 $ref: '#/components/schemas/PropertyDataDefinition'
39123 type:
39124 type: string
39125 version:
39126 type: string
39127 Service:
39128 type: object
39129 properties:
39130 abstract:
39131 type: boolean
39132 writeOnly: true
39133 actualComponentType:
39134 type: string
39135 additionalInformation:
39136 type: array
39137 items:
39138 $ref: '#/components/schemas/AdditionalInformationDefinition'
39139 allArtifacts:
39140 type: object
39141 additionalProperties:
39142 $ref: '#/components/schemas/ArtifactDefinition'
39143 allVersions:
39144 type: object
39145 additionalProperties:
39146 type: string
39147 archiveTime:
39148 type: integer
39149 format: int64
39150 archived:
39151 type: boolean
39152 artifacts:
39153 type: object
39154 additionalProperties:
39155 $ref: '#/components/schemas/ArtifactDefinition'
39156 attributes:
39157 type: array
39158 items:
39159 $ref: '#/components/schemas/AttributeDefinition'
39160 capabilities:
39161 type: object
39162 additionalProperties:
39163 type: array
39164 items:
39165 $ref: '#/components/schemas/CapabilityDefinition'
39166 categories:
39167 type: array
39168 items:
39169 $ref: '#/components/schemas/CategoryDefinition'
39170 categorySpecificMetadata:
39171 type: object
39172 additionalProperties:
39173 type: string
39174 componentInstances:
39175 type: array
39176 items:
39177 $ref: '#/components/schemas/ComponentInstance'
39178 componentInstancesAttributes:
39179 type: object
39180 additionalProperties:
39181 type: array
39182 items:
39183 $ref: '#/components/schemas/ComponentInstanceAttribute'
39184 componentInstancesInputs:
39185 type: object
39186 additionalProperties:
39187 type: array
39188 items:
39189 $ref: '#/components/schemas/ComponentInstanceInput'
39190 componentInstancesInterfaces:
39191 type: object
39192 additionalProperties:
39193 type: array
39194 items:
39195 $ref: '#/components/schemas/ComponentInstanceInterface'
39196 componentInstancesOutputs:
39197 type: object
39198 additionalProperties:
39199 type: array
39200 items:
39201 $ref: '#/components/schemas/ComponentInstanceOutput'
39202 componentInstancesProperties:
39203 type: object
39204 additionalProperties:
39205 type: array
39206 items:
39207 $ref: '#/components/schemas/ComponentInstanceProperty'
39208 componentInstancesRelations:
39209 type: array
39210 items:
39211 $ref: '#/components/schemas/RequirementCapabilityRelDef'
39212 componentMetadataForSupportLog:
39213 type: object
39214 additionalProperties:
39215 type: string
39216 componentType:
39217 type: string
39218 enum:
39219 - RESOURCE
39220 - SERVICE
39221 - RESOURCE_INSTANCE
39222 - PRODUCT
39223 - SERVICE_INSTANCE
39224 conformanceLevel:
39225 type: string
39226 contactId:
39227 type: string
39228 creationDate:
39229 type: integer
39230 format: int64
39231 creatorFullName:
39232 type: string
39233 creatorUserId:
39234 type: string
39235 csarUUID:
39236 type: string
39237 csarVersion:
39238 type: string
39239 dataTypes:
39240 type: array
39241 items:
39242 $ref: '#/components/schemas/DataTypeDefinition'
39243 deploymentArtifacts:
39244 type: object
39245 additionalProperties:
39246 $ref: '#/components/schemas/ArtifactDefinition'
39247 derivedFromGenericInfo:
39248 $ref: '#/components/schemas/Resource'
39249 derivedFromGenericType:
39250 type: string
39251 derivedFromGenericVersion:
39252 type: string
39253 description:
39254 type: string
39255 distributionStatus:
39256 type: string
39257 enum:
39258 - DISTRIBUTION_NOT_APPROVED
39259 - DISTRIBUTED
39260 ecompGeneratedNaming:
39261 type: boolean
39262 environmentContext:
39263 type: string
39264 forwardingPaths:
39265 type: object
39266 additionalProperties:
39267 $ref: '#/components/schemas/ForwardingPathDataDefinition'
39268 groups:
39269 type: array
39270 items:
39271 $ref: '#/components/schemas/GroupDefinition'
39272 highestVersion:
39273 type: boolean
39274 icon:
39275 type: string
39276 importedToscaChecksum:
39277 type: string
39278 inputs:
39279 type: array
39280 items:
39281 $ref: '#/components/schemas/InputDefinition'
39282 instantiationType:
39283 type: string
39284 interfaces:
39285 type: object
39286 additionalProperties:
39287 $ref: '#/components/schemas/InterfaceDefinition'
39288 invariantUUID:
39289 type: string
39290 isDeleted:
39291 type: boolean
39292 lastUpdateDate:
39293 type: integer
39294 format: int64
39295 lastUpdaterFullName:
39296 type: string
39297 lastUpdaterUserId:
39298 type: string
39299 lifecycleState:
39300 type: string
39301 enum:
39302 - CERTIFIED
39303 - NOT_CERTIFIED_CHECKIN
39304 - NOT_CERTIFIED_CHECKOUT
39305 model:
39306 type: string
39307 name:
39308 type: string
39309 namingPolicy:
39310 type: string
39311 nodeFilterComponents:
39312 type: object
39313 additionalProperties:
39314 $ref: '#/components/schemas/CINodeFilterDataDefinition'
39315 normalizedName:
39316 type: string
39317 outputs:
39318 type: array
39319 items:
39320 $ref: '#/components/schemas/OutputDefinition'
39321 policies:
39322 type: object
39323 additionalProperties:
39324 $ref: '#/components/schemas/PolicyDefinition'
39325 projectCode:
39326 type: string
39327 properties:
39328 type: array
39329 items:
39330 $ref: '#/components/schemas/PropertyDefinition'
39331 requirements:
39332 type: object
39333 additionalProperties:
39334 type: array
39335 items:
39336 $ref: '#/components/schemas/RequirementDefinition'
39337 service:
39338 type: boolean
39339 serviceApiArtifacts:
39340 type: object
39341 additionalProperties:
39342 $ref: '#/components/schemas/ArtifactDefinition'
39343 serviceFunction:
39344 type: string
39345 serviceRole:
39346 type: string
39347 serviceType:
39348 type: string
39349 serviceVendorModelNumber:
39350 type: string
39351 writeOnly: true
39352 specificComponetTypeArtifacts:
39353 type: object
39354 additionalProperties:
39355 $ref: '#/components/schemas/ArtifactDefinition'
39356 writeOnly: true
39357 state:
39358 type: string
39359 enum:
39360 - CERTIFIED
39361 - NOT_CERTIFIED_CHECKIN
39362 - NOT_CERTIFIED_CHECKOUT
39363 writeOnly: true
39364 substituteCandidate:
39365 type: boolean
39366 substitutionFilter:
39367 $ref: '#/components/schemas/SubstitutionFilterDataDefinition'
39368 systemName:
39369 type: string
39370 tags:
39371 type: array
39372 items:
39373 type: string
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]39374 tenant:
39375 type: string
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]39376 topologyTemplate:
39377 type: boolean
39378 toscaArtifacts:
39379 type: object
39380 additionalProperties:
39381 $ref: '#/components/schemas/ArtifactDefinition'
39382 toscaServiceName:
39383 type: string
39384 toscaType:
39385 type: string
39386 uniqueId:
39387 type: string
39388 uuid:
39389 type: string
39390 vendorName:
39391 type: string
39392 writeOnly: true
39393 vendorRelease:
39394 type: string
39395 writeOnly: true
39396 version:
39397 type: string
39398 vspArchived:
39399 type: boolean
39400 ServiceRelations:
39401 type: array
39402 items:
39403 $ref: '#/components/schemas/NameIdPairWrapper'
39404 properties:
39405 empty:
39406 type: boolean
39407 relations:
39408 type: array
39409 items:
39410 $ref: '#/components/schemas/NameIdPairWrapper'
39411 uniqueItems: true
39412 SubCategoryDefinition:
39413 type: object
39414 properties:
39415 empty:
39416 type: boolean
39417 groupings:
39418 type: array
39419 items:
39420 $ref: '#/components/schemas/GroupingDefinition'
39421 icons:
39422 type: array
39423 items:
39424 type: string
39425 metadataKeys:
39426 type: array
39427 items:
39428 $ref: '#/components/schemas/MetadataKeyDataDefinition'
39429 name:
39430 type: string
39431 normalizedName:
39432 type: string
39433 ownerId:
39434 type: string
39435 ownerIdIfEmpty:
39436 type: string
39437 writeOnly: true
39438 type:
39439 type: string
39440 uniqueId:
39441 type: string
39442 version:
39443 type: string
39444 SubPropertyToscaFunction:
39445 type: object
39446 properties:
39447 subPropertyPath:
39448 type: array
39449 items:
39450 type: string
39451 toscaFunction:
39452 $ref: '#/components/schemas/ToscaFunction'
39453 SubstitutionFilterDataDefinition:
39454 type: object
39455 properties:
39456 capabilities:
39457 $ref: '#/components/schemas/ListDataDefinitionRequirementSubstitutionFilterCapabilityDataDefinition'
39458 empty:
39459 type: boolean
39460 id:
39461 type: string
39462 name:
39463 type: string
39464 ownerId:
39465 type: string
39466 ownerIdIfEmpty:
39467 type: string
39468 writeOnly: true
39469 properties:
39470 $ref: '#/components/schemas/ListDataDefinitionSubstitutionFilterPropertyDataDefinition'
39471 tosca_id:
39472 type: object
39473 type:
39474 type: string
39475 version:
39476 type: string
39477 SubstitutionFilterPropertyDataDefinition:
39478 type: object
39479 properties:
39480 constraints:
39481 type: array
39482 items:
39483 $ref: '#/components/schemas/PropertyFilterConstraintDataDefinition'
39484 empty:
39485 type: boolean
39486 name:
39487 type: string
39488 ownerId:
39489 type: string
39490 ownerIdIfEmpty:
39491 type: string
39492 writeOnly: true
39493 type:
39494 type: string
39495 version:
39496 type: string
39497 SwitchoverDetectorConfig:
39498 type: object
39499 properties:
39500 beResolveAttempts:
39501 type: integer
39502 format: int32
39503 beVip:
39504 type: string
39505 changePriorityPassword:
39506 type: string
39507 changePriorityUser:
39508 type: string
39509 enabled:
39510 type: boolean
39511 feResolveAttempts:
39512 type: integer
39513 format: int32
39514 feVip:
39515 type: string
39516 getgBeFqdn:
39517 type: string
39518 getgFeFqdn:
39519 type: string
39520 groups:
39521 type: object
39522 additionalProperties:
39523 $ref: '#/components/schemas/GroupInfo'
39524 interval:
39525 type: integer
39526 format: int64
39527 publishNetworkBody:
39528 type: string
39529 publishNetworkUrl:
39530 type: string
39531 ToscaArtifactDataDefinition:
39532 type: object
39533 properties:
39534 file:
39535 type: string
39536 properties:
39537 type: object
39538 additionalProperties:
39539 type: object
39540 type:
39541 type: string
39542 ToscaFunction:
39543 type: object
39544 properties:
39545 jsonObjectValue:
39546 type: object
39547 type:
39548 type: string
39549 enum:
39550 - GET_INPUT
39551 - GET_PROPERTY
39552 - GET_ATTRIBUTE
39553 - CONCAT
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]39554 - CUSTOM
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]39555 - YAML
39556 - STRING
39557 value:
39558 type: string
39559 ToscaGetFunctionDataDefinition:
39560 type: object
39561 properties:
39562 functionType:
39563 type: string
39564 enum:
39565 - GET_INPUT
39566 - GET_PROPERTY
39567 - GET_ATTRIBUTE
39568 propertyName:
39569 type: string
39570 propertyPathFromSource:
39571 type: array
39572 items:
39573 type: string
39574 propertySource:
39575 type: string
39576 enum:
39577 - SELF
39578 - INSTANCE
39579 propertyUniqueId:
39580 type: string
39581 sourceName:
39582 type: string
39583 sourceUniqueId:
39584 type: string
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]39585 toscaIndexList:
39586 type: array
39587 items:
39588 type: object
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]39589 type:
39590 type: string
39591 enum:
39592 - GET_INPUT
39593 - GET_PROPERTY
39594 - GET_ATTRIBUTE
39595 - CONCAT
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]39596 - CUSTOM
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]39597 - YAML
39598 - STRING
39599 ToscaValidatorsConfig:
39600 type: object
39601 properties:
39602 stringMaxLength:
39603 type: integer
39604 format: int32
39605 UIConstraint:
39606 type: object
39607 properties:
39608 capabilityName:
39609 type: string
39610 constraintOperator:
39611 type: string
MichaelMorrisec12bc72023-06-28 15:01:34 +0100[diff] [blame]39612 originalType:
39613 type: string
Fiete Ostkamp81378322022-12-13 21:05:47 +0000[diff] [blame]39614 servicePropertyName:
39615 type: string
39616 sourceName:
39617 type: string
39618 sourceType:
39619 type: string
39620 value:
39621 type: object
39622 User:
39623 type: object
39624 properties:
39625 email:
39626 type: string
39627 firstName:
39628 type: string
39629 fullName:
39630 type: string
39631 lastLoginTime:
39632 type: integer
39633 format: int64
39634 lastName:
39635 type: string
39636 role:
39637 type: string
39638 status:
39639 type: string
39640 enum:
39641 - ACTIVE
39642 - INACTIVE
39643 userId:
39644 type: string
39645 UserRole:
39646 type: object
39647 properties:
39648 role:
39649 type: string
39650 enum:
39651 - ADMIN
39652 - TESTER
39653 - DESIGNER
39654 - PRODUCT_MANAGER
39655 - PRODUCT_STRATEGIST
39656 VfModuleProperty:
39657 type: object
39658 properties:
39659 forBaseModule:
39660 type: string
39661 forNonBaseModule:
39662 type: string